10346: Added UUID type to each resource. Some formatting cleanups.

[arvados.git] / 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 b2548b95859c0824f363d8b281b0634ce0eccae4..9ed0df2a3e1fa0b2b6ae51ba6159d525a4005df0 100644 (file)
--- a/doc/api/methods/traits.html.textile.liquid
+++ b/doc/api/methods/traits.html.textile.liquid
@@ -6,44 +6,38 @@ title: "traits"
 
 ...
 
-h1. traits
+See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
 
-Required arguments are displayed in %{background:#ccffcc}green%.
+API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/traits@
 
+UUID type: @q1cn2@
 
-h2. create
+Required arguments are displayed in %{background:#ccffcc}green%.
 
-Create a new Trait.
+h2. Resource
 
-Arguments:
+Each Trait has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
 
 table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|trait|object||query||
-
-h2. delete
+|_. Attribute|_. Type|_. Description|_. Example|
+|name|string|||
+|properties|hash|||
 
-Delete an existing Trait.
-
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
+h2. Methods
 
-h2. destroy
+h3. create
 
-destroy traits
+Create a new Trait.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+|trait|object||query||
 
-h2. get
+h3. delete
 
-Gets a Trait's metadata by UUID.
+Delete an existing Trait.
 
 Arguments:
 
@@ -51,18 +45,17 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
 
-h2. index
+h3. get
 
-index traits
+Gets a Trait's metadata by UUID.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-|order|string||query||
-|where|object||query||
+{background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
 
-h2. list
+h3. list
 
 List traits.
 
@@ -72,21 +65,9 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 |limit|integer (default 100)|Maximum number of traits to return.|query||
 |order|string|Order in which to return matching traits.|query||
-|pageToken|string|Page token.|query||
-|q|string|Query string for searching traits.|query||
-|where|object|Conditions for filtering traits.|query||
-
-h2. show
-
-show traits
-
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+|filters|array|Conditions for filtering traits.|query||
 
-h2. update
+h3. update
 
 Update attributes of an existing Trait.