fix(ibm-valid-schema-example): support circular references in schemas #737
Conversation
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
The Spectral 'context' object contains processed data about the OpenAPI definition being validated, including the resolved and unresolved versions of the definition and information about references. We use these objects in rule functions and they need to be extracted from deeply nested fields in the spectral context. Rather than always needing to remember or look up the fields, this commit allows us to use simple helper functions to get the data we need. Signed-off-by: Dustin Popp <[email protected]>
Signed-off-by: Dustin Popp <[email protected]>
This rule would previously fail if it tried to validate the example for a schema that contains a circular reference (i.e. defines a schema cycle) because the ref resolver leaves these schemas with unresolved refs. The JSON Schema validator tries to resolve the references but can't find them, so it fails. This commit unconditionally adds the components from the OpenAPI definition to the schema so that the JSON Schema parser can find references if it needs to. Signed-off-by: Dustin Popp <[email protected]>
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.
PR summary
This rule would previously fail if it tried to validate the example for
a schema that contains a circular reference (i.e. defines a schema cycle)
because the ref resolver leaves these schemas with unresolved refs.
The JSON Schema validator tries to resolve the references but can't find
them, so it fails. This commit unconditionally adds the components from
the OpenAPI definition to the schema so that the JSON Schema parser can
find references if it needs to.
PR Checklist
General checklist
Please make sure that your PR fulfills the following requirements: