Add additional clarity to the requestToken errors

pull/1636/head
Travis Ralston 6 years ago
parent 5bb7eca8e8
commit 824ce22caa

@ -282,12 +282,12 @@ 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"
} }

@ -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 permit the user from having 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 third party identifier is already in use on 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 permit the user from having 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 third party identifier is already in use on 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."

Loading…
Cancel
Save