api/

README

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, you should push a new version of the api generator image to gcr.io/ml-pipeline-test, so that others keep using the same image as you do.