swagger-api / swagger-api/swagger-ui
Proposal: coordinate $dynamicRef support across ApiDOM, Swagger Client, and Swagger UI
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Hi, my name is Abdullah. I’m trying to help implement $dynamicRef support across the Swagger API ecosystem.
I started by analyzing Swagger UI support for OpenAPI 3.1 $dynamicRef, and it looks like the work needs to happen in layers:
- ApiDOM needs core
$dynamicRef/$dynamicAnchordereference support. - Swagger Client needs to consume that ApiDOM behavior and resolve
$dynamicRefschemas correctly. - Swagger UI can then consume the updated Swagger Client and validate the user-facing behavior.
I’ve opened the first ApiDOM issue/PR here: swagger-api/apidom#5176. Once that lands, I plan to work on the Swagger Client changes, then the Swagger UI integration.
I also put together a small showcase repo with example OpenAPI documents I’m using to validate the behavior:
https://github.com/aqeelat/openapi-dynamicref-adoption-tracker/
Related issues:
- ApiDOM core support: swagger-api/apidom#5176
- Swagger Client resolver support: swagger-api/swagger-js#4223
- Existing Swagger UI user-facing report: swagger-api/swagger-ui#10651
- Optional Swagger UI display improvement: swagger-api/swagger-ui#10913
The display improvement is related, but it is not a prerequisite for resolver correctness.
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 with the linked ApiDOM issue/PR swagger-api/apidom#5176, then review the Swagger Client resolver issue swagger-api/swagger-js#4223 and the Swagger UI reports #10651 and #10913. Use the showcase repository as a validation reference; done means coordinated $dynamicRef support reaches the client and user-facing Swagger UI behavior without depending on the optional display improvement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100