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
Proposed scope
- Preserve structural type display such as
object, array, or string.
- When metadata is available, also show a useful resolved schema/component name for
$dynamicRef-bound properties.
- Example: render a response
data property as PaginatedPetItems object, or an equivalent clear label, instead of only object.
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
datastructurally renders asobject, while a friendlier resolved schema name such asPaginatedPetItemsmay be useful to display.Related issues
$dynamicRefbug: Issue: $dynamicRef is not supported in Swagger UI / OpenAPI 3.1 #10651Proposed scope
object,array, orstring.$dynamicRef-bound properties.dataproperty asPaginatedPetItems object, or an equivalent clear label, instead of onlyobject.