feat: regenerate API client from OpenAPI spec - #38
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-python-client from
docs/v3/openapi3.yamlon 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
datafor SDK users who relied onModelsEventResponseor 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
dataasModelsEventQueuedResponse(event_type,idempotency_key,uidas event id) instead of fullModelsEventResponse(broadcast) orHandlersStubType0(dynamic, endpoint, fanout).Broadcast, dynamic, endpoint, and fanout create helpers pick up matching docstring notes that
uidis in the 201 body and thatGET /events/{eventID}orGET /eventdeliveries?eventId=can track delivery.Callers that assumed a full event object on create may need to use
uidand fetch the event separately; code already readingresult.data.uidstays compatible.Reviewed by Cursor Bugbot for commit e32f6e1. Bugbot is set up for automated code reviews on this repo. Configure here.