4464: Simplify API collection list method docs.
authorBrett Smith <brett@curoverse.com>
Mon, 9 Feb 2015 21:40:08 +0000 (16:40 -0500)
committerBrett Smith <brett@curoverse.com>
Mon, 9 Feb 2015 22:09:52 +0000 (17:09 -0500)
doc/api/methods/collections.html.textile.liquid
doc/api/methods/groups.html.textile.liquid

index 8760fe88edce9c41ab21e8518edcd66064b371bf..f5e685e2e9be44a1d740defff0a1ffb0e60da80f 100644 (file)
@@ -55,7 +55,7 @@ table(table table-bordered table-condensed).
 |filters|array|Conditions for filtering collections.|query||
 |select|array|Data fields to return in the result list.|query|@["uuid", "manifest_text"]@|
 
-N.B.: Because adding access tokens to manifests can be computationally expensive, the @manifest_text@ field is not included in results by default.  If you need it, pass a @select@ parameter that includes @manifest_text@.
+Note: Because adding access tokens to manifests can be computationally expensive, the @manifest_text@ field is not included in results by default.  If you need it, pass a @select@ parameter that includes @manifest_text@.
 
 h2. update
 
index b9639aa63d4c4ff318cd0dd44fb91dc6b2287510..9f20a88a9519d09eb5d7fe040c93706379bc089d 100644 (file)
@@ -16,7 +16,7 @@ Required arguments are displayed in %{background:#ccffcc}green%.
 
 h2. contents
 
-Retrieve a list of items which are associated with the given group by ownership (i.e., the group owns the item).
+Retrieve a list of items owned by the group.
 
 Arguments:
 
@@ -27,7 +27,7 @@ table(table table-bordered table-condensed).
 |order|string|Order in which to return matching items.  Sort within a resource type by prefixing the attribute with the resource name and a dot.|query|@"collections.modified_at desc"@|
 |filters|array|Conditions for filtering items.|query|@[["uuid", "is_a", "arvados#job"]]@|
 
-N.B.: Because adding access tokens to manifests can be computationally expensive, the @manifest_text@ field is not included in listed collections.  If you need it, request a "list of collections":{{site.baseurl}}/api/methods/collections.html with the filter @["owner_uuid", "=", GROUP_UUID]@, and @"manifest_text"@ listed in the select parameter.
+Note: Because adding access tokens to manifests can be computationally expensive, the @manifest_text@ field is not included in listed collections.  If you need it, request a "list of collections":{{site.baseurl}}/api/methods/collections.html with the filter @["owner_uuid", "=", GROUP_UUID]@, and @"manifest_text"@ listed in the select parameter.
 
 h2. create