feat(parsers): ignore sibling elements of $ref according to OpenAPI 3.0 specification #11
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
mm-matthias
approved these changes
Nov 3, 2024
Comment on lines
+74
to
+76
| return ( | ||
| resolve_reference(schema["$ref"]) | ||
| if "$ref" in schema |
There was a problem hiding this comment.
Do you want to ignore any extra properties silently or throw an exception when that happens?
There was a problem hiding this comment.
I want to ignore extra properties. It's validator responsibility to raise an exception. Unfortunately, in our case validator runs after JSON schema resolving. This should be fixed in the future.
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.
According to OpenAPI 3.0 specification object containing
$refcannot be extended with additional properties and any properties added SHALL be ignored. We already have problems in our auto-generated code whendescriptionfrom object containing$refoverrides schema description.In OpenAPI 3.1
summaryanddescriptionare allowed, but I would like to concentrate on one spec version and extend code later if needed. Because right now it'll take more efforts to implement different behavior based on the spec version. Spec version should be also correctly handled in other parts of the code. Since our specs are 3.0 it shouldn't be a problem for now.