Attempt to make things clearer

This commit is contained in:
David Baker 2016-07-07 17:07:38 +01:00
parent 86db820bb1
commit c109da5b78
2 changed files with 8 additions and 7 deletions

View file

@ -126,8 +126,8 @@ paths:
Proxies the identity server API ``validate/email/requestToken``, but
first checks that the given email address is not already associated
with an account on this Home Server. This API should be used to request
validation tokens when adding an email address to an account. This API
behaves identically to `/register/email/requestToken`
validation tokens when adding an email address to an account. This API's
parameters and response is identical to that of `/register/email/requestToken`.
responses:
200:
description: An email was sent to the given address

View file

@ -250,11 +250,12 @@ paths:
first checks that the given email address is associated with an account
on this Home Server. This API should be used to request
validation tokens when authenticating for the
`account/password` endpoint. This API behaves identically to
`/register/email/requestToken` except that `M_THREEPID_NOT_FOUND` may be
returned if no account matching the given email address could be found.
The server may instead send an email to the given address prompting
the user to create an account. `M_THREEPID_IN_USE` may not be returned.
`account/password` endpoint. This API's parameters and response are
identical to that of `/register/email/requestToken` except that
`M_THREEPID_NOT_FOUND` may be returned if no account matching the
given email address could be found. The server may instead send an
email to the given address prompting the user to create an account.
`M_THREEPID_IN_USE` may not be returned.
responses:
200:
description: An email was sent to the given address