opendev/gerrit
Code Issues Proposed changes

AccountInfo: Link to how detailed account information is requested

Browse Source 
Some fields in AccountInfo are only included if detailed account
information is requested. Link to the option that includes detailed
account information so that readers know how these fields can be
retrieved.

Change-Id: I6d209469942549ffe4e5626ebc8604963899f29a
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
Edwin Kempin 2013-10-16 14:14:54 +02:00
parent e1537dcce3
commit a13c5b8ee2
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -977,12 +977,15 @@ The `AccountInfo` entity contains information about an account.
|Field Name ||Description
|`_account_id` ||The numeric ID of the account.
|`name` |optional|The full name of the user. +
Only set if detailed account information is requested.
Only set if link:rest-api-changes.html#detailed-accounts[detailed
account information] is requested.
|`email` |optional|
The email address the user prefers to be contacted through. +
Only set if detailed account information is requested.
Only set if link:rest-api-changes.html#detailed-accounts[detailed
account information] is requested.
|`username` |optional|The username of the user. +
Only set if detailed account information is requested.
Only set if link:rest-api-changes.html#detailed-accounts[detailed
account information] is requested.
|===========================
[[account-input]]