feat: regenerate API client from OpenAPI spec#22
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
1 participant
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
Low Risk
Additive, generated client-only changes with no runtime server impact; main review risk is spec drift or accidental overwrite of protected hand-written paths.
Overview
Refreshes the
convoyPython SDK fromdocs/v3/openapi3.yamlvia openapi-python-client, replacing or adding the generated tree undersrc/convoy.The package exposes
Client/AuthenticatedClient(httpx-based) and typed API helpers grouped by resource—endpoints, events (broadcast, dynamic, batch replay), event deliveries (list, retry, force resend), delivery attempts, event types, and related operations. Each route follows the usual generated pattern:sync/sync_detailedandasyncio/asyncio_detailed, with per-status response models and optional query/body types from the spec.Hand-maintained code (notably
src/convoy/utils/webhook verification) is excluded from generation and should be unchanged by this sync.Reviewed by Cursor Bugbot for commit 6b37acb. Bugbot is set up for automated code reviews on this repo. Configure here.