api-management-developer-portal icon indicating copy to clipboard operation
api-management-developer-portal copied to clipboard

Developer Portal: OAS Schema property limitations not visible

Open Malakatta opened this issue 9 months ago • 0 comments

Bug description

OAS Schema for properties supports minimum and maximum for property lengths (https://swagger.io/specification/#:~:text=%3A%20100%2C-,%22maximum%22%3A%20600,-%7D ) , those are not visible at all in the developer portal.

Reproduction steps

  1. Create a swagger.json with properties including the minimum and maximum values for the properties, in example:
...
        "properties": {
          "id": {
            "type": "string",
            "description": "Invoice id",
            "format": "uuid",
            "example": "00000000-0000-0000-0000-000000000000",
            "x-faker": "random.uuid"
          },
          "rowVersion": {
            "type": "string",
            "description": "Version",
            "format": "byte",
            "nullable": true,
            "example": "ABCDEFG==",
            "x-faker": "random.number"
          },
          "organizationNumber": {
            "maximum": 2147483647,
            "minimum": 0,
            "type": "integer",
            "description": "##### customer number",
            "format": "int32",
            "example": 1234567
          },
          "number": {
            "maximum": 2147483647,
            "minimum": 0,
            "type": "integer",
            "description": "Invoice number.",
            "format": "int32",
            "example": 444333
          },
...
  1. Import the the swagger.json as new API
  2. Check the table view of the new properties image

Expected behavior

The limitations of different properties for client's is quite important and should be shown in the developer portal.

Is your portal managed or self-hosted?

Managed

Additional notes

Also noticed that the table view does not show example values in all table's even the option to show the example is enabled

Malakatta avatar May 20 '24 10:05 Malakatta