diff options
| author | Adrien Hopkins <[email protected]> | 2021-08-18 14:22:32 -0500 |
|---|---|---|
| committer | Adam Soltys <[email protected]> | 2021-08-30 16:04:48 -0700 |
| commit | 4d2b17ca203c389b4ed678007377a0fd93b889eb (patch) | |
| tree | ac4b238201b2166934290a3668aa50e69b0c9c98 /apidoc | |
| parent | e8d703a78577abc4df8af4747a6408474a848450 (diff) | |
| download | coinos-server-4d2b17ca203c389b4ed678007377a0fd93b889eb.tar.gz coinos-server-4d2b17ca203c389b4ed678007377a0fd93b889eb.zip | |
Documented /api/info
Diffstat (limited to 'apidoc')
| -rw-r--r-- | apidoc/api_data.js | 37 | ||||
| -rw-r--r-- | apidoc/api_data.json | 37 | ||||
| -rw-r--r-- | apidoc/api_project.js | 2 | ||||
| -rw-r--r-- | apidoc/api_project.json | 2 |
4 files changed, 76 insertions, 2 deletions
diff --git a/apidoc/api_data.js b/apidoc/api_data.js index 961f82a7..63c793fa 100644 --- a/apidoc/api_data.js +++ b/apidoc/api_data.js @@ -375,6 +375,43 @@ define({ "api": [ "groupTitle": "Admin" }, { + "type": "get", + "url": "/info", + "title": "Request server information", + "name": "GetInfo", + "group": "Info", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "fx", + "description": "<p>Exchange rates relative to USD - fx.CUR is the value of one CUR in USD.</p>" + }, + { + "group": "Success 200", + "type": "String[]", + "optional": false, + "field": "networks", + "description": "<p>Array of supported networks; possible values are "bitcoin", "liquid" and "lightning".</p>" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "clientVersion", + "description": "<p>the current git commit of the ui</p>" + } + ] + } + }, + "version": "0.0.0", + "filename": "routes/info.js", + "groupTitle": "Info" + }, + { "type": "post", "url": "/grant", "title": "Grant Referral code", diff --git a/apidoc/api_data.json b/apidoc/api_data.json index 180cbe16..5bab3ee7 100644 --- a/apidoc/api_data.json +++ b/apidoc/api_data.json @@ -375,6 +375,43 @@ "groupTitle": "Admin" }, { + "type": "get", + "url": "/info", + "title": "Request server information", + "name": "GetInfo", + "group": "Info", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "fx", + "description": "<p>Exchange rates relative to USD - fx.CUR is the value of one CUR in USD.</p>" + }, + { + "group": "Success 200", + "type": "String[]", + "optional": false, + "field": "networks", + "description": "<p>Array of supported networks; possible values are "bitcoin", "liquid" and "lightning".</p>" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "clientVersion", + "description": "<p>the current git commit of the ui</p>" + } + ] + } + }, + "version": "0.0.0", + "filename": "routes/info.js", + "groupTitle": "Info" + }, + { "type": "post", "url": "/grant", "title": "Grant Referral code", diff --git a/apidoc/api_project.js b/apidoc/api_project.js index ef1b3f4c..b382cf76 100644 --- a/apidoc/api_project.js +++ b/apidoc/api_project.js @@ -9,7 +9,7 @@ define({ "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2021-08-18T18:43:04.642Z", + "time": "2021-08-18T19:13:24.486Z", "url": "https://apidocjs.com", "version": "0.29.0" } diff --git a/apidoc/api_project.json b/apidoc/api_project.json index 828595f0..42943876 100644 --- a/apidoc/api_project.json +++ b/apidoc/api_project.json @@ -9,7 +9,7 @@ "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2021-08-18T18:43:04.642Z", + "time": "2021-08-18T19:13:24.486Z", "url": "https://apidocjs.com", "version": "0.29.0" } |