diff --git a/doc/api_data.js b/doc/api_data.js index e2767bc..754125c 100644 --- a/doc/api_data.js +++ b/doc/api_data.js @@ -303,7 +303,7 @@ define({ "api": [ { "type": "get", "url": "/api.php?q=getAlias", - "title": "189. getAlias", + "title": "19. getAlias", "name": "getAlias", "group": "API", "description": "

Returns the alias of an account

", @@ -1015,6 +1015,79 @@ define({ "api": [ "filename": "./api.php", "groupTitle": "API" }, + { + "type": "get", + "url": "/api.php?q=node-info", + "title": "21. node-info", + "name": "node_info", + "group": "API", + "description": "

Returns details about the node.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "object", + "optional": false, + "field": "data", + "description": "

A collection of data about the node.

" + }, + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "data.hostname", + "description": "

The hostname of the node.

" + }, + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "data.version", + "description": "

The current version of the node.

" + }, + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "data.dbversion", + "description": "

The database schema version for the node.

" + }, + { + "group": "Success 200", + "type": "number", + "optional": false, + "field": "data.accounts", + "description": "

The number of accounts known by the node.

" + }, + { + "group": "Success 200", + "type": "number", + "optional": false, + "field": "data.transactions", + "description": "

The number of transactions known by the node.

" + }, + { + "group": "Success 200", + "type": "number", + "optional": false, + "field": "data.mempool", + "description": "

The number of transactions in the mempool.

" + }, + { + "group": "Success 200", + "type": "number", + "optional": false, + "field": "data.masternodes", + "description": "

The number of masternodes known by the node.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "./api.php", + "groupTitle": "API" + }, { "type": "get", "url": "/api.php?q=randomNumber", @@ -1073,6 +1146,51 @@ define({ "api": [ "filename": "./api.php", "groupTitle": "API" }, + { + "type": "get", + "url": "/api.php?q=sanity", + "title": "20. sanity", + "name": "sanity", + "group": "API", + "description": "

Returns details about the node's sanity process.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "object", + "optional": false, + "field": "data", + "description": "

A collection of data about the sanity process.

" + }, + { + "group": "Success 200", + "type": "boolean", + "optional": false, + "field": "data.sanity_running", + "description": "

Whether the sanity process is currently running.

" + }, + { + "group": "Success 200", + "type": "number", + "optional": false, + "field": "data.last_sanity", + "description": "

The timestamp for the last time the sanity process was run.

" + }, + { + "group": "Success 200", + "type": "boolean", + "optional": false, + "field": "data.sanity_sync", + "description": "

Whether the sanity process is currently synchronising.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "./api.php", + "groupTitle": "API" + }, { "type": "get", "url": "/api.php?q=send", @@ -1183,6 +1301,34 @@ define({ "api": [ "filename": "./api.php", "groupTitle": "API" }, + { + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "optional": false, + "field": "varname1", + "description": "

No type.

" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "varname2", + "description": "

With type.

" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "./doc/main.js", + "group": "C__Users_owen_voke_Documents_GitHub_php_arionum_node_doc_main_js", + "groupTitle": "C__Users_owen_voke_Documents_GitHub_php_arionum_node_doc_main_js", + "name": "" + }, { "type": "php util.php", "url": "balance", @@ -1689,33 +1835,5 @@ define({ "api": [ "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" - }, - { - "success": { - "fields": { - "Success 200": [ - { - "group": "Success 200", - "optional": false, - "field": "varname1", - "description": "

No type.

" - }, - { - "group": "Success 200", - "type": "String", - "optional": false, - "field": "varname2", - "description": "

With type.

" - } - ] - } - }, - "type": "", - "url": "", - "version": "0.0.0", - "filename": "./doc/main.js", - "group": "_github_node_doc_main_js", - "groupTitle": "_github_node_doc_main_js", - "name": "" } ] }); diff --git a/doc/api_data.json b/doc/api_data.json index 52e4c8c..c5a722d 100644 --- a/doc/api_data.json +++ b/doc/api_data.json @@ -303,7 +303,7 @@ { "type": "get", "url": "/api.php?q=getAlias", - "title": "189. getAlias", + "title": "19. getAlias", "name": "getAlias", "group": "API", "description": "

Returns the alias of an account

", @@ -1015,6 +1015,79 @@ "filename": "./api.php", "groupTitle": "API" }, + { + "type": "get", + "url": "/api.php?q=node-info", + "title": "21. node-info", + "name": "node_info", + "group": "API", + "description": "

Returns details about the node.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "object", + "optional": false, + "field": "data", + "description": "

A collection of data about the node.

" + }, + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "data.hostname", + "description": "

The hostname of the node.

" + }, + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "data.version", + "description": "

The current version of the node.

" + }, + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "data.dbversion", + "description": "

The database schema version for the node.

" + }, + { + "group": "Success 200", + "type": "number", + "optional": false, + "field": "data.accounts", + "description": "

The number of accounts known by the node.

" + }, + { + "group": "Success 200", + "type": "number", + "optional": false, + "field": "data.transactions", + "description": "

The number of transactions known by the node.

" + }, + { + "group": "Success 200", + "type": "number", + "optional": false, + "field": "data.mempool", + "description": "

The number of transactions in the mempool.

" + }, + { + "group": "Success 200", + "type": "number", + "optional": false, + "field": "data.masternodes", + "description": "

The number of masternodes known by the node.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "./api.php", + "groupTitle": "API" + }, { "type": "get", "url": "/api.php?q=randomNumber", @@ -1073,6 +1146,51 @@ "filename": "./api.php", "groupTitle": "API" }, + { + "type": "get", + "url": "/api.php?q=sanity", + "title": "20. sanity", + "name": "sanity", + "group": "API", + "description": "

Returns details about the node's sanity process.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "object", + "optional": false, + "field": "data", + "description": "

A collection of data about the sanity process.

" + }, + { + "group": "Success 200", + "type": "boolean", + "optional": false, + "field": "data.sanity_running", + "description": "

Whether the sanity process is currently running.

" + }, + { + "group": "Success 200", + "type": "number", + "optional": false, + "field": "data.last_sanity", + "description": "

The timestamp for the last time the sanity process was run.

" + }, + { + "group": "Success 200", + "type": "boolean", + "optional": false, + "field": "data.sanity_sync", + "description": "

Whether the sanity process is currently synchronising.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "./api.php", + "groupTitle": "API" + }, { "type": "get", "url": "/api.php?q=send", @@ -1183,6 +1301,34 @@ "filename": "./api.php", "groupTitle": "API" }, + { + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "optional": false, + "field": "varname1", + "description": "

No type.

" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "varname2", + "description": "

With type.

" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "./doc/main.js", + "group": "C__Users_owen_voke_Documents_GitHub_php_arionum_node_doc_main_js", + "groupTitle": "C__Users_owen_voke_Documents_GitHub_php_arionum_node_doc_main_js", + "name": "" + }, { "type": "php util.php", "url": "balance", @@ -1689,33 +1835,5 @@ "version": "0.0.0", "filename": "./util.php", "groupTitle": "UTIL" - }, - { - "success": { - "fields": { - "Success 200": [ - { - "group": "Success 200", - "optional": false, - "field": "varname1", - "description": "

No type.

" - }, - { - "group": "Success 200", - "type": "String", - "optional": false, - "field": "varname2", - "description": "

With type.

" - } - ] - } - }, - "type": "", - "url": "", - "version": "0.0.0", - "filename": "./doc/main.js", - "group": "_github_node_doc_main_js", - "groupTitle": "_github_node_doc_main_js", - "name": "" } ] diff --git a/doc/api_project.js b/doc/api_project.js index b16aaa2..7485b95 100644 --- a/doc/api_project.js +++ b/doc/api_project.js @@ -1,13 +1,14 @@ define({ - "name": "", + "name": "Arionum Node", "version": "0.0.0", - "description": "", + "description": "The Arionum Node API and utility documentation.", + "title": "Arionum Node", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2018-08-05T21:17:14.214Z", + "time": "2018-10-12T11:08:47.065Z", "url": "http://apidocjs.com", "version": "0.17.6" } diff --git a/doc/api_project.json b/doc/api_project.json index 6ee5d3e..b9f6676 100644 --- a/doc/api_project.json +++ b/doc/api_project.json @@ -1,13 +1,14 @@ { - "name": "", + "name": "Arionum Node", "version": "0.0.0", - "description": "", + "description": "The Arionum Node API and utility documentation.", + "title": "Arionum Node", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2018-08-05T21:17:14.214Z", + "time": "2018-10-12T11:08:47.065Z", "url": "http://apidocjs.com", "version": "0.17.6" }