[ARVADOS] updated: 0184f81a0519c634d4861f0ddb958bef2fd665a7
git at public.curoverse.com
git at public.curoverse.com
Thu Dec 26 14:32:44 EST 2013
Summary of changes:
doc/api/methods/api_client_authorizations.textile | 109 ++++++++++++++++
doc/api/methods/api_clients.textile | 98 +++++++++++++++
doc/api/methods/authorized_keys.textile | 98 +++++++++++++++
doc/api/methods/collections.textile | 98 +++++++++++++++
doc/api/methods/groups.textile | 98 +++++++++++++++
doc/api/methods/humans.textile | 98 +++++++++++++++
doc/api/methods/job_tasks.textile | 98 +++++++++++++++
doc/api/methods/jobs.textile | 130 ++++++++++++++++++++
doc/api/methods/keep_disks.textile | 114 +++++++++++++++++
doc/api/methods/links.textile | 109 ++++++++++++++++
doc/api/methods/logs.textile | 98 +++++++++++++++
doc/api/methods/nodes.textile | 109 ++++++++++++++++
doc/api/methods/pipeline_instances.textile | 98 +++++++++++++++
doc/api/methods/pipeline_templates.textile | 98 +++++++++++++++
doc/api/methods/repositories.textile | 107 ++++++++++++++++
doc/api/methods/specimens.textile | 98 +++++++++++++++
doc/api/methods/traits.textile | 98 +++++++++++++++
doc/api/methods/users.textile | 126 +++++++++++++++++++
doc/api/methods/virtual_machines.textile | 117 ++++++++++++++++++
.../{ => schema}/ApiClientAuthorization.textile | 2 +-
doc/api/{ => schema}/ApiClients.textile | 2 +-
doc/api/{ => schema}/AuthorizedKey.textile | 2 +-
doc/api/{ => schema}/Collections.textile | 2 +-
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}/JobTasks.textile | 2 +-
doc/api/{ => schema}/Jobs.textile | 2 +-
doc/api/{ => schema}/KeepDisk.textile | 2 +-
doc/api/{ => schema}/Link.textile | 2 +-
doc/api/{ => schema}/Links.textile | 2 +-
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 +-
41 files changed, 2021 insertions(+), 22 deletions(-)
create mode 100644 doc/api/methods/api_client_authorizations.textile
create mode 100644 doc/api/methods/api_clients.textile
create mode 100644 doc/api/methods/authorized_keys.textile
create mode 100644 doc/api/methods/collections.textile
create mode 100644 doc/api/methods/groups.textile
create mode 100644 doc/api/methods/humans.textile
create mode 100644 doc/api/methods/job_tasks.textile
create mode 100644 doc/api/methods/jobs.textile
create mode 100644 doc/api/methods/keep_disks.textile
create mode 100644 doc/api/methods/links.textile
create mode 100644 doc/api/methods/logs.textile
create mode 100644 doc/api/methods/nodes.textile
create mode 100644 doc/api/methods/pipeline_instances.textile
create mode 100644 doc/api/methods/pipeline_templates.textile
create mode 100644 doc/api/methods/repositories.textile
create mode 100644 doc/api/methods/specimens.textile
create mode 100644 doc/api/methods/traits.textile
create mode 100644 doc/api/methods/users.textile
create mode 100644 doc/api/methods/virtual_machines.textile
rename doc/api/{ => schema}/ApiClientAuthorization.textile (98%)
rename doc/api/{ => schema}/ApiClients.textile (98%)
rename doc/api/{ => schema}/AuthorizedKey.textile (98%)
rename doc/api/{ => schema}/Collections.textile (99%)
rename doc/api/{ => schema}/Commit.textile (98%)
rename doc/api/{ => schema}/CommitAncestor.textile (98%)
rename doc/api/{ => schema}/Group.textile (97%)
rename doc/api/{ => schema}/Human.textile (97%)
rename doc/api/{ => schema}/JobTasks.textile (99%)
rename doc/api/{ => schema}/Jobs.textile (99%)
rename doc/api/{ => schema}/KeepDisk.textile (98%)
rename doc/api/{ => schema}/Link.textile (98%)
rename doc/api/{ => schema}/Links.textile (99%)
rename doc/api/{ => schema}/Log.textile (98%)
rename doc/api/{ => schema}/Node.textile (98%)
rename doc/api/{ => schema}/PipelineInstance.textile (98%)
rename doc/api/{ => schema}/PipelineTemplate.textile (98%)
rename doc/api/{ => schema}/Repository.textile (98%)
rename doc/api/{ => schema}/Specimen.textile (97%)
rename doc/api/{ => schema}/Trait.textile (97%)
rename doc/api/{ => schema}/User.textile (98%)
rename doc/api/{ => schema}/VirtualMachine.textile (98%)
via 0184f81a0519c634d4861f0ddb958bef2fd665a7 (commit)
from aed823dfc63b6d6876c2736ac3b7e11b312378d5 (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 0184f81a0519c634d4861f0ddb958bef2fd665a7
Author: Tim Pierce <twp at clinicalfuture.com>
Date: Thu Dec 26 14:31:30 2013 -0500
Adding REST method documentation stubs (resolves #1608)
* Added method documentation pages for all REST method endpoints.
* Updated left navbar for all pages.
* Moved schema pages to doc/api/schema.
diff --git a/doc/api/methods/api_client_authorizations.textile b/doc/api/methods/api_client_authorizations.textile
new file mode 100644
index 0000000..9564b4d
--- /dev/null
+++ b/doc/api/methods/api_client_authorizations.textile
@@ -0,0 +1,109 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "api_client_authorizations"
+navorder: 1
+---
+
+h1. api_client_authorizations
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new ApiClientAuthorization.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|api_client_authorization|object||query||
+
+h2. create_system_auth
+
+create_system_auth api_client_authorizations
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|api_client_id|integer||query||
+|scopes|array||query||
+
+h2. delete
+
+Delete an existing ApiClientAuthorization.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
+
+h2. destroy
+
+destroy api_client_authorizations
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a ApiClientAuthorization's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
+
+h2. index
+
+index api_client_authorizations
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List api_client_authorizations.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of api_client_authorizations to return.|query||
+|order|string|Order in which to return matching api_client_authorizations.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching api_client_authorizations.|query||
+|where|object|Conditions for filtering api_client_authorizations.|query||
+
+h2. show
+
+show api_client_authorizations
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing ApiClientAuthorization.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
+|api_client_authorization|object||query||
diff --git a/doc/api/methods/api_clients.textile b/doc/api/methods/api_clients.textile
new file mode 100644
index 0000000..9ca50f6
--- /dev/null
+++ b/doc/api/methods/api_clients.textile
@@ -0,0 +1,98 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "api_clients"
+navorder: 2
+---
+
+h1. api_clients
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new ApiClient.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|api_client|object||query||
+
+h2. delete
+
+Delete an existing ApiClient.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
+
+h2. destroy
+
+destroy api_clients
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a ApiClient's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
+
+h2. index
+
+index api_clients
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List api_clients.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of api_clients to return.|query||
+|order|string|Order in which to return matching api_clients.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching api_clients.|query||
+|where|object|Conditions for filtering api_clients.|query||
+
+h2. show
+
+show api_clients
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing ApiClient.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
+|api_client|object||query||
diff --git a/doc/api/methods/authorized_keys.textile b/doc/api/methods/authorized_keys.textile
new file mode 100644
index 0000000..9107a69
--- /dev/null
+++ b/doc/api/methods/authorized_keys.textile
@@ -0,0 +1,98 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "authorized_keys"
+navorder: 3
+---
+
+h1. authorized_keys
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new AuthorizedKey.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|authorized_key|object||query||
+
+h2. delete
+
+Delete an existing AuthorizedKey.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path||
+
+h2. destroy
+
+destroy authorized_keys
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a AuthorizedKey's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path||
+
+h2. index
+
+index authorized_keys
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List authorized_keys.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of authorized_keys to return.|query||
+|order|string|Order in which to return matching authorized_keys.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching authorized_keys.|query||
+|where|object|Conditions for filtering authorized_keys.|query||
+
+h2. show
+
+show authorized_keys
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing AuthorizedKey.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path||
+|authorized_key|object||query||
diff --git a/doc/api/methods/collections.textile b/doc/api/methods/collections.textile
new file mode 100644
index 0000000..49bc7e6
--- /dev/null
+++ b/doc/api/methods/collections.textile
@@ -0,0 +1,98 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "collections"
+navorder: 4
+---
+
+h1. collections
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new Collection.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|collection|object||query||
+
+h2. delete
+
+Delete an existing Collection.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path||
+
+h2. destroy
+
+destroy collections
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a Collection's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path||
+
+h2. index
+
+index collections
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List collections.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of collections to return.|query||
+|order|string|Order in which to return matching collections.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching collections.|query||
+|where|object|Conditions for filtering collections.|query||
+
+h2. show
+
+show collections
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing Collection.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path||
+|collection|object||query||
diff --git a/doc/api/methods/groups.textile b/doc/api/methods/groups.textile
new file mode 100644
index 0000000..8484834
--- /dev/null
+++ b/doc/api/methods/groups.textile
@@ -0,0 +1,98 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "groups"
+navorder: 5
+---
+
+h1. groups
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new Group.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|group|object||query||
+
+h2. delete
+
+Delete an existing Group.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
+
+h2. destroy
+
+destroy groups
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a Group's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
+
+h2. index
+
+index groups
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List groups.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of groups to return.|query||
+|order|string|Order in which to return matching groups.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching groups.|query||
+|where|object|Conditions for filtering groups.|query||
+
+h2. show
+
+show groups
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing Group.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
+|group|object||query||
diff --git a/doc/api/methods/humans.textile b/doc/api/methods/humans.textile
new file mode 100644
index 0000000..222008a
--- /dev/null
+++ b/doc/api/methods/humans.textile
@@ -0,0 +1,98 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "humans"
+navorder: 6
+---
+
+h1. humans
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new Human.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|human|object||query||
+
+h2. delete
+
+Delete an existing Human.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
+
+h2. destroy
+
+destroy humans
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a Human's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
+
+h2. index
+
+index humans
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List humans.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of humans to return.|query||
+|order|string|Order in which to return matching humans.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching humans.|query||
+|where|object|Conditions for filtering humans.|query||
+
+h2. show
+
+show humans
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing Human.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path||
+|human|object||query||
diff --git a/doc/api/methods/job_tasks.textile b/doc/api/methods/job_tasks.textile
new file mode 100644
index 0000000..e6695e6
--- /dev/null
+++ b/doc/api/methods/job_tasks.textile
@@ -0,0 +1,98 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "job_tasks"
+navorder: 7
+---
+
+h1. job_tasks
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new JobTask.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|job_task|object||query||
+
+h2. delete
+
+Delete an existing JobTask.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
+
+h2. destroy
+
+destroy job_tasks
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a JobTask's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
+
+h2. index
+
+index job_tasks
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List job_tasks.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of job_tasks to return.|query||
+|order|string|Order in which to return matching job_tasks.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching job_tasks.|query||
+|where|object|Conditions for filtering job_tasks.|query||
+
+h2. show
+
+show job_tasks
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing JobTask.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path||
+|job_task|object||query||
diff --git a/doc/api/methods/jobs.textile b/doc/api/methods/jobs.textile
new file mode 100644
index 0000000..6d34952
--- /dev/null
+++ b/doc/api/methods/jobs.textile
@@ -0,0 +1,130 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "jobs"
+navorder: 8
+---
+
+h1. jobs
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. cancel
+
+cancel jobs
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. create
+
+Create a new Job.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|job|object||query||
+
+h2. delete
+
+Delete an existing Job.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
+
+h2. destroy
+
+destroy jobs
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a Job's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
+
+h2. index
+
+index jobs
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List jobs.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of jobs to return.|query||
+|order|string|Order in which to return matching jobs.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching jobs.|query||
+|where|object|Conditions for filtering jobs.|query||
+
+h2. log_tail_follow
+
+log_tail_follow jobs
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+|buffer_size|integer (default 8192)||query||
+
+h2. queue
+
+queue jobs
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. show
+
+show jobs
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing Job.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
+|job|object||query||
diff --git a/doc/api/methods/keep_disks.textile b/doc/api/methods/keep_disks.textile
new file mode 100644
index 0000000..6239cf8
--- /dev/null
+++ b/doc/api/methods/keep_disks.textile
@@ -0,0 +1,114 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "keep_disks"
+navorder: 9
+---
+
+h1. keep_disks
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new KeepDisk.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|keep_disk|object||query||
+
+h2. delete
+
+Delete an existing KeepDisk.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the KeepDisk in question.|path||
+
+h2. destroy
+
+destroy keep_disks
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a KeepDisk's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the KeepDisk in question.|path||
+
+h2. index
+
+index keep_disks
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List keep_disks.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of keep_disks to return.|query||
+|order|string|Order in which to return matching keep_disks.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching keep_disks.|query||
+|where|object|Conditions for filtering keep_disks.|query||
+
+h2. ping
+
+ping keep_disks
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|ping_secret|string||query||
+{background:#ccffcc}.|service_port|string||query||
+{background:#ccffcc}.|service_ssl_flag|string||query||
+|filesystem_uuid|string||query||
+|node_uuid|string||query||
+|service_host|string||query||
+|uuid|string||query||
+
+h2. show
+
+show keep_disks
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing KeepDisk.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the KeepDisk in question.|path||
+|keep_disk|object||query||
diff --git a/doc/api/methods/links.textile b/doc/api/methods/links.textile
new file mode 100644
index 0000000..1530956
--- /dev/null
+++ b/doc/api/methods/links.textile
@@ -0,0 +1,109 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "links"
+navorder: 10
+---
+
+h1. links
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new Link.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|link|object||query||
+
+h2. delete
+
+Delete an existing Link.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Link in question.|path||
+
+h2. destroy
+
+destroy links
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a Link's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Link in question.|path||
+
+h2. index
+
+index links
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|tail_uuid|string||path||
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List links.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of links to return.|query||
+|order|string|Order in which to return matching links.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching links.|query||
+|where|object|Conditions for filtering links.|query||
+
+h2. render_not_found
+
+render_not_found links
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|a|string||path||
+
+h2. show
+
+show links
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing Link.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Link in question.|path||
+|link|object||query||
diff --git a/doc/api/methods/logs.textile b/doc/api/methods/logs.textile
new file mode 100644
index 0000000..4d8c2f4
--- /dev/null
+++ b/doc/api/methods/logs.textile
@@ -0,0 +1,98 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "logs"
+navorder: 11
+---
+
+h1. logs
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new Log.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|log|object||query||
+
+h2. delete
+
+Delete an existing Log.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Log in question.|path||
+
+h2. destroy
+
+destroy logs
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a Log's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Log in question.|path||
+
+h2. index
+
+index logs
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List logs.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of logs to return.|query||
+|order|string|Order in which to return matching logs.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching logs.|query||
+|where|object|Conditions for filtering logs.|query||
+
+h2. show
+
+show logs
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing Log.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Log in question.|path||
+|log|object||query||
diff --git a/doc/api/methods/nodes.textile b/doc/api/methods/nodes.textile
new file mode 100644
index 0000000..656c085
--- /dev/null
+++ b/doc/api/methods/nodes.textile
@@ -0,0 +1,109 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "nodes"
+navorder: 12
+---
+
+h1. nodes
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new Node.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|node|object||query||
+
+h2. delete
+
+Delete an existing Node.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
+
+h2. destroy
+
+destroy nodes
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a Node's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
+
+h2. index
+
+index nodes
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List nodes.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of nodes to return.|query||
+|order|string|Order in which to return matching nodes.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching nodes.|query||
+|where|object|Conditions for filtering nodes.|query||
+
+h2. ping
+
+ping nodes
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|ping_secret|string||query||
+{background:#ccffcc}.|uuid|string||path||
+
+h2. show
+
+show nodes
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing Node.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
+|node|object||query||
diff --git a/doc/api/methods/pipeline_instances.textile b/doc/api/methods/pipeline_instances.textile
new file mode 100644
index 0000000..32ebe84
--- /dev/null
+++ b/doc/api/methods/pipeline_instances.textile
@@ -0,0 +1,98 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "pipeline_instances"
+navorder: 13
+---
+
+h1. pipeline_instances
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new PipelineInstance.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|pipeline_instance|object||query||
+
+h2. delete
+
+Delete an existing PipelineInstance.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
+
+h2. destroy
+
+destroy pipeline_instances
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a PipelineInstance's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
+
+h2. index
+
+index pipeline_instances
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List pipeline_instances.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of pipeline_instances to return.|query||
+|order|string|Order in which to return matching pipeline_instances.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching pipeline_instances.|query||
+|where|object|Conditions for filtering pipeline_instances.|query||
+
+h2. show
+
+show pipeline_instances
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing PipelineInstance.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
+|pipeline_instance|object||query||
diff --git a/doc/api/methods/pipeline_templates.textile b/doc/api/methods/pipeline_templates.textile
new file mode 100644
index 0000000..d6f5ce8
--- /dev/null
+++ b/doc/api/methods/pipeline_templates.textile
@@ -0,0 +1,98 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "pipeline_templates"
+navorder: 14
+---
+
+h1. pipeline_templates
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new PipelineTemplate.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|pipeline_template|object||query||
+
+h2. delete
+
+Delete an existing PipelineTemplate.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the PipelineTemplate in question.|path||
+
+h2. destroy
+
+destroy pipeline_templates
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a PipelineTemplate's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the PipelineTemplate in question.|path||
+
+h2. index
+
+index pipeline_templates
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List pipeline_templates.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of pipeline_templates to return.|query||
+|order|string|Order in which to return matching pipeline_templates.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching pipeline_templates.|query||
+|where|object|Conditions for filtering pipeline_templates.|query||
+
+h2. show
+
+show pipeline_templates
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing PipelineTemplate.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the PipelineTemplate in question.|path||
+|pipeline_template|object||query||
diff --git a/doc/api/methods/repositories.textile b/doc/api/methods/repositories.textile
new file mode 100644
index 0000000..4137361
--- /dev/null
+++ b/doc/api/methods/repositories.textile
@@ -0,0 +1,107 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "repositories"
+navorder: 15
+---
+
+h1. repositories
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new Repository.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|repository|object||query||
+
+h2. delete
+
+Delete an existing Repository.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
+
+h2. destroy
+
+destroy repositories
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a Repository's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
+
+h2. get_all_permissions
+
+get_all_permissions repositories
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+
+h2. index
+
+index repositories
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List repositories.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of repositories to return.|query||
+|order|string|Order in which to return matching repositories.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching repositories.|query||
+|where|object|Conditions for filtering repositories.|query||
+
+h2. show
+
+show repositories
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing Repository.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
+|repository|object||query||
diff --git a/doc/api/methods/specimens.textile b/doc/api/methods/specimens.textile
new file mode 100644
index 0000000..cf49995
--- /dev/null
+++ b/doc/api/methods/specimens.textile
@@ -0,0 +1,98 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "specimens"
+navorder: 16
+---
+
+h1. specimens
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new Specimen.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|specimen|object||query||
+
+h2. delete
+
+Delete an existing Specimen.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path||
+
+h2. destroy
+
+destroy specimens
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a Specimen's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path||
+
+h2. index
+
+index specimens
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List specimens.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of specimens to return.|query||
+|order|string|Order in which to return matching specimens.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching specimens.|query||
+|where|object|Conditions for filtering specimens.|query||
+
+h2. show
+
+show specimens
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing Specimen.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path||
+|specimen|object||query||
diff --git a/doc/api/methods/traits.textile b/doc/api/methods/traits.textile
new file mode 100644
index 0000000..8a8ffcb
--- /dev/null
+++ b/doc/api/methods/traits.textile
@@ -0,0 +1,98 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "traits"
+navorder: 17
+---
+
+h1. traits
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new Trait.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|trait|object||query||
+
+h2. delete
+
+Delete an existing Trait.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
+
+h2. destroy
+
+destroy traits
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a Trait's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
+
+h2. index
+
+index traits
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List traits.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of traits to return.|query||
+|order|string|Order in which to return matching traits.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching traits.|query||
+|where|object|Conditions for filtering traits.|query||
+
+h2. show
+
+show traits
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing Trait.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path||
+|trait|object||query||
diff --git a/doc/api/methods/users.textile b/doc/api/methods/users.textile
new file mode 100644
index 0000000..c162133
--- /dev/null
+++ b/doc/api/methods/users.textile
@@ -0,0 +1,126 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "users"
+navorder: 18
+---
+
+h1. users
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new User.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|user|object||query||
+
+h2. current
+
+current users
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+
+h2. delete
+
+Delete an existing User.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
+
+h2. destroy
+
+destroy users
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. event_stream
+
+event_stream users
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a User's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
+
+h2. index
+
+index users
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List users.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of users to return.|query||
+|order|string|Order in which to return matching users.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching users.|query||
+|where|object|Conditions for filtering users.|query||
+
+h2. show
+
+show users
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. system
+
+system users
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+
+h2. update
+
+Update attributes of an existing User.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
+|user|object||query||
diff --git a/doc/api/methods/virtual_machines.textile b/doc/api/methods/virtual_machines.textile
new file mode 100644
index 0000000..3667491
--- /dev/null
+++ b/doc/api/methods/virtual_machines.textile
@@ -0,0 +1,117 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "virtual_machines"
+navorder: 19
+---
+
+h1. virtual_machines
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+
+h2. create
+
+Create a new VirtualMachine.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|virtual_machine|object||query||
+
+h2. delete
+
+Delete an existing VirtualMachine.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
+
+h2. destroy
+
+destroy virtual_machines
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. get
+
+Gets a VirtualMachine's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
+
+h2. get_all_logins
+
+get_all_logins virtual_machines
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+
+h2. index
+
+index virtual_machines
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|order|string||query||
+|where|object||query||
+
+h2. list
+
+List virtual_machines.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of virtual_machines to return.|query||
+|order|string|Order in which to return matching virtual_machines.|query||
+|pageToken|string|Page token.|query||
+|q|string|Query string for searching virtual_machines.|query||
+|where|object|Conditions for filtering virtual_machines.|query||
+
+h2. logins
+
+logins virtual_machines
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. show
+
+show virtual_machines
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string||path||
+
+h2. update
+
+Update attributes of an existing VirtualMachine.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
+|virtual_machine|object||query||
diff --git a/doc/api/ApiClientAuthorization.textile b/doc/api/schema/ApiClientAuthorization.textile
similarity index 98%
rename from doc/api/ApiClientAuthorization.textile
rename to doc/api/schema/ApiClientAuthorization.textile
index cb8a8e6..dd841d2 100644
--- a/doc/api/ApiClientAuthorization.textile
+++ b/doc/api/schema/ApiClientAuthorization.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: ApiClientAuthorization"
-navorder: 101
+navorder: 1
---
h1. ApiClientAuthorization
diff --git a/doc/api/ApiClients.textile b/doc/api/schema/ApiClients.textile
similarity index 98%
rename from doc/api/ApiClients.textile
rename to doc/api/schema/ApiClients.textile
index 7acfcf0..4f338f0 100644
--- a/doc/api/ApiClients.textile
+++ b/doc/api/schema/ApiClients.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: ApiClient"
-navorder: 101
+navorder: 2
---
h1. ApiClients
diff --git a/doc/api/AuthorizedKey.textile b/doc/api/schema/AuthorizedKey.textile
similarity index 98%
rename from doc/api/AuthorizedKey.textile
rename to doc/api/schema/AuthorizedKey.textile
index 28b7769..e42facc 100644
--- a/doc/api/AuthorizedKey.textile
+++ b/doc/api/schema/AuthorizedKey.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: AuthorizedKey"
-navorder: 101
+navorder: 3
---
h1. AuthorizedKey
diff --git a/doc/api/Collections.textile b/doc/api/schema/Collections.textile
similarity index 99%
rename from doc/api/Collections.textile
rename to doc/api/schema/Collections.textile
index 90dcf2e..0210793 100644
--- a/doc/api/Collections.textile
+++ b/doc/api/schema/Collections.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Collections"
-navorder: 13
+navorder: 4
---
h1. Collections
diff --git a/doc/api/Commit.textile b/doc/api/schema/Commit.textile
similarity index 98%
rename from doc/api/Commit.textile
rename to doc/api/schema/Commit.textile
index dddb61e..1dcfd79 100644
--- a/doc/api/Commit.textile
+++ b/doc/api/schema/Commit.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Commit"
-navorder: 101
+navorder: 6
---
h1. Commit
diff --git a/doc/api/CommitAncestor.textile b/doc/api/schema/CommitAncestor.textile
similarity index 98%
rename from doc/api/CommitAncestor.textile
rename to doc/api/schema/CommitAncestor.textile
index ae444ea..c105d7d 100644
--- a/doc/api/CommitAncestor.textile
+++ b/doc/api/schema/CommitAncestor.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: CommitAncestor"
-navorder: 101
+navorder: 5
---
h1. CommitAncestor
diff --git a/doc/api/Group.textile b/doc/api/schema/Group.textile
similarity index 97%
rename from doc/api/Group.textile
rename to doc/api/schema/Group.textile
index 853d052..14e5aa0 100644
--- a/doc/api/Group.textile
+++ b/doc/api/schema/Group.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Group"
-navorder: 101
+navorder: 7
---
h1. Group
diff --git a/doc/api/Human.textile b/doc/api/schema/Human.textile
similarity index 97%
rename from doc/api/Human.textile
rename to doc/api/schema/Human.textile
index 11a1dde..f5ccf8a 100644
--- a/doc/api/Human.textile
+++ b/doc/api/schema/Human.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Human"
-navorder: 101
+navorder: 8
---
h1. Human
diff --git a/doc/api/JobTasks.textile b/doc/api/schema/JobTasks.textile
similarity index 99%
rename from doc/api/JobTasks.textile
rename to doc/api/schema/JobTasks.textile
index 656ca1d..e86f111 100644
--- a/doc/api/JobTasks.textile
+++ b/doc/api/schema/JobTasks.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: JobTasks"
-navorder: 16
+navorder: 10
---
h1. JobTasks
diff --git a/doc/api/Jobs.textile b/doc/api/schema/Jobs.textile
similarity index 99%
rename from doc/api/Jobs.textile
rename to doc/api/schema/Jobs.textile
index b837b3e..b0ccfa6 100644
--- a/doc/api/Jobs.textile
+++ b/doc/api/schema/Jobs.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Jobs"
-navorder: 15
+navorder: 9
---
h1. Jobs
diff --git a/doc/api/KeepDisk.textile b/doc/api/schema/KeepDisk.textile
similarity index 98%
rename from doc/api/KeepDisk.textile
rename to doc/api/schema/KeepDisk.textile
index b013ede..4d192e9 100644
--- a/doc/api/KeepDisk.textile
+++ b/doc/api/schema/KeepDisk.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: KeepDisk"
-navorder: 101
+navorder: 11
---
h1. KeepDisk
diff --git a/doc/api/Link.textile b/doc/api/schema/Link.textile
similarity index 98%
rename from doc/api/Link.textile
rename to doc/api/schema/Link.textile
index 1bffc1f..a1252fb 100644
--- a/doc/api/Link.textile
+++ b/doc/api/schema/Link.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Link"
-navorder: 101
+navorder: 13
---
h1. Link
diff --git a/doc/api/Links.textile b/doc/api/schema/Links.textile
similarity index 99%
rename from doc/api/Links.textile
rename to doc/api/schema/Links.textile
index 5faa9b0..0332ca9 100644
--- a/doc/api/Links.textile
+++ b/doc/api/schema/Links.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Links"
-navorder: 17
+navorder: 12
---
h1. Links
diff --git a/doc/api/Log.textile b/doc/api/schema/Log.textile
similarity index 98%
rename from doc/api/Log.textile
rename to doc/api/schema/Log.textile
index 34ec27f..516f0d3 100644
--- a/doc/api/Log.textile
+++ b/doc/api/schema/Log.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Log"
-navorder: 101
+navorder: 14
---
h1. Log
diff --git a/doc/api/Node.textile b/doc/api/schema/Node.textile
similarity index 98%
rename from doc/api/Node.textile
rename to doc/api/schema/Node.textile
index c2f0ee9..aefde93 100644
--- a/doc/api/Node.textile
+++ b/doc/api/schema/Node.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Node"
-navorder: 101
+navorder: 15
---
h1. Node
diff --git a/doc/api/PipelineInstance.textile b/doc/api/schema/PipelineInstance.textile
similarity index 98%
rename from doc/api/PipelineInstance.textile
rename to doc/api/schema/PipelineInstance.textile
index 2a646c9..9ae4c4e 100644
--- a/doc/api/PipelineInstance.textile
+++ b/doc/api/schema/PipelineInstance.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: PipelineInstance"
-navorder: 101
+navorder: 16
---
h1. PipelineInstance
diff --git a/doc/api/PipelineTemplate.textile b/doc/api/schema/PipelineTemplate.textile
similarity index 98%
rename from doc/api/PipelineTemplate.textile
rename to doc/api/schema/PipelineTemplate.textile
index c316ac4..ac89b6d 100644
--- a/doc/api/PipelineTemplate.textile
+++ b/doc/api/schema/PipelineTemplate.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: PipelineTemplate"
-navorder: 101
+navorder: 17
---
h1. PipelineTemplate
diff --git a/doc/api/Repository.textile b/doc/api/schema/Repository.textile
similarity index 98%
rename from doc/api/Repository.textile
rename to doc/api/schema/Repository.textile
index f014b48..65755dc 100644
--- a/doc/api/Repository.textile
+++ b/doc/api/schema/Repository.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Repository"
-navorder: 101
+navorder: 18
---
h1. Repository
diff --git a/doc/api/Specimen.textile b/doc/api/schema/Specimen.textile
similarity index 97%
rename from doc/api/Specimen.textile
rename to doc/api/schema/Specimen.textile
index dcb4326..5ecb59b 100644
--- a/doc/api/Specimen.textile
+++ b/doc/api/schema/Specimen.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Specimen"
-navorder: 101
+navorder: 19
---
h1. Specimen
diff --git a/doc/api/Trait.textile b/doc/api/schema/Trait.textile
similarity index 97%
rename from doc/api/Trait.textile
rename to doc/api/schema/Trait.textile
index 49c444e..9a1b07f 100644
--- a/doc/api/Trait.textile
+++ b/doc/api/schema/Trait.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: Trait"
-navorder: 101
+navorder: 20
---
h1. Trait
diff --git a/doc/api/User.textile b/doc/api/schema/User.textile
similarity index 98%
rename from doc/api/User.textile
rename to doc/api/schema/User.textile
index 5d9d90d..2d3445f 100644
--- a/doc/api/User.textile
+++ b/doc/api/schema/User.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: User"
-navorder: 101
+navorder: 21
---
h1. User
diff --git a/doc/api/VirtualMachine.textile b/doc/api/schema/VirtualMachine.textile
similarity index 98%
rename from doc/api/VirtualMachine.textile
rename to doc/api/schema/VirtualMachine.textile
index 241f4c7..36cde5f 100644
--- a/doc/api/VirtualMachine.textile
+++ b/doc/api/schema/VirtualMachine.textile
@@ -3,7 +3,7 @@ layout: default
navsection: api
navmenu: Schema
title: "Resource: VirtualMachine"
-navorder: 101
+navorder: 22
---
h1. VirtualMachine
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list