X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b91db14a4dced9d6ea124e86be3c796e6f2c8e8c..051efbd3d843baa690b334e57fd09fad6a908bb9:/doc/api/methods/traits.html.textile.liquid diff --git a/doc/api/methods/traits.html.textile.liquid b/doc/api/methods/traits.html.textile.liquid index 9b19a0880b..9ed0df2a3e 100644 --- a/doc/api/methods/traits.html.textile.liquid +++ b/doc/api/methods/traits.html.textile.liquid @@ -10,10 +10,22 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/traits@ +UUID type: @q1cn2@ + Required arguments are displayed in %{background:#ccffcc}green%. +h2. Resource + +Each Trait has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: + +table(table table-bordered table-condensed). +|_. Attribute|_. Type|_. Description|_. Example| +|name|string||| +|properties|hash||| + +h2. Methods -h2. create +h3. create Create a new Trait. @@ -23,7 +35,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |trait|object||query|| -h2. delete +h3. delete Delete an existing Trait. @@ -33,7 +45,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path|| -h2. get +h3. get Gets a Trait's metadata by UUID. @@ -43,7 +55,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path|| -h2. list +h3. list List traits. @@ -55,7 +67,7 @@ table(table table-bordered table-condensed). |order|string|Order in which to return matching traits.|query|| |filters|array|Conditions for filtering traits.|query|| -h2. update +h3. update Update attributes of an existing Trait.