19b3de4dd0
* add description to upload_pipeline_description http endpoint * add test for pipeline upload server description * add description to new pipeline version * show pipeline version in pipeline detail page * make description optional on UI + show version descriptio or pipeline description * remove unused reference * revert wrong change of ref * updated on should be pipeline version * add more versions to mock-backend * show pipeline and version description at the same time * add tests for UI * show pipeline version always |
||
|---|---|---|
| .. | ||
| go_client | ||
| go_http_client | ||
| hack | ||
| python_http_client | ||
| python_http_client_template | ||
| swagger | ||
| .gitignore | ||
| Dockerfile | ||
| Makefile | ||
| README.md | ||
| auth.proto | ||
| build_kfp_server_api_python_package.sh | ||
| error.proto | ||
| experiment.proto | ||
| filter.proto | ||
| healthz.proto | ||
| job.proto | ||
| parameter.proto | ||
| pipeline.proto | ||
| pipeline_spec.proto | ||
| report.proto | ||
| resource_reference.proto | ||
| run.proto | ||
| task.proto | ||
| visualization.proto | ||
README.md
Kubeflow Pipelines API
Before You Start
Tools needed:
- Docker
- Make
Auto-generation of Go client and swagger definitions
make
Code will be generated in:
./go_client./go_http_client./swagger
Auto-generation of Python client
./build_kfp_server_api_python_package.sh
Code will be generated in ./python_http_client.
Auto-generation of API reference documentation
This directory contains API definitions. They are used to generate the API reference on kubeflow.org.
-
Use the tools bootprint-openapi and html-inline to generate the API reference from kfp_api_single_file.swagger.json. These instructions have shown how to generate a single self-contained html file which is the API reference, from a json file.
-
Use the above generated html to replace the html section, which is below the title section, in the file kubeflow-pipeline-api-spec.html
Note: whenever the API definition changes (i.e., the file kfp_api_single_file.swagger.json changes), the API reference needs to be updated.
Auto-generation of api generator image
make push
When you update the Dockerfile, to make sure others are using the same image as you do:
- push a new version of the api generator image to gcr.io/ml-pipeline-test/api-generator:latest.
- update the PREBUILT_REMOTE_IMAGE var in Makefile to point to your new image.
- push a new version of the release tools image to gcr.io/ml-pipeline-test/release:latest, run
make pushin test/release/Makefile.