[ARVADOS] updated: cb2aec9c9a0fb6c4d15b9b3db25e59f3c531df42
git at public.curoverse.com
git at public.curoverse.com
Fri Dec 27 18:00:25 EST 2013
Summary of changes:
doc/api/crunch-scripts.textile | 4 ++--
doc/api/index.textile | 12 ++++++------
doc/api/schema/ApiClient.textile | 2 +-
doc/api/schema/ApiClientAuthorization.textile | 2 +-
doc/api/schema/AuthorizedKey.textile | 2 +-
doc/api/schema/Collection.textile | 4 ++--
doc/api/schema/Commit.textile | 2 +-
doc/api/schema/CommitAncestor.textile | 2 +-
doc/api/schema/Group.textile | 2 +-
doc/api/schema/Human.textile | 2 +-
doc/api/schema/Job.textile | 6 +++---
doc/api/schema/JobTask.textile | 6 +++---
doc/api/schema/KeepDisk.textile | 2 +-
doc/api/schema/Link.textile | 4 ++--
doc/api/schema/Log.textile | 2 +-
doc/api/schema/Node.textile | 2 +-
doc/api/schema/PipelineInstance.textile | 2 +-
doc/api/schema/PipelineTemplate.textile | 2 +-
doc/api/schema/Repository.textile | 2 +-
doc/api/schema/Specimen.textile | 2 +-
doc/api/schema/Trait.textile | 2 +-
doc/api/schema/User.textile | 2 +-
doc/api/schema/VirtualMachine.textile | 2 +-
23 files changed, 35 insertions(+), 35 deletions(-)
via cb2aec9c9a0fb6c4d15b9b3db25e59f3c531df42 (commit)
from c5293d314b5ac46ef712ffbee0c2fa64e8baba52 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit cb2aec9c9a0fb6c4d15b9b3db25e59f3c531df42
Author: Tim Pierce <twp at clinicalfuture.com>
Date: Fri Dec 27 18:00:16 2013 -0500
Fixed more broken links, normalized styles. (refs #1608)
diff --git a/doc/api/crunch-scripts.textile b/doc/api/crunch-scripts.textile
index 3048fa7..076a589 100644
--- a/doc/api/crunch-scripts.textile
+++ b/doc/api/crunch-scripts.textile
@@ -20,8 +20,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/Jobs.html|
-|@TASK_UUID@|UUID of the current "JobTask":schema/JobTasks.html|
+|@JOB_UUID@|UUID of the current "Job":schema/Job.html|
+|@TASK_UUID@|UUID of the current "JobTask":schema/JobTask.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|
diff --git a/doc/api/index.textile b/doc/api/index.textile
index 271b2da..11cf0ed 100644
--- a/doc/api/index.textile
+++ b/doc/api/index.textile
@@ -13,16 +13,16 @@ h2. Concepts
* Resources in requests and responses adhere to a "common structure":resources.html.
* API transactions use common "REST methods":methods.html.
* API transactions are subject to a "permission model":permission-model.html.
-* "Job tasks":schema/JobTasks.html use some special API features.
+* "Job tasks":schema/JobTask.html use some special API features.
h2. Resources
h3. Generic Resources
-* "Collections":schema/Collections.html
-* "Jobs":schema/Jobs.html
-* "JobTasks":schema/JobTasks.html
-* "Links":schema/Links.html
+* "Collection":schema/Collection.html
+* "Job":schema/Job.html
+* "JobTask":schema/JobTask.html
+* "Link":schema/Link.html
* "Log":schema/Log.html
* "PipelineTemplate":schema/PipelineTemplate.html
* "PipelineInstance":schema/PipelineInstance.html
@@ -36,7 +36,7 @@ h3. Authentication
These Arvados resources govern authorization and "authentication":authentication.html:
-* "ApiClients":schema/ApiClients.html
+* "ApiClient":schema/ApiClient.html
* "ApiClientAuthorization":schema/ApiClientAuthorization.html
* "AuthorizedKey":schema/AuthorizedKey.html
diff --git a/doc/api/schema/ApiClient.textile b/doc/api/schema/ApiClient.textile
index 004ed15..3d835fb 100644
--- a/doc/api/schema/ApiClient.textile
+++ b/doc/api/schema/ApiClient.textile
@@ -32,7 +32,7 @@ h2. Resources
Each ApiClient has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|url_prefix|string|||
|is_trusted|boolean|||
diff --git a/doc/api/schema/ApiClientAuthorization.textile b/doc/api/schema/ApiClientAuthorization.textile
index 8e71afe..289ff76 100644
--- a/doc/api/schema/ApiClientAuthorization.textile
+++ b/doc/api/schema/ApiClientAuthorization.textile
@@ -31,7 +31,7 @@ h2. Resources
An ApiClientAuthorization is not a generic Arvados resource. The full list of properties that belong to an ApiClientAuthorization is:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|api_token|string|||
|api_client_id|integer|||
|user_id|integer|||
diff --git a/doc/api/schema/AuthorizedKey.textile b/doc/api/schema/AuthorizedKey.textile
index d1b57dd..aec56ff 100644
--- a/doc/api/schema/AuthorizedKey.textile
+++ b/doc/api/schema/AuthorizedKey.textile
@@ -31,7 +31,7 @@ h2. Resources
Each AuthorizedKey has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|key_type|string|||
|authorized_user_uuid|string|||
diff --git a/doc/api/schema/Collection.textile b/doc/api/schema/Collection.textile
index 0b0e970..485ab3c 100644
--- a/doc/api/schema/Collection.textile
+++ b/doc/api/schema/Collection.textile
@@ -8,7 +8,7 @@ navorder: 4
h1. Collection
-This resource concerns metadata, usage accounting, and integrity checks for data stored on the cloud. Reading and writing the data _per se_ is achieved by the "Keep":{{ baseurl }}/user/intro-keep.html storage system.
+This resource concerns metadata, usage accounting, and integrity checks for data stored on the cloud. Reading and writing the data _per se_ is achieved by the "Keep":/user/tutorials/tutorial-keep.html storage system.
h2. Methods
@@ -34,7 +34,7 @@ h2. Resource
Each collection has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|locator|string|||
|portable_data_hash|string|||
|name|string|||
diff --git a/doc/api/schema/Commit.textile b/doc/api/schema/Commit.textile
index 19c54b8..0a02d8f 100644
--- a/doc/api/schema/Commit.textile
+++ b/doc/api/schema/Commit.textile
@@ -31,7 +31,7 @@ h2. Resources
Each Commit has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|repository_name|string|||
|sha1|string|||
|message|string|||
diff --git a/doc/api/schema/CommitAncestor.textile b/doc/api/schema/CommitAncestor.textile
index 56fd5c5..aac8698 100644
--- a/doc/api/schema/CommitAncestor.textile
+++ b/doc/api/schema/CommitAncestor.textile
@@ -31,7 +31,7 @@ h2. Resources
Each CommitAncestor has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|repository_name|string|||
|descendant|string|||
|ancestor|string|||
diff --git a/doc/api/schema/Group.textile b/doc/api/schema/Group.textile
index 6854241..650cbb7 100644
--- a/doc/api/schema/Group.textile
+++ b/doc/api/schema/Group.textile
@@ -31,7 +31,7 @@ h2. Resources
Each Group has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|description|text|||
|updated_at|datetime|||
diff --git a/doc/api/schema/Human.textile b/doc/api/schema/Human.textile
index 9fce0ad..596cb0d 100644
--- a/doc/api/schema/Human.textile
+++ b/doc/api/schema/Human.textile
@@ -31,6 +31,6 @@ h2. Resources
Each Human has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|properties|Hash|||
|updated_at|datetime|||
diff --git a/doc/api/schema/Job.textile b/doc/api/schema/Job.textile
index 8c1e61b..17e7358 100644
--- a/doc/api/schema/Job.textile
+++ b/doc/api/schema/Job.textile
@@ -22,7 +22,7 @@ API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/jobs@
h3. Additional parameters for "Create" method
table(table table-bordered table-condensed).
-|*Parameter name*|*Type*|*Description*|
+|_. Parameter name|_. Type|_. Description|
|allow_duplicate|boolean|If true, a new job is submitted even if an identical job has already been submitted (and has not failed). If false or not supplied, a new job will _not_ be submitted and the existing job will be returned in the API response.|
h3. Queue
@@ -44,7 +44,7 @@ h2. Resource
Each job has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*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|||
|runtime_constraints{}|list|Constraints that must be satisfied by the job/task scheduler in order to run the job.|See below.|
@@ -66,7 +66,7 @@ table(table table-bordered table-condensed).
h3. Runtime constraints
table(table table-bordered table-condensed).
-|*Key*|*Type*|*Description*|*Implemented*|
+|_. Key|_. Type|_. Description|_. Implemented|
|dependencies{}|list|[
{
"name": "freebayes",
diff --git a/doc/api/schema/JobTask.textile b/doc/api/schema/JobTask.textile
index 04b8bdc..4efaa09 100644
--- a/doc/api/schema/JobTask.textile
+++ b/doc/api/schema/JobTask.textile
@@ -8,7 +8,7 @@ navorder: 10
h1. JobTask
-A Job Task is a well defined independently-computable portion of a "Job":Jobs.html.
+A Job Task is a well defined independently-computable portion of a "Job":Job.html.
Job tasks are created two ways:
* When a job starts, it is seeded with a job task with @sequence=0@ and an empty @parameters{}@ list.
@@ -31,7 +31,7 @@ h2. Resources
Each JobTask has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|sequence|integer|Execution sequence.
A step cannot be run until all steps with lower sequence numbers have completed.
Job steps with the same sequence number can be run in any order.||
@@ -43,7 +43,7 @@ Job steps with the same sequence number can be run in any order.||
The following attributes should not be updated by anyone other than the job manager:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Notes*|
+|_. Attribute|_. Type|_. Description|_. Notes|
|qsequence|integer|Order of arrival|0-based|
|job_uuid|string|||
|created_by_job_task_uuid|string|||
diff --git a/doc/api/schema/KeepDisk.textile b/doc/api/schema/KeepDisk.textile
index 7ab4cf7..152ea8d 100644
--- a/doc/api/schema/KeepDisk.textile
+++ b/doc/api/schema/KeepDisk.textile
@@ -31,7 +31,7 @@ h2. Resources
Each KeepDisk has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|ping_secret|string|||
|node_uuid|string|||
|filesystem_uuid|string|||
diff --git a/doc/api/schema/Link.textile b/doc/api/schema/Link.textile
index 0b2cf5e..ed8271d 100644
--- a/doc/api/schema/Link.textile
+++ b/doc/api/schema/Link.textile
@@ -26,7 +26,7 @@ h2. Resource
Each link has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|
+|_. Attribute|_. Type|_. Description|
|tail_uuid|string|Object UUID at the tail (start, source, origin) of this link|
|tail_kind|string|Object kind at the tail (start, source, origin) of this link|
|link_class|string|Class (see below)|
@@ -40,7 +40,7 @@ h2. Link classes
Some classes are pre-defined by convention and have standard meanings attached to names.
table(table table-bordered table-condensed).
-|*link_class*|*tail_type→head_type*|*name→head_uuid {properties}*|*Notes*|
+|_. link_class|_. tail_type→head_type|_. name→head_uuid {properties}|_. Notes|
|provenance|→Collection |provided → _collection uuid_
{url→http://example.com/foo.tgz, retrieved_at→1352616640.000}||
|provenance|Job→Collection |provided → _collection uuid_||
diff --git a/doc/api/schema/Log.textile b/doc/api/schema/Log.textile
index 590da00..b6d1b07 100644
--- a/doc/api/schema/Log.textile
+++ b/doc/api/schema/Log.textile
@@ -31,7 +31,7 @@ h2. Resources
Each Log has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|object_kind|string|||
|object_uuid|string|||
|event_at|datetime|||
diff --git a/doc/api/schema/Node.textile b/doc/api/schema/Node.textile
index c63ebba..7a6e4ef 100644
--- a/doc/api/schema/Node.textile
+++ b/doc/api/schema/Node.textile
@@ -31,7 +31,7 @@ h2. Resources
Each Node has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|slot_number|integer|||
|hostname|string|||
|domain|string|||
diff --git a/doc/api/schema/PipelineInstance.textile b/doc/api/schema/PipelineInstance.textile
index 1b18f8f..bdefce2 100644
--- a/doc/api/schema/PipelineInstance.textile
+++ b/doc/api/schema/PipelineInstance.textile
@@ -31,7 +31,7 @@ h2. Resources
Each PipelineInstance has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|pipeline_template_uuid|string|||
|name|string|||
|components|Hash|||
diff --git a/doc/api/schema/PipelineTemplate.textile b/doc/api/schema/PipelineTemplate.textile
index 3f80fa6..8511a49 100644
--- a/doc/api/schema/PipelineTemplate.textile
+++ b/doc/api/schema/PipelineTemplate.textile
@@ -31,7 +31,7 @@ h2. Resources
Each PipelineTemplate has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|components|Hash|||
|updated_at|datetime|||
diff --git a/doc/api/schema/Repository.textile b/doc/api/schema/Repository.textile
index e7c6052..084e66e 100644
--- a/doc/api/schema/Repository.textile
+++ b/doc/api/schema/Repository.textile
@@ -31,7 +31,7 @@ h2. Resources
Each Repository has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|fetch_url|string|||
|push_url|string|||
diff --git a/doc/api/schema/Specimen.textile b/doc/api/schema/Specimen.textile
index dd75e9e..875c041 100644
--- a/doc/api/schema/Specimen.textile
+++ b/doc/api/schema/Specimen.textile
@@ -31,7 +31,7 @@ h2. Resources
Each Specimen has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|material|string|||
|updated_at|datetime|||
|properties|Hash|||
diff --git a/doc/api/schema/Trait.textile b/doc/api/schema/Trait.textile
index 3af0744..45087a5 100644
--- a/doc/api/schema/Trait.textile
+++ b/doc/api/schema/Trait.textile
@@ -31,7 +31,7 @@ h2. Resources
Each Trait has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|name|string|||
|properties|Hash|||
|updated_at|datetime|||
diff --git a/doc/api/schema/User.textile b/doc/api/schema/User.textile
index 4df7a34..c7fadb3 100644
--- a/doc/api/schema/User.textile
+++ b/doc/api/schema/User.textile
@@ -31,7 +31,7 @@ h2. Resources
Each User has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|email|string|||
|first_name|string|||
|last_name|string|||
diff --git a/doc/api/schema/VirtualMachine.textile b/doc/api/schema/VirtualMachine.textile
index 04068a2..49a23b0 100644
--- a/doc/api/schema/VirtualMachine.textile
+++ b/doc/api/schema/VirtualMachine.textile
@@ -31,6 +31,6 @@ h2. Resources
Each VirtualMachine has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
table(table table-bordered table-condensed).
-|*Attribute*|*Type*|*Description*|*Example*|
+|_. Attribute|_. Type|_. Description|_. Example|
|hostname|string|||
|updated_at|datetime|||
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list