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.

Sign up for GitHub

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

Jump to bottom

Need documentation for webhooks #487

Closed
JoeCap08055 opened this issue Sep 6, 2024 · 2 comments
Closed

Need documentation for webhooks #487

JoeCap08055 opened this issue Sep 6, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@JoeCap08055
Copy link
Contributor

Description

As a client of Gateway services, I want to understand what APIs my services should expose in order to inter-operate fully with various Gateway servives.

We have webhook specifications in separate OpenAPI files from the service REST API specs. The specs for the webhook types and endpoints should also be published with the docs, and some additional documentation added regarding the purpose of the webhooks and the flows they support.

Requested by Odessa.
@JoeCap08055 JoeCap08055 added bug Something isn't working documentation Improvements or additions to documentation and removed bug Something isn't working labels Sep 6, 2024
@wilwade
Copy link
Contributor

wilwade commented Sep 24, 2024

@JoeCap08055 is this fixed in #523

@JoeCap08055
Copy link
Contributor Author

@JoeCap08055 is this fixed in #523

Nominally, yes, but something still seems to be missing. Or it might just be because the docs site doesn't update until we cut a new release.

@wilwade wilwade closed this as completed Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@wilwade @JoeCap08055