Api doc status (#8165)

* Add example * Update example
2025-12-17 14:47:53 +01:00 · 2016-11-03 08:31:30 -05:00
parent b094fb1e52
commit fcfac30caa
1 changed files with 5 additions and 0 deletions
--- a/website/server/controllers/api-v3/status.js
+++ b/website/server/controllers/api-v3/status.js
@@ -6,6 +6,11 @@ let api = {};
 * @apiGroup Status
 *
 * @apiSuccess {String} data.status 'up' if everything is ok
+ *
+ * @apiSuccessExample {JSON} Server is Up
+ * {
+ *   'status': 'up',
+ * }
 */
 api.getStatus = {
  method: 'GET',