Skip to content

Starting in v3.23.4, descriptions no longer display for responses #5604

@scrohde

Description

@scrohde

Q&A (please complete the following information)

  • OS: any
  • Browser: any
  • Version: v3.23.4
  • Method of installation: dist assets
  • Swagger-UI version: v3.23.4
  • Swagger/OpenAPI version: OpenAPI 3.0

Content & configuration

Example Swagger/OpenAPI definition:

  /nfv/cntlr:
    get:
      tags:
      - users
      summary: Controller Version
      operationId: cntlrShow
      responses:
        "200":
          description: success
          content:
            application/json:
              schema:
                $ref: schemas/users.json#/definitions/cntlr
        default:
          description: |-
            Error Responses

            Expected HTTP status codes for this operation:
            - 400 - Bad Request
            - 401 - Unauthorized
            - 403 - Forbidden
            - 500 - Internal Server Error
            - 503 - Service Unavailable

            The response body will contain more information
          content:
            application/json:
              schema:
                $ref: schemas/common.json#/definitions/GigaErrors

Swagger-UI configuration options:

SwaggerUI({
  // your config options here
})
?yourQueryStringConfig

Describe the bug you're encountering

Descriptions in Response Object no longer displays in swagger-ui

To reproduce...

Steps to reproduce the behavior:
Add a description to a OpenAPI 3.0.0 Response Object
Try to view it in swagger-ui v3.23.4 or greater

Expected behavior

Should see the description

Screenshots

In v3.23.3 it works just fine
Selection_045.pdf

In v3.23.4 it no longer works
Selection_046.pdf

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions