feat: regenerate API client from OpenAPI spec - #23
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated regeneration via OpenAPI Generator (php) from
docs/v3/openapi3.yamlon frain-dev/convoy main. Hand-written SDK code (src/outsidesrc/Client/, incl. webhook verify) is untouched by the sync script.Note
Medium Risk
Breaking rename/removal of
CreateBroadcastEvent201Responseand 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 returnCreateEndpointEvent201Response, whosedataisModelsEventQueuedResponse(event_type,idempotency_key,uid). Several create methods previously deserialized 201 bodies asGetProjects400Response, which was a generator/spec bug fix.200 read/replay paths (
getEndpointEvent,replayEndpointEvent) now useGetEndpointEvent200Response(replacing the oldCreateBroadcastEvent201Responsename on that file), with full event payload viaModelsEventResponse.SDK consumers may need to update type hints/imports:
CreateBroadcastEvent201Responseis removed in favor ofGetEndpointEvent200Response/CreateEndpointEvent201Response.Reviewed by Cursor Bugbot for commit c35053a. Bugbot is set up for automated code reviews on this repo. Configure here.