Merge branch '10499-cwl-crunch2-docs' refs #10499

[arvados.git] / doc / api / methods / logs.html.textile.liquid

diff --git a/doc/api/methods/logs.html.textile.liquid b/doc/api/methods/logs.html.textile.liquid
index c5895d78a211dab8170a4b21ffcf66b6c574e33f..e5380d89397b487172510742cf266cd9d67eefb5 100644 (file)
--- a/doc/api/methods/logs.html.textile.liquid
+++ b/doc/api/methods/logs.html.textile.liquid
@@ -6,14 +6,39 @@ title: "logs"
 
 ...
 
 
 ...
 

-See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
-

 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/logs@
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/logs@
 

-Required arguments are displayed in %{background:#ccffcc}green%.
+Object type: @57u5n@
+
+Example UUID: @zzzzz-57u5n-0123456789abcde@
+
+h2. Resource
+
+Each Log has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
+
+table(table table-bordered table-condensed).
+|_. Attribute|_. Type|_. Description|_. Example|
+|object_uuid|string|The arvados object that is the subject of the log.||
+|event_at|datetime|||
+|event_type|string|A user-defined category or type for this event.|@LOGIN@|
+|summary|text|||
+|properties|hash|||
+
+h3. Creation
+
+Any user may create Log entries for any event they find useful. User-generated Logs have no intrinsic meaning to other users or to the Arvados system itself; it is up to each user to choose appropriate log event types and summaries for their project.

 
 

+h3. System Logs

 
 

-h2. create
+Arvados uses Logs to record creation, deletion, and updates of other Arvados resources.
+
+h2. Methods
+
+See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
+h3. create

 
 Create a new log entry.
 
 
 Create a new log entry.
 


@@ -23,7 +48,7 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 |log|object||query||
 
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 |log|object||query||
 

-h2. delete
+h3. delete

 
 Delete an existing log entry. This method can only be used by privileged (system administrator) users.
 
 
 Delete an existing log entry. This method can only be used by privileged (system administrator) users.
 


@@ -33,7 +58,7 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
 
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
 

-h2. get
+h3. get

 
 Retrieve a log entry.
 
 
 Retrieve a log entry.
 


@@ -43,19 +68,13 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
 
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
 

-h2. list
+h3. list

 
 List log entries.
 
 
 List log entries.
 

-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|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||
+See "common resource list method.":{{site.baseurl}}/api/methods.html#index

 
 

-h2. update
+h3. update

 
 Update attributes of an existing log entry. This method can only be used by privileged (system administrator) users.
 
 
 Update attributes of an existing log entry. This method can only be used by privileged (system administrator) users.