opendev/gerrit
Code Issues Proposed changes

Fix documentation for 'exclude-groups' parameter of suggest reviewer REST endpoint

Browse Source 
The current documentation says that groups can be excluded by 'e=f'. I
think this translates to 'exclude-groups=false' which would actually
include groups.

Change-Id: I1ee44c6c1dd3d1a1afcf13714f9b71319788ac32
Signed-off-by: Edwin Kempin <ekempin@google.com>
This commit is contained in:
Edwin Kempin
2019-08-27 09:30:15 +02:00
parent 2d660ed86d
commit ec02a5597d
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2987,7 +2987,12 @@ As result a list of link:#reviewer-info[ReviewerInfo] entries is returned.
Suggest the reviewers for a given query `q` and result limit `n`. If result
limit is not passed, then the default 10 is used.
Groups can be excluded from the results by specifying 'e=f'.
Groups can be excluded from the results by specifying the 'exclude-groups'
request parameter:
--
'GET /changes/link:#change-id[\{change-id\}]/suggest_reviewers?q=J&n=5&exclude-groups'
--
As result a list of link:#suggested-reviewer-info[SuggestedReviewerInfo] entries is returned.