swagger-api / swagger-api/swagger-ui
Show resolved schema names for $dynamicRef-bound properties
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Summary
Optional Swagger UI rendering enhancement for $dynamicRef-bound properties. This is a UX improvement that can be worked on in parallel and is not a prerequisite for resolver correctness.
Reference implementation / showcase
The showcase includes response schemas where a property such as data structurally renders as object, while a friendlier resolved schema name such as PaginatedPetItems may be useful to display.
Related issues
- Related coordination issue: swagger-api/swagger-ui#10912
- User-facing
$dynamicRefbug: swagger-api/swagger-ui#10651 - ApiDOM resolver work: swagger-api/apidom#5176
- Swagger Client resolver work: swagger-api/swagger-js#4223
Proposed scope
- Preserve structural type display such as
object,array, orstring. - When metadata is available, also show a useful resolved schema/component name for
$dynamicRef-bound properties. - Example: render a response
dataproperty asPaginatedPetItems object, or an equivalent clear label, instead of onlyobject.
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 file or test is named. Start with the linked adoption-tracker showcase and trace Swagger UI’s schema/property rendering path for $dynamicRef; done means preserving structural type labels while adding resolved names such as PaginatedPetItems when metadata is available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100