From b0cc8e4b91a887cbb8cd1db33f5f8333132e3c41 Mon Sep 17 00:00:00 2001 From: Yuan Gong Date: Wed, 3 Jun 2020 11:02:07 +0800 Subject: [PATCH] Update kfp_server_api from new swagger.json --- backend/api/python_http_client/README.md | 60 ++++++------- .../docs/ApiGetTemplateResponse.md | 2 +- .../docs/ApiListJobsResponse.md | 4 +- .../docs/ApiListPipelineVersionsResponse.md | 4 +- .../docs/ApiListPipelinesResponse.md | 4 +- .../docs/ApiListRunsResponse.md | 4 +- backend/api/python_http_client/docs/ApiRun.md | 2 +- backend/api/python_http_client/docs/ApiUrl.md | 2 +- .../docs/ExperimentServiceApi.md | 52 +++++------ .../python_http_client/docs/JobServiceApi.md | 32 +++---- .../docs/PipelineServiceApi.md | 89 ++++++++++--------- .../python_http_client/docs/RunServiceApi.md | 86 +++++++++--------- .../api/experiment_service_api.py | 40 ++++----- .../kfp_server_api/api/job_service_api.py | 24 ++--- .../api/pipeline_service_api.py | 76 ++++++++-------- .../kfp_server_api/api/run_service_api.py | 68 +++++++------- .../models/api_get_template_response.py | 2 + .../models/api_list_jobs_response.py | 4 + .../api_list_pipeline_versions_response.py | 4 + .../models/api_list_pipelines_response.py | 4 + .../models/api_list_runs_response.py | 4 + .../kfp_server_api/models/api_run.py | 4 +- .../kfp_server_api/models/api_url.py | 2 + .../test/test_experiment_service_api.py | 12 +-- .../test/test_job_service_api.py | 8 +- .../test/test_pipeline_service_api.py | 13 ++- .../test/test_run_service_api.py | 18 ++-- 27 files changed, 327 insertions(+), 297 deletions(-) diff --git a/backend/api/python_http_client/README.md b/backend/api/python_http_client/README.md index a31a86608df..cde089e050d 100644 --- a/backend/api/python_http_client/README.md +++ b/backend/api/python_http_client/README.md @@ -79,10 +79,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.ExperimentServiceApi(api_client) - id = 'id_example' # str | + id = 'id_example' # str | The ID of the experiment to be archived. try: - # Archive an experiment. + # Archives an experiment and the experiment's runs and jobs. api_response = api_instance.archive_experiment(id) pprint(api_response) except ApiException as e: @@ -96,40 +96,40 @@ All URIs are relative to *http://localhost* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*ExperimentServiceApi* | [**archive_experiment**](docs/ExperimentServiceApi.md#archive_experiment) | **POST** /apis/v1beta1/experiments/{id}:archive | Archive an experiment. -*ExperimentServiceApi* | [**create_experiment**](docs/ExperimentServiceApi.md#create_experiment) | **POST** /apis/v1beta1/experiments | Create a new experiment. -*ExperimentServiceApi* | [**delete_experiment**](docs/ExperimentServiceApi.md#delete_experiment) | **DELETE** /apis/v1beta1/experiments/{id} | Delete an experiment. -*ExperimentServiceApi* | [**get_experiment**](docs/ExperimentServiceApi.md#get_experiment) | **GET** /apis/v1beta1/experiments/{id} | Find a specific experiment by ID. -*ExperimentServiceApi* | [**list_experiment**](docs/ExperimentServiceApi.md#list_experiment) | **GET** /apis/v1beta1/experiments | Find all experiments. -*ExperimentServiceApi* | [**unarchive_experiment**](docs/ExperimentServiceApi.md#unarchive_experiment) | **POST** /apis/v1beta1/experiments/{id}:unarchive | Restore an archived experiment. -*JobServiceApi* | [**create_job**](docs/JobServiceApi.md#create_job) | **POST** /apis/v1beta1/jobs | Create a new job. -*JobServiceApi* | [**delete_job**](docs/JobServiceApi.md#delete_job) | **DELETE** /apis/v1beta1/jobs/{id} | Delete a job. +*ExperimentServiceApi* | [**archive_experiment**](docs/ExperimentServiceApi.md#archive_experiment) | **POST** /apis/v1beta1/experiments/{id}:archive | Archives an experiment and the experiment's runs and jobs. +*ExperimentServiceApi* | [**create_experiment**](docs/ExperimentServiceApi.md#create_experiment) | **POST** /apis/v1beta1/experiments | Creates a new experiment. +*ExperimentServiceApi* | [**delete_experiment**](docs/ExperimentServiceApi.md#delete_experiment) | **DELETE** /apis/v1beta1/experiments/{id} | Deletes an experiment without deleting the experiment's runs and jobs. To avoid unexpected behaviors, delete an experiment's runs and jobs before deleting the experiment. +*ExperimentServiceApi* | [**get_experiment**](docs/ExperimentServiceApi.md#get_experiment) | **GET** /apis/v1beta1/experiments/{id} | Finds a specific experiment by ID. +*ExperimentServiceApi* | [**list_experiment**](docs/ExperimentServiceApi.md#list_experiment) | **GET** /apis/v1beta1/experiments | Finds all experiments. Supports pagination, and sorting on certain fields. +*ExperimentServiceApi* | [**unarchive_experiment**](docs/ExperimentServiceApi.md#unarchive_experiment) | **POST** /apis/v1beta1/experiments/{id}:unarchive | Restores an archived experiment. The experiment's archived runs and jobs will stay archived. +*JobServiceApi* | [**create_job**](docs/JobServiceApi.md#create_job) | **POST** /apis/v1beta1/jobs | Creates a new job. +*JobServiceApi* | [**delete_job**](docs/JobServiceApi.md#delete_job) | **DELETE** /apis/v1beta1/jobs/{id} | Deletes a job. *JobServiceApi* | [**disable_job**](docs/JobServiceApi.md#disable_job) | **POST** /apis/v1beta1/jobs/{id}/disable | Stops a job and all its associated runs. The job is not deleted. *JobServiceApi* | [**enable_job**](docs/JobServiceApi.md#enable_job) | **POST** /apis/v1beta1/jobs/{id}/enable | Restarts a job that was previously stopped. All runs associated with the job will continue. -*JobServiceApi* | [**get_job**](docs/JobServiceApi.md#get_job) | **GET** /apis/v1beta1/jobs/{id} | Find a specific job by ID. -*JobServiceApi* | [**list_jobs**](docs/JobServiceApi.md#list_jobs) | **GET** /apis/v1beta1/jobs | Find all jobs. -*PipelineServiceApi* | [**create_pipeline**](docs/PipelineServiceApi.md#create_pipeline) | **POST** /apis/v1beta1/pipelines | Add a pipeline. -*PipelineServiceApi* | [**create_pipeline_version**](docs/PipelineServiceApi.md#create_pipeline_version) | **POST** /apis/v1beta1/pipeline_versions | -*PipelineServiceApi* | [**delete_pipeline**](docs/PipelineServiceApi.md#delete_pipeline) | **DELETE** /apis/v1beta1/pipelines/{id} | Delete a pipeline. -*PipelineServiceApi* | [**delete_pipeline_version**](docs/PipelineServiceApi.md#delete_pipeline_version) | **DELETE** /apis/v1beta1/pipeline_versions/{version_id} | -*PipelineServiceApi* | [**get_pipeline**](docs/PipelineServiceApi.md#get_pipeline) | **GET** /apis/v1beta1/pipelines/{id} | Find a specific pipeline by ID. -*PipelineServiceApi* | [**get_pipeline_version**](docs/PipelineServiceApi.md#get_pipeline_version) | **GET** /apis/v1beta1/pipeline_versions/{version_id} | -*PipelineServiceApi* | [**get_pipeline_version_template**](docs/PipelineServiceApi.md#get_pipeline_version_template) | **GET** /apis/v1beta1/pipeline_versions/{version_id}/templates | +*JobServiceApi* | [**get_job**](docs/JobServiceApi.md#get_job) | **GET** /apis/v1beta1/jobs/{id} | Finds a specific job by ID. +*JobServiceApi* | [**list_jobs**](docs/JobServiceApi.md#list_jobs) | **GET** /apis/v1beta1/jobs | Finds all jobs. +*PipelineServiceApi* | [**create_pipeline**](docs/PipelineServiceApi.md#create_pipeline) | **POST** /apis/v1beta1/pipelines | Creates a pipeline. +*PipelineServiceApi* | [**create_pipeline_version**](docs/PipelineServiceApi.md#create_pipeline_version) | **POST** /apis/v1beta1/pipeline_versions | Adds a pipeline version to the specified pipeline. +*PipelineServiceApi* | [**delete_pipeline**](docs/PipelineServiceApi.md#delete_pipeline) | **DELETE** /apis/v1beta1/pipelines/{id} | Deletes a pipeline and its pipeline versions. +*PipelineServiceApi* | [**delete_pipeline_version**](docs/PipelineServiceApi.md#delete_pipeline_version) | **DELETE** /apis/v1beta1/pipeline_versions/{version_id} | Deletes a pipeline version by pipeline version ID. If the deleted pipeline version is the default pipeline version, the pipeline's default version changes to the pipeline's most recent pipeline version. If there are no remaining pipeline versions, the pipeline will have no default version. Examines the run_service_api.ipynb notebook to learn more about creating a run using a pipeline version (https://github.com/kubeflow/pipelines/blob/master/tools/benchmarks/run_service_api.ipynb). +*PipelineServiceApi* | [**get_pipeline**](docs/PipelineServiceApi.md#get_pipeline) | **GET** /apis/v1beta1/pipelines/{id} | Finds a specific pipeline by ID. +*PipelineServiceApi* | [**get_pipeline_version**](docs/PipelineServiceApi.md#get_pipeline_version) | **GET** /apis/v1beta1/pipeline_versions/{version_id} | Gets a pipeline version by pipeline version ID. +*PipelineServiceApi* | [**get_pipeline_version_template**](docs/PipelineServiceApi.md#get_pipeline_version_template) | **GET** /apis/v1beta1/pipeline_versions/{version_id}/templates | Returns a YAML template that contains the specified pipeline version's description, parameters and metadata. *PipelineServiceApi* | [**get_template**](docs/PipelineServiceApi.md#get_template) | **GET** /apis/v1beta1/pipelines/{id}/templates | Returns a single YAML template that contains the description, parameters, and metadata associated with the pipeline provided. -*PipelineServiceApi* | [**list_pipeline_versions**](docs/PipelineServiceApi.md#list_pipeline_versions) | **GET** /apis/v1beta1/pipeline_versions | -*PipelineServiceApi* | [**list_pipelines**](docs/PipelineServiceApi.md#list_pipelines) | **GET** /apis/v1beta1/pipelines | Find all pipelines. +*PipelineServiceApi* | [**list_pipeline_versions**](docs/PipelineServiceApi.md#list_pipeline_versions) | **GET** /apis/v1beta1/pipeline_versions | Lists all pipeline versions of a given pipeline. +*PipelineServiceApi* | [**list_pipelines**](docs/PipelineServiceApi.md#list_pipelines) | **GET** /apis/v1beta1/pipelines | Finds all pipelines. *PipelineUploadServiceApi* | [**upload_pipeline**](docs/PipelineUploadServiceApi.md#upload_pipeline) | **POST** /apis/v1beta1/pipelines/upload | *PipelineUploadServiceApi* | [**upload_pipeline_version**](docs/PipelineUploadServiceApi.md#upload_pipeline_version) | **POST** /apis/v1beta1/pipelines/upload_version | -*RunServiceApi* | [**archive_run**](docs/RunServiceApi.md#archive_run) | **POST** /apis/v1beta1/runs/{id}:archive | Archive a run. -*RunServiceApi* | [**create_run**](docs/RunServiceApi.md#create_run) | **POST** /apis/v1beta1/runs | Create a new run. -*RunServiceApi* | [**delete_run**](docs/RunServiceApi.md#delete_run) | **DELETE** /apis/v1beta1/runs/{id} | Delete a run. -*RunServiceApi* | [**get_run**](docs/RunServiceApi.md#get_run) | **GET** /apis/v1beta1/runs/{run_id} | Find a specific run by ID. -*RunServiceApi* | [**list_runs**](docs/RunServiceApi.md#list_runs) | **GET** /apis/v1beta1/runs | Find all runs. -*RunServiceApi* | [**read_artifact**](docs/RunServiceApi.md#read_artifact) | **GET** /apis/v1beta1/runs/{run_id}/nodes/{node_id}/artifacts/{artifact_name}:read | Find a run's artifact data. +*RunServiceApi* | [**archive_run**](docs/RunServiceApi.md#archive_run) | **POST** /apis/v1beta1/runs/{id}:archive | Archives a run. +*RunServiceApi* | [**create_run**](docs/RunServiceApi.md#create_run) | **POST** /apis/v1beta1/runs | Creates a new run. +*RunServiceApi* | [**delete_run**](docs/RunServiceApi.md#delete_run) | **DELETE** /apis/v1beta1/runs/{id} | Deletes a run. +*RunServiceApi* | [**get_run**](docs/RunServiceApi.md#get_run) | **GET** /apis/v1beta1/runs/{run_id} | Finds a specific run by ID. +*RunServiceApi* | [**list_runs**](docs/RunServiceApi.md#list_runs) | **GET** /apis/v1beta1/runs | Finds all runs. +*RunServiceApi* | [**read_artifact**](docs/RunServiceApi.md#read_artifact) | **GET** /apis/v1beta1/runs/{run_id}/nodes/{node_id}/artifacts/{artifact_name}:read | Finds a run's artifact data. *RunServiceApi* | [**report_run_metrics**](docs/RunServiceApi.md#report_run_metrics) | **POST** /apis/v1beta1/runs/{run_id}:reportMetrics | ReportRunMetrics reports metrics of a run. Each metric is reported in its own transaction, so this API accepts partial failures. Metric can be uniquely identified by (run_id, node_id, name). Duplicate reporting will be ignored by the API. First reporting wins. -*RunServiceApi* | [**retry_run**](docs/RunServiceApi.md#retry_run) | **POST** /apis/v1beta1/runs/{run_id}/retry | Re-initiate a failed or terminated run. -*RunServiceApi* | [**terminate_run**](docs/RunServiceApi.md#terminate_run) | **POST** /apis/v1beta1/runs/{run_id}/terminate | Terminate an active run. -*RunServiceApi* | [**unarchive_run**](docs/RunServiceApi.md#unarchive_run) | **POST** /apis/v1beta1/runs/{id}:unarchive | Restore an archived run. +*RunServiceApi* | [**retry_run**](docs/RunServiceApi.md#retry_run) | **POST** /apis/v1beta1/runs/{run_id}/retry | Re-initiates a failed or terminated run. +*RunServiceApi* | [**terminate_run**](docs/RunServiceApi.md#terminate_run) | **POST** /apis/v1beta1/runs/{run_id}/terminate | Terminates an active run. +*RunServiceApi* | [**unarchive_run**](docs/RunServiceApi.md#unarchive_run) | **POST** /apis/v1beta1/runs/{id}:unarchive | Restores an archived run. ## Documentation For Models diff --git a/backend/api/python_http_client/docs/ApiGetTemplateResponse.md b/backend/api/python_http_client/docs/ApiGetTemplateResponse.md index 1ac68e05439..478c48166c5 100644 --- a/backend/api/python_http_client/docs/ApiGetTemplateResponse.md +++ b/backend/api/python_http_client/docs/ApiGetTemplateResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**template** | **str** | | [optional] +**template** | **str** | The template of the pipeline specified in a GetTemplate request, or of a pipeline version specified in a GetPipelinesVersionTemplate request. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/backend/api/python_http_client/docs/ApiListJobsResponse.md b/backend/api/python_http_client/docs/ApiListJobsResponse.md index c12024d8606..8a94f7cc046 100644 --- a/backend/api/python_http_client/docs/ApiListJobsResponse.md +++ b/backend/api/python_http_client/docs/ApiListJobsResponse.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **jobs** | [**list[ApiJob]**](ApiJob.md) | A list of jobs returned. | [optional] -**total_size** | **int** | | [optional] -**next_page_token** | **str** | | [optional] +**total_size** | **int** | The total number of jobs for the given query. | [optional] +**next_page_token** | **str** | The token to list the next page of jobs. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/backend/api/python_http_client/docs/ApiListPipelineVersionsResponse.md b/backend/api/python_http_client/docs/ApiListPipelineVersionsResponse.md index 06dd53786a6..9ab2eacb2e3 100644 --- a/backend/api/python_http_client/docs/ApiListPipelineVersionsResponse.md +++ b/backend/api/python_http_client/docs/ApiListPipelineVersionsResponse.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **versions** | [**list[ApiPipelineVersion]**](ApiPipelineVersion.md) | | [optional] -**next_page_token** | **str** | | [optional] -**total_size** | **int** | | [optional] +**next_page_token** | **str** | The token to list the next page of pipeline versions. | [optional] +**total_size** | **int** | The total number of pipeline versions for the given query. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/backend/api/python_http_client/docs/ApiListPipelinesResponse.md b/backend/api/python_http_client/docs/ApiListPipelinesResponse.md index f59d27a184a..cb9d319b7ce 100644 --- a/backend/api/python_http_client/docs/ApiListPipelinesResponse.md +++ b/backend/api/python_http_client/docs/ApiListPipelinesResponse.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pipelines** | [**list[ApiPipeline]**](ApiPipeline.md) | | [optional] -**total_size** | **int** | | [optional] -**next_page_token** | **str** | | [optional] +**total_size** | **int** | The total number of pipelines for the given query. | [optional] +**next_page_token** | **str** | The token to list the next page of pipelines. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/backend/api/python_http_client/docs/ApiListRunsResponse.md b/backend/api/python_http_client/docs/ApiListRunsResponse.md index 26d19e1f3eb..4b93b22d17d 100644 --- a/backend/api/python_http_client/docs/ApiListRunsResponse.md +++ b/backend/api/python_http_client/docs/ApiListRunsResponse.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **runs** | [**list[ApiRun]**](ApiRun.md) | | [optional] -**total_size** | **int** | | [optional] -**next_page_token** | **str** | | [optional] +**total_size** | **int** | The total number of runs for the given query. | [optional] +**next_page_token** | **str** | The token to list the next page of runs. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/backend/api/python_http_client/docs/ApiRun.md b/backend/api/python_http_client/docs/ApiRun.md index bf67737b5f3..adef1ebfd8a 100644 --- a/backend/api/python_http_client/docs/ApiRun.md +++ b/backend/api/python_http_client/docs/ApiRun.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **storage_state** | [**RunStorageState**](RunStorageState.md) | | [optional] **description** | **str** | | [optional] **pipeline_spec** | [**ApiPipelineSpec**](ApiPipelineSpec.md) | | [optional] -**resource_references** | [**list[ApiResourceReference]**](ApiResourceReference.md) | Optional input field. Specify which resource this run belongs to. | [optional] +**resource_references** | [**list[ApiResourceReference]**](ApiResourceReference.md) | Optional input field. Specify which resource this run belongs to. When creating a run from a particular pipeline version, the pipeline version can be specified here. | [optional] **service_account** | **str** | Optional input field. Specify which Kubernetes service account this run uses. | [optional] **created_at** | **datetime** | Output. The time that the run created. | [optional] **scheduled_at** | **datetime** | Output. When this run is scheduled to run. This could be different from created_at. For example, if a run is from a backfilling job that was supposed to run 2 month ago, the scheduled_at is 2 month ago, v.s. created_at is the current time. | [optional] diff --git a/backend/api/python_http_client/docs/ApiUrl.md b/backend/api/python_http_client/docs/ApiUrl.md index a098f68fba5..3b112d2b4f5 100644 --- a/backend/api/python_http_client/docs/ApiUrl.md +++ b/backend/api/python_http_client/docs/ApiUrl.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pipeline_url** | **str** | | [optional] +**pipeline_url** | **str** | URL of the pipeline definition or the pipeline version definition. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/backend/api/python_http_client/docs/ExperimentServiceApi.md b/backend/api/python_http_client/docs/ExperimentServiceApi.md index bca90051df9..0ac2cc68a87 100644 --- a/backend/api/python_http_client/docs/ExperimentServiceApi.md +++ b/backend/api/python_http_client/docs/ExperimentServiceApi.md @@ -4,18 +4,18 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**archive_experiment**](ExperimentServiceApi.md#archive_experiment) | **POST** /apis/v1beta1/experiments/{id}:archive | Archive an experiment. -[**create_experiment**](ExperimentServiceApi.md#create_experiment) | **POST** /apis/v1beta1/experiments | Create a new experiment. -[**delete_experiment**](ExperimentServiceApi.md#delete_experiment) | **DELETE** /apis/v1beta1/experiments/{id} | Delete an experiment. -[**get_experiment**](ExperimentServiceApi.md#get_experiment) | **GET** /apis/v1beta1/experiments/{id} | Find a specific experiment by ID. -[**list_experiment**](ExperimentServiceApi.md#list_experiment) | **GET** /apis/v1beta1/experiments | Find all experiments. -[**unarchive_experiment**](ExperimentServiceApi.md#unarchive_experiment) | **POST** /apis/v1beta1/experiments/{id}:unarchive | Restore an archived experiment. +[**archive_experiment**](ExperimentServiceApi.md#archive_experiment) | **POST** /apis/v1beta1/experiments/{id}:archive | Archives an experiment and the experiment's runs and jobs. +[**create_experiment**](ExperimentServiceApi.md#create_experiment) | **POST** /apis/v1beta1/experiments | Creates a new experiment. +[**delete_experiment**](ExperimentServiceApi.md#delete_experiment) | **DELETE** /apis/v1beta1/experiments/{id} | Deletes an experiment without deleting the experiment's runs and jobs. To avoid unexpected behaviors, delete an experiment's runs and jobs before deleting the experiment. +[**get_experiment**](ExperimentServiceApi.md#get_experiment) | **GET** /apis/v1beta1/experiments/{id} | Finds a specific experiment by ID. +[**list_experiment**](ExperimentServiceApi.md#list_experiment) | **GET** /apis/v1beta1/experiments | Finds all experiments. Supports pagination, and sorting on certain fields. +[**unarchive_experiment**](ExperimentServiceApi.md#unarchive_experiment) | **POST** /apis/v1beta1/experiments/{id}:unarchive | Restores an archived experiment. The experiment's archived runs and jobs will stay archived. # **archive_experiment** > object archive_experiment(id) -Archive an experiment. +Archives an experiment and the experiment's runs and jobs. ### Example @@ -51,10 +51,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.ExperimentServiceApi(api_client) - id = 'id_example' # str | + id = 'id_example' # str | The ID of the experiment to be archived. try: - # Archive an experiment. + # Archives an experiment and the experiment's runs and jobs. api_response = api_instance.archive_experiment(id) pprint(api_response) except ApiException as e: @@ -65,7 +65,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **id** | **str**| The ID of the experiment to be archived. | ### Return type @@ -91,7 +91,7 @@ Name | Type | Description | Notes # **create_experiment** > ApiExperiment create_experiment(body) -Create a new experiment. +Creates a new experiment. ### Example @@ -130,7 +130,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: body = kfp_server_api.ApiExperiment() # ApiExperiment | The experiment to be created. try: - # Create a new experiment. + # Creates a new experiment. api_response = api_instance.create_experiment(body) pprint(api_response) except ApiException as e: @@ -167,7 +167,7 @@ Name | Type | Description | Notes # **delete_experiment** > object delete_experiment(id) -Delete an experiment. +Deletes an experiment without deleting the experiment's runs and jobs. To avoid unexpected behaviors, delete an experiment's runs and jobs before deleting the experiment. ### Example @@ -206,7 +206,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: id = 'id_example' # str | The ID of the experiment to be deleted. try: - # Delete an experiment. + # Deletes an experiment without deleting the experiment's runs and jobs. To avoid unexpected behaviors, delete an experiment's runs and jobs before deleting the experiment. api_response = api_instance.delete_experiment(id) pprint(api_response) except ApiException as e: @@ -243,7 +243,7 @@ Name | Type | Description | Notes # **get_experiment** > ApiExperiment get_experiment(id) -Find a specific experiment by ID. +Finds a specific experiment by ID. ### Example @@ -282,7 +282,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: id = 'id_example' # str | The ID of the experiment to be retrieved. try: - # Find a specific experiment by ID. + # Finds a specific experiment by ID. api_response = api_instance.get_experiment(id) pprint(api_response) except ApiException as e: @@ -319,7 +319,7 @@ Name | Type | Description | Notes # **list_experiment** > ApiListExperimentsResponse list_experiment(page_token=page_token, page_size=page_size, sort_by=sort_by, filter=filter, resource_reference_key_type=resource_reference_key_type, resource_reference_key_id=resource_reference_key_id) -Find all experiments. +Finds all experiments. Supports pagination, and sorting on certain fields. ### Example @@ -355,15 +355,15 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.ExperimentServiceApi(api_client) - page_token = 'page_token_example' # str | (optional) -page_size = 56 # int | (optional) + page_token = 'page_token_example' # str | A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListExperiment call or can be omitted when fetching the first page. (optional) +page_size = 56 # int | The number of experiments to be listed per page. If there are more experiments than this number, the response message will contain a nextPageToken field you can use to fetch the next page. (optional) sort_by = 'sort_by_example' # str | Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. (optional) filter = 'filter_example' # str | A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/ blob/master/backend/api/filter.proto)). (optional) resource_reference_key_type = 'UNKNOWN_RESOURCE_TYPE' # str | The type of the resource that referred to. (optional) (default to 'UNKNOWN_RESOURCE_TYPE') resource_reference_key_id = 'resource_reference_key_id_example' # str | The ID of the resource that referred to. (optional) try: - # Find all experiments. + # Finds all experiments. Supports pagination, and sorting on certain fields. api_response = api_instance.list_experiment(page_token=page_token, page_size=page_size, sort_by=sort_by, filter=filter, resource_reference_key_type=resource_reference_key_type, resource_reference_key_id=resource_reference_key_id) pprint(api_response) except ApiException as e: @@ -374,8 +374,8 @@ resource_reference_key_id = 'resource_reference_key_id_example' # str | The ID o Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_token** | **str**| | [optional] - **page_size** | **int**| | [optional] + **page_token** | **str**| A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListExperiment call or can be omitted when fetching the first page. | [optional] + **page_size** | **int**| The number of experiments to be listed per page. If there are more experiments than this number, the response message will contain a nextPageToken field you can use to fetch the next page. | [optional] **sort_by** | **str**| Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. | [optional] **filter** | **str**| A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/ blob/master/backend/api/filter.proto)). | [optional] **resource_reference_key_type** | **str**| The type of the resource that referred to. | [optional] [default to 'UNKNOWN_RESOURCE_TYPE'] @@ -405,7 +405,7 @@ Name | Type | Description | Notes # **unarchive_experiment** > object unarchive_experiment(id) -Restore an archived experiment. +Restores an archived experiment. The experiment's archived runs and jobs will stay archived. ### Example @@ -441,10 +441,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.ExperimentServiceApi(api_client) - id = 'id_example' # str | + id = 'id_example' # str | The ID of the experiment to be restored. try: - # Restore an archived experiment. + # Restores an archived experiment. The experiment's archived runs and jobs will stay archived. api_response = api_instance.unarchive_experiment(id) pprint(api_response) except ApiException as e: @@ -455,7 +455,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **id** | **str**| The ID of the experiment to be restored. | ### Return type diff --git a/backend/api/python_http_client/docs/JobServiceApi.md b/backend/api/python_http_client/docs/JobServiceApi.md index 2e4a6469587..7342143b4e1 100644 --- a/backend/api/python_http_client/docs/JobServiceApi.md +++ b/backend/api/python_http_client/docs/JobServiceApi.md @@ -4,18 +4,18 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_job**](JobServiceApi.md#create_job) | **POST** /apis/v1beta1/jobs | Create a new job. -[**delete_job**](JobServiceApi.md#delete_job) | **DELETE** /apis/v1beta1/jobs/{id} | Delete a job. +[**create_job**](JobServiceApi.md#create_job) | **POST** /apis/v1beta1/jobs | Creates a new job. +[**delete_job**](JobServiceApi.md#delete_job) | **DELETE** /apis/v1beta1/jobs/{id} | Deletes a job. [**disable_job**](JobServiceApi.md#disable_job) | **POST** /apis/v1beta1/jobs/{id}/disable | Stops a job and all its associated runs. The job is not deleted. [**enable_job**](JobServiceApi.md#enable_job) | **POST** /apis/v1beta1/jobs/{id}/enable | Restarts a job that was previously stopped. All runs associated with the job will continue. -[**get_job**](JobServiceApi.md#get_job) | **GET** /apis/v1beta1/jobs/{id} | Find a specific job by ID. -[**list_jobs**](JobServiceApi.md#list_jobs) | **GET** /apis/v1beta1/jobs | Find all jobs. +[**get_job**](JobServiceApi.md#get_job) | **GET** /apis/v1beta1/jobs/{id} | Finds a specific job by ID. +[**list_jobs**](JobServiceApi.md#list_jobs) | **GET** /apis/v1beta1/jobs | Finds all jobs. # **create_job** > ApiJob create_job(body) -Create a new job. +Creates a new job. ### Example @@ -54,7 +54,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: body = kfp_server_api.ApiJob() # ApiJob | The job to be created try: - # Create a new job. + # Creates a new job. api_response = api_instance.create_job(body) pprint(api_response) except ApiException as e: @@ -91,7 +91,7 @@ Name | Type | Description | Notes # **delete_job** > object delete_job(id) -Delete a job. +Deletes a job. ### Example @@ -130,7 +130,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: id = 'id_example' # str | The ID of the job to be deleted try: - # Delete a job. + # Deletes a job. api_response = api_instance.delete_job(id) pprint(api_response) except ApiException as e: @@ -319,7 +319,7 @@ Name | Type | Description | Notes # **get_job** > ApiJob get_job(id) -Find a specific job by ID. +Finds a specific job by ID. ### Example @@ -358,7 +358,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: id = 'id_example' # str | The ID of the job to be retrieved try: - # Find a specific job by ID. + # Finds a specific job by ID. api_response = api_instance.get_job(id) pprint(api_response) except ApiException as e: @@ -395,7 +395,7 @@ Name | Type | Description | Notes # **list_jobs** > ApiListJobsResponse list_jobs(page_token=page_token, page_size=page_size, sort_by=sort_by, resource_reference_key_type=resource_reference_key_type, resource_reference_key_id=resource_reference_key_id, filter=filter) -Find all jobs. +Finds all jobs. ### Example @@ -431,15 +431,15 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.JobServiceApi(api_client) - page_token = 'page_token_example' # str | (optional) -page_size = 56 # int | (optional) + page_token = 'page_token_example' # str | A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListJobs call or can be omitted when fetching the first page. (optional) +page_size = 56 # int | The number of jobs to be listed per page. If there are more jobs than this number, the response message will contain a nextPageToken field you can use to fetch the next page. (optional) sort_by = 'sort_by_example' # str | Can be format of \"field_name\", \"field_name asc\" or \"field_name des\". Ascending by default. (optional) resource_reference_key_type = 'UNKNOWN_RESOURCE_TYPE' # str | The type of the resource that referred to. (optional) (default to 'UNKNOWN_RESOURCE_TYPE') resource_reference_key_id = 'resource_reference_key_id_example' # str | The ID of the resource that referred to. (optional) filter = 'filter_example' # str | A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/ blob/master/backend/api/filter.proto)). (optional) try: - # Find all jobs. + # Finds all jobs. api_response = api_instance.list_jobs(page_token=page_token, page_size=page_size, sort_by=sort_by, resource_reference_key_type=resource_reference_key_type, resource_reference_key_id=resource_reference_key_id, filter=filter) pprint(api_response) except ApiException as e: @@ -450,8 +450,8 @@ filter = 'filter_example' # str | A url-encoded, JSON-serialized Filter protocol Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_token** | **str**| | [optional] - **page_size** | **int**| | [optional] + **page_token** | **str**| A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListJobs call or can be omitted when fetching the first page. | [optional] + **page_size** | **int**| The number of jobs to be listed per page. If there are more jobs than this number, the response message will contain a nextPageToken field you can use to fetch the next page. | [optional] **sort_by** | **str**| Can be format of \"field_name\", \"field_name asc\" or \"field_name des\". Ascending by default. | [optional] **resource_reference_key_type** | **str**| The type of the resource that referred to. | [optional] [default to 'UNKNOWN_RESOURCE_TYPE'] **resource_reference_key_id** | **str**| The ID of the resource that referred to. | [optional] diff --git a/backend/api/python_http_client/docs/PipelineServiceApi.md b/backend/api/python_http_client/docs/PipelineServiceApi.md index f35c65ac192..9c7c875dda6 100644 --- a/backend/api/python_http_client/docs/PipelineServiceApi.md +++ b/backend/api/python_http_client/docs/PipelineServiceApi.md @@ -4,22 +4,22 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_pipeline**](PipelineServiceApi.md#create_pipeline) | **POST** /apis/v1beta1/pipelines | Add a pipeline. -[**create_pipeline_version**](PipelineServiceApi.md#create_pipeline_version) | **POST** /apis/v1beta1/pipeline_versions | -[**delete_pipeline**](PipelineServiceApi.md#delete_pipeline) | **DELETE** /apis/v1beta1/pipelines/{id} | Delete a pipeline. -[**delete_pipeline_version**](PipelineServiceApi.md#delete_pipeline_version) | **DELETE** /apis/v1beta1/pipeline_versions/{version_id} | -[**get_pipeline**](PipelineServiceApi.md#get_pipeline) | **GET** /apis/v1beta1/pipelines/{id} | Find a specific pipeline by ID. -[**get_pipeline_version**](PipelineServiceApi.md#get_pipeline_version) | **GET** /apis/v1beta1/pipeline_versions/{version_id} | -[**get_pipeline_version_template**](PipelineServiceApi.md#get_pipeline_version_template) | **GET** /apis/v1beta1/pipeline_versions/{version_id}/templates | +[**create_pipeline**](PipelineServiceApi.md#create_pipeline) | **POST** /apis/v1beta1/pipelines | Creates a pipeline. +[**create_pipeline_version**](PipelineServiceApi.md#create_pipeline_version) | **POST** /apis/v1beta1/pipeline_versions | Adds a pipeline version to the specified pipeline. +[**delete_pipeline**](PipelineServiceApi.md#delete_pipeline) | **DELETE** /apis/v1beta1/pipelines/{id} | Deletes a pipeline and its pipeline versions. +[**delete_pipeline_version**](PipelineServiceApi.md#delete_pipeline_version) | **DELETE** /apis/v1beta1/pipeline_versions/{version_id} | Deletes a pipeline version by pipeline version ID. If the deleted pipeline version is the default pipeline version, the pipeline's default version changes to the pipeline's most recent pipeline version. If there are no remaining pipeline versions, the pipeline will have no default version. Examines the run_service_api.ipynb notebook to learn more about creating a run using a pipeline version (https://github.com/kubeflow/pipelines/blob/master/tools/benchmarks/run_service_api.ipynb). +[**get_pipeline**](PipelineServiceApi.md#get_pipeline) | **GET** /apis/v1beta1/pipelines/{id} | Finds a specific pipeline by ID. +[**get_pipeline_version**](PipelineServiceApi.md#get_pipeline_version) | **GET** /apis/v1beta1/pipeline_versions/{version_id} | Gets a pipeline version by pipeline version ID. +[**get_pipeline_version_template**](PipelineServiceApi.md#get_pipeline_version_template) | **GET** /apis/v1beta1/pipeline_versions/{version_id}/templates | Returns a YAML template that contains the specified pipeline version's description, parameters and metadata. [**get_template**](PipelineServiceApi.md#get_template) | **GET** /apis/v1beta1/pipelines/{id}/templates | Returns a single YAML template that contains the description, parameters, and metadata associated with the pipeline provided. -[**list_pipeline_versions**](PipelineServiceApi.md#list_pipeline_versions) | **GET** /apis/v1beta1/pipeline_versions | -[**list_pipelines**](PipelineServiceApi.md#list_pipelines) | **GET** /apis/v1beta1/pipelines | Find all pipelines. +[**list_pipeline_versions**](PipelineServiceApi.md#list_pipeline_versions) | **GET** /apis/v1beta1/pipeline_versions | Lists all pipeline versions of a given pipeline. +[**list_pipelines**](PipelineServiceApi.md#list_pipelines) | **GET** /apis/v1beta1/pipelines | Finds all pipelines. # **create_pipeline** > ApiPipeline create_pipeline(body) -Add a pipeline. +Creates a pipeline. ### Example @@ -58,7 +58,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: body = kfp_server_api.ApiPipeline() # ApiPipeline | try: - # Add a pipeline. + # Creates a pipeline. api_response = api_instance.create_pipeline(body) pprint(api_response) except ApiException as e: @@ -95,7 +95,7 @@ Name | Type | Description | Notes # **create_pipeline_version** > ApiPipelineVersion create_pipeline_version(body) - +Adds a pipeline version to the specified pipeline. ### Example @@ -134,6 +134,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: body = kfp_server_api.ApiPipelineVersion() # ApiPipelineVersion | ResourceReference inside PipelineVersion specifies the pipeline that this version belongs to. try: + # Adds a pipeline version to the specified pipeline. api_response = api_instance.create_pipeline_version(body) pprint(api_response) except ApiException as e: @@ -170,7 +171,7 @@ Name | Type | Description | Notes # **delete_pipeline** > object delete_pipeline(id) -Delete a pipeline. +Deletes a pipeline and its pipeline versions. ### Example @@ -206,10 +207,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.PipelineServiceApi(api_client) - id = 'id_example' # str | + id = 'id_example' # str | The ID of the pipeline to be deleted. try: - # Delete a pipeline. + # Deletes a pipeline and its pipeline versions. api_response = api_instance.delete_pipeline(id) pprint(api_response) except ApiException as e: @@ -220,7 +221,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **id** | **str**| The ID of the pipeline to be deleted. | ### Return type @@ -246,7 +247,7 @@ Name | Type | Description | Notes # **delete_pipeline_version** > object delete_pipeline_version(version_id) - +Deletes a pipeline version by pipeline version ID. If the deleted pipeline version is the default pipeline version, the pipeline's default version changes to the pipeline's most recent pipeline version. If there are no remaining pipeline versions, the pipeline will have no default version. Examines the run_service_api.ipynb notebook to learn more about creating a run using a pipeline version (https://github.com/kubeflow/pipelines/blob/master/tools/benchmarks/run_service_api.ipynb). ### Example @@ -282,9 +283,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.PipelineServiceApi(api_client) - version_id = 'version_id_example' # str | + version_id = 'version_id_example' # str | The ID of the pipeline version to be deleted. try: + # Deletes a pipeline version by pipeline version ID. If the deleted pipeline version is the default pipeline version, the pipeline's default version changes to the pipeline's most recent pipeline version. If there are no remaining pipeline versions, the pipeline will have no default version. Examines the run_service_api.ipynb notebook to learn more about creating a run using a pipeline version (https://github.com/kubeflow/pipelines/blob/master/tools/benchmarks/run_service_api.ipynb). api_response = api_instance.delete_pipeline_version(version_id) pprint(api_response) except ApiException as e: @@ -295,7 +297,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **version_id** | **str**| | + **version_id** | **str**| The ID of the pipeline version to be deleted. | ### Return type @@ -321,7 +323,7 @@ Name | Type | Description | Notes # **get_pipeline** > ApiPipeline get_pipeline(id) -Find a specific pipeline by ID. +Finds a specific pipeline by ID. ### Example @@ -357,10 +359,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.PipelineServiceApi(api_client) - id = 'id_example' # str | + id = 'id_example' # str | The ID of the pipeline to be retrieved. try: - # Find a specific pipeline by ID. + # Finds a specific pipeline by ID. api_response = api_instance.get_pipeline(id) pprint(api_response) except ApiException as e: @@ -371,7 +373,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **id** | **str**| The ID of the pipeline to be retrieved. | ### Return type @@ -397,7 +399,7 @@ Name | Type | Description | Notes # **get_pipeline_version** > ApiPipelineVersion get_pipeline_version(version_id) - +Gets a pipeline version by pipeline version ID. ### Example @@ -433,9 +435,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.PipelineServiceApi(api_client) - version_id = 'version_id_example' # str | + version_id = 'version_id_example' # str | The ID of the pipeline version to be retrieved. try: + # Gets a pipeline version by pipeline version ID. api_response = api_instance.get_pipeline_version(version_id) pprint(api_response) except ApiException as e: @@ -446,7 +449,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **version_id** | **str**| | + **version_id** | **str**| The ID of the pipeline version to be retrieved. | ### Return type @@ -472,7 +475,7 @@ Name | Type | Description | Notes # **get_pipeline_version_template** > ApiGetTemplateResponse get_pipeline_version_template(version_id) - +Returns a YAML template that contains the specified pipeline version's description, parameters and metadata. ### Example @@ -508,9 +511,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.PipelineServiceApi(api_client) - version_id = 'version_id_example' # str | + version_id = 'version_id_example' # str | The ID of the pipeline version whose template is to be retrieved. try: + # Returns a YAML template that contains the specified pipeline version's description, parameters and metadata. api_response = api_instance.get_pipeline_version_template(version_id) pprint(api_response) except ApiException as e: @@ -521,7 +525,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **version_id** | **str**| | + **version_id** | **str**| The ID of the pipeline version whose template is to be retrieved. | ### Return type @@ -583,7 +587,7 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.PipelineServiceApi(api_client) - id = 'id_example' # str | + id = 'id_example' # str | The ID of the pipeline whose template is to be retrieved. try: # Returns a single YAML template that contains the description, parameters, and metadata associated with the pipeline provided. @@ -597,7 +601,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **id** | **str**| The ID of the pipeline whose template is to be retrieved. | ### Return type @@ -623,7 +627,7 @@ Name | Type | Description | Notes # **list_pipeline_versions** > ApiListPipelineVersionsResponse list_pipeline_versions(resource_key_type=resource_key_type, resource_key_id=resource_key_id, page_size=page_size, page_token=page_token, sort_by=sort_by, filter=filter) - +Lists all pipeline versions of a given pipeline. ### Example @@ -661,12 +665,13 @@ with kfp_server_api.ApiClient(configuration) as api_client: api_instance = kfp_server_api.PipelineServiceApi(api_client) resource_key_type = 'UNKNOWN_RESOURCE_TYPE' # str | The type of the resource that referred to. (optional) (default to 'UNKNOWN_RESOURCE_TYPE') resource_key_id = 'resource_key_id_example' # str | The ID of the resource that referred to. (optional) -page_size = 56 # int | (optional) -page_token = 'page_token_example' # str | (optional) +page_size = 56 # int | The number of pipeline versions to be listed per page. If there are more pipeline versions than this number, the response message will contain a nextPageToken field you can use to fetch the next page. (optional) +page_token = 'page_token_example' # str | A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelineVersions call or can be omitted when fetching the first page. (optional) sort_by = 'sort_by_example' # str | Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. (optional) filter = 'filter_example' # str | A base-64 encoded, JSON-serialized Filter protocol buffer (see filter.proto). (optional) try: + # Lists all pipeline versions of a given pipeline. api_response = api_instance.list_pipeline_versions(resource_key_type=resource_key_type, resource_key_id=resource_key_id, page_size=page_size, page_token=page_token, sort_by=sort_by, filter=filter) pprint(api_response) except ApiException as e: @@ -679,8 +684,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **resource_key_type** | **str**| The type of the resource that referred to. | [optional] [default to 'UNKNOWN_RESOURCE_TYPE'] **resource_key_id** | **str**| The ID of the resource that referred to. | [optional] - **page_size** | **int**| | [optional] - **page_token** | **str**| | [optional] + **page_size** | **int**| The number of pipeline versions to be listed per page. If there are more pipeline versions than this number, the response message will contain a nextPageToken field you can use to fetch the next page. | [optional] + **page_token** | **str**| A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelineVersions call or can be omitted when fetching the first page. | [optional] **sort_by** | **str**| Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. | [optional] **filter** | **str**| A base-64 encoded, JSON-serialized Filter protocol buffer (see filter.proto). | [optional] @@ -708,7 +713,7 @@ Name | Type | Description | Notes # **list_pipelines** > ApiListPipelinesResponse list_pipelines(page_token=page_token, page_size=page_size, sort_by=sort_by, filter=filter) -Find all pipelines. +Finds all pipelines. ### Example @@ -744,13 +749,13 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.PipelineServiceApi(api_client) - page_token = 'page_token_example' # str | (optional) -page_size = 56 # int | (optional) + page_token = 'page_token_example' # str | A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelines call. (optional) +page_size = 56 # int | The number of pipelines to be listed per page. If there are more pipelines than this number, the response message will contain a valid value in the nextPageToken field. (optional) sort_by = 'sort_by_example' # str | Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. (optional) filter = 'filter_example' # str | A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/ blob/master/backend/api/filter.proto)). (optional) try: - # Find all pipelines. + # Finds all pipelines. api_response = api_instance.list_pipelines(page_token=page_token, page_size=page_size, sort_by=sort_by, filter=filter) pprint(api_response) except ApiException as e: @@ -761,8 +766,8 @@ filter = 'filter_example' # str | A url-encoded, JSON-serialized Filter protocol Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_token** | **str**| | [optional] - **page_size** | **int**| | [optional] + **page_token** | **str**| A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelines call. | [optional] + **page_size** | **int**| The number of pipelines to be listed per page. If there are more pipelines than this number, the response message will contain a valid value in the nextPageToken field. | [optional] **sort_by** | **str**| Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. | [optional] **filter** | **str**| A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/ blob/master/backend/api/filter.proto)). | [optional] diff --git a/backend/api/python_http_client/docs/RunServiceApi.md b/backend/api/python_http_client/docs/RunServiceApi.md index 9268be3d6b4..596d025566c 100644 --- a/backend/api/python_http_client/docs/RunServiceApi.md +++ b/backend/api/python_http_client/docs/RunServiceApi.md @@ -4,22 +4,22 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**archive_run**](RunServiceApi.md#archive_run) | **POST** /apis/v1beta1/runs/{id}:archive | Archive a run. -[**create_run**](RunServiceApi.md#create_run) | **POST** /apis/v1beta1/runs | Create a new run. -[**delete_run**](RunServiceApi.md#delete_run) | **DELETE** /apis/v1beta1/runs/{id} | Delete a run. -[**get_run**](RunServiceApi.md#get_run) | **GET** /apis/v1beta1/runs/{run_id} | Find a specific run by ID. -[**list_runs**](RunServiceApi.md#list_runs) | **GET** /apis/v1beta1/runs | Find all runs. -[**read_artifact**](RunServiceApi.md#read_artifact) | **GET** /apis/v1beta1/runs/{run_id}/nodes/{node_id}/artifacts/{artifact_name}:read | Find a run's artifact data. +[**archive_run**](RunServiceApi.md#archive_run) | **POST** /apis/v1beta1/runs/{id}:archive | Archives a run. +[**create_run**](RunServiceApi.md#create_run) | **POST** /apis/v1beta1/runs | Creates a new run. +[**delete_run**](RunServiceApi.md#delete_run) | **DELETE** /apis/v1beta1/runs/{id} | Deletes a run. +[**get_run**](RunServiceApi.md#get_run) | **GET** /apis/v1beta1/runs/{run_id} | Finds a specific run by ID. +[**list_runs**](RunServiceApi.md#list_runs) | **GET** /apis/v1beta1/runs | Finds all runs. +[**read_artifact**](RunServiceApi.md#read_artifact) | **GET** /apis/v1beta1/runs/{run_id}/nodes/{node_id}/artifacts/{artifact_name}:read | Finds a run's artifact data. [**report_run_metrics**](RunServiceApi.md#report_run_metrics) | **POST** /apis/v1beta1/runs/{run_id}:reportMetrics | ReportRunMetrics reports metrics of a run. Each metric is reported in its own transaction, so this API accepts partial failures. Metric can be uniquely identified by (run_id, node_id, name). Duplicate reporting will be ignored by the API. First reporting wins. -[**retry_run**](RunServiceApi.md#retry_run) | **POST** /apis/v1beta1/runs/{run_id}/retry | Re-initiate a failed or terminated run. -[**terminate_run**](RunServiceApi.md#terminate_run) | **POST** /apis/v1beta1/runs/{run_id}/terminate | Terminate an active run. -[**unarchive_run**](RunServiceApi.md#unarchive_run) | **POST** /apis/v1beta1/runs/{id}:unarchive | Restore an archived run. +[**retry_run**](RunServiceApi.md#retry_run) | **POST** /apis/v1beta1/runs/{run_id}/retry | Re-initiates a failed or terminated run. +[**terminate_run**](RunServiceApi.md#terminate_run) | **POST** /apis/v1beta1/runs/{run_id}/terminate | Terminates an active run. +[**unarchive_run**](RunServiceApi.md#unarchive_run) | **POST** /apis/v1beta1/runs/{id}:unarchive | Restores an archived run. # **archive_run** > object archive_run(id) -Archive a run. +Archives a run. ### Example @@ -55,10 +55,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.RunServiceApi(api_client) - id = 'id_example' # str | + id = 'id_example' # str | The ID of the run to be archived. try: - # Archive a run. + # Archives a run. api_response = api_instance.archive_run(id) pprint(api_response) except ApiException as e: @@ -69,7 +69,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **id** | **str**| The ID of the run to be archived. | ### Return type @@ -95,7 +95,7 @@ Name | Type | Description | Notes # **create_run** > ApiRunDetail create_run(body) -Create a new run. +Creates a new run. ### Example @@ -134,7 +134,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: body = kfp_server_api.ApiRun() # ApiRun | try: - # Create a new run. + # Creates a new run. api_response = api_instance.create_run(body) pprint(api_response) except ApiException as e: @@ -171,7 +171,7 @@ Name | Type | Description | Notes # **delete_run** > object delete_run(id) -Delete a run. +Deletes a run. ### Example @@ -207,10 +207,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.RunServiceApi(api_client) - id = 'id_example' # str | + id = 'id_example' # str | The ID of the run to be deleted. try: - # Delete a run. + # Deletes a run. api_response = api_instance.delete_run(id) pprint(api_response) except ApiException as e: @@ -221,7 +221,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **id** | **str**| The ID of the run to be deleted. | ### Return type @@ -247,7 +247,7 @@ Name | Type | Description | Notes # **get_run** > ApiRunDetail get_run(run_id) -Find a specific run by ID. +Finds a specific run by ID. ### Example @@ -283,10 +283,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.RunServiceApi(api_client) - run_id = 'run_id_example' # str | + run_id = 'run_id_example' # str | The ID of the run to be retrieved. try: - # Find a specific run by ID. + # Finds a specific run by ID. api_response = api_instance.get_run(run_id) pprint(api_response) except ApiException as e: @@ -297,7 +297,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **run_id** | **str**| | + **run_id** | **str**| The ID of the run to be retrieved. | ### Return type @@ -323,7 +323,7 @@ Name | Type | Description | Notes # **list_runs** > ApiListRunsResponse list_runs(page_token=page_token, page_size=page_size, sort_by=sort_by, resource_reference_key_type=resource_reference_key_type, resource_reference_key_id=resource_reference_key_id, filter=filter) -Find all runs. +Finds all runs. ### Example @@ -359,15 +359,15 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.RunServiceApi(api_client) - page_token = 'page_token_example' # str | (optional) -page_size = 56 # int | (optional) + page_token = 'page_token_example' # str | A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListRuns call or can be omitted when fetching the first page. (optional) +page_size = 56 # int | The number of runs to be listed per page. If there are more runs than this number, the response message will contain a nextPageToken field you can use to fetch the next page. (optional) sort_by = 'sort_by_example' # str | Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" (Example, \"name asc\" or \"id des\"). Ascending by default. (optional) resource_reference_key_type = 'UNKNOWN_RESOURCE_TYPE' # str | The type of the resource that referred to. (optional) (default to 'UNKNOWN_RESOURCE_TYPE') resource_reference_key_id = 'resource_reference_key_id_example' # str | The ID of the resource that referred to. (optional) filter = 'filter_example' # str | A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/ blob/master/backend/api/filter.proto)). (optional) try: - # Find all runs. + # Finds all runs. api_response = api_instance.list_runs(page_token=page_token, page_size=page_size, sort_by=sort_by, resource_reference_key_type=resource_reference_key_type, resource_reference_key_id=resource_reference_key_id, filter=filter) pprint(api_response) except ApiException as e: @@ -378,8 +378,8 @@ filter = 'filter_example' # str | A url-encoded, JSON-serialized Filter protocol Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_token** | **str**| | [optional] - **page_size** | **int**| | [optional] + **page_token** | **str**| A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListRuns call or can be omitted when fetching the first page. | [optional] + **page_size** | **int**| The number of runs to be listed per page. If there are more runs than this number, the response message will contain a nextPageToken field you can use to fetch the next page. | [optional] **sort_by** | **str**| Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" (Example, \"name asc\" or \"id des\"). Ascending by default. | [optional] **resource_reference_key_type** | **str**| The type of the resource that referred to. | [optional] [default to 'UNKNOWN_RESOURCE_TYPE'] **resource_reference_key_id** | **str**| The ID of the resource that referred to. | [optional] @@ -409,7 +409,7 @@ Name | Type | Description | Notes # **read_artifact** > ApiReadArtifactResponse read_artifact(run_id, node_id, artifact_name) -Find a run's artifact data. +Finds a run's artifact data. ### Example @@ -450,7 +450,7 @@ node_id = 'node_id_example' # str | The ID of the running node. artifact_name = 'artifact_name_example' # str | The name of the artifact. try: - # Find a run's artifact data. + # Finds a run's artifact data. api_response = api_instance.read_artifact(run_id, node_id, artifact_name) pprint(api_response) except ApiException as e: @@ -567,7 +567,7 @@ Name | Type | Description | Notes # **retry_run** > object retry_run(run_id) -Re-initiate a failed or terminated run. +Re-initiates a failed or terminated run. ### Example @@ -603,10 +603,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.RunServiceApi(api_client) - run_id = 'run_id_example' # str | + run_id = 'run_id_example' # str | The ID of the run to be retried. try: - # Re-initiate a failed or terminated run. + # Re-initiates a failed or terminated run. api_response = api_instance.retry_run(run_id) pprint(api_response) except ApiException as e: @@ -617,7 +617,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **run_id** | **str**| | + **run_id** | **str**| The ID of the run to be retried. | ### Return type @@ -643,7 +643,7 @@ Name | Type | Description | Notes # **terminate_run** > object terminate_run(run_id) -Terminate an active run. +Terminates an active run. ### Example @@ -679,10 +679,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.RunServiceApi(api_client) - run_id = 'run_id_example' # str | + run_id = 'run_id_example' # str | The ID of the run to be terminated. try: - # Terminate an active run. + # Terminates an active run. api_response = api_instance.terminate_run(run_id) pprint(api_response) except ApiException as e: @@ -693,7 +693,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **run_id** | **str**| | + **run_id** | **str**| The ID of the run to be terminated. | ### Return type @@ -719,7 +719,7 @@ Name | Type | Description | Notes # **unarchive_run** > object unarchive_run(id) -Restore an archived run. +Restores an archived run. ### Example @@ -755,10 +755,10 @@ configuration = kfp_server_api.Configuration( with kfp_server_api.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = kfp_server_api.RunServiceApi(api_client) - id = 'id_example' # str | + id = 'id_example' # str | The ID of the run to be restored. try: - # Restore an archived run. + # Restores an archived run. api_response = api_instance.unarchive_run(id) pprint(api_response) except ApiException as e: @@ -769,7 +769,7 @@ with kfp_server_api.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **id** | **str**| The ID of the run to be restored. | ### Return type diff --git a/backend/api/python_http_client/kfp_server_api/api/experiment_service_api.py b/backend/api/python_http_client/kfp_server_api/api/experiment_service_api.py index 854cff63eb9..8355f5d0bb8 100644 --- a/backend/api/python_http_client/kfp_server_api/api/experiment_service_api.py +++ b/backend/api/python_http_client/kfp_server_api/api/experiment_service_api.py @@ -38,7 +38,7 @@ def __init__(self, api_client=None): self.api_client = api_client def archive_experiment(self, id, **kwargs): # noqa: E501 - """Archive an experiment. # noqa: E501 + """Archives an experiment and the experiment's runs and jobs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -46,7 +46,7 @@ def archive_experiment(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the experiment to be archived. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -62,7 +62,7 @@ def archive_experiment(self, id, **kwargs): # noqa: E501 return self.archive_experiment_with_http_info(id, **kwargs) # noqa: E501 def archive_experiment_with_http_info(self, id, **kwargs): # noqa: E501 - """Archive an experiment. # noqa: E501 + """Archives an experiment and the experiment's runs and jobs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -70,7 +70,7 @@ def archive_experiment_with_http_info(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the experiment to be archived. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -150,7 +150,7 @@ def archive_experiment_with_http_info(self, id, **kwargs): # noqa: E501 collection_formats=collection_formats) def create_experiment(self, body, **kwargs): # noqa: E501 - """Create a new experiment. # noqa: E501 + """Creates a new experiment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -174,7 +174,7 @@ def create_experiment(self, body, **kwargs): # noqa: E501 return self.create_experiment_with_http_info(body, **kwargs) # noqa: E501 def create_experiment_with_http_info(self, body, **kwargs): # noqa: E501 - """Create a new experiment. # noqa: E501 + """Creates a new experiment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -266,7 +266,7 @@ def create_experiment_with_http_info(self, body, **kwargs): # noqa: E501 collection_formats=collection_formats) def delete_experiment(self, id, **kwargs): # noqa: E501 - """Delete an experiment. # noqa: E501 + """Deletes an experiment without deleting the experiment's runs and jobs. To avoid unexpected behaviors, delete an experiment's runs and jobs before deleting the experiment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -290,7 +290,7 @@ def delete_experiment(self, id, **kwargs): # noqa: E501 return self.delete_experiment_with_http_info(id, **kwargs) # noqa: E501 def delete_experiment_with_http_info(self, id, **kwargs): # noqa: E501 - """Delete an experiment. # noqa: E501 + """Deletes an experiment without deleting the experiment's runs and jobs. To avoid unexpected behaviors, delete an experiment's runs and jobs before deleting the experiment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -378,7 +378,7 @@ def delete_experiment_with_http_info(self, id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_experiment(self, id, **kwargs): # noqa: E501 - """Find a specific experiment by ID. # noqa: E501 + """Finds a specific experiment by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -402,7 +402,7 @@ def get_experiment(self, id, **kwargs): # noqa: E501 return self.get_experiment_with_http_info(id, **kwargs) # noqa: E501 def get_experiment_with_http_info(self, id, **kwargs): # noqa: E501 - """Find a specific experiment by ID. # noqa: E501 + """Finds a specific experiment by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -490,7 +490,7 @@ def get_experiment_with_http_info(self, id, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_experiment(self, **kwargs): # noqa: E501 - """Find all experiments. # noqa: E501 + """Finds all experiments. Supports pagination, and sorting on certain fields. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -498,8 +498,8 @@ def list_experiment(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str page_token: - :param int page_size: + :param str page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListExperiment call or can be omitted when fetching the first page. + :param int page_size: The number of experiments to be listed per page. If there are more experiments than this number, the response message will contain a nextPageToken field you can use to fetch the next page. :param str sort_by: Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. :param str filter: A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/ blob/master/backend/api/filter.proto)). :param str resource_reference_key_type: The type of the resource that referred to. @@ -519,7 +519,7 @@ def list_experiment(self, **kwargs): # noqa: E501 return self.list_experiment_with_http_info(**kwargs) # noqa: E501 def list_experiment_with_http_info(self, **kwargs): # noqa: E501 - """Find all experiments. # noqa: E501 + """Finds all experiments. Supports pagination, and sorting on certain fields. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -527,8 +527,8 @@ def list_experiment_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str page_token: - :param int page_size: + :param str page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListExperiment call or can be omitted when fetching the first page. + :param int page_size: The number of experiments to be listed per page. If there are more experiments than this number, the response message will contain a nextPageToken field you can use to fetch the next page. :param str sort_by: Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. :param str filter: A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/ blob/master/backend/api/filter.proto)). :param str resource_reference_key_type: The type of the resource that referred to. @@ -623,7 +623,7 @@ def list_experiment_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def unarchive_experiment(self, id, **kwargs): # noqa: E501 - """Restore an archived experiment. # noqa: E501 + """Restores an archived experiment. The experiment's archived runs and jobs will stay archived. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -631,7 +631,7 @@ def unarchive_experiment(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the experiment to be restored. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -647,7 +647,7 @@ def unarchive_experiment(self, id, **kwargs): # noqa: E501 return self.unarchive_experiment_with_http_info(id, **kwargs) # noqa: E501 def unarchive_experiment_with_http_info(self, id, **kwargs): # noqa: E501 - """Restore an archived experiment. # noqa: E501 + """Restores an archived experiment. The experiment's archived runs and jobs will stay archived. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -655,7 +655,7 @@ def unarchive_experiment_with_http_info(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the experiment to be restored. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will diff --git a/backend/api/python_http_client/kfp_server_api/api/job_service_api.py b/backend/api/python_http_client/kfp_server_api/api/job_service_api.py index 5870110e288..e42706ad1a0 100644 --- a/backend/api/python_http_client/kfp_server_api/api/job_service_api.py +++ b/backend/api/python_http_client/kfp_server_api/api/job_service_api.py @@ -38,7 +38,7 @@ def __init__(self, api_client=None): self.api_client = api_client def create_job(self, body, **kwargs): # noqa: E501 - """Create a new job. # noqa: E501 + """Creates a new job. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -62,7 +62,7 @@ def create_job(self, body, **kwargs): # noqa: E501 return self.create_job_with_http_info(body, **kwargs) # noqa: E501 def create_job_with_http_info(self, body, **kwargs): # noqa: E501 - """Create a new job. # noqa: E501 + """Creates a new job. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -154,7 +154,7 @@ def create_job_with_http_info(self, body, **kwargs): # noqa: E501 collection_formats=collection_formats) def delete_job(self, id, **kwargs): # noqa: E501 - """Delete a job. # noqa: E501 + """Deletes a job. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -178,7 +178,7 @@ def delete_job(self, id, **kwargs): # noqa: E501 return self.delete_job_with_http_info(id, **kwargs) # noqa: E501 def delete_job_with_http_info(self, id, **kwargs): # noqa: E501 - """Delete a job. # noqa: E501 + """Deletes a job. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -490,7 +490,7 @@ def enable_job_with_http_info(self, id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_job(self, id, **kwargs): # noqa: E501 - """Find a specific job by ID. # noqa: E501 + """Finds a specific job by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -514,7 +514,7 @@ def get_job(self, id, **kwargs): # noqa: E501 return self.get_job_with_http_info(id, **kwargs) # noqa: E501 def get_job_with_http_info(self, id, **kwargs): # noqa: E501 - """Find a specific job by ID. # noqa: E501 + """Finds a specific job by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -602,7 +602,7 @@ def get_job_with_http_info(self, id, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_jobs(self, **kwargs): # noqa: E501 - """Find all jobs. # noqa: E501 + """Finds all jobs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -610,8 +610,8 @@ def list_jobs(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str page_token: - :param int page_size: + :param str page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListJobs call or can be omitted when fetching the first page. + :param int page_size: The number of jobs to be listed per page. If there are more jobs than this number, the response message will contain a nextPageToken field you can use to fetch the next page. :param str sort_by: Can be format of \"field_name\", \"field_name asc\" or \"field_name des\". Ascending by default. :param str resource_reference_key_type: The type of the resource that referred to. :param str resource_reference_key_id: The ID of the resource that referred to. @@ -631,7 +631,7 @@ def list_jobs(self, **kwargs): # noqa: E501 return self.list_jobs_with_http_info(**kwargs) # noqa: E501 def list_jobs_with_http_info(self, **kwargs): # noqa: E501 - """Find all jobs. # noqa: E501 + """Finds all jobs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -639,8 +639,8 @@ def list_jobs_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str page_token: - :param int page_size: + :param str page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListJobs call or can be omitted when fetching the first page. + :param int page_size: The number of jobs to be listed per page. If there are more jobs than this number, the response message will contain a nextPageToken field you can use to fetch the next page. :param str sort_by: Can be format of \"field_name\", \"field_name asc\" or \"field_name des\". Ascending by default. :param str resource_reference_key_type: The type of the resource that referred to. :param str resource_reference_key_id: The ID of the resource that referred to. diff --git a/backend/api/python_http_client/kfp_server_api/api/pipeline_service_api.py b/backend/api/python_http_client/kfp_server_api/api/pipeline_service_api.py index 819952ac003..8075d3391ea 100644 --- a/backend/api/python_http_client/kfp_server_api/api/pipeline_service_api.py +++ b/backend/api/python_http_client/kfp_server_api/api/pipeline_service_api.py @@ -38,7 +38,7 @@ def __init__(self, api_client=None): self.api_client = api_client def create_pipeline(self, body, **kwargs): # noqa: E501 - """Add a pipeline. # noqa: E501 + """Creates a pipeline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -62,7 +62,7 @@ def create_pipeline(self, body, **kwargs): # noqa: E501 return self.create_pipeline_with_http_info(body, **kwargs) # noqa: E501 def create_pipeline_with_http_info(self, body, **kwargs): # noqa: E501 - """Add a pipeline. # noqa: E501 + """Creates a pipeline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -154,7 +154,7 @@ def create_pipeline_with_http_info(self, body, **kwargs): # noqa: E501 collection_formats=collection_formats) def create_pipeline_version(self, body, **kwargs): # noqa: E501 - """create_pipeline_version # noqa: E501 + """Adds a pipeline version to the specified pipeline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -178,7 +178,7 @@ def create_pipeline_version(self, body, **kwargs): # noqa: E501 return self.create_pipeline_version_with_http_info(body, **kwargs) # noqa: E501 def create_pipeline_version_with_http_info(self, body, **kwargs): # noqa: E501 - """create_pipeline_version # noqa: E501 + """Adds a pipeline version to the specified pipeline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -270,7 +270,7 @@ def create_pipeline_version_with_http_info(self, body, **kwargs): # noqa: E501 collection_formats=collection_formats) def delete_pipeline(self, id, **kwargs): # noqa: E501 - """Delete a pipeline. # noqa: E501 + """Deletes a pipeline and its pipeline versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -278,7 +278,7 @@ def delete_pipeline(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the pipeline to be deleted. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -294,7 +294,7 @@ def delete_pipeline(self, id, **kwargs): # noqa: E501 return self.delete_pipeline_with_http_info(id, **kwargs) # noqa: E501 def delete_pipeline_with_http_info(self, id, **kwargs): # noqa: E501 - """Delete a pipeline. # noqa: E501 + """Deletes a pipeline and its pipeline versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -302,7 +302,7 @@ def delete_pipeline_with_http_info(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the pipeline to be deleted. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -382,7 +382,7 @@ def delete_pipeline_with_http_info(self, id, **kwargs): # noqa: E501 collection_formats=collection_formats) def delete_pipeline_version(self, version_id, **kwargs): # noqa: E501 - """delete_pipeline_version # noqa: E501 + """Deletes a pipeline version by pipeline version ID. If the deleted pipeline version is the default pipeline version, the pipeline's default version changes to the pipeline's most recent pipeline version. If there are no remaining pipeline versions, the pipeline will have no default version. Examines the run_service_api.ipynb notebook to learn more about creating a run using a pipeline version (https://github.com/kubeflow/pipelines/blob/master/tools/benchmarks/run_service_api.ipynb). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -390,7 +390,7 @@ def delete_pipeline_version(self, version_id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str version_id: (required) + :param str version_id: The ID of the pipeline version to be deleted. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -406,7 +406,7 @@ def delete_pipeline_version(self, version_id, **kwargs): # noqa: E501 return self.delete_pipeline_version_with_http_info(version_id, **kwargs) # noqa: E501 def delete_pipeline_version_with_http_info(self, version_id, **kwargs): # noqa: E501 - """delete_pipeline_version # noqa: E501 + """Deletes a pipeline version by pipeline version ID. If the deleted pipeline version is the default pipeline version, the pipeline's default version changes to the pipeline's most recent pipeline version. If there are no remaining pipeline versions, the pipeline will have no default version. Examines the run_service_api.ipynb notebook to learn more about creating a run using a pipeline version (https://github.com/kubeflow/pipelines/blob/master/tools/benchmarks/run_service_api.ipynb). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -414,7 +414,7 @@ def delete_pipeline_version_with_http_info(self, version_id, **kwargs): # noqa: >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str version_id: (required) + :param str version_id: The ID of the pipeline version to be deleted. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -494,7 +494,7 @@ def delete_pipeline_version_with_http_info(self, version_id, **kwargs): # noqa: collection_formats=collection_formats) def get_pipeline(self, id, **kwargs): # noqa: E501 - """Find a specific pipeline by ID. # noqa: E501 + """Finds a specific pipeline by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -502,7 +502,7 @@ def get_pipeline(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the pipeline to be retrieved. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -518,7 +518,7 @@ def get_pipeline(self, id, **kwargs): # noqa: E501 return self.get_pipeline_with_http_info(id, **kwargs) # noqa: E501 def get_pipeline_with_http_info(self, id, **kwargs): # noqa: E501 - """Find a specific pipeline by ID. # noqa: E501 + """Finds a specific pipeline by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -526,7 +526,7 @@ def get_pipeline_with_http_info(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the pipeline to be retrieved. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -606,7 +606,7 @@ def get_pipeline_with_http_info(self, id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_pipeline_version(self, version_id, **kwargs): # noqa: E501 - """get_pipeline_version # noqa: E501 + """Gets a pipeline version by pipeline version ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -614,7 +614,7 @@ def get_pipeline_version(self, version_id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str version_id: (required) + :param str version_id: The ID of the pipeline version to be retrieved. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -630,7 +630,7 @@ def get_pipeline_version(self, version_id, **kwargs): # noqa: E501 return self.get_pipeline_version_with_http_info(version_id, **kwargs) # noqa: E501 def get_pipeline_version_with_http_info(self, version_id, **kwargs): # noqa: E501 - """get_pipeline_version # noqa: E501 + """Gets a pipeline version by pipeline version ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -638,7 +638,7 @@ def get_pipeline_version_with_http_info(self, version_id, **kwargs): # noqa: E5 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str version_id: (required) + :param str version_id: The ID of the pipeline version to be retrieved. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -718,7 +718,7 @@ def get_pipeline_version_with_http_info(self, version_id, **kwargs): # noqa: E5 collection_formats=collection_formats) def get_pipeline_version_template(self, version_id, **kwargs): # noqa: E501 - """get_pipeline_version_template # noqa: E501 + """Returns a YAML template that contains the specified pipeline version's description, parameters and metadata. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -726,7 +726,7 @@ def get_pipeline_version_template(self, version_id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str version_id: (required) + :param str version_id: The ID of the pipeline version whose template is to be retrieved. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -742,7 +742,7 @@ def get_pipeline_version_template(self, version_id, **kwargs): # noqa: E501 return self.get_pipeline_version_template_with_http_info(version_id, **kwargs) # noqa: E501 def get_pipeline_version_template_with_http_info(self, version_id, **kwargs): # noqa: E501 - """get_pipeline_version_template # noqa: E501 + """Returns a YAML template that contains the specified pipeline version's description, parameters and metadata. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -750,7 +750,7 @@ def get_pipeline_version_template_with_http_info(self, version_id, **kwargs): # >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str version_id: (required) + :param str version_id: The ID of the pipeline version whose template is to be retrieved. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -838,7 +838,7 @@ def get_template(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the pipeline whose template is to be retrieved. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -862,7 +862,7 @@ def get_template_with_http_info(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the pipeline whose template is to be retrieved. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -942,7 +942,7 @@ def get_template_with_http_info(self, id, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_pipeline_versions(self, **kwargs): # noqa: E501 - """list_pipeline_versions # noqa: E501 + """Lists all pipeline versions of a given pipeline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -952,8 +952,8 @@ def list_pipeline_versions(self, **kwargs): # noqa: E501 :param async_req bool: execute request asynchronously :param str resource_key_type: The type of the resource that referred to. :param str resource_key_id: The ID of the resource that referred to. - :param int page_size: - :param str page_token: + :param int page_size: The number of pipeline versions to be listed per page. If there are more pipeline versions than this number, the response message will contain a nextPageToken field you can use to fetch the next page. + :param str page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelineVersions call or can be omitted when fetching the first page. :param str sort_by: Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. :param str filter: A base-64 encoded, JSON-serialized Filter protocol buffer (see filter.proto). :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -971,7 +971,7 @@ def list_pipeline_versions(self, **kwargs): # noqa: E501 return self.list_pipeline_versions_with_http_info(**kwargs) # noqa: E501 def list_pipeline_versions_with_http_info(self, **kwargs): # noqa: E501 - """list_pipeline_versions # noqa: E501 + """Lists all pipeline versions of a given pipeline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -981,8 +981,8 @@ def list_pipeline_versions_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool: execute request asynchronously :param str resource_key_type: The type of the resource that referred to. :param str resource_key_id: The ID of the resource that referred to. - :param int page_size: - :param str page_token: + :param int page_size: The number of pipeline versions to be listed per page. If there are more pipeline versions than this number, the response message will contain a nextPageToken field you can use to fetch the next page. + :param str page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelineVersions call or can be omitted when fetching the first page. :param str sort_by: Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. :param str filter: A base-64 encoded, JSON-serialized Filter protocol buffer (see filter.proto). :param _return_http_data_only: response data without head status code @@ -1075,7 +1075,7 @@ def list_pipeline_versions_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_pipelines(self, **kwargs): # noqa: E501 - """Find all pipelines. # noqa: E501 + """Finds all pipelines. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1083,8 +1083,8 @@ def list_pipelines(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str page_token: - :param int page_size: + :param str page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelines call. + :param int page_size: The number of pipelines to be listed per page. If there are more pipelines than this number, the response message will contain a valid value in the nextPageToken field. :param str sort_by: Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. :param str filter: A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/ blob/master/backend/api/filter.proto)). :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -1102,7 +1102,7 @@ def list_pipelines(self, **kwargs): # noqa: E501 return self.list_pipelines_with_http_info(**kwargs) # noqa: E501 def list_pipelines_with_http_info(self, **kwargs): # noqa: E501 - """Find all pipelines. # noqa: E501 + """Finds all pipelines. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1110,8 +1110,8 @@ def list_pipelines_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str page_token: - :param int page_size: + :param str page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelines call. + :param int page_size: The number of pipelines to be listed per page. If there are more pipelines than this number, the response message will contain a valid value in the nextPageToken field. :param str sort_by: Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" Ascending by default. :param str filter: A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/ blob/master/backend/api/filter.proto)). :param _return_http_data_only: response data without head status code diff --git a/backend/api/python_http_client/kfp_server_api/api/run_service_api.py b/backend/api/python_http_client/kfp_server_api/api/run_service_api.py index 8eee703cb3b..145913f66d3 100644 --- a/backend/api/python_http_client/kfp_server_api/api/run_service_api.py +++ b/backend/api/python_http_client/kfp_server_api/api/run_service_api.py @@ -38,7 +38,7 @@ def __init__(self, api_client=None): self.api_client = api_client def archive_run(self, id, **kwargs): # noqa: E501 - """Archive a run. # noqa: E501 + """Archives a run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -46,7 +46,7 @@ def archive_run(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the run to be archived. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -62,7 +62,7 @@ def archive_run(self, id, **kwargs): # noqa: E501 return self.archive_run_with_http_info(id, **kwargs) # noqa: E501 def archive_run_with_http_info(self, id, **kwargs): # noqa: E501 - """Archive a run. # noqa: E501 + """Archives a run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -70,7 +70,7 @@ def archive_run_with_http_info(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the run to be archived. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -150,7 +150,7 @@ def archive_run_with_http_info(self, id, **kwargs): # noqa: E501 collection_formats=collection_formats) def create_run(self, body, **kwargs): # noqa: E501 - """Create a new run. # noqa: E501 + """Creates a new run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -174,7 +174,7 @@ def create_run(self, body, **kwargs): # noqa: E501 return self.create_run_with_http_info(body, **kwargs) # noqa: E501 def create_run_with_http_info(self, body, **kwargs): # noqa: E501 - """Create a new run. # noqa: E501 + """Creates a new run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -266,7 +266,7 @@ def create_run_with_http_info(self, body, **kwargs): # noqa: E501 collection_formats=collection_formats) def delete_run(self, id, **kwargs): # noqa: E501 - """Delete a run. # noqa: E501 + """Deletes a run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -274,7 +274,7 @@ def delete_run(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the run to be deleted. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -290,7 +290,7 @@ def delete_run(self, id, **kwargs): # noqa: E501 return self.delete_run_with_http_info(id, **kwargs) # noqa: E501 def delete_run_with_http_info(self, id, **kwargs): # noqa: E501 - """Delete a run. # noqa: E501 + """Deletes a run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -298,7 +298,7 @@ def delete_run_with_http_info(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the run to be deleted. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -378,7 +378,7 @@ def delete_run_with_http_info(self, id, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_run(self, run_id, **kwargs): # noqa: E501 - """Find a specific run by ID. # noqa: E501 + """Finds a specific run by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -386,7 +386,7 @@ def get_run(self, run_id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str run_id: (required) + :param str run_id: The ID of the run to be retrieved. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -402,7 +402,7 @@ def get_run(self, run_id, **kwargs): # noqa: E501 return self.get_run_with_http_info(run_id, **kwargs) # noqa: E501 def get_run_with_http_info(self, run_id, **kwargs): # noqa: E501 - """Find a specific run by ID. # noqa: E501 + """Finds a specific run by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -410,7 +410,7 @@ def get_run_with_http_info(self, run_id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str run_id: (required) + :param str run_id: The ID of the run to be retrieved. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -490,7 +490,7 @@ def get_run_with_http_info(self, run_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_runs(self, **kwargs): # noqa: E501 - """Find all runs. # noqa: E501 + """Finds all runs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -498,8 +498,8 @@ def list_runs(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str page_token: - :param int page_size: + :param str page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListRuns call or can be omitted when fetching the first page. + :param int page_size: The number of runs to be listed per page. If there are more runs than this number, the response message will contain a nextPageToken field you can use to fetch the next page. :param str sort_by: Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" (Example, \"name asc\" or \"id des\"). Ascending by default. :param str resource_reference_key_type: The type of the resource that referred to. :param str resource_reference_key_id: The ID of the resource that referred to. @@ -519,7 +519,7 @@ def list_runs(self, **kwargs): # noqa: E501 return self.list_runs_with_http_info(**kwargs) # noqa: E501 def list_runs_with_http_info(self, **kwargs): # noqa: E501 - """Find all runs. # noqa: E501 + """Finds all runs. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -527,8 +527,8 @@ def list_runs_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str page_token: - :param int page_size: + :param str page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListRuns call or can be omitted when fetching the first page. + :param int page_size: The number of runs to be listed per page. If there are more runs than this number, the response message will contain a nextPageToken field you can use to fetch the next page. :param str sort_by: Can be format of \"field_name\", \"field_name asc\" or \"field_name des\" (Example, \"name asc\" or \"id des\"). Ascending by default. :param str resource_reference_key_type: The type of the resource that referred to. :param str resource_reference_key_id: The ID of the resource that referred to. @@ -623,7 +623,7 @@ def list_runs_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def read_artifact(self, run_id, node_id, artifact_name, **kwargs): # noqa: E501 - """Find a run's artifact data. # noqa: E501 + """Finds a run's artifact data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -649,7 +649,7 @@ def read_artifact(self, run_id, node_id, artifact_name, **kwargs): # noqa: E501 return self.read_artifact_with_http_info(run_id, node_id, artifact_name, **kwargs) # noqa: E501 def read_artifact_with_http_info(self, run_id, node_id, artifact_name, **kwargs): # noqa: E501 - """Find a run's artifact data. # noqa: E501 + """Finds a run's artifact data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -878,7 +878,7 @@ def report_run_metrics_with_http_info(self, run_id, body, **kwargs): # noqa: E5 collection_formats=collection_formats) def retry_run(self, run_id, **kwargs): # noqa: E501 - """Re-initiate a failed or terminated run. # noqa: E501 + """Re-initiates a failed or terminated run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -886,7 +886,7 @@ def retry_run(self, run_id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str run_id: (required) + :param str run_id: The ID of the run to be retried. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -902,7 +902,7 @@ def retry_run(self, run_id, **kwargs): # noqa: E501 return self.retry_run_with_http_info(run_id, **kwargs) # noqa: E501 def retry_run_with_http_info(self, run_id, **kwargs): # noqa: E501 - """Re-initiate a failed or terminated run. # noqa: E501 + """Re-initiates a failed or terminated run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -910,7 +910,7 @@ def retry_run_with_http_info(self, run_id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str run_id: (required) + :param str run_id: The ID of the run to be retried. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -990,7 +990,7 @@ def retry_run_with_http_info(self, run_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def terminate_run(self, run_id, **kwargs): # noqa: E501 - """Terminate an active run. # noqa: E501 + """Terminates an active run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -998,7 +998,7 @@ def terminate_run(self, run_id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str run_id: (required) + :param str run_id: The ID of the run to be terminated. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -1014,7 +1014,7 @@ def terminate_run(self, run_id, **kwargs): # noqa: E501 return self.terminate_run_with_http_info(run_id, **kwargs) # noqa: E501 def terminate_run_with_http_info(self, run_id, **kwargs): # noqa: E501 - """Terminate an active run. # noqa: E501 + """Terminates an active run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1022,7 +1022,7 @@ def terminate_run_with_http_info(self, run_id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str run_id: (required) + :param str run_id: The ID of the run to be terminated. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -1102,7 +1102,7 @@ def terminate_run_with_http_info(self, run_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def unarchive_run(self, id, **kwargs): # noqa: E501 - """Restore an archived run. # noqa: E501 + """Restores an archived run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1110,7 +1110,7 @@ def unarchive_run(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the run to be restored. (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -1126,7 +1126,7 @@ def unarchive_run(self, id, **kwargs): # noqa: E501 return self.unarchive_run_with_http_info(id, **kwargs) # noqa: E501 def unarchive_run_with_http_info(self, id, **kwargs): # noqa: E501 - """Restore an archived run. # noqa: E501 + """Restores an archived run. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1134,7 +1134,7 @@ def unarchive_run_with_http_info(self, id, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param str id: (required) + :param str id: The ID of the run to be restored. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will diff --git a/backend/api/python_http_client/kfp_server_api/models/api_get_template_response.py b/backend/api/python_http_client/kfp_server_api/models/api_get_template_response.py index d6970009c33..28f15c37330 100644 --- a/backend/api/python_http_client/kfp_server_api/models/api_get_template_response.py +++ b/backend/api/python_http_client/kfp_server_api/models/api_get_template_response.py @@ -57,6 +57,7 @@ def __init__(self, template=None, local_vars_configuration=None): # noqa: E501 def template(self): """Gets the template of this ApiGetTemplateResponse. # noqa: E501 + The template of the pipeline specified in a GetTemplate request, or of a pipeline version specified in a GetPipelinesVersionTemplate request. # noqa: E501 :return: The template of this ApiGetTemplateResponse. # noqa: E501 :rtype: str @@ -67,6 +68,7 @@ def template(self): def template(self, template): """Sets the template of this ApiGetTemplateResponse. + The template of the pipeline specified in a GetTemplate request, or of a pipeline version specified in a GetPipelinesVersionTemplate request. # noqa: E501 :param template: The template of this ApiGetTemplateResponse. # noqa: E501 :type: str diff --git a/backend/api/python_http_client/kfp_server_api/models/api_list_jobs_response.py b/backend/api/python_http_client/kfp_server_api/models/api_list_jobs_response.py index a875433565b..d198488ffa4 100644 --- a/backend/api/python_http_client/kfp_server_api/models/api_list_jobs_response.py +++ b/backend/api/python_http_client/kfp_server_api/models/api_list_jobs_response.py @@ -90,6 +90,7 @@ def jobs(self, jobs): def total_size(self): """Gets the total_size of this ApiListJobsResponse. # noqa: E501 + The total number of jobs for the given query. # noqa: E501 :return: The total_size of this ApiListJobsResponse. # noqa: E501 :rtype: int @@ -100,6 +101,7 @@ def total_size(self): def total_size(self, total_size): """Sets the total_size of this ApiListJobsResponse. + The total number of jobs for the given query. # noqa: E501 :param total_size: The total_size of this ApiListJobsResponse. # noqa: E501 :type: int @@ -111,6 +113,7 @@ def total_size(self, total_size): def next_page_token(self): """Gets the next_page_token of this ApiListJobsResponse. # noqa: E501 + The token to list the next page of jobs. # noqa: E501 :return: The next_page_token of this ApiListJobsResponse. # noqa: E501 :rtype: str @@ -121,6 +124,7 @@ def next_page_token(self): def next_page_token(self, next_page_token): """Sets the next_page_token of this ApiListJobsResponse. + The token to list the next page of jobs. # noqa: E501 :param next_page_token: The next_page_token of this ApiListJobsResponse. # noqa: E501 :type: str diff --git a/backend/api/python_http_client/kfp_server_api/models/api_list_pipeline_versions_response.py b/backend/api/python_http_client/kfp_server_api/models/api_list_pipeline_versions_response.py index 38c1dd99ace..43de7a5ae56 100644 --- a/backend/api/python_http_client/kfp_server_api/models/api_list_pipeline_versions_response.py +++ b/backend/api/python_http_client/kfp_server_api/models/api_list_pipeline_versions_response.py @@ -88,6 +88,7 @@ def versions(self, versions): def next_page_token(self): """Gets the next_page_token of this ApiListPipelineVersionsResponse. # noqa: E501 + The token to list the next page of pipeline versions. # noqa: E501 :return: The next_page_token of this ApiListPipelineVersionsResponse. # noqa: E501 :rtype: str @@ -98,6 +99,7 @@ def next_page_token(self): def next_page_token(self, next_page_token): """Sets the next_page_token of this ApiListPipelineVersionsResponse. + The token to list the next page of pipeline versions. # noqa: E501 :param next_page_token: The next_page_token of this ApiListPipelineVersionsResponse. # noqa: E501 :type: str @@ -109,6 +111,7 @@ def next_page_token(self, next_page_token): def total_size(self): """Gets the total_size of this ApiListPipelineVersionsResponse. # noqa: E501 + The total number of pipeline versions for the given query. # noqa: E501 :return: The total_size of this ApiListPipelineVersionsResponse. # noqa: E501 :rtype: int @@ -119,6 +122,7 @@ def total_size(self): def total_size(self, total_size): """Sets the total_size of this ApiListPipelineVersionsResponse. + The total number of pipeline versions for the given query. # noqa: E501 :param total_size: The total_size of this ApiListPipelineVersionsResponse. # noqa: E501 :type: int diff --git a/backend/api/python_http_client/kfp_server_api/models/api_list_pipelines_response.py b/backend/api/python_http_client/kfp_server_api/models/api_list_pipelines_response.py index 5bff674a368..1dfa4b03e2f 100644 --- a/backend/api/python_http_client/kfp_server_api/models/api_list_pipelines_response.py +++ b/backend/api/python_http_client/kfp_server_api/models/api_list_pipelines_response.py @@ -88,6 +88,7 @@ def pipelines(self, pipelines): def total_size(self): """Gets the total_size of this ApiListPipelinesResponse. # noqa: E501 + The total number of pipelines for the given query. # noqa: E501 :return: The total_size of this ApiListPipelinesResponse. # noqa: E501 :rtype: int @@ -98,6 +99,7 @@ def total_size(self): def total_size(self, total_size): """Sets the total_size of this ApiListPipelinesResponse. + The total number of pipelines for the given query. # noqa: E501 :param total_size: The total_size of this ApiListPipelinesResponse. # noqa: E501 :type: int @@ -109,6 +111,7 @@ def total_size(self, total_size): def next_page_token(self): """Gets the next_page_token of this ApiListPipelinesResponse. # noqa: E501 + The token to list the next page of pipelines. # noqa: E501 :return: The next_page_token of this ApiListPipelinesResponse. # noqa: E501 :rtype: str @@ -119,6 +122,7 @@ def next_page_token(self): def next_page_token(self, next_page_token): """Sets the next_page_token of this ApiListPipelinesResponse. + The token to list the next page of pipelines. # noqa: E501 :param next_page_token: The next_page_token of this ApiListPipelinesResponse. # noqa: E501 :type: str diff --git a/backend/api/python_http_client/kfp_server_api/models/api_list_runs_response.py b/backend/api/python_http_client/kfp_server_api/models/api_list_runs_response.py index 3a0049b5870..78d66e649b9 100644 --- a/backend/api/python_http_client/kfp_server_api/models/api_list_runs_response.py +++ b/backend/api/python_http_client/kfp_server_api/models/api_list_runs_response.py @@ -88,6 +88,7 @@ def runs(self, runs): def total_size(self): """Gets the total_size of this ApiListRunsResponse. # noqa: E501 + The total number of runs for the given query. # noqa: E501 :return: The total_size of this ApiListRunsResponse. # noqa: E501 :rtype: int @@ -98,6 +99,7 @@ def total_size(self): def total_size(self, total_size): """Sets the total_size of this ApiListRunsResponse. + The total number of runs for the given query. # noqa: E501 :param total_size: The total_size of this ApiListRunsResponse. # noqa: E501 :type: int @@ -109,6 +111,7 @@ def total_size(self, total_size): def next_page_token(self): """Gets the next_page_token of this ApiListRunsResponse. # noqa: E501 + The token to list the next page of runs. # noqa: E501 :return: The next_page_token of this ApiListRunsResponse. # noqa: E501 :rtype: str @@ -119,6 +122,7 @@ def next_page_token(self): def next_page_token(self, next_page_token): """Sets the next_page_token of this ApiListRunsResponse. + The token to list the next page of runs. # noqa: E501 :param next_page_token: The next_page_token of this ApiListRunsResponse. # noqa: E501 :type: str diff --git a/backend/api/python_http_client/kfp_server_api/models/api_run.py b/backend/api/python_http_client/kfp_server_api/models/api_run.py index c2b0b38b1bc..1065ab87e0d 100644 --- a/backend/api/python_http_client/kfp_server_api/models/api_run.py +++ b/backend/api/python_http_client/kfp_server_api/models/api_run.py @@ -226,7 +226,7 @@ def pipeline_spec(self, pipeline_spec): def resource_references(self): """Gets the resource_references of this ApiRun. # noqa: E501 - Optional input field. Specify which resource this run belongs to. # noqa: E501 + Optional input field. Specify which resource this run belongs to. When creating a run from a particular pipeline version, the pipeline version can be specified here. # noqa: E501 :return: The resource_references of this ApiRun. # noqa: E501 :rtype: list[ApiResourceReference] @@ -237,7 +237,7 @@ def resource_references(self): def resource_references(self, resource_references): """Sets the resource_references of this ApiRun. - Optional input field. Specify which resource this run belongs to. # noqa: E501 + Optional input field. Specify which resource this run belongs to. When creating a run from a particular pipeline version, the pipeline version can be specified here. # noqa: E501 :param resource_references: The resource_references of this ApiRun. # noqa: E501 :type: list[ApiResourceReference] diff --git a/backend/api/python_http_client/kfp_server_api/models/api_url.py b/backend/api/python_http_client/kfp_server_api/models/api_url.py index e5923d4a1f0..7e46a43ff24 100644 --- a/backend/api/python_http_client/kfp_server_api/models/api_url.py +++ b/backend/api/python_http_client/kfp_server_api/models/api_url.py @@ -57,6 +57,7 @@ def __init__(self, pipeline_url=None, local_vars_configuration=None): # noqa: E def pipeline_url(self): """Gets the pipeline_url of this ApiUrl. # noqa: E501 + URL of the pipeline definition or the pipeline version definition. # noqa: E501 :return: The pipeline_url of this ApiUrl. # noqa: E501 :rtype: str @@ -67,6 +68,7 @@ def pipeline_url(self): def pipeline_url(self, pipeline_url): """Sets the pipeline_url of this ApiUrl. + URL of the pipeline definition or the pipeline version definition. # noqa: E501 :param pipeline_url: The pipeline_url of this ApiUrl. # noqa: E501 :type: str diff --git a/backend/api/python_http_client/test/test_experiment_service_api.py b/backend/api/python_http_client/test/test_experiment_service_api.py index 8aee4ac832f..9c6ee83ba2a 100644 --- a/backend/api/python_http_client/test/test_experiment_service_api.py +++ b/backend/api/python_http_client/test/test_experiment_service_api.py @@ -32,42 +32,42 @@ def tearDown(self): def test_archive_experiment(self): """Test case for archive_experiment - Archive an experiment. # noqa: E501 + Archives an experiment and the experiment's runs and jobs. # noqa: E501 """ pass def test_create_experiment(self): """Test case for create_experiment - Create a new experiment. # noqa: E501 + Creates a new experiment. # noqa: E501 """ pass def test_delete_experiment(self): """Test case for delete_experiment - Delete an experiment. # noqa: E501 + Deletes an experiment without deleting the experiment's runs and jobs. To avoid unexpected behaviors, delete an experiment's runs and jobs before deleting the experiment. # noqa: E501 """ pass def test_get_experiment(self): """Test case for get_experiment - Find a specific experiment by ID. # noqa: E501 + Finds a specific experiment by ID. # noqa: E501 """ pass def test_list_experiment(self): """Test case for list_experiment - Find all experiments. # noqa: E501 + Finds all experiments. Supports pagination, and sorting on certain fields. # noqa: E501 """ pass def test_unarchive_experiment(self): """Test case for unarchive_experiment - Restore an archived experiment. # noqa: E501 + Restores an archived experiment. The experiment's archived runs and jobs will stay archived. # noqa: E501 """ pass diff --git a/backend/api/python_http_client/test/test_job_service_api.py b/backend/api/python_http_client/test/test_job_service_api.py index 4373c77f08a..a736811e314 100644 --- a/backend/api/python_http_client/test/test_job_service_api.py +++ b/backend/api/python_http_client/test/test_job_service_api.py @@ -32,14 +32,14 @@ def tearDown(self): def test_create_job(self): """Test case for create_job - Create a new job. # noqa: E501 + Creates a new job. # noqa: E501 """ pass def test_delete_job(self): """Test case for delete_job - Delete a job. # noqa: E501 + Deletes a job. # noqa: E501 """ pass @@ -60,14 +60,14 @@ def test_enable_job(self): def test_get_job(self): """Test case for get_job - Find a specific job by ID. # noqa: E501 + Finds a specific job by ID. # noqa: E501 """ pass def test_list_jobs(self): """Test case for list_jobs - Find all jobs. # noqa: E501 + Finds all jobs. # noqa: E501 """ pass diff --git a/backend/api/python_http_client/test/test_pipeline_service_api.py b/backend/api/python_http_client/test/test_pipeline_service_api.py index 693ff0e903d..2f29e28c1fc 100644 --- a/backend/api/python_http_client/test/test_pipeline_service_api.py +++ b/backend/api/python_http_client/test/test_pipeline_service_api.py @@ -32,45 +32,49 @@ def tearDown(self): def test_create_pipeline(self): """Test case for create_pipeline - Add a pipeline. # noqa: E501 + Creates a pipeline. # noqa: E501 """ pass def test_create_pipeline_version(self): """Test case for create_pipeline_version + Adds a pipeline version to the specified pipeline. # noqa: E501 """ pass def test_delete_pipeline(self): """Test case for delete_pipeline - Delete a pipeline. # noqa: E501 + Deletes a pipeline and its pipeline versions. # noqa: E501 """ pass def test_delete_pipeline_version(self): """Test case for delete_pipeline_version + Deletes a pipeline version by pipeline version ID. If the deleted pipeline version is the default pipeline version, the pipeline's default version changes to the pipeline's most recent pipeline version. If there are no remaining pipeline versions, the pipeline will have no default version. Examines the run_service_api.ipynb notebook to learn more about creating a run using a pipeline version (https://github.com/kubeflow/pipelines/blob/master/tools/benchmarks/run_service_api.ipynb). # noqa: E501 """ pass def test_get_pipeline(self): """Test case for get_pipeline - Find a specific pipeline by ID. # noqa: E501 + Finds a specific pipeline by ID. # noqa: E501 """ pass def test_get_pipeline_version(self): """Test case for get_pipeline_version + Gets a pipeline version by pipeline version ID. # noqa: E501 """ pass def test_get_pipeline_version_template(self): """Test case for get_pipeline_version_template + Returns a YAML template that contains the specified pipeline version's description, parameters and metadata. # noqa: E501 """ pass @@ -84,13 +88,14 @@ def test_get_template(self): def test_list_pipeline_versions(self): """Test case for list_pipeline_versions + Lists all pipeline versions of a given pipeline. # noqa: E501 """ pass def test_list_pipelines(self): """Test case for list_pipelines - Find all pipelines. # noqa: E501 + Finds all pipelines. # noqa: E501 """ pass diff --git a/backend/api/python_http_client/test/test_run_service_api.py b/backend/api/python_http_client/test/test_run_service_api.py index b86edbb8f57..bdde72895ed 100644 --- a/backend/api/python_http_client/test/test_run_service_api.py +++ b/backend/api/python_http_client/test/test_run_service_api.py @@ -32,42 +32,42 @@ def tearDown(self): def test_archive_run(self): """Test case for archive_run - Archive a run. # noqa: E501 + Archives a run. # noqa: E501 """ pass def test_create_run(self): """Test case for create_run - Create a new run. # noqa: E501 + Creates a new run. # noqa: E501 """ pass def test_delete_run(self): """Test case for delete_run - Delete a run. # noqa: E501 + Deletes a run. # noqa: E501 """ pass def test_get_run(self): """Test case for get_run - Find a specific run by ID. # noqa: E501 + Finds a specific run by ID. # noqa: E501 """ pass def test_list_runs(self): """Test case for list_runs - Find all runs. # noqa: E501 + Finds all runs. # noqa: E501 """ pass def test_read_artifact(self): """Test case for read_artifact - Find a run's artifact data. # noqa: E501 + Finds a run's artifact data. # noqa: E501 """ pass @@ -81,21 +81,21 @@ def test_report_run_metrics(self): def test_retry_run(self): """Test case for retry_run - Re-initiate a failed or terminated run. # noqa: E501 + Re-initiates a failed or terminated run. # noqa: E501 """ pass def test_terminate_run(self): """Test case for terminate_run - Terminate an active run. # noqa: E501 + Terminates an active run. # noqa: E501 """ pass def test_unarchive_run(self): """Test case for unarchive_run - Restore an archived run. # noqa: E501 + Restores an archived run. # noqa: E501 """ pass