python: Use openapi-codegen for high-level python API client #1646

svix-mman · 2025-01-16T19:50:15Z

The openapi.json file I am working with is incomplete.

Some of the deprecated methods are not included in the openapi.json.
Some of the API resources are missing, background_task and operational_webhook. (I know that operational_webhook is not a single resource)
Some API resources that are in the openapi.json are not currently in the high-level API client (health and environment).

Jonas is working on a fix for the openapi.json generator.

For now.

I will manually add these deprecated calls by hand. And add a @deprecated decorator to those methods.
If the API resource is not included in the openapi.json, I will leave it as is.
For API resources that are not currently in the high-level API client, but are included in the openapi.json, I will ignore them for now.

Part of https://github.com/svix/monorepo-private/issues/9675

svix-mman · 2025-01-16T20:26:30Z

(I force-pushed a typo fix in the commit message)

svix-jplatte

Looks pretty good! I think we just need to document the breaking changes, then we can merge.

python/svix/api/endpoint.py

python/svix/api/event_type.py

python/svix/api/message_attempt.py

python/svix/api/statistics.py

tasn · 2025-01-17T15:46:28Z

python/svix/api/message.py

+        self,
+        app_id: str,
+        message_in: MessageIn,
+        options: MessageCreateOptions = MessageCreateOptions(),


@svix-jplatte, I wonder if we want to break this? I guess it's fine and we can just swallow this? Though if we do, just need to make sure it's the last Python break.

svix-mman · 2025-01-17T15:52:02Z

Looks pretty good! I think we just need to document the breaking changes, then we can merge.

I will go through the diffs one at a time and document the breaking changes for the ChnageLog.md

svix-jplatte

I have lots of thoughts on these changelog entries 😅

ChangeLog.md

svix-jplatte · 2025-01-17T19:04:22Z

ChangeLog.md

+* Libs/Python **(Breaking)**: `PostOptions` and `ListOptions` are no longer used in methods for `Authentication`,`Endpoint`,`EventType`,`Integration`,`MessageAttempt`,`Message` and `Statistics` resources. Instead each API call now has it's own ResourceMethodsOptions. (Both sync and async)
+* Libs/Python: `Application.dashboard_access` is not marked as deprecated. (Both sync and async)
+* Libs/Python **(Breaking)**: `EndpointStatsOptions` is renamed to `EndpointGetStatsOptions`
+* Libs/Python **(Breaking)**: For `Endpoint.patch_headers` the `endpoint_headers_in` argument is rename to `endpoint_patch_headers_in` (Both sync and async)


typo: "is rename"

This is a breaking change because every Python argument can be passed as name=value by default? I wonder if it's worth noting down..

I'm seeing a bunch more like this below. I think they're decreasing the signal-noise ratio a bit. If you need sbd. else to make a decision ask Tom but I'd be inclined to skip these, seems extremely unlikely that people are using named arguments for these methods with very few parameters, and should be very easy to adjust to w/o reading the changelog as well.

TBH I wouldn't be surprised if people are, but I'm happy with making it more a blanket statement.

We just need to make sure to clarify that this is a one-time break, and that everything should be easy to adjust manually.

ChangeLog.md

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 0a45271 to f724642 Compare January 16, 2025 20:24

svix-mman force-pushed the mendy/add-generated-python-client-code branch from f342fb5 to 6cb2f29 Compare January 16, 2025 20:43

svix-mman marked this pull request as ready for review January 16, 2025 21:29

svix-mman requested a review from a team as a code owner January 16, 2025 21:29

Base automatically changed from mendy/sort-python-methods-consistently to main January 17, 2025 12:13

svix-jplatte reviewed Jan 17, 2025

View reviewed changes

tasn reviewed Jan 17, 2025

View reviewed changes

svix-jplatte reviewed Jan 17, 2025

View reviewed changes

svix-jplatte approved these changes Jan 17, 2025

View reviewed changes

svix-mman added 15 commits January 17, 2025 15:07

python: Add the authentication.py generated by the new openapi-codegen

175c294

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

python: Add openapi-codegen generated endpoint.py

f5d7bb2

python: Add endpoint.py *Options to __init__.py

71bec70

python: Add openapi-codegen generated event_type.py

16c93a8

python: Add event_type.py *Options to __init__.py

0857c08

python: Add authentication.py *Options to __init__.py

67361cb

python: Add integration.py *Options to __init__.py

1ebccaf

python: Add openapi-codegen generated message_attempt.py

1579a3f

Braking changes: - `MessageAttemptListOptions` is not importable from `svix.api`

python: Add message_attempt.py *Options to __init__.py

3bc407c

python: Add openapi-codegen generated message.py

69300bd

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)

python: Add statistics.py *Options to __init__.py

5ebe694

Document breaking changes in Changelog

0406384

svix-mman force-pushed the mendy/add-generated-python-client-code branch from a2949fd to 0406384 Compare January 17, 2025 20:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

python: Use openapi-codegen for high-level python API client #1646

python: Use openapi-codegen for high-level python API client #1646

svix-mman commented Jan 16, 2025 •

edited

Loading

svix-mman commented Jan 16, 2025

svix-jplatte left a comment

tasn Jan 17, 2025

svix-mman commented Jan 17, 2025 •

edited

Loading

svix-jplatte left a comment •

edited

Loading

svix-jplatte Jan 17, 2025

svix-jplatte Jan 17, 2025

svix-jplatte Jan 17, 2025

tasn Jan 17, 2025

python: Use openapi-codegen for high-level python API client #1646

Are you sure you want to change the base?

python: Use openapi-codegen for high-level python API client #1646

Conversation

svix-mman commented Jan 16, 2025 • edited Loading

svix-mman commented Jan 16, 2025

svix-jplatte left a comment

Choose a reason for hiding this comment

tasn Jan 17, 2025

Choose a reason for hiding this comment

svix-mman commented Jan 17, 2025 • edited Loading

svix-jplatte left a comment • edited Loading

Choose a reason for hiding this comment

svix-jplatte Jan 17, 2025

Choose a reason for hiding this comment

svix-jplatte Jan 17, 2025

Choose a reason for hiding this comment

svix-jplatte Jan 17, 2025

Choose a reason for hiding this comment

tasn Jan 17, 2025

Choose a reason for hiding this comment

svix-mman commented Jan 16, 2025 •

edited

Loading

svix-mman commented Jan 17, 2025 •

edited

Loading

svix-jplatte left a comment •

edited

Loading