[ARVADOS] updated: 1.3.0-1274-gf73fdac62

Git user git at public.curoverse.com
Thu Jul 11 19:12:51 UTC 2019


Summary of changes:
 doc/api/methods/groups.html.textile.liquid | 25 +++++++++++++++----------
 1 file changed, 15 insertions(+), 10 deletions(-)

       via  f73fdac62e1b4a46858a67b57286765a652b565d (commit)
      from  322b628a69e03d96dbf37fa33a402078af210b84 (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 f73fdac62e1b4a46858a67b57286765a652b565d
Author: Peter Amstutz <pamstutz at veritasgenetics.com>
Date:   Thu Jul 11 15:12:32 2019 -0400

    15421: Improve wording
    
    Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <pamstutz at veritasgenetics.com>

diff --git a/doc/api/methods/groups.html.textile.liquid b/doc/api/methods/groups.html.textile.liquid
index 6a7e0c7d3..2653cccd5 100644
--- a/doc/api/methods/groups.html.textile.liquid
+++ b/doc/api/methods/groups.html.textile.liquid
@@ -44,8 +44,6 @@ h3. contents
 
 Retrieve a list of items owned by the group.  Use "recursive" to list objects within subprojects as well.
 
-When called with "include=owner_uuid" this also returns (in the @included@ field of the response) the objects (users, projects, or other groups) that own the objects returned in @items at .  This can be used to fetch an object and the record of the parent project in a single API call.
-
 Arguments:
 
 table(table table-bordered table-condensed).
@@ -56,11 +54,16 @@ table(table table-bordered table-condensed).
 |filters|array|Conditions for filtering items.|query|@[["uuid", "is_a", "arvados#job"]]@|
 |recursive|boolean (default false)|Include items owned by subprojects.|query|@true@|
 |exclude_home_project|boolean (default false)|Only return items which are visible to the user but not accessible within the user's home project.  Use this to get a list of items that are shared with the user.  Uses the logic described under the "shared" endpoint.|query|@true@|
-|include|string|If provided with the value "owner_uuid", this will return owner objects in the "included" field of the response.|query|?include=owner_uuid|
+|include|string|If provided with the value "owner_uuid", this will return owner objects in the "included" field of the response.|query||
+
+Notes:
+
+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.
+Use filters with the attribute format @<item type>.<field name>@ to filter items of a specific type. For example: @["container_requests.state", "=", "Final"]@ to filter @container_requests@ where @state@ is @Final at . All other types of items owned by this group will be unimpacted by this filter and will still be included.
+
+When called with “include=owner_uuid”, the @included@ field of the response is populated with users, projects, or other groups that own the objects returned in @items at .  This can be used to fetch an object and its parent with a single API call.
 
-Note: Use filters with the attribute format @<item type>.<field name>@ to filter items of a specific type. For example: @["container_requests.state", "=", "Final"]@ to filter @container_requests@ where @state@ is @Final at . All other types of items owned by this group will be unimpacted by this filter and will still be included.
 
 h3. create
 
@@ -136,8 +139,6 @@ h3. shared
 
 This endpoint returns the toplevel set of groups to which access is granted through a chain of one or more permission links rather than through direct ownership by the current user account.  This is useful for clients which wish to browse the list of projects the user has permission to read which are not part of the "home" project tree.  Similar behavior is also available with the @exclude_home_project@ option of the "contents" endpoint.
 
-When called with "include=owner_uuid" this also returns (in the @included@ field) the objects that own those projects (users or non-project groups).
-
 Specifically, the logic is:
 
 <pre>
@@ -147,8 +148,12 @@ select groups that are readable by current user AND
      the owner_uuid is a group but group_class is not a project)
 </pre>
 
-In addition to the "include" parameter this endpoint also supports the same parameters as the "list method.":{{site.baseurl}}/api/methods.html#index
-
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-|include|string|If provided with the value "owner_uuid", this will return owner objects in the @included@ field of the response.|query|?include=owner_uuid|
+|include|string|If provided with the value "owner_uuid", this will return owner objects in the @included@ field of the response.|query||
+
+Notes:
+
+When called with “include=owner_uuid”, the @included@ field of the response is populated with users and non-project groups that own the objects returned in @items at .
+
+In addition to the "include" parameter this endpoint also supports the same parameters as the "list method.":{{site.baseurl}}/api/methods.html#index

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


hooks/post-receive
-- 




More information about the arvados-commits mailing list