Proposal: coordinate $dynamicRef support across ApiDOM, Swagger Client, and Swagger UI

[aqeelat]

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:

1. ApiDOM needs core $dynamicRef / $dynamicAnchor dereference support.
2. Swagger Client needs to consume that ApiDOM behavior and resolve $dynamicRef schemas correctly.
3. 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: Add $dynamicRef dereference support for OpenAPI 3.1 and 3.2 strategies apidom#5176
• Swagger Client resolver support: Support OpenAPI 3.1/3.2 $dynamicRef resolution with ApiDOM swagger-js#4223
• Existing Swagger UI user-facing report: Issue: $dynamicRef is not supported in Swagger UI / OpenAPI 3.1 #10651
• Optional Swagger UI display improvement: Show resolved schema names for $dynamicRef-bound properties #10913

The display improvement is related, but it is not a prerequisite for resolver correctness.