Sharkey/src/api/endpoints/meta.ts

48 lines
1 KiB
TypeScript
Raw Normal View History

2016-12-29 00:49:51 +02:00
/**
* Module dependencies
*/
2017-01-06 15:03:12 +02:00
import prominence from 'prominence';
2017-03-22 18:26:46 +02:00
import version from '../../version';
2017-03-03 13:06:47 +02:00
import config from '../../conf';
2016-12-29 00:49:51 +02:00
2017-01-06 16:39:57 +02:00
/**
* @swagger
* /meta:
* post:
* summary: Show the misskey's information
* responses:
* 200:
* description: Success
* schema:
* type: object
* properties:
* maintainer:
* description: maintainer's name
* type: string
* commit:
* description: latest commit's hash
* type: string
2017-02-27 09:18:47 +02:00
* secure:
2017-02-27 09:19:04 +02:00
* description: whether the server supports secure protocols
2017-01-06 16:39:57 +02:00
* type: boolean
2017-02-27 09:18:47 +02:00
*
2017-01-06 16:39:57 +02:00
* default:
* description: Failed
* schema:
* $ref: "#/definitions/Error"
*/
2016-12-29 00:49:51 +02:00
/**
* Show core info
*
2017-03-01 10:37:01 +02:00
* @param {any} params
* @return {Promise<any>}
2016-12-29 00:49:51 +02:00
*/
2017-03-03 21:28:38 +02:00
module.exports = (params) => new Promise(async (res, rej) => {
res({
maintainer: config.maintainer,
2017-03-17 17:02:41 +02:00
version: version,
2017-03-03 21:28:38 +02:00
secure: config.https.enable
2016-12-29 00:49:51 +02:00
});
2017-03-03 21:28:38 +02:00
});