search

Apicurio / apicurio-studio

Open Source API Design
https://www.apicur.io/studio/
Apache License 2.0
989 stars 499 forks source link

Webhooks support OAS 3.1 #1224

Open Herrick19 opened 4 years ago

Herrick19 commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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 commented 2 years ago

@EricWittmann How is the support for OAS 3.1?

EricWittmann commented 2 years ago

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.