15516: Merge branch 'master' into 15516-fix-arvados-server-dependencies

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

diff --git a/doc/api/methods/specimens.html.textile.liquid b/doc/api/methods/specimens.html.textile.liquid
index 79ef47965336156ac78c2cfc8bc10fdae130f055..be3712a2064cdd174150769078ccf5eaf5c5d8a6 100644 (file)
--- a/doc/api/methods/specimens.html.textile.liquid
+++ b/doc/api/methods/specimens.html.textile.liquid
@@ -3,18 +3,26 @@ layout: default
 navsection: api
 navmenu: API Methods
 title: "specimens"
-
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
 
-See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
+p=. *Deprecated, likely to be removed in a future version.  The recommended way to store metadata is "collection properties":collections.html*
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/specimens@
 
-Required arguments are displayed in %{background:#ccffcc}green%.
+Object type: @j58dm@
+
+Example UUID: @zzzzz-j58dm-0123456789abcde@
 
 h2. Resource
 
-Each Specimen has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
+A metadata record that may be used to represent a biological specimen.
+
+Each Specimen has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
 
 table(table table-bordered table-condensed).
 |_. Attribute|_. Type|_. Description|_. Example|
@@ -23,6 +31,10 @@ table(table table-bordered table-condensed).
 
 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 Specimen.
@@ -57,13 +69,7 @@ h3. list
 
 List specimens.
 
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|limit|integer (default 100)|Maximum number of specimens to return.|query||
-|order|string|Order in which to return matching specimens.|query||
-|filters|array|Conditions for filtering specimens.|query||
+See "common resource list method.":{{site.baseurl}}/api/methods.html#index
 
 h3. update