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

OpenAPI spec for webhook call #59

Closed
scothis opened this issue Mar 24, 2022 · 2 comments
Closed

OpenAPI spec for webhook call #59

scothis opened this issue Mar 24, 2022 · 2 comments
Assignees
@katmutua
Labels
documentation Improvements or additions to documentation webhook

Comments

@scothis
Copy link
Contributor

scothis commented Mar 24, 2022

We expect third parties to implement the webhook contract in order to provide a convention. OpenAPI is the canonical way to describe a REST API. We should publish an OpenAPI spec for this endpoint.
@scothis scothis added enhancement New feature or request webhook documentation Improvements or additions to documentation and removed enhancement New feature or request labels Mar 24, 2022
@katmutua katmutua self-assigned this Apr 4, 2022
@katmutua katmutua mentioned this issue Apr 7, 2022
Merged
@seagomezar
Copy link

@katmutua Is this done?

@scothis
Copy link
Contributor Author

scothis commented Nov 2, 2022

The spec is defined here https://github.com/vmware-tanzu/cartographer-conventions/blob/main/api/openapi-spec/conventions-server.yaml

@scothis scothis closed this as completed Nov 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@katmutua katmutua

Labels
documentation Improvements or additions to documentation webhook
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@scothis @seagomezar @katmutua