feat: regenerate client from corrected OpenAPI spec#24
Merged
Conversation
regenerated the python client from the spec produced by frain-dev/convoy#2742, which fixes nullable object/map handling, the bearer auth security scheme, json-only onboard, and portal link endpoints_metadata nullability. nullable object/map schemas now generate as *_type_0 union models, replacing the previous non-nullable model classes.
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.
Summary
endpoints_metadatanullability).*_type_0union models, replacing the previous non-nullable model classes.Test plan
Note
High Risk
Wide generated-surface changes plus bulk onboard wire format and enum renames are breaking for SDK consumers; auth-related
AuthRoleTyperenames can break role checks at runtime.Overview
Regenerates the Convoy Python client from an updated OpenAPI spec so generated types and HTTP calls match the API more closely.
Bulk onboard no longer accepts a raw
Filewithapplication/octet-stream. The onboard helpers now take an optionalModelsBulkOnboardRequestand POST JSON (body.to_dict(),Content-Type: application/json).Nullable object/map fields are modeled as separate
*_type_0types (e.g. eventdata, custom headers, JSON schemas, filter bulk-update maps). Public exports inmodels/__init__.pywere updated to those names, so imports of the old symbol names will break.API error envelopes across many
*Response400/401/404models now typedataasHandlersStubType0 | None | Unset, withto_dict/from_dictthat preserve JSONnulland fall back whendatais not a stub object.Enums were reshaped by the generator:
AuthRoleTypemembers drop theROLE_prefix (e.g.APIinstead ofROLE_API), and some config header enums add alternate members such asVALUE_1for empty-string variants.Reviewed by Cursor Bugbot for commit b1e01e5. Bugbot is set up for automated code reviews on this repo. Configure here.