feat: regenerate API client from OpenAPI spec#28
Merged
Conversation
![convoy-sdk-reviewer[bot]](https://avatars.githubusercontent.com/u/66191081?s=60&v=4){kind=small}
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
Low Risk
Documentation-only changes in generated client code; no runtime or API behavior changes in the shown diff.
Overview
Regenerated OpenAPI Python client updates the bulk onboard endpoint docstrings on all four entry points (
sync_detailed,sync,asyncio_detailed,asyncio).The docs no longer imply the SDK accepts CSV directly. They state that JSON (
ModelsBulkOnboardRequest) is what the generated client sends, while CSV remains available only via raw HTTP multipart/form-data with afilefield. Docstrings user"""so escaped quotes in that note render correctly.No request-building or typing changes appear in this diff—only documentation strings aligned with the OpenAPI spec.
Reviewed by Cursor Bugbot for commit 2882d80. Bugbot is set up for automated code reviews on this repo. Configure here.