From 7b475aea175a7e9ffc35a66cf1748ae95ceca8af Mon Sep 17 00:00:00 2001 From: Tim Pierce Date: Wed, 18 Dec 2013 17:55:32 -0500 Subject: [PATCH] Updated table headings, removed redundant fields. --- doc/api/ApiClientAuthorization.textile | 4 +- doc/api/ApiClients.textile | 2 +- doc/api/AuthorizedKey.textile | 9 +--- doc/api/Collections.textile | 2 +- doc/api/Commit.textile | 4 +- doc/api/CommitAncestor.textile | 4 +- doc/api/Group.textile | 9 +--- doc/api/Human.textile | 9 +--- doc/api/Job.textile | 58 -------------------------- doc/api/JobTask.textile | 49 ---------------------- doc/api/KeepDisk.textile | 9 +--- doc/api/Link.textile | 9 +--- doc/api/Log.textile | 9 +--- doc/api/Node.textile | 9 +--- doc/api/PipelineInstance.textile | 9 +--- doc/api/PipelineTemplate.textile | 9 +--- doc/api/Repository.textile | 9 +--- doc/api/Specimen.textile | 9 +--- doc/api/Trait.textile | 9 +--- doc/api/User.textile | 9 +--- doc/api/VirtualMachine.textile | 9 +--- 21 files changed, 19 insertions(+), 230 deletions(-) delete mode 100644 doc/api/Job.textile delete mode 100644 doc/api/JobTask.textile diff --git a/doc/api/ApiClientAuthorization.textile b/doc/api/ApiClientAuthorization.textile index 254ee4d62e..133b9cbb19 100644 --- a/doc/api/ApiClientAuthorization.textile +++ b/doc/api/ApiClientAuthorization.textile @@ -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||| diff --git a/doc/api/ApiClients.textile b/doc/api/ApiClients.textile index 791c652d8c..b4bc5d1876 100644 --- a/doc/api/ApiClients.textile +++ b/doc/api/ApiClients.textile @@ -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||| diff --git a/doc/api/AuthorizedKey.textile b/doc/api/AuthorizedKey.textile index fc15c54ab1..6450807408 100644 --- a/doc/api/AuthorizedKey.textile +++ b/doc/api/AuthorizedKey.textile @@ -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||| diff --git a/doc/api/Collections.textile b/doc/api/Collections.textile index 38002fe456..428cdddd95 100644 --- a/doc/api/Collections.textile +++ b/doc/api/Collections.textile @@ -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||| diff --git a/doc/api/Commit.textile b/doc/api/Commit.textile index 2dab8393e7..9bb8dbf884 100644 --- a/doc/api/Commit.textile +++ b/doc/api/Commit.textile @@ -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||| diff --git a/doc/api/CommitAncestor.textile b/doc/api/CommitAncestor.textile index 675b5dc43e..d8921c318d 100644 --- a/doc/api/CommitAncestor.textile +++ b/doc/api/CommitAncestor.textile @@ -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||| diff --git a/doc/api/Group.textile b/doc/api/Group.textile index 49b6851f14..5b4fae8a39 100644 --- a/doc/api/Group.textile +++ b/doc/api/Group.textile @@ -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||| diff --git a/doc/api/Human.textile b/doc/api/Human.textile index 0cd53cdb89..15718f39c2 100644 --- a/doc/api/Human.textile +++ b/doc/api/Human.textile @@ -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 index cfce3119a6..0000000000 --- a/doc/api/Job.textile +++ /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 index 7ff460537e..0000000000 --- a/doc/api/JobTask.textile +++ /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||| diff --git a/doc/api/KeepDisk.textile b/doc/api/KeepDisk.textile index 4a1b76817e..6873e8b471 100644 --- a/doc/api/KeepDisk.textile +++ b/doc/api/KeepDisk.textile @@ -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||| diff --git a/doc/api/Link.textile b/doc/api/Link.textile index b840798031..95ddeb55b1 100644 --- a/doc/api/Link.textile +++ b/doc/api/Link.textile @@ -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||| diff --git a/doc/api/Log.textile b/doc/api/Log.textile index 033ff3aeca..adeb166197 100644 --- a/doc/api/Log.textile +++ b/doc/api/Log.textile @@ -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||| diff --git a/doc/api/Node.textile b/doc/api/Node.textile index e64730f017..9c4c4267fc 100644 --- a/doc/api/Node.textile +++ b/doc/api/Node.textile @@ -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||| diff --git a/doc/api/PipelineInstance.textile b/doc/api/PipelineInstance.textile index eca4026fb4..9b4c9a306c 100644 --- a/doc/api/PipelineInstance.textile +++ b/doc/api/PipelineInstance.textile @@ -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||| diff --git a/doc/api/PipelineTemplate.textile b/doc/api/PipelineTemplate.textile index 876200fd63..84e012845a 100644 --- a/doc/api/PipelineTemplate.textile +++ b/doc/api/PipelineTemplate.textile @@ -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||| diff --git a/doc/api/Repository.textile b/doc/api/Repository.textile index f26efc3d75..ad954792f4 100644 --- a/doc/api/Repository.textile +++ b/doc/api/Repository.textile @@ -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||| diff --git a/doc/api/Specimen.textile b/doc/api/Specimen.textile index 0110682f3a..90216aa342 100644 --- a/doc/api/Specimen.textile +++ b/doc/api/Specimen.textile @@ -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||| diff --git a/doc/api/Trait.textile b/doc/api/Trait.textile index 2cac6a5ade..d2e625d7ff 100644 --- a/doc/api/Trait.textile +++ b/doc/api/Trait.textile @@ -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||| diff --git a/doc/api/User.textile b/doc/api/User.textile index b3022e45d2..d5fce1a85c 100644 --- a/doc/api/User.textile +++ b/doc/api/User.textile @@ -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||| diff --git a/doc/api/VirtualMachine.textile b/doc/api/VirtualMachine.textile index 5cabc546bf..964df01bf7 100644 --- a/doc/api/VirtualMachine.textile +++ b/doc/api/VirtualMachine.textile @@ -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||| -- 2.30.2