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

Document Horreum webhooks in the open api spec #1358

Open
johnaohara opened this issue Feb 21, 2024 · 1 comment
Open

Document Horreum webhooks in the open api spec #1358

johnaohara opened this issue Feb 21, 2024 · 1 comment
Labels
area/documentation Improvements or additions to documentation area/integration Integration with other systems type/enhancement An enhancement to an existing feature

Comments

@johnaohara
Copy link
Member

Describe the bug

It is possible to document the webhook API in openapi.yaml. We should document the webhook payloads and publish alongside the REST API

see: https://redocly.com/docs/openapi-visual-reference/webhooks/
@johnaohara johnaohara added area/documentation Improvements or additions to documentation type/enhancement An enhancement to an existing feature area/integration Integration with other systems labels Feb 21, 2024
@whitingjr whitingjr self-assigned this Feb 21, 2024
@whitingjr whitingjr mentioned this issue Mar 6, 2024
Closed
2 tasks
@whitingjr
Copy link
Collaborator

@johnaohara Webhooks are not currently available in microprofile-open-api yet. There is an outstanding issue for the addition. Coming in 4.0 release.

@whitingjr whitingjr removed their assignment Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation Improvements or additions to documentation area/integration Integration with other systems type/enhancement An enhancement to an existing feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@whitingjr @johnaohara