swagger-api / swagger-api/swagger-ui
Add support for extensions in response codes
Open
Nobody has claimed this yet.
cat: rendering
type: enhancement
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Content & configuration
Swagger/OpenAPI definition:
/v1/somepath:
post:
x-rendered-extension: "30s" # This extension is rendered properly in the UI
responses:
202:
x-non-rendered-extension: true # This extension is NOT rendered at all in the UI
Describe the solution you'd like
Currently the UI does not render extensions that are described under a response code. As per swagger documentation extension are supported in responses.
https://swagger.io/docs/specification/2-0/swagger-extensions/
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Swagger UI code that renders response codes and compare it with the existing rendering of the operation-level x-rendered-extension. Use the YAML example in this issue to verify that an extension under response 202 appears in the UI; done means response-level extensions are displayed without breaking existing response documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100