Reorganize navbars.

[arvados.git] / doc / api / Jobs.textile

diff --git a/doc/api/Jobs.textile b/doc/api/Jobs.textile
index 8c374a4eebfef9b6883169afcc9a1a0fa61e6125..d238c13e2b9163c18ff33ec28159230564c21d74 100644 (file)
--- a/doc/api/Jobs.textile
+++ b/doc/api/Jobs.textile
@@ -2,7 +2,7 @@
 layout: default
 navsection: api
 title: "Resource: Jobs"
-navorder: 10
+navorder: 15
 ---
 
 h1. Jobs
@@ -31,7 +31,7 @@ GET https://{{ site.arvados_api_host }}/arvados/v1/jobs/queue
  
 POST https://{{ site.arvados_api_host }}/arvados/v1/jobs/queue
 _method=GET
-where[owner]=xyzzy-tpzed-a4lcehql0dv2u25
+where[owner_uuid]=xyzzy-tpzed-a4lcehql0dv2u25
 </pre>
 
 &rarr; Job resource list
@@ -43,28 +43,40 @@ h2. Resource
 Each job has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Type*|*Description*|*Notes*|
+|*Attribute*|*Type*|*Description*|*Notes*|
 |submit_id|string|Unique ID provided by client when job was submitted|Optional. Can be used by client to ensure idempotence|
 |priority|string|||
-|resource_limits{}|list|Constraints that must be satisfied by the job/task scheduler in order to run the job.|See below.|
-|script_name|string|Name of MapReduce script||
+|runtime_constraints{}|list|Constraints that must be satisfied by the job/task scheduler in order to run the job.|See below.|
+|script|string|Name of crunch script in @/crunch_scripts/@||
 |script_parameters{}|list|Parameters passed to MapReduce script||
-|script_version|string|git commit/tree used when running the job|If the job has not started, this can be a tag/branch instead of an unambiguous commit id.|
-|cancelled_by_client|string|API client ID|Is null if job has not been cancelled|
-|cancelled_by_user|string|Authenticated user ID|Is null if job has not been cancelled|
-|cancelled_at|string|When job was cancelled|Is null if job has not been cancelled|
+|script_version|string|git commit/tree used when running the job|This can be submitted as an unambiguous prefix of a commit sha1, "repository:tag", or "repository:branch". Before the job starts, Arvados will resolve it to a full 40-character git commit sha1.|
+|cancelled_by_client_uuid|string|API client ID|Is null if job has not been cancelled|
+|cancelled_by_user_uuid|string|Authenticated user ID|Is null if job has not been cancelled|
+|cancelled_at|datetime|When job was cancelled|Is null if job has not been cancelled|
 |started_at|datetime|When job started running|Is null if job has not [yet] started|
 |finished_at|datetime|When job finished running|Is null if job has not [yet] finished|
 |running|boolean|Whether the job is running||
 |success|boolean|Whether the job indicated successful completion|Is null if job has not finished|
-|is_locked_by|string|UUID of the user who has locked this job|Is null if job is not locked. The system user locks the job when starting the job, in order to prevent job attributes from being altered.|
+|is_locked_by_uuid|string|UUID of the user who has locked this job|Is null if job is not locked. The system user locks the job when starting the job, in order to prevent job attributes from being altered.|
+|log|string|||
+|tasks_summary|Hash|||
+|output|string|||
 
-h3. Resource limits
+h3. Runtime constraints
 
 table(table table-bordered table-condensed).
 |*Key*|*Type*|*Description*|*Implemented*|
-|min_nodes|integer||&#x2713;|
+|dependencies{}|list|[
+ {
+  "name": "freebayes",
+  "package_type": "git",
+  "origin": "https://github.com/ekg/freebayes.git",
+  "version": "011561f4a96619125d4388b66b2e82b173f3de7a"
+ },
+ ...
+]||
+|min_nodes|integer||&#10003;|
 |max_nodes|integer|||
-|max_tasks_per_node|integer|Maximum simultaneous tasks on a single node|&#x2713;|
+|max_tasks_per_node|integer|Maximum simultaneous tasks on a single node|&#10003;|
 |min_ram_per_task|integer|Minimum real memory (KiB) per task||
-|min_ram_per_node|integer|Minimum real memory (KiB) per node||
\ No newline at end of file
+|min_ram_per_node|integer|Minimum real memory (KiB) per node||