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

74 lines
1.7 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';
2016-12-29 00:49:51 +02:00
import App from '../../models/app';
2018-02-02 01:21:30 +02:00
import { pack } from '../../models/app';
2016-12-29 00:49:51 +02:00
2017-01-06 09:16:53 +02:00
/**
* @swagger
* /app/show:
* post:
* summary: Show an application's information
* description: Require app_id or name_id
* parameters:
* -
* name: app_id
* description: Application ID
* in: formData
* type: string
* -
* name: name_id
* 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) => {
2016-12-29 00:49:51 +02:00
// Get 'app_id' parameter
2017-03-08 20:50:09 +02:00
const [appId, appIdErr] = $(params.app_id).optional.id().$;
2017-03-03 12:48:00 +02:00
if (appIdErr) return rej('invalid app_id param');
2016-12-29 00:49:51 +02:00
// Get 'name_id' parameter
2017-03-08 20:50:09 +02:00
const [nameId, nameIdErr] = $(params.name_id).optional.string().$;
2017-03-03 12:48:00 +02:00
if (nameIdErr) return rej('invalid name_id param');
2016-12-29 00:49:51 +02:00
2017-03-03 13:28:42 +02:00
if (appId === undefined && nameId === undefined) {
2016-12-29 00:49:51 +02:00
return rej('app_id or name_id is required');
}
// 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 })
2016-12-29 00:49:51 +02:00
: await App.findOne({ name_id_lower: nameId.toLowerCase() });
if (app === null) {
return rej('app not found');
}
// Send response
2018-02-02 01:21:30 +02:00
res(await pack(app, user, {
2016-12-29 00:49:51 +02:00
includeSecret: isSecure && app.user_id.equals(user._id)
}));
});