Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-11 14:04:10 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

General clarity and spelling for the requestToken APIs

Browse source
This commit is contained in:
Travis Ralston 2018-08-31 10:32:30 -06:00
parent 7f1b94c211
commit a4c2b2b905
1 changed files with 15 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -189,10 +189,10 @@ paths:
description: |- description: |-
Proxies the identity service API ``validate/email/requestToken``, but Proxies the identity service 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 homeserver. 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 the client-server API parameters and response is identical to that of the |/register/email/requestToken|_
|/register/email/requestToken|_ endpoint. endpoint.
operationId: requestTokenTo3PIDEmail operationId: requestTokenTo3PIDEmail
parameters: parameters:
- in: body - in: body
@ -216,7 +216,10 @@ paths:
schema: schema:
$ref: "../identity/definitions/sid.yaml" $ref: "../identity/definitions/sid.yaml"
403: 403:
description: The homeserver does not permit the address to be bound. description: |-
The homeserver does not permit the user from having the third party
identifier as a contact option. This does not prevent the identity
service from binding the third party identifier, however.
schema: schema:
$ref: "definitions/errors/error.yaml" $ref: "definitions/errors/error.yaml"
examples: examples:
@ -226,8 +229,8 @@ paths:
} }
400: 400:
description: |- description: |-
The homeserver was unable to location a user with the third party identifier The homeserver was unable to locate a user with the third party identifier
alrady bound, or the request was invalid. already bound, or the request was invalid.
schema: schema:
$ref: "definitions/errors/error.yaml" $ref: "definitions/errors/error.yaml"
examples: examples:
@ -243,8 +246,8 @@ paths:
first checks that the given phone number is **not** already associated first checks that the given phone number 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 a phone number to an account. This API's validation tokens when adding a phone number to an account. This API's
parameters and response is identical to that of the client-server API parameters and response is identical to that of the |/register/msisdn/requestToken|_
|/register/msisdn/requestToken|_ endpoint. endpoint.
operationId: requestTokenTo3PIDMSISDN operationId: requestTokenTo3PIDMSISDN
parameters: parameters:
- in: body - in: body
@ -268,7 +271,10 @@ paths:
schema: schema:
$ref: "../identity/definitions/sid.yaml" $ref: "../identity/definitions/sid.yaml"
403: 403:
description: The homeserver does not permit the address to be bound. description: |-
The homeserver does not permit the user from having the third party
identifier as a contact option. This does not prevent the identity
service from binding the third party identifier, however.
schema: schema:
$ref: "definitions/errors/error.yaml" $ref: "definitions/errors/error.yaml"
examples: examples: