From 0ded48427652857f92e323d5d85580adf0b6c7bd Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Sun, 9 Jun 2019 16:10:44 +0100 Subject: [PATCH] Address review comments --- api/client-server/administrative_contact.yaml | 4 ++-- api/client-server/registration.yaml | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/api/client-server/administrative_contact.yaml b/api/client-server/administrative_contact.yaml index bc6f98c7c..994512949 100644 --- a/api/client-server/administrative_contact.yaml +++ b/api/client-server/administrative_contact.yaml @@ -235,7 +235,7 @@ paths: account. This API's parameters and response are identical to that of the |/register/email/requestToken|_ endpoint. The homeserver has the choice of validating the email address itself, or proxying the request - to the ``validate/email/requestToken`` Identity Service API as + to the ``/validate/email/requestToken`` Identity Service API as identified by ``id_server``. operationId: requestTokenTo3PIDEmail parameters: @@ -312,7 +312,7 @@ paths: account. This API's parameters and response are identical to that of the |/register/msisdn/requestToken|_ endpoint. The homeserver has the choice of validating the phone number itself, or proxying the request - to the ``validate/msisdn/requestToken`` Identity Service API as + to the ``/validate/msisdn/requestToken`` Identity Service API as identified by ``id_server``. operationId: requestTokenTo3PIDMSISDN parameters: diff --git a/api/client-server/registration.yaml b/api/client-server/registration.yaml index c8615d293..216268156 100644 --- a/api/client-server/registration.yaml +++ b/api/client-server/registration.yaml @@ -213,7 +213,7 @@ paths: The homeserver must check that the given email address is **not** already associated with an account on this homeserver. The homeserver has the choice of validating the email address itself, or proxying the - request to the ``validate/email/requestToken`` Identity Service API. The + request to the ``/validate/email/requestToken`` Identity Service API. The request should be proxied to the domain that is sent by the client in the ``id_server``. It is imperative that the homeserver keep a list of trusted Identity Servers and only proxies to those it trusts. @@ -294,7 +294,7 @@ paths: The homeserver must check that the given phone number is **not** already associated with an account on this homeserver. The homeserver has the choice of validating the phone number itself, or proxying the - request to the ``validate/msisdn/requestToken`` Identity Service API. The + request to the ``/validate/msisdn/requestToken`` Identity Service API. The request should be proxied to the domain that is sent by the client in the ``id_server``. It is imperative that the homeserver keep a list of trusted Identity Servers and only proxies to those it trusts. @@ -428,7 +428,7 @@ paths: The homeserver must check that the given email address **is associated** with an account on this homeserver. This API should be used to request validation tokens when authenticating for the - ``account/password`` endpoint. + ``/account/password`` endpoint. This API's parameters and response are identical to that of the |/register/email/requestToken|_ endpoint, except that @@ -438,7 +438,7 @@ paths: ``M_THREEPID_IN_USE`` may not be returned. The homeserver has the choice of validating the email address itself, - or proxying the request to the ``validate/email/requestToken`` Identity + or proxying the request to the ``/validate/email/requestToken`` Identity Server API. The request should be proxied to the domain that is sent by the client in the ``id_server``. It is imperative that the homeserver keep a list of trusted Identity Servers and only proxies to those it @@ -517,7 +517,7 @@ paths: The homeserver must check that the given phone number **is associated** with an account on this homeserver. This API should be used to request validation tokens when authenticating for the - ``account/password`` endpoint. + ``/account/password`` endpoint. This API's parameters and response are identical to that of the |/register/msisdn/requestToken|_ endpoint, except that @@ -527,7 +527,7 @@ paths: ``M_THREEPID_IN_USE`` may not be returned. The homeserver has the choice of validating the phone number itself, - or proxying the request to the ``validate/msisdn/requestToken`` Identity + or proxying the request to the ``/validate/msisdn/requestToken`` Identity Server API. The request should be proxied to the domain that is sent by the client in the ``id_server``. It is imperative that the homeserver keep a list of trusted Identity Servers and only proxies to those it