-
Notifications
You must be signed in to change notification settings - Fork 175
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
python: Add generated svix/internal
openapi client
#1665
Conversation
All CI _must_ pass before merging
Between CI failing, this being a huuuuge directory and there probably not being a meaningful diff to the new stuff, I feel like I'm turning around on this being useful (even though I said "this is what we did for Rust, let's do it again basically 10 minutes ago). @svix-onelson since you're the one who initiated this for Rust in #1598, how do you feel about it? |
Funny story about failing CI. Usually |
Yeah, I don't think adding the API directories is every useful, as we never have a diff against them, just the models are useful. |
I removed the API directory, this is only the models 😰 |
The motivation for the rust lib doing this was two-fold:
If the question is "should we include generated sources for python, or nah?" I really don't have skin in the game. Either way is fine by me, but (after this initial big diff is done) I think it'll be useful to be able to eyeball the output in PRs. If the question is "should we stop including generated sources across the board?" then naturally Go would be the exception to the rule as it was before, but also we'd have to do some work to generate sources during the dist build environment for cli. Make sense? |
In my head, I think tracking the generated models in git is fine (as long as the openapi-codegen generates diffs that are as small as possible) I want to switch the python client to use them, my question is. What would make the review easier?
|
Ah, I see. Personally, I don't care about the diff between the old models and the new ones. For python at least we've got some limited test coverage. I'd lean on that for this transition to make sure basic things still align as needed between the models, the api calls, and the server's expectations. If there's concern about an area, add a test for it. |
Ok. I am closing this PR. And I will create a different PR that switches to our new models. |
This code was generated using
python/scripts/generate_openapi.sh
. The code here will be replaced by our new codegen.