Skip to content

Fixed the webhook example #2434

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

Merged
merged 1 commit into from
Feb 11, 2021
Merged

Fixed the webhook example #2434

merged 1 commit into from
Feb 11, 2021

Conversation

christianfds
Copy link
Contributor

Fixes #2430

Signed-off-by: Christian Franchin dos Santos [email protected]

Signed-off-by: Christian Franchin dos Santos <[email protected]>
@Polo2
Copy link

Polo2 commented Feb 10, 2021

I'm not sure webhook example has to be fixed by removing /paths, since it's specified for version 3.1:

The OpenAPI document MUST contain at least one paths field, a components field or a webhooks field

A documentation may include both paths and webhooks, ad it's done in this example. WDYT ?

@Polo2
Copy link

Polo2 commented Feb 10, 2021

I'm not sure webhook example has to be fixed by removing /paths, since it's specified for version 3.1:

The OpenAPI document MUST contain at least one paths field, a components field or a webhooks field

A documentation may include both paths and webhooks, ad it's done in this example. WDYT ?

Ooops, my bad, I should have read related issue #2430 before adding this comment... 🙏 Sorry!
Indeed, a webhook example with only webhooks , and not extra paths could help to understand this new feature

@webron webron merged commit f1adc84 into OAI:master Feb 11, 2021
@darrelmiller
Copy link
Member

@christianfds Thank you for your contribution. Much appreciated.

philsturgeon pushed a commit to philsturgeon/OpenAPI-Specification that referenced this pull request Feb 18, 2021
Signed-off-by: Christian Franchin dos Santos <[email protected]>
charjr pushed a commit to charjr/OpenAPI-Specification that referenced this pull request Apr 27, 2023
Signed-off-by: Christian Franchin dos Santos <[email protected]>
charjr pushed a commit to charjr/OpenAPI-Specification that referenced this pull request Apr 27, 2023
Signed-off-by: Christian Franchin dos Santos <[email protected]>
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 this pull request may close these issues.

webhook need a paths?
4 participants