Repository navigation
Webhooks support OAS 3.1 #1327
Description
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
Activity
adamaltman commentedon Jul 24, 2020
See here: #1304
We plan to merge it next week (we hope).
Herrick19 commentedon Jul 24, 2020
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 commentedon Jul 24, 2020
It is implemented as
x-webhooksfor 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).