question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

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

See original GitHub issue

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

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:5 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
Alex314Rucommented, Sep 16, 2019

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

0reactions
webroncommented, Sep 16, 2019

Thanks for verifying!

Read more comments on GitHub >

github_iconTop Results From Across the Web

16. Job Templates — Ansible Tower User Guide v3.8.6
When a label is removed, and is no longer associated with a Job or Job ... Use the Key button in the roles...
Read more >
OpenAPI Specification v3.0.3 | Introduction, Definitions, & More
In the following description, if a field is not explicitly REQUIRED or described with a MUST or SHALL, it can be considered OPTIONAL....
Read more >
RFC 3261: SIP: Session Initiation Protocol
SIP invitations used to create sessions carry session descriptions that ... Call Leg: Another name for a dialog [31]; no longer used in...
Read more >
RFC 3261 SIP: Session Initiation Protocol - IETF
(SIP allows header fields that would not be valid RFC 2822 header fields, for example.) Both types of messages consist of a start-line,...
Read more >
Responses Section of Survey Options - Qualtrics
Warning: In some cases, a back button will not show on a page of the survey even if ... Enter a description that...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found