Support root-level webhooks for OpenAPI 3.1 documents (parse + WebhooksIn30 rule) - #199
Merged
Conversation
OpenAPI root gains a `webhooks` hash-of-PathItem accessor; the parse layer accepts the field in any version. Rules::WebhooksIn30 reports the version mismatch when a 3.0 document declares webhooks.
A root-level `webhooks` on a 3.0 document warns and raises (3.1 addition); the same field on a 3.1 document stays clean.
takayamaki
marked this pull request as ready for review
August 1, 2026 03:17
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
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 #152.
OpenAPI 3.1 adds a root-level
webhooksfield:a map of names to Path Item objects describing requests the API sends rather than receives.
3.0 has no equivalent field.
This PR adds parse support and version-mismatch detection.
Parse layer
webhooksis parsed as a hash ofPathItemobjects (with$refsupport),exposed as an accessor on the root object:
Following the permissive-parse strategy agreed in #152,
the parse layer accepts
webhooksregardless of the declared OpenAPI version.SpecValidator rule
WebhooksIn30reports a violation when a 3.0 document declares root-levelwebhooks: