X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/051efbd3d843baa690b334e57fd09fad6a908bb9..33c10053b22fd5065516eb7df4c58b55a70d490c:/doc/api/methods/pipeline_templates.html.textile.liquid diff --git a/doc/api/methods/pipeline_templates.html.textile.liquid b/doc/api/methods/pipeline_templates.html.textile.liquid index 672b274c8b..85df2799e4 100644 --- a/doc/api/methods/pipeline_templates.html.textile.liquid +++ b/doc/api/methods/pipeline_templates.html.textile.liquid @@ -5,18 +5,23 @@ navmenu: API Methods title: "pipeline_templates" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_templates@ -UUID type: @p5p6p@ +Object type: @p5p6p@ -Required arguments are displayed in %{background:#ccffcc}green%. +Example UUID: @zzzzz-p5p6p-0123456789abcde@ h2. Resource -Each PipelineTemplate has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: +Deprecated. A pipeline template is a collection of jobs that can be instantiated as a pipeline_instance. + +Each PipelineTemplate has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| @@ -167,6 +172,10 @@ This pipeline consists of three components. The component "cleanup" depends on h2. Methods +See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@. + +Required arguments are displayed in %{background:#ccffcc}green%. + h3. create Create a new PipelineTemplate. @@ -201,13 +210,7 @@ h3. list List pipeline_templates. -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|limit|integer (default 100)|Maximum number of pipeline_templates to return.|query|| -|order|string|Order in which to return matching pipeline_templates.|query|| -|filters|array|Conditions for filtering pipeline_templates.|query|| +See "common resource list method.":{{site.baseurl}}/api/methods.html#index h3. update