From 2068cba598b3e3630950f95d0d730a1a2e081a56 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Mon, 10 Jun 2019 09:14:25 +0100 Subject: [PATCH] Clients should submit a POST request --- api/client-server/administrative_contact.yaml | 8 ++++---- .../definitions/request_token_response.yaml | 16 +++++++--------- 2 files changed, 11 insertions(+), 13 deletions(-) diff --git a/api/client-server/administrative_contact.yaml b/api/client-server/administrative_contact.yaml index 6ee4a152e..a3a391bca 100644 --- a/api/client-server/administrative_contact.yaml +++ b/api/client-server/administrative_contact.yaml @@ -145,10 +145,10 @@ paths: description: |- An optional field containing a URL where the client must submit the validation token to, with identical parameters - to the Identity Service API's - ``/validate/email/submitToken`` endpoint. The homeserver - must send this token to the user (if applicable), which - should then be prompted to provide it to the client. + to the Identity Service API's ``POST + /validate/email/submitToken`` endpoint. The homeserver must + send this token to the user (if applicable), which should + then be prompted to provide it to the client. If this field is not present, the client can assume that verification will happen without the client's involvement. diff --git a/api/client-server/definitions/request_token_response.yaml b/api/client-server/definitions/request_token_response.yaml index 50b45ca96..48f818e54 100644 --- a/api/client-server/definitions/request_token_response.yaml +++ b/api/client-server/definitions/request_token_response.yaml @@ -24,15 +24,13 @@ properties: submit_url: type: string description: |- - An optional field containing a URL where the client must - submit the validation token to, with identical parameters - to the Identity Service API's - ``/validate/email/submitToken`` endpoint. The homeserver - must send this token to the user (if applicable), which - should then be prompted to provide it to the client. + An optional field containing a URL where the client must submit the + validation token to, with identical parameters to the Identity Service + API's ``POST /validate/email/submitToken`` endpoint. The homeserver must + send this token to the user (if applicable), which should then be + prompted to provide it to the client. - If this field is not present, the client can assume that - verification will happen without the client's - involvement. + If this field is not present, the client can assume that verification + will happen without the client's involvement. example: "https://example.org/path/to/submitToken" required: ['sid']