Support listing the email addresses of an account via REST
The email addresses of an account can now be retrieved by GET on
/accounts/<account-id>/emails.
Change-Id: I225b1b62cdffaa138d923e0fa6d8386904b8ee04
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
diff --git a/Documentation/rest-api-accounts.txt b/Documentation/rest-api-accounts.txt
index 332fe7f..8a3b24f 100644
--- a/Documentation/rest-api-accounts.txt
+++ b/Documentation/rest-api-accounts.txt
@@ -161,6 +161,40 @@
HTTP/1.1 204 No Content
----
+[[list-account-emails]]
+List Account Emails
+~~~~~~~~~~~~~~~~~~~
+[verse]
+'GET /accounts/link:#account-id[\{account-id\}]/emails'
+
+Returns the email addresses that are configured for the specified user.
+
+.Request
+----
+ GET /accounts/self/emails HTTP/1.0
+----
+
+As response the email addresses of the user are returned as a list of
+link:#email-info[EmailInfo] entities.
+
+.Response
+----
+ HTTP/1.1 200 OK
+ Content-Disposition: attachment
+ Content-Type: application/json;charset=UTF-8
+
+ )]}'
+ [
+ {
+ "email": "john.doe@example.com",
+ "preferred": true
+ },
+ {
+ "email": "j.doe@example.com"
+ }
+ ]
+----
+
[[list-account-capabilities]]
List Account Capabilities
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -717,6 +751,20 @@
Number of spaces that should be used to display one tab.
|=====================================
+[[email-info]]
+EmailInfo
+~~~~~~~~~
+The `EmailInfo` entity contains information about an email address of a
+user.
+
+[options="header",width="50%",cols="1,^1,5"]
+|========================
+|Field Name ||Description
+|`email` ||The email address.
+|`preferred`|not set if `false`|
+Whether this is the preferred email address of the user.
+|========================
+
[[query-limit-info]]
QueryLimitInfo
~~~~~~~~~~~~~~
