Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
scrohde opened this issue Sep 11, 2019 · 5 comments
Closed

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

scrohde opened this issue Sep 11, 2019 · 5 comments

Comments

@scrohde
Copy link

scrohde commented Sep 11, 2019

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

@Alex314Ru
Copy link

Alex314Ru commented Sep 12, 2019

Moreover, starting from v3.23.4 I cannot see descriptions for paths, parameters and properties in requestBody section.

Swagger/OpenAPI version: OpenAPI 3.0.2

swagger.json generated via latest version of https://github.com/Surnet/swagger-jsdoc from YAML format. So most likely it may be related to #5511

@shockey
Copy link
Contributor

shockey commented Sep 15, 2019

@scrohde & @Alex314Ru, I'm not able to reproduce this using either Swagger UI v3.23.4's static assets or the latest Swagger UI.

Here's what I'm seeing, based on @scrohde's fragment of an OpenAPI document:

image

Happy to look into this further, but there's not much I can do without being able see what's going on locally. More information, context, or a repository that reproduces the problem would be helpful!

@Alex314Ru
Copy link

@shockey That's strange. Today I installed v3.23.10, and now everything works fine for me.

@scrohde
Copy link
Author

scrohde commented Sep 16, 2019

Yep, unable to reproduce in v3.23.10.

@webron
Copy link
Contributor

webron commented Sep 16, 2019

Thanks for verifying!

@webron webron closed this as completed Sep 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants