aboutsummaryrefslogtreecommitdiffstats
path: root/routes
diff options
context:
space:
mode:
authorAdrien Hopkins <[email protected]>2021-08-18 14:22:32 -0500
committerAdrien Hopkins <[email protected]>2021-08-18 14:22:32 -0500
commit2a0252707890c156c008719574f0da000b853ba2 (patch)
treeaedf7738116ce534e17673d6bb506f340e03cf4b /routes
parente4669eaf9700ecc503bee3305315256968bd05e5 (diff)
downloadcoinos-server-2a0252707890c156c008719574f0da000b853ba2.tar.gz
coinos-server-2a0252707890c156c008719574f0da000b853ba2.zip
Documented /api/info
Diffstat (limited to 'routes')
-rw-r--r--routes/info.js9
1 files changed, 9 insertions, 0 deletions
diff --git a/routes/info.js b/routes/info.js
index 6d9d5f32..8d098a2f 100644
--- a/routes/info.js
+++ b/routes/info.js
@@ -1,6 +1,15 @@
const sequelize = require("sequelize");
const { Op } = sequelize;
+/**
+ * @api {get} /info Request server information
+ * @apiName GetInfo
+ * @apiGroup Info
+ *
+ * @apiSuccess {Object} fx Exchange rates relative to USD - fx.CUR is the value of one CUR in USD.
+ * @apiSuccess {String[]} networks Array of supported networks; possible values are "bitcoin", "liquid" and "lightning".
+ * @apiSuccess {String} clientVersion the current git commit of the ui
+ */
app.get("/info", ah(async (req, res, next) => {
const { clientVersion } = config;