Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug]: OpenAPI 3 Emitter failed to define a webhooks in root -- oas v3.1.0 #3882

Closed
4 tasks done
skywing918 opened this issue Jul 18, 2024 · 2 comments
Closed
4 tasks done

Comments

@skywing918
Copy link
Member

skywing918 commented 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

@skywing918 skywing918 added the bug Something isn't working label Jul 18, 2024
@skywing918 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
@bterlson
Copy link
Member

bterlson commented Jul 18, 2024

This sounds like a feature request for webhooks and/or OpenAPI 3.1 to me?

@timotheeguerin timotheeguerin removed the bug Something isn't working label Jul 18, 2024
@timotheeguerin
Copy link
Member

closing as dup of #1698

@timotheeguerin timotheeguerin closed this as not planned Won't fix, can't repro, duplicate, stale Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants