opendev/gerrit
Code Issues Proposed changes

Improve documentation of REST endpoints for default diff preferences

Browse Source 
- Sections headers now say that these REST endpoints are for the
  default diff preferences.
- Rather link to the 'Administrate Server' capability than to the
  'Administrators' group.
- For setting the default diff preferences link to
  DiffPreferencesInput instead of DiffPreferencesInfo. This eliminates
  the need to describe that at least one field must be set.

Change-Id: I931e950412b868b7ab37be56861d8e2772243ab2
Signed-off-by: Edwin Kempin <ekempin@google.com>
This commit is contained in:
Edwin Kempin
2016-06-23 13:20:52 +02:00
parent 9c3d23bb93
commit c8b9034a12
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Documentation/rest-api-config.txt
View File

@@ -937,7 +937,7 @@ link:#top-menu-entry-info[TopMenuEntryInfo] entities is returned.
----
[[get-diff-preferences]]
=== Get diff preferences
=== Get Default Diff Preferences
--
'GET /config/server/preferences.diff'
@@ -976,16 +976,22 @@ DiffPreferencesInfo] is returned.
----
[[set-diff-preferences]]
=== Set Diff Preferences
=== Set Default Diff Preferences
--
'PUT /config/server/preferences.diff'
--
Sets the default diff preferences for the server. Default diff preferences can
only be set by a Gerrit link:access-control.html#administrators[administrator].
At least one field of alink:rest-api-accounts.html#diff-preferences-info[
DiffPreferencesInfo] must be provided in the request body.
Sets the default diff preferences for the server.
The new diff preferences must be provided in the request body as a
link:rest-api-accounts.html#diff-preferences-input[
DiffPreferencesInput] entity.
To be allowed to set default diff preferences, a user must be a member
of a group that is granted the
link:access-control.html#capability_administrateServer[
Administrate Server] capability.
.Request
----