Updated table headings, removed redundant fields.
authorTim Pierce <twp@unchi.org>
Wed, 18 Dec 2013 22:55:32 +0000 (17:55 -0500)
committerTim Pierce <twp@clinicalfuture.com>
Thu, 26 Dec 2013 17:33:34 +0000 (12:33 -0500)
21 files changed:
doc/api/ApiClientAuthorization.textile
doc/api/ApiClients.textile
doc/api/AuthorizedKey.textile
doc/api/Collections.textile
doc/api/Commit.textile
doc/api/CommitAncestor.textile
doc/api/Group.textile
doc/api/Human.textile
doc/api/Job.textile [deleted file]
doc/api/JobTask.textile [deleted file]
doc/api/KeepDisk.textile
doc/api/Link.textile
doc/api/Log.textile
doc/api/Node.textile
doc/api/PipelineInstance.textile
doc/api/PipelineTemplate.textile
doc/api/Repository.textile
doc/api/Specimen.textile
doc/api/Trait.textile
doc/api/User.textile
doc/api/VirtualMachine.textile

index 254ee4d62e7eada273e8c90b4e4d99137a3e8bb3..133b9cbb191d088325dd7c28c576f1a807425dc6 100644 (file)
@@ -30,8 +30,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).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |api_token|string|||
 |api_client_id|integer|||
 |user_id|integer|||
@@ -39,7 +38,6 @@ table(table table-bordered table-condensed).
 |last_used_by_ip_address|string|||
 |last_used_at|datetime|||
 |expires_at|datetime|||
-|created_at|datetime|||
 |updated_at|datetime|||
 |default_owner_uuid|string|||
 |scopes|Array|||
index 791c652d8c406a31178e3016a76ec5ef0960df16..b4bc5d1876f61f9bcfdb2e23af18b83d1d011d4f 100644 (file)
@@ -31,7 +31,7 @@ h2. Resources
 Each ApiClient has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
+|*Attribute*|*Type*|*Description*|*Example*|
 |name|string|||
 |url_prefix|string|||
 |is_trusted|boolean|||
index fc15c54ab105203cca9cc876fb76c4e19dc20fd8..645080740842d6c9c4dd2f50d9a5900c62bc3b43 100644 (file)
@@ -30,17 +30,10 @@ h2. Resources
 Each AuthorizedKey has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |name|string|||
 |key_type|string|||
 |authorized_user_uuid|string|||
 |public_key|text|||
 |expires_at|datetime|||
-|created_at|datetime|||
 |updated_at|datetime|||
index 38002fe4567817486ec75db42eaf57bbe81e2ad6..428cdddd95d80f6b94c27dcb0d1354d1273e8731 100644 (file)
@@ -33,7 +33,7 @@ h2. Resource
 Each collection has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
+|*Attribute*|*Type*|*Description*|*Example*|
 |locator|string|||
 |portable_data_hash|string|||
 |name|string|||
index 2dab8393e7e7828392a379f03ec0967b0902c6a5..9bb8dbf88430c462eaf72cd884702ee73ca493b3 100644 (file)
@@ -30,10 +30,8 @@ h2. Resources
 Each Commit has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |repository_name|string|||
 |sha1|string|||
 |message|string|||
-|created_at|datetime|||
 |updated_at|datetime|||
index 675b5dc43eb82e40698c5d88d47fbf04989b1b6a..d8921c318d46324e7c73f8bb4180388fcd8eed67 100644 (file)
@@ -30,11 +30,9 @@ h2. Resources
 Each CommitAncestor has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |repository_name|string|||
 |descendant|string|||
 |ancestor|string|||
 |is|boolean|||
-|created_at|datetime|||
 |updated_at|datetime|||
index 49b6851f14964a2ca43ac14d9bc287442096138f..5b4fae8a394d2c9187148a6438a19d36f3090e4d 100644 (file)
@@ -30,14 +30,7 @@ h2. Resources
 Each Group has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |name|string|||
 |description|text|||
 |updated_at|datetime|||
index 0cd53cdb89779dccce50cf188ad60ceba4964dcd..15718f39c29abe3d36c8f615de85a689bd0b2505 100644 (file)
@@ -30,13 +30,6 @@ h2. Resources
 Each Human has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |properties|Hash|||
-|created_at|datetime|||
 |updated_at|datetime|||
