Detect singular example in OpenAPI 3.1 schemas (ExampleSingularDeprecation rule) - #195
Merged
geemus merged 3 commits intoJul 2, 2026
Merged
Conversation
takayamaki
marked this pull request as ready for review
July 1, 2026 23:43
takayamaki
added a commit
to takayamaki/openapi_parser
that referenced
this pull request
Jul 4, 2026
This was referenced Jul 4, 2026
geemus
pushed a commit
that referenced
this pull request
Jul 16, 2026
…ule) (#196) * Add pending specs for PathItemsIn30 rule (3.1 strategy PR7) * PathItemsIn30 rule for components.pathItems on 3.0 docs (3.1 strategy 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. * Integration test: components.pathItems new in 3.1 `components.pathItems` on a 3.0 document warns and raises (3.1 addition); the same field on a 3.1 document stays clean. * Add CHANGELOG entries for PathItemsIn30 + rules from #193 / #195 --------- Co-authored-by: fusagiko / takayamaki <takayamaki@users.noreply.github.com>
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.
ref: #152
Continuing the OpenAPI 3.1 work from #193.
This PR adds a new
SpecValidatorrule:OpenAPIParser::SpecValidator::Rules::ExampleSingularDeprecationIn 3.0, the singular
examplekeyword on a Schema Object is the standard way to attach a sample value.3.1 deprecates it in favor of the JSON Schema
examplesarray.The rule flags the presence of
exampleon any schema in a 3.1 document.