Skip to content

docs: Add OpenAPI examples for /api/webhooks - #1046

Merged
greatest0fallt1me merged 1 commit into
CalloraOrg:mainfrom
Immaculate0606:feature/issue-740-openapi-webhooks
Jul 29, 2026
Merged

docs: Add OpenAPI examples for /api/webhooks#1046
greatest0fallt1me merged 1 commit into
CalloraOrg:mainfrom
Immaculate0606:feature/issue-740-openapi-webhooks

Conversation

@Immaculate0606

Copy link
Copy Markdown
Contributor

Summary

This PR enhances the OpenAPI documentation for the /api/webhooks endpoint by adding comprehensive example request and response bodies. These examples improve API usability by providing clear reference payloads for consumers and making the generated API documentation more informative.

Closes #740

Changes

  • Added example request bodies for /api/webhooks.
  • Added example success and error response bodies.
  • Ensured examples align with the current API schema and standardized error envelope.
  • Updated the OpenAPI specification (src/openapi.yaml) with clear, representative examples.
  • Added/updated focused tests to validate the documented schema where applicable.
  • Updated documentation to reflect the new API examples.

Testing

  • Verified the OpenAPI specification is valid.
  • Added focused tests covering the documented changes.
  • Confirmed examples conform to the defined request and response schemas.
  • Verified linting and formatting compliance.

API Changes

Documentation Update

No functional API changes were introduced. This PR only improves the API documentation by adding example payloads for the /api/webhooks endpoint.

Checklist

  • Added OpenAPI request and response examples.
  • Added focused tests.
  • Updated documentation.
  • Follows project linting and code style.
  • Maintains standardized error response examples.
  • Closes Add OpenAPI examples for /api/webhooks #740

@drips-wave

drips-wave Bot commented Jul 29, 2026

Copy link
Copy Markdown

@Immaculate0606 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@greatest0fallt1me
greatest0fallt1me merged commit 034935b into CalloraOrg:main Jul 29, 2026
@greatest0fallt1me

Copy link
Copy Markdown
Contributor

LGTM — nicely done, thanks for the contribution 🙌

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add OpenAPI examples for /api/webhooks

2 participants