20840: Add warning boxes to legacy APIs and rearrange API listing
[arvados.git] / doc / api / methods / specimens.html.textile.liquid
index 33a2dd8959b383595d9c1376ccdcbe08834c0b4f..3820eeb242b9125e3b3a9320af03e4043227edf2 100644 (file)
@@ -4,6 +4,15 @@ 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' %}
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/specimens@
 
@@ -24,7 +33,7 @@ table(table table-bordered table-condensed).
 
 h2. Methods
 
-See "Common resource methods":{{site.baseurl}}/api/methods.html more information about @create@, @delete@, @get@, @list@, and @update@.
+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%.