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

Use the new OpenAPI webhooks and callbacks to describe Stripe webhooks #69

Open
gpetrov opened this issue Jan 29, 2021 · 2 comments
Open
Labels

Comments

@gpetrov
Copy link

gpetrov commented Jan 29, 2021

In OpenAPI 3.0 there is already a "callbacks" parameter describing the webhooks triggered by an API call.

In the new OpenAPI 3.1 there is also a webhooks root description for out of bands webhook events like the one Stripe uses.
See https://github.com/OAI/OpenAPI-Specification/releases/tag/3.1.0-rc0

Could you please improve the Stripe Open API definitions to include both webhooks and callbacks descriptions in the Stripe OpenAPI specification?

@remi-stripe
Copy link
Collaborator

@gpetrov Thanks for reaching out! This is a great feature request and I do see how helpful this could be. I'm going to tag as "future" for now as this not something that would happen in the near future unfortunately. This logic of which events can be sent by which endpoint is pretty gnarly and not something that's immediately available in our code unfortunately and is partly why it's not documented today. We'd love to see this happen though and I'll track it internally.

@gpetrov
Copy link
Author

gpetrov commented Jan 29, 2021

Thanks @remi-stripe ! I think the "webhooks" root description in openAPI, will be really a great addition!
Stripe already have all the webhook events - with specific data types. We just need to have a good list of those in the openAPI spec.

Then we can run all the code generators for webhooks :)

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

No branches or pull requests

2 participants