Repository navigation
Conversation
Danger ReportNo issues found. |
numbata
force-pushed
the
pr/6-oas31-extras
branch
from
October 14, 2026 18:28
eb09f07 to
674d9ab
Compare
numbata
force-pushed
the
pr/6-oas31-extras
branch
2 times, most recently
from
October 14, 2026 19:41
157cead to
f95a545
Compare
OpenAPI 3.1 describes events an API sends to its consumers as webhooks and lets a document declare which JSON Schema dialect its schemas use. Neither could be expressed through the new builder, so users on 3.1 had to patch the generated document by hand. `webhooks:` takes Path Item definitions keyed by name and `json_schema_dialect:` takes the dialect URI. Both apply only when `openapi_version` is '3.1'; with '3.0' or Swagger 2.0 they are ignored. Swagger 2.0 style `#/definitions/` references inside webhooks are rewritten to `#/components/schemas/`.
numbata
force-pushed
the
pr/6-oas31-extras
branch
from
October 14, 2026 20:13
f95a545 to
0b72ccc
Compare
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.
Summary
Teams on OpenAPI 3.1 can document the events their API sends as webhooks and declare which JSON Schema dialect their schemas follow. Without this they had to edit the generated document by hand. Projects on 3.0 or Swagger 2.0 are unaffected.
Problem solved
Webhooks and a declared dialect are 3.1 features that do not come from routes, so the builder cannot infer them. Users need a way to supply them through configuration.
What changes
webhooks:accepts Path Item definitions keyed by name andjson_schema_dialect:accepts the dialect URI. Swagger 2.0 style definition references inside webhooks are rewritten to point to components.Drawbacks and nuances
openapi_versionis '3.1'.Alternatives considered
Stacks on: pr/5-builder-responses-schemas.