From d532da29a2f954f6a24ccacd1142e61b299ea292 Mon Sep 17 00:00:00 2001 From: Brett Smith Date: Thu, 16 Oct 2014 17:00:39 -0400 Subject: [PATCH] 4189: Document the API server's writable_by field. --- doc/api/schema/Group.html.textile.liquid | 1 + doc/api/schema/User.html.textile.liquid | 1 + 2 files changed, 2 insertions(+) diff --git a/doc/api/schema/Group.html.textile.liquid b/doc/api/schema/Group.html.textile.liquid index 8a542650d2..2bf67eb6ff 100644 --- a/doc/api/schema/Group.html.textile.liquid +++ b/doc/api/schema/Group.html.textile.liquid @@ -22,3 +22,4 @@ table(table table-bordered table-condensed). |group_class|string|Type of group. This does not affect behavior, but determines how the group is presented in the user interface. For example, @project@ indicates that the group should be displayed by Workbench and arv-mount as a project for organizing and naming objects.|@"project"@ null| |description|text||| +|writable_by|array|List of UUID strings identifying Users and other Groups that have write permission for this Group. Only users who are allowed to administer the Group will receive a full list. Other users will receive a partial list that includes the Group's owner_uuid and (if applicable) their own user UUID.|| diff --git a/doc/api/schema/User.html.textile.liquid b/doc/api/schema/User.html.textile.liquid index c95a2439a2..9a1b0566d4 100644 --- a/doc/api/schema/User.html.textile.liquid +++ b/doc/api/schema/User.html.textile.liquid @@ -26,3 +26,4 @@ table(table table-bordered table-condensed). |prefs|hash||| |default_owner_uuid|string||| |is_active|boolean||| +|writable_by|array|List of UUID strings identifying Groups and other Users that can modify this User object. This will include the user's owner_uuid and, for administrators and users requesting their own User object, the requesting user's UUID.|| -- 2.30.2