History

Yuan Gong 1c66f93f51 chore(release): bumped version to 1.6.0		2021-05-24 13:36:51 +08:00
..
go_client	feat(backend): Added multi-user pipelines (UI + API); Fixes #4197 (#4835 )	2021-02-26 06:10:15 -08:00
go_http_client	feat(backend): Added multi-user pipelines (UI + API); Fixes #4197 (#4835 )	2021-02-26 06:10:15 -08:00
hack	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
python_http_client	chore(release): bumped version to 1.6.0	2021-05-24 13:36:51 +08:00
python_http_client_template	doc(sdk/client): fix kfp-server-api py client's docstring format (#4047 )	2020-06-23 06:21:45 -07:00
swagger	chore(release): bumped version to 1.6.0	2021-05-24 13:36:51 +08:00
.gitignore	fix(backend): remove Bazel from building the API. Part of #3250 (#4906 )	2021-02-16 16:58:30 -08:00
Dockerfile	fix(backend): remove Bazel from building the API. Part of #3250 (#4906 )	2021-02-16 16:58:30 -08:00
Makefile	chore(api): build api clients using a prebuilt image (#5150 )	2021-02-19 10:27:44 -08:00
README.md	fix(backend): remove Bazel from building the API. Part of #3250 (#4906 )	2021-02-16 16:58:30 -08:00
auth.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
build_kfp_server_api_python_package.sh	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
error.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
experiment.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
filter.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
healthz.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
job.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
parameter.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
pipeline.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
pipeline_spec.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
report.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
resource_reference.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
run.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00
visualization.proto	Assigned copyright to the project authors (#5587 )	2021-05-05 13:53:22 +08:00

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.