opendev/gerrit
Code Issues Proposed changes

Fix doc for a few fields in rest-api-accounts PreferencesInfo and Input

Browse Source 
Add 'optional' to the download_scheme field, since it can be null thus
not listed by PreferencesInfo.

Fix typo for PreferencesInfo email_ field name. Add the missing
email_strategy field doc to PreferencesInput.

Change-Id: Iee3385dfcc55b093d8554e0646fddca9194818d7
This commit is contained in:
Marco Miller
2016-04-28 10:51:24 -04:00
parent 382b0a97a4
commit a8614b750e
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/rest-api-accounts.txt
View File

@@ -1944,7 +1944,7 @@ Allowed values are `10`, `25`, `50`, `100`.
Whether the site header should be shown.
|`use_flash_clipboard` |not set if `false`|
Whether to use the flash clipboard widget.
|`download_scheme` ||
|`download_scheme` |optional|
The type of download URL the user prefers to use. May be any key from
the `schemes` map in
link:rest-api-config.html#download-info[DownloadInfo].
@@ -1981,7 +1981,7 @@ link:rest-api-config.html#top-menu-item-info[TopMenuItemInfo] entities.
|`url_aliases` |optional|
A map of URL path pairs, where the first URL path is an alias for the
second URL path.
|`email_notifications` ||
|`email_strategy` ||
The type of email strategy to use. On `ENABLED`, the user will receive emails
from Gerrit. On `CC_ON_OWN_COMMENTS` the user will also receive emails for
their own comments. On `DISABLED` the user will not receive any email
@@ -2039,6 +2039,12 @@ link:rest-api-config.html#top-menu-item-info[TopMenuItemInfo] entities.
|`url_aliases` |optional|
A map of URL path pairs, where the first URL path is an alias for the
second URL path.
|`email_strategy` |optional|
The type of email strategy to use. On `ENABLED`, the user will receive emails
from Gerrit. On `CC_ON_OWN_COMMENTS` the user will also receive emails for
their own comments. On `DISABLED` the user will not receive any email
notifications from Gerrit.
Allowed values are `ENABLED`, `CC_ON_OWN_COMMENTS`, `DISABLED`.
|============================================
[[query-limit-info]]