You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
webhooks failed to add to the root of the document.
Since OAS 3.1.0 the paths element isn't necessary. Now a valid OpenAPI Document can describe only paths, webhooks, or even only reusable components
Actual Specification
webhooks, not currently supported.
Expected Specification
webhooks, The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the callbacks feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An [example](https://github.com/OAI/OpenAPI-Specification/tree/master/examples/v3.1/webhook-example.yaml) is available.
skywing918
changed the title
[Bug]: OpenAPI 3 Emitter failed to define a webhooks in root
[Bug]: OpenAPI 3 Emitter failed to define a webhooks in root -- oas v3.1.0
Jul 18, 2024
Describe the bug
webhooks failed to add to the root of the document.
Since OAS 3.1.0 the paths element isn't necessary. Now a valid OpenAPI Document can describe only paths, webhooks, or even only reusable components
Actual Specification
webhooks, not currently supported.
Expected Specification
webhooks, The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the callbacks feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An [example](https://github.com/OAI/OpenAPI-Specification/tree/master/examples/v3.1/webhook-example.yaml) is available.
Reproduction
https://github.com/OAI/OpenAPI-Specification/tree/master/examples/v3.1/webhook-example.yaml
Checklist
The text was updated successfully, but these errors were encountered: