X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/ddeef8adc0cb7cdb55be644b9335ea51919ed513..d394bc5c81dc488fc67cf3402e1074fafa1d9bcd:/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 89c79ab1fc..13fa838767 100644 --- a/doc/api/methods/jobs.html.textile.liquid +++ b/doc/api/methods/jobs.html.textile.liquid @@ -5,6 +5,13 @@ navmenu: API Methods title: "jobs" ... +{% comment %} +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@ @@ -14,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: @@ -27,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| @@ -71,7 +76,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%.