-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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 Client] Use openapi generator instead of swagger #3872
Conversation
Skipping CI for Draft Pull Request. |
0105cbb
to
92dc587
Compare
9f57b93
to
478e5b8
Compare
/assign @Ark-kun |
/lgtm |
/assign @IronPan |
/retest |
/lgtm |
Strange, tests fail without any log |
/retest |
Travis is stuck. Maybe make a force-push. |
e666fd3
to
4ca8d28
Compare
/lgtm |
52a0fc7
to
b0cc8e4
Compare
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jingzhang36 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
* Generate python client package into repo using kfp_api_single_file.swagger.json * Commit python client generated by swagger * Use openapi-generator instead * Regenerate using openapi-generator * Add extra info into swagger single file * Update more info * update * Move python http client to upper folder * Clean up build script * Update kfp_server_api from new swagger.json
* Generate python client package into repo using kfp_api_single_file.swagger.json * Commit python client generated by swagger * Use openapi-generator instead * Regenerate using openapi-generator * Add extra info into swagger single file * Update more info * update * Move python http client to upper folder * Clean up build script * Update kfp_server_api from new swagger.json
Fixes #3871
Changes
backend/api/build_kfp_server_api_python_package.sh
kfp_api_single_file.swagger.json
instead of generating a temporary one each time (original logic for generating them were duplicated between this script and generate_api.sh, while they were almost the same.)backend/api/python_http_client
folder and checked into github repogenerate_api.sh
.Why this PR?
Diff for both clients can be viewed at 0105cbb
The major diff why we wanted to do this is https://github.com/kubeflow/pipelines/pull/3872/files/823fdf569f48f39e3698c74ffc1b191e251a553c..9f57b9313afff9a78ed951c275c158d9338cef91#diff-ba5c487d723b38c9c8d3d9b5f74cb1ec
openapi-generator adds author, license info from the swagger file into
setup.py
, so these information will be available on pypi.Verification
I tried the new client via
pip install .
and used a few of my client usage examples.So far the client worked great the same way as before.
I verified
is the new version, so I'm testing the right library.
I tried the following apis:
All is good. We'd still need more testing, but my early verification makes me feel the new client is very promising.