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

[arvados.git] / doc / api / methods / api_clients.html.textile.liquid

diff --git a/doc/api/methods/api_clients.html.textile.liquid b/doc/api/methods/api_clients.html.textile.liquid
index 056cc30812c767ea06b8ec53310dc1c8bc362fa0..3c668bdc5665a63591373a65e30d1db30f37270a 100644 (file)
--- a/doc/api/methods/api_clients.html.textile.liquid
+++ b/doc/api/methods/api_clients.html.textile.liquid
@@ -10,9 +10,23 @@ See "REST methods for working with Arvados resources":{{site.baseurl}}/api/metho
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/api_clients@
 
+UUID type: @ozdt8@
+
 Required arguments are displayed in %{background:#ccffcc}green%.
 
-h2. create
+h2. Resource
+
+Each ApiClient 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|||
+|url_prefix|string|||
+|is_trusted|boolean|Trusted by users to handle their API tokens (ApiClientAuthorizations).||
+
+h2. Methods
+
+h3. create
 
 Create a new ApiClient.
 
@@ -22,7 +36,7 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 |api_client|object||query||
 
-h2. delete
+h3. delete
 
 Delete an existing ApiClient.
 
@@ -32,7 +46,7 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
 
-h2. get
+h3. get
 
 Gets a ApiClient's metadata by UUID.
 
@@ -42,7 +56,7 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
 
-h2. list
+h3. list
 
 List api_clients.
 
@@ -54,7 +68,7 @@ table(table table-bordered table-condensed).
 |order|string|Order in which to return matching api_clients.|query||
 |filters|array|Conditions for filtering api_clients.|query||
 
-h2. update
+h3. update
 
 Update attributes of an existing ApiClient.