Skip to content

feat: regenerate API client from OpenAPI spec - #23

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#23
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 Generator (php) from docs/v3/openapi3.yaml on frain-dev/convoy main. Hand-written SDK code (src/ outside src/Client/, incl. webhook verify) is untouched by the sync script.


Note

Medium Risk
Breaking rename/removal of CreateBroadcastEvent201Response and changed return types on Events API methods can break consumer code; runtime JSON is likely unchanged but deserialization types differ.

Overview
Regenerated Events client typings so success responses deserialize into the correct models instead of mis-typed or error-shaped classes.

201 create paths (createBroadcastEvent, createDynamicEvent, createEndpointEvent, createEndpointFanoutEvent) now return CreateEndpointEvent201Response, whose data is ModelsEventQueuedResponse (event_type, idempotency_key, uid). Several create methods previously deserialized 201 bodies as GetProjects400Response, which was a generator/spec bug fix.

200 read/replay paths (getEndpointEvent, replayEndpointEvent) now use GetEndpointEvent200Response (replacing the old CreateBroadcastEvent201Response name on that file), with full event payload via ModelsEventResponse.

SDK consumers may need to update type hints/imports: CreateBroadcastEvent201Response is removed in favor of GetEndpointEvent200Response / CreateEndpointEvent201Response.

Reviewed by Cursor Bugbot for commit c35053a. 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:01
@convoy-sdk-bot
convoy-sdk-bot Bot merged commit 94c9d97 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:06
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