History

Yuan Gong d79071c0be chore(release): bumped version to 1.4.1		2021-02-25 23:50:18 +00:00
..
go_client	fix(backend): remove Bazel from building the API. Part of #3250 (#4906 )	2021-02-25 19:31:01 +08:00
go_http_client	fix(backend): remove Bazel from building the API. Part of #3250 (#4906 )	2021-02-25 19:31:01 +08:00
hack	fix(backend): remove Bazel from building the API. Part of #3250 (#4906 )	2021-02-25 19:31:01 +08:00
python_http_client	chore(release): bumped version to 1.4.1	2021-02-25 23:50:18 +00: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.4.1	2021-02-25 23:50:18 +00:00
.gitignore	fix(backend): remove Bazel from building the API. Part of #3250 (#4906 )	2021-02-25 19:31:01 +08:00
Dockerfile	fix(backend): remove Bazel from building the API. Part of #3250 (#4906 )	2021-02-25 19:31:01 +08:00
Makefile	chore(api): build api clients using a prebuilt image (#5150 )	2021-02-25 19:32:36 +08:00
README.md	fix(backend): remove Bazel from building the API. Part of #3250 (#4906 )	2021-02-25 19:31:01 +08:00
auth.proto	chore(backend): clean up backend code generation (#5116 )	2021-02-09 07:10:57 -08:00
build_kfp_server_api_python_package.sh	chore(backend): clean up backend code generation (#5116 )	2021-02-09 07:10:57 -08:00
error.proto	Fix API package names and regenerate checked-in proto files. (#1404 )	2019-05-30 11:26:28 -07:00
experiment.proto	fix typo on sort order: 'des' --> 'desc' (#3893 )	2020-06-02 18:00:17 -07:00
filter.proto	Fix API package names and regenerate checked-in proto files. (#1404 )	2019-05-30 11:26:28 -07:00
healthz.proto	chore(backend): clean up backend code generation (#5116 )	2021-02-09 07:10:57 -08:00
job.proto	chore(backend): remove unused import in .proto (#4448 )	2020-09-22 00:28:47 -07:00
parameter.proto	Fix API package names and regenerate checked-in proto files. (#1404 )	2019-05-30 11:26:28 -07:00
pipeline.proto	chore(backend): clean up backend code generation (#5116 )	2021-02-09 07:10:57 -08:00
pipeline_spec.proto	Propagate pipeline name in pipeline spec (#1842 )	2019-08-14 23:30:32 -07:00
report.proto	Fix API package names and regenerate checked-in proto files. (#1404 )	2019-05-30 11:26:28 -07:00
resource_reference.proto	add namespace to the resourcereference (#2651 )	2019-12-03 22:06:57 -08:00
run.proto	fix typo on sort order: 'des' --> 'desc' (#3893 )	2020-06-02 18:00:17 -07:00
visualization.proto	chore(backend): clean up backend code generation (#5116 )	2021-02-09 07:10:57 -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.