From a600386c050a00c099295b72953e5bc857be18af Mon Sep 17 00:00:00 2001 From: David Baker Date: Thu, 30 Jun 2016 16:12:11 +0100 Subject: [PATCH] Consistent working for error response Also format json example better --- api/client-server/registration.yaml | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/api/client-server/registration.yaml b/api/client-server/registration.yaml index 5301bfef..f6803b88 100644 --- a/api/client-server/registration.yaml +++ b/api/client-server/registration.yaml @@ -177,13 +177,16 @@ paths: type: object 400: description: |- - Returns an error object indicating the nature of the error. A Home Server may use - ``M_THREEPID_IN_USE`` to inform the user that the email address is already registered - to an account on this server, however, if the home server has the ability to send email, - it is recommended that the server instead send an email to the user with instructions - on how to reset their password. + The request was invalid. An errcode of ``M_THREEPID_IN_USE`` is used to inform the user + that the email address is already registered to an account on this server, however, + if the home server has the ability to send email, it is recommended that the server + instead send an email to the user with instructions on how to reset their password. examples: - application/json: '{"errcode": "M_THREEPID_IN_USE", "error": "The specified address is already in use"}' + application/json: |- + { + "errcode": "M_THREEPID_IN_USE", + "error": "The specified address is already in use" + } schema: type: object "/account/password":