OpenAPI schema: 'allOf' children do display description correctly

redashimself commented 11 months ago

Bug description

We have APIs defined with OpenAPI which we are importing into the Azure API Management. When the APIs define schemas with allOf descriptions, the child elements don't appear to be imported and display field descriptions correctly.

Reproduction steps

Define an API using OpenAPI 3.0.1 with a schema having allOf child with a description (see example below)
Import API into Azure API Management
Open and inspect API in the Developer Portal

Is your portal managed or self-hosted?

Managed

API Management service name

[e.g., contoso-api]

Environment

Operating system: Windows 11
Browser: Any
Version:

Additional context

OpenAPI schema (YAML format, cut down version)

openapi: 3.0.1
info:
  version: 1.0.0
  title: Departure Times API Specification Issue Highlight
paths: {}

components:
  schemas:
    DepartureTimes:
      type: object
      properties:
        outGate:
          allOf:
            - $ref: '#/components/schemas/Time'
            - description: 'Super cool outGate'
        offGround:
          allOf:
            - $ref: '#/components/schemas/Time'
            - description: 'Super lame offGround'
        onGround:
          $ref: '#/components/schemas/Time'
    Time:
      type: object
      properties:
        local:
          type: string
          description: 'The local passenger arrival/departure time (hh:mm format).'
          nullable: true
        utc:
          type: string
          description: 'The utc passenger arrival/departure time (hh:mm format).'
          nullable: true
      description: 'The passenger arrival/departure time (hh:mm format).'

Developer portal view
Swagger Editor view
I expect the description for outGate (Super cool outGate) and offGround (Super lame offGround) to be present in the developer portal.

Can attach full schema exported from the portal for reference if needed.

jsorohova commented 11 months ago

Hello, thank you for reporting the issue. I've created a work item and will prioritize it.

mrcarlosdev commented 6 months ago

This issue is related to managed developer portal. We advise you to create a Azure support request to get assistance on this issue. Please refer to the below link to create a new Azure support request, Please select Problem Type = "Developer Portal" in the request to route it appropriately.

https://learn.microsoft.com/en-us/azure/azure-portal/supportability/how-to-create-azure-support-request

Azure / api-management-developer-portal