swagger-api / swagger-api/swagger-ui
Swagger document object order affects rendering
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
- OS: Linux
- Browser: Firefox
- Version: 122.0
- Method of installation: distribution rpm package
- Swagger-UI version: 5.11.2
- Swagger/OpenAPI version: OpenAPI 3.0
When the "components" section of a Swagger document is placed before the "paths", the rendering of schemas with $ref fails to display as shown below:
- "components" placed before "paths" (bug.json):
- "paths" placed before "components" (nobug.json):
The only difference in the docs is the order of "components" and "paths".
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 comparing the supplied bug.json and nobug.json files, then reproduce both documents in Swagger UI 5.11.2 with Firefox. The work is complete when schemas using $ref render identically regardless of whether components or paths appears first.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100