From c109da5b78d075c150c75d3b281237294d746520 Mon Sep 17 00:00:00 2001 From: David Baker Date: Thu, 7 Jul 2016 17:07:38 +0100 Subject: [PATCH] Attempt to make things clearer --- api/client-server/administrative_contact.yaml | 4 ++-- api/client-server/registration.yaml | 11 ++++++----- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/api/client-server/administrative_contact.yaml b/api/client-server/administrative_contact.yaml index fabb2ac9..d3821d04 100644 --- a/api/client-server/administrative_contact.yaml +++ b/api/client-server/administrative_contact.yaml @@ -126,8 +126,8 @@ paths: Proxies the identity server API ``validate/email/requestToken``, but 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 - validation tokens when adding an email address to an account. This API - behaves identically to `/register/email/requestToken` + validation tokens when adding an email address to an account. This API's + parameters and response is identical to that of `/register/email/requestToken`. responses: 200: description: An email was sent to the given address diff --git a/api/client-server/registration.yaml b/api/client-server/registration.yaml index a9bd3fe0..70d4ee07 100644 --- a/api/client-server/registration.yaml +++ b/api/client-server/registration.yaml @@ -250,11 +250,12 @@ paths: first checks that the given email address is associated with an account on this Home Server. This API should be used to request validation tokens when authenticating for the - `account/password` endpoint. This API behaves identically to - `/register/email/requestToken` except that `M_THREEPID_NOT_FOUND` may be - returned if no account matching the given email address could be found. - The server may instead send an email to the given address prompting - the user to create an account. `M_THREEPID_IN_USE` may not be returned. + `account/password` endpoint. This API's parameters and response are + identical to that of `/register/email/requestToken` except that + `M_THREEPID_NOT_FOUND` may be returned if no account matching the + given email address could be found. The server may instead send an + email to the given address prompting the user to create an account. + `M_THREEPID_IN_USE` may not be returned. responses: 200: description: An email was sent to the given address