misskey/src/api/endpoints/app/show.js

'use strict';

/**
 * Module dependencies
 */
import * as mongo from 'mongodb';
import App from '../../models/app';
import serialize from '../../serializers/app';

/**
 * @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
 *
 *     responses:
 *       200:
 *         description: Success
 *         schema:
 *           $ref: "#/definitions/Application"
 *
 *       default:
 *         description: Failed
 *         schema:
 *           $ref: "#/definitions/Error"
 */

/**
 * Show an app
 *
 * @param {any} params
 * @param {any} user
 * @param {any} _
 * @param {any} isSecure
 * @return {Promise<any>}
 */
module.exports = (params, user, _, isSecure) =>
	new Promise(async (res, rej) =>
{
	// Get 'app_id' parameter
	let appId = params.app_id;
	if (appId == null || appId == '') {
		appId = null;
	}

	// Get 'name_id' parameter
	let nameId = params.name_id;
	if (nameId == null || nameId == '') {
		nameId = null;
	}

	if (appId === null && nameId === null) {
		return rej('app_id or name_id is required');
	}

	// Lookup app
	const app = appId !== null
		? await App.findOne({ _id: new mongo.ObjectID(appId) })
		: await App.findOne({ name_id_lower: nameId.toLowerCase() });

	if (app === null) {
		return rej('app not found');
	}

	// Send response
	res(await serialize(app, user, {
		includeSecret: isSecure && app.user_id.equals(user._id)
	}));
});