Merge branch '2640-folder-api'
[arvados.git] / doc / api / schema / Group.html.textile.liquid
index 71a006c1867c8a7a561d48b79665857bbffdeaff..4613326f564ca466f73f74e1ebaad358fc3b5f00 100644 (file)
@@ -6,32 +6,19 @@ title: Group
 
 ...
 
-h1. Group
-
-A **Group** represents...
+A **Group** represents a set of objects. Groups allow you to organize content, define user roles, and apply permissions to sets of objects.
 
 h2. Methods
 
-See "REST methods for working with Arvados resources":/api/methods.html
-
-API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/group@
-
-h2. Creation
-
-h3. Prerequisites
-
-Prerequisites for creating a Group.
-
-h3. Side effects
-
-Side effects of creating a Group.
+See "groups":{{site.baseurl}}/api/methods/groups.html
 
-h2. Resources
+h2. Resource
 
-Each Group has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
+Each Group has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
 
 table(table table-bordered table-condensed).
 |_. Attribute|_. Type|_. Description|_. Example|
 |name|string|||
+|group_class|string|Type of group. This does not affect behavior, but determines how the group is presented in the user interface. For example, @folder@ indicates that the group should be displayed by Workbench and arv-mount as a folder for organizing and naming objects.|@"folder"@
+null|
 |description|text|||
-|updated_at|datetime|||