Sharkey/src/server/api/endpoints/app/show.ts

73 lines
1.6 KiB
TypeScript
Raw Normal View History

2016-12-29 00:49:51 +02:00
/**
* Module dependencies
*/
2017-03-08 20:50:09 +02:00
import $ from 'cafy';
2018-03-29 14:32:18 +03:00
import App, { pack } from '../../../../models/app';
2016-12-29 00:49:51 +02:00
2017-01-06 09:16:53 +02:00
/**
* @swagger
* /app/show:
2018-04-07 20:30:37 +03:00
* note:
2017-01-06 09:16:53 +02:00
* summary: Show an application's information
2018-03-29 08:48:47 +03:00
* description: Require appId or nameId
2017-01-06 09:16:53 +02:00
* parameters:
* -
2018-03-29 08:48:47 +03:00
* name: appId
2017-01-06 09:16:53 +02:00
* description: Application ID
* in: formData
* type: string
* -
2018-03-29 08:48:47 +03:00
* name: nameId
2017-01-06 09:16:53 +02:00
* description: Application unique name
* in: formData
* type: string
2017-03-01 10:37:01 +02:00
*
2017-01-06 09:16:53 +02:00
* responses:
* 200:
* description: Success
* schema:
* $ref: "#/definitions/Application"
2017-03-01 10:37:01 +02:00
*
2017-01-06 09:16:53 +02:00
* default:
* description: Failed
* schema:
* $ref: "#/definitions/Error"
*/
2016-12-29 00:49:51 +02:00
/**
* Show an app
*
2017-03-01 10:37:01 +02:00
* @param {any} params
* @param {any} user
* @param {any} _
* @param {any} isSecure
* @return {Promise<any>}
2016-12-29 00:49:51 +02:00
*/
2017-03-03 21:28:38 +02:00
module.exports = (params, user, _, isSecure) => new Promise(async (res, rej) => {
2018-03-29 08:48:47 +03:00
// Get 'appId' parameter
const [appId, appIdErr] = $(params.appId).optional.id().$;
if (appIdErr) return rej('invalid appId param');
2016-12-29 00:49:51 +02:00
2018-03-29 08:48:47 +03:00
// Get 'nameId' parameter
const [nameId, nameIdErr] = $(params.nameId).optional.string().$;
if (nameIdErr) return rej('invalid nameId param');
2016-12-29 00:49:51 +02:00
2017-03-03 13:28:42 +02:00
if (appId === undefined && nameId === undefined) {
2018-03-29 08:48:47 +03:00
return rej('appId or nameId is required');
2016-12-29 00:49:51 +02:00
}
// Lookup app
2017-03-03 13:28:42 +02:00
const app = appId !== undefined
2017-03-03 12:48:00 +02:00
? await App.findOne({ _id: appId })
2018-03-29 08:48:47 +03:00
: await App.findOne({ nameIdLower: nameId.toLowerCase() });
2016-12-29 00:49:51 +02:00
if (app === null) {
return rej('app not found');
}
// Send response
2018-02-02 01:21:30 +02:00
res(await pack(app, user, {
2018-03-29 08:48:47 +03:00
includeSecret: isSecure && app.userId.equals(user._id)
2016-12-29 00:49:51 +02:00
}));
});