opendev/gerrit
Code Issues Proposed changes

Docs: Clarify that for external groups the name in GroupInfo can be missing

Browse Source 
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 219e797144)
This commit is contained in:
Edwin Kempin 2018-03-27 09:24:54 +02:00 committed by Bassem Rabil
parent aaa40aa1b8
commit a3cd22efee
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/rest-api-groups.txt
View File

@ -1404,8 +1404,11 @@ a Gerrit internal group, or an external group that is known to Gerrit.
|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.