X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/becada3b24006cf39417335794cb46556d7aa605..f17da3a5f54ccaad3ec4f38dedac8b6c50a5cb0a:/doc/api/methods/groups.html.textile.liquid diff --git a/doc/api/methods/groups.html.textile.liquid b/doc/api/methods/groups.html.textile.liquid index b22926671a..7a15d20d5a 100644 --- a/doc/api/methods/groups.html.textile.liquid +++ b/doc/api/methods/groups.html.textile.liquid @@ -3,19 +3,19 @@ layout: default navsection: api navmenu: API Methods title: "groups" - ... - -See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html - API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/groups@ -Required arguments are displayed in %{background:#ccffcc}green%. +Object type: @j7d0g@ + +Example UUID: @zzzzz-j7d0g-0123456789abcde@ h2. Resource -Each Group has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: +Groups provides a way to apply the same permissions to a set of Arvados objects. See "permission model":{{site.baseurl}}/api/permission-model.html for details. + +Each Group has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| @@ -27,6 +27,10 @@ null| 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. contents Retrieve a list of items owned by the group. @@ -78,13 +82,7 @@ h3. list List groups. -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|limit|integer (default 100)|Maximum number of groups to return.|query|| -|order|string|Order in which to return matching groups.|query|| -|filters|array|Conditions for filtering groups.|query|| +See "common resource list method.":{{site.baseurl}}/api/methods.html#index h3. show