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 #1224

Open
Herrick19 opened this issue Jul 24, 2020 · 4 comments
Open

Webhooks support OAS 3.1 #1224

Herrick19 opened this issue Jul 24, 2020 · 4 comments

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

@Herrick19
Copy link
Author

I see that Redoc decided to implement it as "x-webhooks" in the meantime since "webhooks" will be official only in version 3.1

You might want to implement "x-webhooks" instead in the meantime since you are using Redoc for live documentation

See this: #1304

@EricWittmann
Copy link
Member

Thanks @Herrick19 - support for OpenAPI 3.1 is on our to-do list. It's still a release candidate, but I assume will be released fairly soon.

@Yuutakasan
Copy link

@EricWittmann How is the support for OAS 3.1?

@EricWittmann
Copy link
Member

Two years overdue. :(

The pressure hasn't been there yet to get this done because I don't think there is a huge amount of buy-in for OpenAPI 3.1. That's not a great excuse though.

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