diff --git a/doc/api/Job.textile b/doc/api/Job.textile
deleted file mode 100644 (file)
index cfce311..0000000
+++ /dev/null
@@ -1,58 +0,0 @@
----
-layout: default
-navsection: api
-title: "Resource: Job"
-navorder: 101
----
-
-h1. Job
-
-A **Job** represents...
-
-h2. Methods
-
-See "REST methods for working with Arvados resources":methods.html
-
-API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/job@
-
-h2. Creation
-
-h3. Prerequisites
-
-Prerequisites for creating a Job.
-
-h3. Side effects
-
-Side effects of creating a Job.
-
-h2. Resources
-
-Each Job has, in addition to the usual "attributes of Arvados resources":resources.html:
-
-table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
-|submit_id|string|||
-|script|string|||
-|script_version|string|||
-|script_parameters|Hash|||
-|cancelled_by_client_uuid|string|||
-|cancelled_by_user_uuid|string|||
-|cancelled_at|datetime|||
-|started_at|datetime|||
-|finished_at|datetime|||
-|running|boolean|||
-|success|boolean|||
-|output|string|||
-|created_at|datetime|||
-|updated_at|datetime|||
-|priority|string|||
-|is_locked_by_uuid|string|||
-|log|string|||
-|tasks_summary|Hash|||
-|runtime_constraints|Hash|||
diff --git a/doc/api/JobTask.textile b/doc/api/JobTask.textile
deleted file mode 100644 (file)
index 7ff4605..0000000
+++ /dev/null
@@ -1,49 +0,0 @@
----
-layout: default
-navsection: api
-title: "Resource: JobTask"
-navorder: 101
----
-
-h1. JobTask
-
-A **JobTask** represents...
-
-h2. Methods
-
-See "REST methods for working with Arvados resources":methods.html
-
-API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/job_task@
-
-h2. Creation
-
-h3. Prerequisites
-
-Prerequisites for creating a JobTask.
-
-h3. Side effects
-
-Side effects of creating a JobTask.
-
-h2. Resources
-
-Each JobTask has, in addition to the usual "attributes of Arvados resources":resources.html:
-
-table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
-|job_uuid|string|||
-|sequence|integer|||
-|parameters|Hash|||
-|output|text|||
-|progress|float|||
-|success|boolean|||
-|created_at|datetime|||
-|updated_at|datetime|||
-|created_by_job_task_uuid|string|||
-|qsequence|integer|||
index 4a1b76817e45d65f71ec020bd438504ca0fddf46..6873e8b471a6784c6dbdd3c4001c2a70a91ec4a5 100644 (file)
@@ -30,13 +30,7 @@ h2. Resources
 Each KeepDisk has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |ping_secret|string|||
 |node_uuid|string|||
 |filesystem_uuid|string|||
@@ -47,7 +41,6 @@ table(table table-bordered table-condensed).
 |last_read_at|datetime|||
 |last_write_at|datetime|||
 |last_ping_at|datetime|||
-|created_at|datetime|||
 |updated_at|datetime|||
 |service_host|string|||
 |service_port|integer|||
index b840798031caed8488526edeabd73a459c385cec..95ddeb55b1079f59d4a9359c388f66f9040574f6 100644 (file)
@@ -30,14 +30,7 @@ h2. Resources
 Each Link has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |tail_uuid|string|||
 |tail_kind|string|||
 |link_class|string|||
index 033ff3aeca7046ce0b4768da4e1b28000b5fe216..adeb166197dc64287556d12eddc8936c48998dad 100644 (file)
@@ -30,18 +30,11 @@ h2. Resources
 Each Log has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |object_kind|string|||
 |object_uuid|string|||
 |event_at|datetime|||
 |event_type|string|||
 |summary|text|||
 |info|Hash|||
-|created_at|datetime|||
 |updated_at|datetime|||
-|modified_at|datetime|||
index e64730f0174b1a3027c8e9bbf4376e1a1bc84c63..9c4c4267fc44bf5dc00f22f4142369da988a7fb0 100644 (file)
@@ -30,14 +30,7 @@ h2. Resources
 Each Node has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |slot_number|integer|||
 |hostname|string|||
 |domain|string|||
index eca4026fb434404df900bebb014c69382a0a5029..9b4c9a306cde97b8a4944c6b11fc3adb1158d5e7 100644 (file)
@@ -30,14 +30,7 @@ h2. Resources
 Each PipelineInstance has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |pipeline_template_uuid|string|||
 |name|string|||
 |components|Hash|||
index 876200fd63a05e9c983f7d1c5bbdc3921ab4f303..84e012845a903ea7035bcb201d3828d1ad686be1 100644 (file)
@@ -30,14 +30,7 @@ h2. Resources
 Each PipelineTemplate has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |name|string|||
 |components|Hash|||
 |updated_at|datetime|||
index f26efc3d75dfa60f0b2893f14e902b81de85faef..ad954792f4c2060c6b99bac81b18101ef23ebff8 100644 (file)
@@ -30,15 +30,8 @@ h2. Resources
 Each Repository has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |name|string|||
 |fetch_url|string|||
 |push_url|string|||
-|created_at|datetime|||
 |updated_at|datetime|||
index 0110682f3a98dbbb3dc6daf67be6a6b9b20f7cd6..90216aa3421bcbf870a482d89542f374a731158c 100644 (file)
@@ -30,14 +30,7 @@ h2. Resources
 Each Specimen has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |material|string|||
 |updated_at|datetime|||
 |properties|Hash|||
index 2cac6a5ade47e7ea7338215e5629c93875584823..d2e625d7ff0d773e27ba1d6f0201b5db302a9914 100644 (file)
@@ -30,14 +30,7 @@ h2. Resources
 Each Trait has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |name|string|||
 |properties|Hash|||
-|created_at|datetime|||
 |updated_at|datetime|||
index b3022e45d2c1b79a1e0bc3ef83d47ed50095245f..d5fce1a85c0b10a8f0d536afd0df7775f0dcc725 100644 (file)
@@ -30,14 +30,7 @@ h2. Resources
 Each User has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|created_at|datetime|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |email|string|||
 |first_name|string|||
 |last_name|string|||
index 5cabc546bfb795d95f21afea91173cbfbf53222c..964df01bf7648aef593265ec4daba70bb117c8ff 100644 (file)
@@ -30,13 +30,6 @@ h2. Resources
 Each VirtualMachine has, in addition to the usual "attributes of Arvados resources":resources.html:
 
 table(table table-bordered table-condensed).
-|*Property name*|*Value*|*Description*|*Example*|
-|id|integer|||
-|uuid|string|||
-|owner_uuid|string|||
-|modified_by_client_uuid|string|||
-|modified_by_user_uuid|string|||
-|modified_at|datetime|||
+|*Attribute*|*Type*|*Description*|*Example*|
 |hostname|string|||
-|created_at|datetime|||
 |updated_at|datetime|||