[ARVADOS] updated: 10bcbe8343f6f91f3c8e338a4a53766f7ba26ef1

git at public.curoverse.com git at public.curoverse.com
Tue May 20 13:38:29 EDT 2014


Summary of changes:
 doc/_config.yml                                    |  2 ++
 ...le.liquid => keep_services.html.textile.liquid} | 31 +++++++++++-----------
 doc/api/schema/KeepDisk.html.textile.liquid        |  4 +--
 doc/api/schema/KeepService.html.textile.liquid     | 24 +++++++++++++++++
 4 files changed, 42 insertions(+), 19 deletions(-)
 copy doc/api/methods/{job_tasks.html.textile.liquid => keep_services.html.textile.liquid} (57%)
 create mode 100644 doc/api/schema/KeepService.html.textile.liquid

       via  10bcbe8343f6f91f3c8e338a4a53766f7ba26ef1 (commit)
      from  286c3627d978a7862b7f7eea366aa48ab930786d (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 10bcbe8343f6f91f3c8e338a4a53766f7ba26ef1
Author: Peter Amstutz <peter.amstutz at curoverse.com>
Date:   Tue May 20 13:38:18 2014 -0400

    2776: Added stub API documentation for keep_services table.

diff --git a/doc/_config.yml b/doc/_config.yml
index 72fcb7d..f3d34cb 100644
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -78,6 +78,7 @@ navbar:
       - api/methods/jobs.html.textile.liquid
       - api/methods/job_tasks.html.textile.liquid
       - api/methods/keep_disks.html.textile.liquid
+      - api/methods/keep_services.html.textile.liquid
       - api/methods/links.html.textile.liquid
       - api/methods/logs.html.textile.liquid
       - api/methods/nodes.html.textile.liquid
@@ -98,6 +99,7 @@ navbar:
       - api/schema/Job.html.textile.liquid
       - api/schema/JobTask.html.textile.liquid
       - api/schema/KeepDisk.html.textile.liquid
+      - api/schema/KeepService.html.textile.liquid
       - api/schema/Link.html.textile.liquid
       - api/schema/Log.html.textile.liquid
       - api/schema/Node.html.textile.liquid
diff --git a/doc/api/methods/keep_services.html.textile.liquid b/doc/api/methods/keep_services.html.textile.liquid
new file mode 100644
index 0000000..016e566
--- /dev/null
+++ b/doc/api/methods/keep_services.html.textile.liquid
@@ -0,0 +1,66 @@
+---
+layout: default
+navsection: api
+navmenu: API Methods
+title: "keep_services"
+
+...
+
+See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
+
+API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/keep_services@
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+h2. create
+
+Create a new KeepService.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|keep_disk|object||query||
+
+h2. delete
+
+Delete an existing KeepService.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
+
+h2. get
+
+Gets a KeepService's metadata by UUID.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
+
+h2. list
+
+List keep_services.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+|limit|integer (default 100)|Maximum number of keep_services to return.|query||
+|order|string|Order in which to return matching keep_services.|query||
+|filters|array|Conditions for filtering keep_services.|query||
+
+h2. update
+
+Update attributes of an existing KeepService.
+
+Arguments:
+
+table(table table-bordered table-condensed).
+|_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
+|keep_service|object||query||
diff --git a/doc/api/schema/KeepDisk.html.textile.liquid b/doc/api/schema/KeepDisk.html.textile.liquid
index f2bffb1..c128c3e 100644
--- a/doc/api/schema/KeepDisk.html.textile.liquid
+++ b/doc/api/schema/KeepDisk.html.textile.liquid
@@ -28,6 +28,4 @@ table(table table-bordered table-condensed).
 |last_read_at|datetime|||
 |last_write_at|datetime|||
 |last_ping_at|datetime|||
-|service_host|string|||
-|service_port|integer|||
-|service_ssl_flag|boolean|||
+|keep_service_uuid|string|||
diff --git a/doc/api/schema/KeepService.html.textile.liquid b/doc/api/schema/KeepService.html.textile.liquid
new file mode 100644
index 0000000..ac1d974
--- /dev/null
+++ b/doc/api/schema/KeepService.html.textile.liquid
@@ -0,0 +1,24 @@
+---
+layout: default
+navsection: api
+navmenu: Schema
+title: KeepService
+
+...
+
+A **KeepService** is a service endpoint that supports the Keep protocol.
+
+h2. Methods
+
+See "keep_services":{{site.baseurl}}/api/methods/keep_services.html
+
+h2. Resource
+
+Each KeepService has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
+
+table(table table-bordered table-condensed).
+|_. Attribute|_. Type|_. Description|_. Example|
+|service_host|string|||
+|service_port|integer|||
+|service_ssl_flag|boolean|||
+|service_type|string|||
\ No newline at end of file

-----------------------------------------------------------------------


hooks/post-receive
-- 




More information about the arvados-commits mailing list