Merge branch '8784-dir-listings'

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

diff --git a/doc/api/methods/humans.html.textile.liquid b/doc/api/methods/humans.html.textile.liquid
index a0e715b58e8b7fb2027187bcab251c34267e7f02..84cb22c99738755dded5f6cea7b35cf02ecfdf2f 100644 (file)
--- a/doc/api/methods/humans.html.textile.liquid
+++ b/doc/api/methods/humans.html.textile.liquid
@@ -5,45 +5,47 @@ navmenu: API Methods
 title: "humans"
 
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
 
-h1. humans
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
 
-Required arguments are displayed in %{background:#ccffcc}green%.
+API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/humans@
 
+Object type: @7a9it@
 
-h2. create
+Example UUID: @zzzzz-7a9it-0123456789abcde@
 
-Create a new Human.
+h2. Resource
 
-Arguments:
+A metadata record that may be used to represent a human subject.
+
+Each Human has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
 
 table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|human|object||query||
+|_. Attribute|_. Type|_. Description|_. Example|
+|properties|hash|||
 
-h2. delete
+h2. Methods
 
-Delete an existing Human.
+See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
 
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
+Required arguments are displayed in %{background:#ccffcc}green%.
 
-h2. destroy
+h3. create
 
-destroy humans
+Create a new Human.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+|human|object||query||
 
-h2. get
+h3. delete
 
-Gets a Human's metadata by UUID.
+Delete an existing Human.
 
 Arguments:
 
@@ -51,42 +53,23 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
 
-h2. index
+h3. get
 
-index humans
+Gets a Human'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 Human in question.|path||
 
-h2. list
+h3. list
 
 List humans.
 
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|limit|integer (default 100)|Maximum number of humans to return.|query||
-|order|string|Order in which to return matching humans.|query||
-|pageToken|string|Page token.|query||
-|q|string|Query string for searching humans.|query||
-|where|object|Conditions for filtering humans.|query||
-
-h2. show
-
-show humans
-
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+See "common resource list method.":{{site.baseurl}}/api/methods.html#index
 
-h2. update
+h3. update
 
 Update attributes of an existing Human.