swagger-api / swagger-api/swagger-ui
Deep linking for models
Open
Nobody has claimed this yet.
cat: deep linking
P3
type: feature
version: 3.x
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
For large complex models, it'd be very nice to be able to click on a type that's referenced in some property and have it link to the schema for that type (especially since types aren't displayed in any particular order, so scrolling to find them can be tedious). The current styling actually makes the type names look like links, but they're not.
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
No files, tests, or entry points are named. Start by locating the model and property rendering path in Swagger UI, then define the expected anchor and navigation behavior; done means clicking a referenced type opens the schema for that type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100