aboutsummaryrefslogtreecommitdiffstats
path: root/routes
diff options
context:
space:
mode:
authorAdrien Hopkins <[email protected]>2021-08-18 14:22:32 -0500
committerAdam Soltys <[email protected]>2021-08-30 16:04:48 -0700
commit4d2b17ca203c389b4ed678007377a0fd93b889eb (patch)
treeac4b238201b2166934290a3668aa50e69b0c9c98 /routes
parente8d703a78577abc4df8af4747a6408474a848450 (diff)
downloadcoinos-server-4d2b17ca203c389b4ed678007377a0fd93b889eb.tar.gz
coinos-server-4d2b17ca203c389b4ed678007377a0fd93b889eb.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;