swagger-api / swagger-api/swagger-ui
Swagger-ui : Issue with model renderer layout for deeply nested objects.
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
We use swagger-ui to render the documentation for the APIs in our platform. It works mostly well and solves lot of the problems.
But the model renderer is causing us layout problems with deeply nested objects. It's indentation is strange and grid-like and as we expand properties we push the content outside of the available area.
Is it possible if
- We tweak or bend the current renderer to layout its property differently.
or - We can replace wholesale the embedded component.
We are in between of our implementation and actually stuck. Please suggest at the earliest.
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 reproducing the layout problem in swagger-ui with an API schema containing deeply nested objects, then inspect the model renderer entry point and its layout behavior. Done means the expanded model remains usable within the available area and the renderer or replacement approach is validated against the reported case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100