Files
habitica/website/server/controllers/api-v3/status.js
AccioBooks fcfac30caa Api doc status (#8165)
* Add example

* Update example
2016-11-03 08:31:30 -05:00

26 lines
424 B
JavaScript

let api = {};
/**
* @api {get} /api/v3/status Get Habitica's API status
* @apiName GetStatus
* @apiGroup Status
*
* @apiSuccess {String} data.status 'up' if everything is ok
*
* @apiSuccessExample {JSON} Server is Up
* {
* 'status': 'up',
* }
*/
api.getStatus = {
method: 'GET',
url: '/status',
async handler (req, res) {
res.respond(200, {
status: 'up',
});
},
};
module.exports = api;