X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/060d38d627bd1e51dd2b3c6e7de9af6aa7d7b6f3..d9cb58fdfa203eee880dba91a239a1f0edf97422:/doc/api/methods/jobs.html.textile.liquid
diff --git a/doc/api/methods/jobs.html.textile.liquid b/doc/api/methods/jobs.html.textile.liquid
index 2f061866f9..aa7a58898a 100644
--- a/doc/api/methods/jobs.html.textile.liquid
+++ b/doc/api/methods/jobs.html.textile.liquid
@@ -11,6 +11,8 @@ Copyright (C) The Arvados Authors. All rights reserved.
SPDX-License-Identifier: CC-BY-SA-3.0
{% endcomment %}
+p=. *Legacy. This endpoint is read-only and disabled by default in new installations.*
+
API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/jobs@
Object type: @8i9sb@
@@ -19,8 +21,6 @@ Example UUID: @zzzzz-8i9sb-0123456789abcde@
h2. Resource
-Deprecated.
-
A job describes a work order to be executed by the Arvados cluster.
Each job has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
@@ -32,7 +32,7 @@ table(table table-bordered table-condensed).
|repository|string|Git repository name or URL.|Source of the repository where the given script_version is to be found. This can be given as the name of a locally hosted repository, or as a publicly accessible URL starting with @git://@, @http://@, or @https://@.
Examples:
@yourusername/yourrepo@
-@https://github.com/curoverse/arvados.git@|
+@https://github.com/arvados/arvados.git@|
|script_version|string|Git commit|During a **create** transaction, this is the Git branch, tag, or hash supplied by the client. Before the job starts, Arvados updates it to the full 40-character SHA-1 hash of the commit used by the job.
See "Specifying Git versions":#script_version below for more detail about acceptable ways to specify a commit.|
|cancelled_by_client_uuid|string|API client ID|Is null if job has not been cancelled|
@@ -57,7 +57,7 @@ See "Specifying Git versions":#script_version below for more detail about accept
h3(#script_version). Specifying Git versions
-The script_version attribute and arvados_sdk_version runtime constraint are typically given as a branch, tag, or commit hash, but there are many more ways to specify a Git commit. The "specifying revisions" section of the "gitrevisions manual page":http://git-scm.com/docs/gitrevisions.html has a definitive list. Arvados accepts Git versions in any format listed there that names a single commit (not a tree, a blob, or a range of commits). However, some kinds of names can be expected to resolve differently in Arvados than they do in your local repository. For example, HEAD@{1}
refers to the local reflog, and @origin/master@ typically refers to a remote branch: neither is likely to work as desired if given as a Git version.
+The script_version attribute and arvados_sdk_version runtime constraint are typically given as a branch, tag, or commit hash, but there are many more ways to specify a Git commit. The "specifying revisions" section of the "gitrevisions manual page":http://git-scm.com/docs/gitrevisions.html has a definitive list. Arvados accepts Git versions in any format listed there that names a single commit (not a tree, a blob, or a range of commits). However, some kinds of names can be expected to resolve differently in Arvados than they do in your local repository. For example, HEAD@{1}
refers to the local reflog, and @origin/main@ typically refers to a remote branch: neither is likely to work as desired if given as a Git version.
h3. Runtime constraints
@@ -138,14 +138,14 @@ notextile.
{ "job": { "script": "hash.py", "repository": "you/you", - "script_version": "master", + "script_version": "main", "script_parameters": { "input": "c1bad4b39ca5a924e481008009d94e32+210" } @@ -170,14 +170,14 @@ Run using exactly the version "d00220fb38d4b85ca8fc28a8151702a2b9d1dec5". Arvado }
{ "job": { "script": "hash.py", "repository": "you/you", - "script_version": "master", + "script_version": "main", "script_parameters": { "input": "c1bad4b39ca5a924e481008009d94e32+210" } @@ -195,7 +195,7 @@ The same behavior, using filters: "job": { "script": "hash.py", "repository": "you/you", - "script_version": "master", + "script_version": "main", "script_parameters": { "input": "c1bad4b39ca5a924e481008009d94e32+210" } @@ -208,14 +208,14 @@ The same behavior, using filters: }
{ "job": { "script": "monte-carlo.py", "repository": "you/you", - "script_version": "master", + "script_version": "main", "nondeterministic": true, "script_parameters": { "input": "c1bad4b39ca5a924e481008009d94e32+210"