From 4d2b17ca203c389b4ed678007377a0fd93b889eb Mon Sep 17 00:00:00 2001 From: Adrien Hopkins Date: Wed, 18 Aug 2021 14:22:32 -0500 Subject: Documented /api/info --- routes/info.js | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'routes') 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; -- cgit v1.2.3