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

[arvados.git] / doc / api / crunch-scripts.html.textile.liquid

diff --git a/doc/api/crunch-scripts.html.textile.liquid b/doc/api/crunch-scripts.html.textile.liquid
index 98634cdd9ba11ba1f110eaadb8c9554c7b5d847a..5d7fe5d98fa9104da43c7ca72a9d73977367c6f1 100644 (file)
--- a/doc/api/crunch-scripts.html.textile.liquid
+++ b/doc/api/crunch-scripts.html.textile.liquid
@@ -5,6 +5,15 @@ navmenu: Concepts
 title: Crunch scripts
 
 ...
+{% 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.  Is is replaced by "container requests.":methods/container_requests.html
+{% include 'notebox_end' %}
 
 h2. Crunch scripts
 
@@ -20,8 +29,8 @@ A task's context is provided in environment variables.
 
 table(table table-bordered table-condensed).
 |Environment variable|Description|
-|@JOB_UUID@|UUID of the current "Job":schema/Job.html|
-|@TASK_UUID@|UUID of the current "JobTask":schema/JobTask.html|
+|@JOB_UUID@|UUID of the current "Job":methods/jobs.html|
+|@TASK_UUID@|UUID of the current "JobTask":methods/job_tasks.html|
 |@ARVADOS_API_HOST@|Hostname and port number of API server|
 |@ARVADOS_API_TOKEN@|Authentication token to use with API calls made by the current task|
 
@@ -43,4 +52,3 @@ task = arvados.api().job_tasks().get(uuid=os.environ['TASK_UUID']).execute()
 $sys.stderr.write("current task sequence number is %d"
                   % task['sequence'])
 </pre>
-