docs: add OpenAPI.NET $ref siblings guidance#168
Merged
Conversation
Contributor
|
Learn Build status updates of commit 529f756: ✅ Validation status: passed
For more details, please refer to the build report. |
Contributor
Author
|
Updated and rebased on main (includes #167). Ready for review. Changes:
|
Contributor
|
Learn Build status updates of commit 73a7e9b: ✅ Validation status: passed
For more details, please refer to the build report. |
- Add section explaining $ref sibling behavior in OpenAPI 3.1 vs 3.0 - Document OpenApiSchemaReference.Target and Reference access patterns - Update $dynamicRef section: resolution now implemented - Note $anchor fallback alongside $dynamicAnchor resolution - Add version notes (siblings: 3.8.0/2.10.0, dynamicRef: 3.9.0/2.11.0) Follow-up to #167
aqeelat
force-pushed
the
feat/ref-siblings-docs
branch
from
73a7e9b to
60f8b4b
Compare
Contributor
|
Learn Build status updates of commit 60f8b4b: ✅ Validation status: passed
For more details, please refer to the build report. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents OpenAPI.NET behavior for OpenAPI 3.1
$refschema siblings and$dynamicRefresolution.$refsiblings section$ref; 3.1 allows JSON Schema sibling keywordsJsonSchemaReferenceOpenApiSchemaReference.Targetreturns the resolved target schema$dynamicRefsection updates$dynamicAnchorand$anchorregistries)ResolveDynamicAnchorInContextfor multi-candidate resolution$dynamicRefresolution (including cross-document relative URIs) added in 3.9.0 / 2.11.0Related