[ARVADOS] updated: 45938e41f983ce41d8b55c3f980b7f31bc269124
git at public.curoverse.com
git at public.curoverse.com
Wed May 7 00:16:47 EDT 2014
Summary of changes:
doc/api/methods/logs.html.textile.liquid | 22 +++++++++++-----------
1 files changed, 11 insertions(+), 11 deletions(-)
via 45938e41f983ce41d8b55c3f980b7f31bc269124 (commit)
from f91c73aba940adf1e9fbd530d102931af45a63c5 (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 45938e41f983ce41d8b55c3f980b7f31bc269124
Author: Tom Clegg <tom at curoverse.com>
Date: Wed May 7 00:16:30 2014 -0400
Clarify log methods page: say "log entry" instead of "log".
diff --git a/doc/api/methods/logs.html.textile.liquid b/doc/api/methods/logs.html.textile.liquid
index 6d91322..c5895d7 100644
--- a/doc/api/methods/logs.html.textile.liquid
+++ b/doc/api/methods/logs.html.textile.liquid
@@ -15,7 +15,7 @@ Required arguments are displayed in %{background:#ccffcc}green%.
h2. create
-Create a new Log.
+Create a new log entry.
Arguments:
@@ -25,43 +25,43 @@ table(table table-bordered table-condensed).
h2. delete
-Delete an existing Log.
+Delete an existing log entry. This method can only be used by privileged (system administrator) users.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the Log in question.|path||
+{background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
h2. get
-Gets a Log's metadata by UUID.
+Retrieve a log entry.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the Log in question.|path||
+{background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
h2. list
-List logs.
+List log entries.
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||
-|filters|array|Conditions for filtering logs.|query||
+|limit|integer (default 100)|Maximum number of log entries to return.|query||
+|order|string|Order in which to return matching log entries.|query||
+|filters|array|Conditions for filtering log entries.|query||
h2. update
-Update attributes of an existing Log.
+Update attributes of an existing log entry. This method can only be used by privileged (system administrator) users.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the Log in question.|path||
+{background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
|log|object||query||
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list