Docs: Clarify that for external groups the name in GroupInfo can be missing
For external groups the group name is missing if there is no group
backend that can resolve the group UUID. E.g. this can happen when a
plugin that provided a group backend was uninstalled (e.g. the
singleusergroup plugin).
Change-Id: I0d7f7253698c0125d7692781fa32f4294cda3bcc
Signed-off-by: Edwin Kempin <ekempin@google.com>
(cherry picked from commit 219e797144d7e6425373bd35c7fa1f48b8ac4abb)
diff --git a/Documentation/rest-api-groups.txt b/Documentation/rest-api-groups.txt
index 378c7f5..61b746d 100644
--- a/Documentation/rest-api-groups.txt
+++ b/Documentation/rest-api-groups.txt
@@ -1404,8 +1404,11 @@
|Field Name ||Description
|`id` ||The URL encoded UUID of the group.
|`name` |
-not set if returned in a map where the group name is used as map key|
-The name of the group.
+optional, not set if returned in a map where the group name is used as map key|
+The name of the group. +
+For external groups the group name is missing if there is no group
+backend that can resolve the group UUID. E.g. this can happen when a
+plugin that provided a group backend was uninstalled.
|`url` |optional|
URL to information about the group. Typically a URL to a web page that
permits users to apply to join the group, or manage their membership.