Skip to content

Commit

Permalink
Update kfp 2.0.0 API reference doc (#3570)
Browse files Browse the repository at this point in the history
  • Loading branch information
@chensun
chensun committed Aug 14, 2023
1 parent 47d0b3c commit 2200739
Showing 1 changed file with 139 additions and 1 deletion.
140 changes: 139 additions & 1 deletion content/en/docs/components/pipelines/v2/reference/api/kubeflow-pipeline-api-spec.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
<h1>Kubeflow Pipelines API</h1>
<p class="sw-info">

Version: <span class="sw-info-version">2.0.0-beta.0</span>
Version: <span class="sw-info-version">2.0.0</span>
</p>
<p><p>This file contains REST API specification for Kubeflow Pipelines. The file is autogenerated from the swagger definition.</p>
</p>
Expand Down Expand Up @@ -243,6 +243,11 @@ <h3 id="tag-PipelineService" class="swagger-summary-tag">Tag: PipelineService</h
<tr>
<td><a href="#operation--apis-v2beta1-pipelines-post">POST /apis/v2beta1/pipelines</a></td>
<td><p>Creates a pipeline.</p>
</td>
</tr>
<tr>
<td><a href="#operation--apis-v2beta1-pipelines-create-post">POST /apis/v2beta1/pipelines/create</a></td>
<td><p>Creates a new pipeline and a new pipeline version in a single transaction.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1472,6 +1477,90 @@ <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/apis/v
</div>
</div>

<span id="path--apis-v2beta1-pipelines-create"></span>
<div id="operation--apis-v2beta1-pipelines-create-post" class="swagger--panel-operation-post panel">
<div class="panel-heading">
<div class="operation-summary">Creates a new pipeline and a new pipeline version in a single transaction.</div>
<h3 class="panel-title"><span class="operation-name">POST</span> <strong>/apis/v2beta1/pipelines/create</strong></h3>
Tags:
<a href="#tag-PipelineService">PipelineService</a>
</div>
<div class="panel-body">
<section class="sw-operation-description">

</section>


<section class="sw-request-body">

<p><a href="#sw-default-consumes">Uses default content-types: </a>
<span class="label label-default">application/json</span>
</p>
<div class="row">
<div class="col-md-6">
<p></p>
</div>
<div class="col-md-6 sw-request-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/v2beta1CreatePipelineAndVersionRequest">v2beta1CreatePipelineAndVersionRequest</a>
</div>
</div></div>
</div>
</section>

<section class="sw-responses">
<p><a href="#sw-default-produces">Uses default content-types: </a>
<span class="label label-default">application/json</span>
</p>

<dl>
<dt class="sw-response-200">
200 OK

</dt>
<dd class="sw-response-200">
<div class="row">
<div class="col-md-12">
<p>A successful response.</p>

</div>
</div>
<div class="row">

<div class="col-md-6 sw-response-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/v2beta1Pipeline">v2beta1Pipeline</a>
</div>
</div></div>

</div> </dd>
<dt class="sw-response-default">
default

</dt>
<dd class="sw-response-default">
<div class="row">
<div class="col-md-12">

</div>
</div>
<div class="row">

<div class="col-md-6 sw-response-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/googlerpcStatus">googlerpcStatus</a>
</div>
</div></div>

</div> </dd>
</dl>
</section>
</div>
</div>

<span id="path--apis-v2beta1-pipelines-names--name-"></span>
<div id="operation--apis-v2beta1-pipelines-names--name--get" class="swagger--panel-operation-get panel">
<div class="panel-heading">
Expand Down Expand Up @@ -4939,6 +5028,55 @@ <h3 class="panel-title"><a name="/definitions/v2beta1ArtifactList"></a>v2beta1Ar
</section>
</div>
</div>
<div id="definition-v2beta1CreatePipelineAndVersionRequest" class="panel panel-definition">
<div class="panel-heading">
<h3 class="panel-title"><a name="/definitions/v2beta1CreatePipelineAndVersionRequest"></a>v2beta1CreatePipelineAndVersionRequest:
<span class="json-property-type">
<span class="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></span>

</span>
</h3>
</div>
<div class="panel-body">

<section class="json-schema-properties">
<dl>
<dt data-property-name="pipeline">
<span class="json-property-name">pipeline:</span>

<span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/v2beta1Pipeline">v2beta1Pipeline</a>
</span>
<span class="json-property-range" title="Value limits"></span>

</dt>
<dd>
<p>Required input. Pipeline (parent) to be created.</p>

<div class="json-inner-schema">

</div>
</dd>
<dt data-property-name="pipeline_version">
<span class="json-property-name">pipeline_version:</span>

<span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/v2beta1PipelineVersion">v2beta1PipelineVersion</a>
</span>
<span class="json-property-range" title="Value limits"></span>

</dt>
<dd>
<p>Required input. Pipeline version (child) to be created.
Pipeline spec will be downloaded from pipeline_version.package_url.</p>

<div class="json-inner-schema">

</div>
</dd>
</dl>
</section>
</div>
</div>
<div id="definition-v2beta1CronSchedule" class="panel panel-definition">
<div class="panel-heading">
<h3 class="panel-title"><a name="/definitions/v2beta1CronSchedule"></a>v2beta1CronSchedule:
Expand Down

0 comments on commit 2200739

Please sign in to comment.