From d3e14e3b628b94187c7a6c80eb8c28170de5d87f Mon Sep 17 00:00:00 2001 From: Eldad Fux Date: Fri, 13 Nov 2020 00:50:53 +0200 Subject: [PATCH] Updated response models --- app/controllers/api/account.php | 12 ++++++++++++ app/controllers/web/home.php | 3 --- app/init.php | 2 +- src/Appwrite/Utopia/Response/Model/ErrorDev.php | 5 +++++ 4 files changed, 18 insertions(+), 4 deletions(-) diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php index 7b20a32a8..20fc724d2 100644 --- a/app/controllers/api/account.php +++ b/app/controllers/api/account.php @@ -1157,6 +1157,9 @@ App::post('/v1/account/recovery') ->label('sdk.namespace', 'account') ->label('sdk.method', 'createRecovery') ->label('sdk.description', '/docs/references/account/create-recovery.md') + ->label('sdk.response.code', Response::STATUS_CODE_CREATED) + ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) + ->label('sdk.response.model', Response::MODEL_TOKEN) ->label('abuse-limit', 10) ->label('abuse-key', 'url:{url},email:{param-email}') ->param('email', '', new Email(), 'User email.') @@ -1263,6 +1266,9 @@ App::put('/v1/account/recovery') ->label('sdk.namespace', 'account') ->label('sdk.method', 'updateRecovery') ->label('sdk.description', '/docs/references/account/update-recovery.md') + ->label('sdk.response.code', Response::STATUS_CODE_OK) + ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) + ->label('sdk.response.model', Response::MODEL_TOKEN) ->label('abuse-limit', 10) ->label('abuse-key', 'url:{url},userId:{param-userId}') ->param('userId', '', new UID(), 'User account UID address.') @@ -1335,6 +1341,9 @@ App::post('/v1/account/verification') ->label('sdk.namespace', 'account') ->label('sdk.method', 'createVerification') ->label('sdk.description', '/docs/references/account/create-verification.md') + ->label('sdk.response.code', Response::STATUS_CODE_CREATED) + ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) + ->label('sdk.response.model', Response::MODEL_TOKEN) ->label('abuse-limit', 10) ->label('abuse-key', 'url:{url},email:{param-email}') ->param('url', '', function ($clients) { return new Host($clients); }, 'URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.', false, ['clients']) // TODO add built-in confirm page @@ -1430,6 +1439,9 @@ App::put('/v1/account/verification') ->label('sdk.namespace', 'account') ->label('sdk.method', 'updateVerification') ->label('sdk.description', '/docs/references/account/update-verification.md') + ->label('sdk.response.code', Response::STATUS_CODE_OK) + ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) + ->label('sdk.response.model', Response::MODEL_TOKEN) ->label('abuse-limit', 10) ->label('abuse-key', 'url:{url},userId:{param-userId}') ->param('userId', '', new UID(), 'User unique ID.') diff --git a/app/controllers/web/home.php b/app/controllers/web/home.php index 10e0ec1e1..e57a6abb8 100644 --- a/app/controllers/web/home.php +++ b/app/controllers/web/home.php @@ -1,16 +1,13 @@