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

Webhooks support OAS 3.1 #1327

Closed
Herrick19 opened this issue Jul 24, 2020 · 3 comments · Fixed by #1622
Closed

Webhooks support OAS 3.1 #1327

Herrick19 opened this issue Jul 24, 2020 · 3 comments · Fixed by #1622

Comments

@Herrick19
Copy link

Hi,

There was callbacks, but now OAS 3.1 supports Webhooks as well.

It's pretty much the same structure as a Callback but out of scope of a path. It would be nice if you could support it.

Ref: OAI/OpenAPI-Specification#1968 (Feature request)
Ref: OAI/OpenAPI-Specification#2103 (Pull Request)
Ref: https://github.com/OAI/OpenAPI-Specification/pull/2103/files/3fb1bffff5ef599418420e7d27593418deeaa2a3#diff-d2aac6cc1f8743d6fda6b4932242c6eb (Example file)

Since these are not associated to a path, they could perhaps have their own section in the left menu.

Thanks in advance

@adamaltman
Copy link
Member

See here: #1304

We plan to merge it next week (we hope).

@Herrick19
Copy link
Author

I've check #1304

You have implemented it as "x-webhooks", but since it will be supported as "webhooks" in 3.1, shouldn't you remove the "x-" ?

Or for now you will have the "x-" and remove it eventually ?

Best Regards

@adamaltman
Copy link
Member

It is implemented as x-webhooks for forward compatibility. This means someone who is using OAS 3.0 can use this new feature without adopting 3.1 (which currently has a release candidate, but is not in general release yet). There will need to be a set of tasks to add support for 3.1 (yes, the webhooks support will be quite easy because it is already done with x-webhooks, but there are quite a few other differences between 3.1 and 3.0).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants