From ba5f0c8b31ffe9ead80352d4de0698d9b05a1f73 Mon Sep 17 00:00:00 2001 From: Eldad Fux Date: Tue, 14 Jan 2020 18:16:24 +0200 Subject: [PATCH] Added more metadata for new SDKs --- app/controllers/api/account.php | 3 ++- app/controllers/api/storage.php | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php index 81936f7304..648025a403 100644 --- a/app/controllers/api/account.php +++ b/app/controllers/api/account.php @@ -397,7 +397,8 @@ $utopia->get('/v1/account/sessions/oauth/:provider') ->label('sdk.namespace', 'account') ->label('sdk.method', 'createAccountSessionOAuth') ->label('sdk.description', '/docs/references/account/create-session-oauth.md') - ->label('sdk.location', true) + ->label('sdk.response.code', 301) + ->label('sdk.response.type', 'text/html') ->label('abuse-limit', 50) ->label('abuse-key', 'ip:{ip}') ->param('provider', '', function () use ($providers) { return new WhiteList(array_keys($providers)); }, 'OAuth Provider. Currently, supported providers are: ' . implode(', ', array_keys($providers))) diff --git a/app/controllers/api/storage.php b/app/controllers/api/storage.php index 911e58b649..b2fa86a381 100644 --- a/app/controllers/api/storage.php +++ b/app/controllers/api/storage.php @@ -173,6 +173,7 @@ $utopia->get('/v1/storage/files/:fileId/preview') ->label('sdk.namespace', 'storage') ->label('sdk.method', 'getFilePreview') ->label('sdk.description', '/docs/references/storage/get-file-preview.md') + ->label('sdk.response.type', 'image/*') ->param('fileId', '', function () { return new UID(); }, 'File unique ID') ->param('width', 0, function () { return new Range(0, 4000); }, 'Resize preview image width, Pass an integer between 0 to 4000', true) ->param('height', 0, function () { return new Range(0, 4000); }, 'Resize preview image height, Pass an integer between 0 to 4000', true) @@ -284,6 +285,7 @@ $utopia->get('/v1/storage/files/:fileId/download') ->label('sdk.namespace', 'storage') ->label('sdk.method', 'getFileDownload') ->label('sdk.description', '/docs/references/storage/get-file-download.md') + ->label('sdk.response.type', '*') ->param('fileId', '', function () { return new UID(); }, 'File unique ID.') ->action( function ($fileId) use ($response, $request, $projectDB) { @@ -334,6 +336,7 @@ $utopia->get('/v1/storage/files/:fileId/view') ->label('sdk.namespace', 'storage') ->label('sdk.method', 'getFileView') ->label('sdk.description', '/docs/references/storage/get-file-view.md') + ->label('sdk.response.type', '*') ->param('fileId', '', function () { return new UID(); }, 'File unique ID.') ->param('as', '', function () { return new WhiteList(['pdf', /*'html',*/ 'text']); }, 'Choose a file format to convert your file to. Currently you can only convert word and pdf files to pdf or txt. This option is currently experimental only, use at your own risk.', true) ->action(