20840: Add warning boxes to legacy APIs and rearrange API listing

[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 46cbefef8fdb917678aac553fb95bf687bc64923..3820eeb242b9125e3b3a9320af03e4043227edf2 100644 (file)
--- a/doc/api/methods/specimens.html.textile.liquid
+++ b/doc/api/methods/specimens.html.textile.liquid
@@ -3,47 +3,53 @@ 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 %}
 
+{% include 'notebox_begin_warning' %}
+This is a legacy API.  This endpoint is deprecated, disabled by default in new installations, and is slated to be removed entirely in a future major release of Arvados.  The recommended way to store metadata is with "'properties' field on collections and projects.":../properties.html
+{% include 'notebox_end' %}
 
-Required arguments are displayed in %{background:#ccffcc}green%.
+API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/specimens@
 
+Object type: @j58dm@
 
-h2. create
+Example UUID: @zzzzz-j58dm-0123456789abcde@
 
-Create a new Specimen.
+h2. Resource
 
-Arguments:
+A metadata record that may be used to represent a biological specimen.
 
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|specimen|object||query||
+Each Specimen has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
 
-h2. delete
+table(table table-bordered table-condensed).
+|_. Attribute|_. Type|_. Description|_. Example|
+|material|string|||
+|properties|hash|||
 
-Delete an existing Specimen.
+h2. Methods
 
-Arguments:
+See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
 
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path||
+Required arguments are displayed in %{background:#ccffcc}green%.
 
-h2. destroy
+h3. create
 
-destroy specimens
+Create a new Specimen.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+|specimen|object||query||
 
-h2. get
+h3. delete
 
-Gets a Specimen's metadata by UUID.
+Delete an existing Specimen.
 
 Arguments:
 
@@ -51,29 +57,23 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path||
 
-h2. list
+h3. get
 
-List specimens.
+Gets a Specimen's metadata by UUID.
 
 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||
-
-h2. show
+{background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path||
 
-show specimens
+h3. list
 
-Arguments:
+List specimens.
 
-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 Specimen.