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 (documented with x-webhooks) do not show the request verb #1616

Closed
mm-gmbd opened this issue May 11, 2021 · 0 comments · Fixed by #1994
Closed

Webhooks (documented with x-webhooks) do not show the request verb #1616

mm-gmbd opened this issue May 11, 2021 · 0 comments · Fixed by #1994
Assignees

Comments

@mm-gmbd
Copy link

mm-gmbd commented May 11, 2021

Following the x-webhooks docs, I've updated my OpenAPI spec to document a few webhook calls our service initiates. In most cases we utilize the POST verb but, in one specific case, we use the GET verb and I realized that is not reflected anywhere in the resulting rendered docs - only "Event" and "Webhook" are specified.

This can be seen in the Redoc Interactive Demo for the "new pet webhook".

I understand that the use of POST for webhooks is typical, but it is not always the case.

image

Not sure how best to display Webhook|{Verb}, but it would be useful in my case.

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

Successfully merging a pull request may close this issue.

3 participants