Support $ref with sibling keywords (OpenAPI 3.1)#12
Closed
nolannbiron wants to merge 5 commits intomainfrom
Closed
Support $ref with sibling keywords (OpenAPI 3.1)#12nolannbiron wants to merge 5 commits intomainfrom
nolannbiron wants to merge 5 commits intomainfrom
Conversation
In OpenAPI 3.1, $ref can have sibling keywords like maxLength, minLength, pattern, etc. Merge sibling constraints into the resolved schema so they are compiled into the generated validator.
nolannbiron
force-pushed
the
nolann/add-support-for-openapi-3.1-ref-siblings
branch
from
c9581a2 to
98b0605
Compare
SamyPesse
reviewed
Mar 24, 2026
Comment on lines
+46
to
+60
| // Apply the siblings to the additionalProperties schema if it exists | ||
| if (resolved.type === 'object' && typeof resolved.additionalProperties === 'object') { | ||
| return compileValueSchema(compiler, { | ||
| ...resolved, | ||
| additionalProperties: { ...resolved.additionalProperties, ...siblings }, | ||
| }); | ||
| } | ||
|
|
||
| // Apply the siblings to the items schema if it exists | ||
| if (resolved.type === 'array' && typeof resolved.items === 'object') { | ||
| return compileValueSchema(compiler, { | ||
| ...resolved, | ||
| items: { ...resolved.items, ...siblings }, | ||
| }); | ||
| } |
Member
There was a problem hiding this comment.
Are you sure about this? it looks like an odd case for the spec.
Member
Author
There was a problem hiding this comment.
you mean adding the constraints to additionalProperties and items ?
Member
Author
There was a problem hiding this comment.
it's valid in OpenAPI 3.1 also
Member
Author
There was a problem hiding this comment.
@SamyPesse ok I see I thought the standard was $ref + siblings applies to items/additionalProperties since they're the descriptor for an object/array, closing the PR we don't need it
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.
In OpenAPI 3.1, $ref can have sibling keywords like maxLength, minLength, pattern, etc. Merge sibling constraints into the resolved schema so they are compiled into the generated validator.