Detect $dynamicRef in OpenAPI 3.0 documents (DynamicRefIn30 rule) - #203
Open
takayamaki wants to merge 4 commits into
Open
Detect $dynamicRef in OpenAPI 3.0 documents (DynamicRefIn30 rule)#203takayamaki wants to merge 4 commits into
takayamaki wants to merge 4 commits into
Conversation
Parse layer keeps $dynamicRef as raw schema data; reference expansion support is left for a follow-up. The rule reports the version mismatch so 3.0 documents that smuggle the keyword in get flagged.
$dynamicRef on a 3.0 document warns and raises (JSON Schema 2020-12 dynamic referencing; 3.0 only knows $ref); the same keyword on a 3.1 document stays clean.
takayamaki
marked this pull request as ready for review
August 19, 2026 17:53
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
1 participant
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.
Continuing the OpenAPI 3.1 work from #152.
OpenAPI 3.1 adopts JSON Schema 2020-12, which brings the
$dynamicRefreferencing mechanism.3.0 only knows
$ref.This PR adds detection of that version mismatch.
A 3.0 document using
$dynamicRefis relying on a keyword its declared version does not define, andSpecValidatorshould be able to say so.SpecValidator rule
DynamicRefIn30reports a violation for each schema in a 3.0 document that uses$dynamicRef:Detection inspects
raw_schemakey presence,so it fires regardless of whether the referenced anchor exists.
Scope
This PR does not make
$dynamicRefresolvable.$dynamicRefhas to branch its reference dynamically while the schema is being evaluated, which likely means redesigningSchemaValidatorin this gem.Resolving it is a TODO beyond this series of PRs.