python: Use openapi-codegen for high-level python API client #1646
Conversation
This file contains 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
svix-mman
force-pushed
the
mendy/add-generated-python-client-code
branch
from
0a45271 to
f724642
Compare
|
(I force-pushed a typo fix in the commit message) |
svix-mman
force-pushed
the
mendy/add-generated-python-client-code
branch
from
f342fb5 to
6cb2f29
Compare
Base automatically changed from
mendy/sort-python-methods-consistently
to
main
January 17, 2025 12:13
tasn
reviewed
Jan 17, 2025
I will go through the diffs one at a time and document the breaking changes for the |
svix-jplatte
approved these changes
Jan 17, 2025
Note: the openapi.json file I am working with does not include some deprecated methods. For now I will manually add these deprecated calls by hand
Breaking change: in the create and update function the integ_(in/update) is renamed to integration_(in/update) This is due to the way that the codegen decides how to name function arg. (The type of the function arg to_snake_case) I don't think it makes sense to add a special case in the codegen to shorten `integration` to `integ` This problem is a bit more annoying, since the path param is called `integ_id` (in the `openapi.json`). So to keep consistency we may want to add the special case to the codegen Alternatively (and this would make me happy) we could change the path param name from `integ_id` to `integration_id`. (in the `openapi.json`) This will make the file consistent, and won't require a special case in the openapi-codegen
Braking changes: - `MessageAttemptListOptions` is not importable from `svix.api`
Manual edits: - For `v1.message.create` manually set `ret.payload` to `message_in.payload` - For `MessageCreateOptions` set the `with_content` false by default. (this is preserve previous behavior)
This also switches the `MessageListOptions` import from `message_attempt` to `message`, and removes the definition in `message_attempt` since it is not used by anything (except the `from svix.api` import, which we replaced) Breaking change: - The `status_code_class` and `status` optional fields are removed from `svix.api.MessageListOptions`
Technically? breaking change: - the `task_id` argument is removed from the `aggregate_event_types` method. However this argument was not previously used by the inner API client at all. So this technically breaks the high-level API client, but no change to the actual outgoing api.svix.com requests
svix-mman
force-pushed
the
mendy/add-generated-python-client-code
branch
from
a2949fd to
0406384
Compare
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.
The
openapi.jsonfile I am working with is incomplete.openapi.json.background_taskandoperational_webhook. (I know thatoperational_webhookis not a single resource)openapi.jsonare not currently in the high-level API client (healthandenvironment).Jonas is working on a fix for the
openapi.jsongenerator.For now.
@deprecateddecorator to those methods.openapi.json, I will leave it as is.openapi.json, I will ignore them for now.Part of https://github.com/svix/monorepo-private/issues/9675