Skip to content

feat: regenerate API client from OpenAPI spec - #38

Merged
convoy-sdk-bot[bot] merged 1 commit into
mainfrom
speakeasy-sdk-regen-20260827
Aug 27, 2026
Merged

feat: regenerate API client from OpenAPI spec#38
convoy-sdk-bot[bot] merged 1 commit into
mainfrom
speakeasy-sdk-regen-20260827

Conversation

@convoy-sdk-bot

@convoy-sdk-bot convoy-sdk-bot Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Automated regeneration via openapi-python-client from docs/v3/openapi3.yaml on frain-dev/convoy main. Hand-written webhook verify (src/convoy/utils/) is untouched by the sync script.


Note

Medium Risk
Breaking type change on create-event 201 data for SDK users who relied on ModelsEventResponse or stub fields; runtime parsing is stricter and omits fields no longer in the queued response.

Overview
Regenerated client models align create-event HTTP 201 bodies with the updated OpenAPI spec: successful creates now deserialize data as ModelsEventQueuedResponse (event_type, idempotency_key, uid as event id) instead of full ModelsEventResponse (broadcast) or HandlersStubType0 (dynamic, endpoint, fanout).

Broadcast, dynamic, endpoint, and fanout create helpers pick up matching docstring notes that uid is in the 201 body and that GET /events/{eventID} or GET /eventdeliveries?eventId= can track delivery.

Callers that assumed a full event object on create may need to use uid and fetch the event separately; code already reading result.data.uid stays compatible.

Reviewed by Cursor Bugbot for commit e32f6e1. Bugbot is set up for automated code reviews on this repo. Configure here.

@convoy-sdk-reviewer convoy-sdk-reviewer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SDK reviewer app: approving a generated-paths-only diff on the regen branch. Auto-merge completes only after required status checks pass.

@convoy-sdk-bot
convoy-sdk-bot Bot enabled auto-merge (squash) August 27, 2026 10:08
@convoy-sdk-bot
convoy-sdk-bot Bot merged commit 957972b into main Aug 27, 2026
3 checks passed
@convoy-sdk-bot
convoy-sdk-bot Bot deleted the speakeasy-sdk-regen-20260827 branch August 27, 2026 10:12
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.

0 participants