Allow properties on $ref objects for OpenAPI 3.1. #958
+39
−8
Conversation
This file contains 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
JSON Schema draft 5 (OpenAPI 3.0.4), it specifically says additional properties on a $ref object are ignored. > All other properties in a "$ref" object MUST be ignored. https://datatracker.ietf.org/doc/html/draft-wright-json-schema-00#section-7 However, draft 2020-12 seems to have changed its tune: > Its results are the results of the referenced schema. [[CREF5: Note > that this definition of how the results are determined means that other > keywords can appear alongside of "$ref" in the same schema object. ]] https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00#section-8.2.3.1 If I'm interpreting this correctly, $ref now allows properties alongside it.
lafrech
approved these changes
Dec 2, 2024
|
I merged you PRs and released 6.8.0. Thanks again! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
JSON Schema draft 5 (OpenAPI 3.0.4), it specifically says additional properties on a $ref object are ignored.
https://datatracker.ietf.org/doc/html/draft-wright-json-schema-00#section-7
However, draft 2020-12 (OpenAPI 3.1.0) seems to have changed its tune:
https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00#section-8.2.3.1
So if I'm understanding correctly, things like this are now valid and meaningful:
{ "$ref": "#/components/schemas/Child", "description": "A category", "x-extension": "A great extension", }