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

Merge remote-tracking branch 'origin/master' into rav/is_token_grammar

Browse source
This commit is contained in:
Richard van der Hoff 2018-08-31 22:38:04 +01:00
commit 21f8898cd8
2 changed files with 60 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -191,7 +191,7 @@ paths:
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 homeserver. 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 |/register/email/requestToken|_ parameters and response are identical to that of the |/register/email/requestToken|_
endpoint. endpoint.
operationId: requestTokenTo3PIDEmail operationId: requestTokenTo3PIDEmail
parameters: parameters:
@ -217,9 +217,8 @@ paths:
$ref: "../identity/definitions/sid.yaml" $ref: "../identity/definitions/sid.yaml"
403: 403:
description: |- description: |-
The homeserver does not permit the user from having the third party The homeserver does not allow the third party identifier as a
identifier as a contact option. This does not prevent the identity contact option.
service from binding the third party identifier, however.
schema: schema:
$ref: "definitions/errors/error.yaml" $ref: "definitions/errors/error.yaml"
examples: examples:
@ -229,14 +228,14 @@ paths:
} }
400: 400:
description: |- description: |-
The homeserver was unable to locate a user with the third party identifier The third party identifier is already in use on the homeserver, or
already bound, or the request was invalid. the request was invalid.
schema: schema:
$ref: "definitions/errors/error.yaml" $ref: "definitions/errors/error.yaml"
examples: examples:
application/json: { application/json: {
"errcode": "M_THREEPID_NOT_FOUND", "errcode": "M_THREEPID_IN_USE",
"error": "Third party identifier not found" "error": "Third party identifier already in use"
} }
"/account/3pid/msisdn/requestToken": "/account/3pid/msisdn/requestToken":
post: post:
@ -246,7 +245,7 @@ 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 |/register/msisdn/requestToken|_ parameters and response are identical to that of the |/register/msisdn/requestToken|_
endpoint. endpoint.
operationId: requestTokenTo3PIDMSISDN operationId: requestTokenTo3PIDMSISDN
parameters: parameters:
@ -272,9 +271,8 @@ paths:
$ref: "../identity/definitions/sid.yaml" $ref: "../identity/definitions/sid.yaml"
403: 403:
description: |- description: |-
The homeserver does not permit the user from having the third party The homeserver does not allow the third party identifier as a
identifier as a contact option. This does not prevent the identity contact option.
service from binding the third party identifier, however.
schema: schema:
$ref: "definitions/errors/error.yaml" $ref: "definitions/errors/error.yaml"
examples: examples:
@ -284,12 +282,12 @@ paths:
} }
400: 400:
description: |- description: |-
The homeserver was unable to location a user with the third party identifier The third party identifier is already in use on the homeserver, or
alrady bound, or the request was invalid. the request was invalid.
schema: schema:
$ref: "definitions/errors/error.yaml" $ref: "definitions/errors/error.yaml"
examples: examples:
application/json: { application/json: {
"errcode": "M_THREEPID_NOT_FOUND", "errcode": "M_THREEPID_IN_USE",
"error": "Third party identifier not found" "error": "Third party identifier already in use"
} }

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

@ -406,9 +406,31 @@ paths:
required: ['id_server'] required: ['id_server']
responses: responses:
200: 200:
description: An email was sent to the given address description: An email was sent to the given address.
schema: schema:
$ref: "../identity/definitions/sid.yaml" $ref: "../identity/definitions/sid.yaml"
403:
description: |-
The homeserver does not allow the third party identifier as a
contact option.
schema:
$ref: "definitions/errors/error.yaml"
examples:
application/json: {
"errcode": "M_THREEPID_DENIED",
"error": "Third party identifier is not allowed"
}
400:
description: |-
The referenced third party identifier is not recognised by the
homeserver, or the request was invalid
schema:
$ref: "definitions/errors/error.yaml"
examples:
application/json: {
"errcode": "M_THREEPID_NOT_FOUND",
"error": "Email not found"
}
"/account/password/msisdn/requestToken": "/account/password/msisdn/requestToken":
post: post:
summary: Requests a validation token be sent to the given phone number for the purpose of resetting a user's password. summary: Requests a validation token be sent to the given phone number for the purpose of resetting a user's password.
@ -420,7 +442,7 @@ paths:
`account/password` endpoint. This API's parameters and response are `account/password` endpoint. This API's parameters and response are
identical to that of the HS API |/register/msisdn/requestToken|_ except that identical to that of the HS API |/register/msisdn/requestToken|_ except that
`M_THREEPID_NOT_FOUND` may be returned if no account matching the `M_THREEPID_NOT_FOUND` may be returned if no account matching the
given email address could be found. The server may instead send an given phone number could be found. The server may instead send an
SMS message to the given address prompting the user to create an account. SMS message to the given address prompting the user to create an account.
`M_THREEPID_IN_USE` may not be returned. `M_THREEPID_IN_USE` may not be returned.
@ -449,6 +471,28 @@ paths:
description: An SMS message was sent to the given phone number. description: An SMS message was sent to the given phone number.
schema: schema:
$ref: "../identity/definitions/sid.yaml" $ref: "../identity/definitions/sid.yaml"
403:
description: |-
The homeserver does not allow the third party identifier as a
contact option.
schema:
$ref: "definitions/errors/error.yaml"
examples:
application/json: {
"errcode": "M_THREEPID_DENIED",
"error": "Third party identifier is not allowed"
}
400:
description: |-
The referenced third party identifier is not recognised by the
homeserver, or the request was invalid
schema:
$ref: "definitions/errors/error.yaml"
examples:
application/json: {
"errcode": "M_THREEPID_NOT_FOUND",
"error": "Phone number not found"
}
"/account/deactivate": "/account/deactivate":
post: post:
summary: "Deactivate a user's account." summary: "Deactivate a user's account."