wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Some PR feedback corrections

Browse source 
Including adding a hyperlink, although this requires a separate fix that I'll do on a different branch
This commit is contained in:
David Baker 2016-07-08 11:56:23 +01:00
parent c109da5b78
commit 7c8651480a
2 changed files with 10 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
api/client-server/administrative_contact.yaml
View file

@ -124,10 +124,15 @@ paths:
summary: Requests a validation token be sent to the given email address for the purpose of adding an email address to an account summary: Requests a validation token be sent to the given email address for the purpose of adding an email address to an account
description: |- description: |-
Proxies the identity server API ``validate/email/requestToken``, but Proxies the identity server API ``validate/email/requestToken``, but
first checks that the given email address is not already associated 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 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's validation tokens when adding an email address to an account. This API's
parameters and response is identical to that of `/register/email/requestToken`. parameters and response is identical to that of the HS API
|/register/email/requestToken|_ endpoint.
.. |/register/email/requestToken| replace:: ``/register/email/requestToken``
.. _/register/email/requestToken: #post-matrix-client-%CLIENT_MAJOR_VERSION%-register-email-requesttoken
responses: responses:
200: 200:
description: An email was sent to the given address description: An email was sent to the given address

4
api/client-server/registration.yaml
View file

@ -136,6 +136,8 @@ paths:
post: post:
summary: Requests a validation token be sent to the given email address for the purpose of registering an account summary: Requests a validation token be sent to the given email address for the purpose of registering an account
description: |- description: |-
.. _register-email-requestToken-endpoint:
Proxies the identity server API ``validate/email/requestToken``, but Proxies the identity server API ``validate/email/requestToken``, but
first checks that the given email address is not already associated first checks that the given email address is not already associated
with an account on this Home Server. Note that, for consistency, with an account on this Home Server. Note that, for consistency,
@ -247,7 +249,7 @@ paths:
summary: Requests a validation token be sent to the given email address for the purpose of resetting a user's password summary: Requests a validation token be sent to the given email address for the purpose of resetting a user's password
description: |- description: |-
Proxies the identity server API ``validate/email/requestToken``, but Proxies the identity server API ``validate/email/requestToken``, but
first checks that the given email address is associated with an account first checks that the given email address **is** associated with an account
on this Home Server. This API should be used to request on this Home Server. This API should be used to request
validation tokens when authenticating for the validation tokens when authenticating for the
`account/password` endpoint. This API's parameters and response are `account/password` endpoint. This API's parameters and response are