swagger-api / swagger-api/swagger-ui
Access extension data from OpenAPI/Swagger schema
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
How can we help?
Currently, after reading the documentation, for showing extensions found in the schema, you can do that with the showExtensions property, but only for Operations/Parameters/Response/Schema objects. The problem is that there are some schemas that have extensions at the top-level or path level ( eg. shown in the screenshot below ) and they are not shown by default.
I've tried to access the data of the extension through SwaggerUI plugins, but only managed to do so at the operation level with wrapComponents -> operation. Are there any examples or could you provide some help on how I can access the extension data through plugins if the extension is at top-level or path level?
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 reviewing the documented showExtensions property and the SwaggerUI plugin entry point using wrapComponents -> operation. Determine how top-level and path-level extension data can be accessed, then verify that the resulting approach exposes the extensions shown in the schema screenshot.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100