Detect components.pathItems in OpenAPI 3.0 documents (PathItemsIn30 rule)#196
Open
takayamaki wants to merge 4 commits into
Open
Detect components.pathItems in OpenAPI 3.0 documents (PathItemsIn30 rule)#196takayamaki wants to merge 4 commits into
takayamaki wants to merge 4 commits into
Conversation
… PR7)
The parse layer keeps accepting Components.pathItems in any version
(geemus suggested permissive parsing); this rule reports the 3.0
mismatch so callers on :warn / :raise can surface it. Detection
inspects components.raw_schema directly to catch an explicitly empty
`pathItems: {}` literal too.
`components.pathItems` on a 3.0 document warns and raises (3.1 addition); the same field on a 3.1 document stays clean.
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 #195 / #152.
components.pathItemswas added in OpenAPI 3.1 and is not part of the 3.0 spec.The parse layer already accepts it permissively (#191), but until now there was no way to detect the version mismatch.
This PR adds a
PathItemsIn30rule toSpecValidatorthat reports a violation when a 3.0 document declarescomponents.pathItems.How it works
The rule checks
root.components.raw_schemafor apathItemskey.It only fires on 3.0 documents.
Housekeeping
This PR also backfills the CHANGELOG entries for
NullableDeprecation(#193) andExampleSingularDeprecation(#195), which I forgot to include in those PRs.