Update the API documentation output
This commit is contained in:
		
							
								
								
									
										176
									
								
								doc/api_data.js
									
									
									
									
									
								
							
							
						
						
									
										176
									
								
								doc/api_data.js
									
									
									
									
									
								
							| @@ -303,7 +303,7 @@ define({ "api": [ | |||||||
|   { |   { | ||||||
|     "type": "get", |     "type": "get", | ||||||
|     "url": "/api.php?q=getAlias", |     "url": "/api.php?q=getAlias", | ||||||
|     "title": "189. getAlias", |     "title": "19. getAlias", | ||||||
|     "name": "getAlias", |     "name": "getAlias", | ||||||
|     "group": "API", |     "group": "API", | ||||||
|     "description": "<p>Returns the alias of an account</p>", |     "description": "<p>Returns the alias of an account</p>", | ||||||
| @@ -1015,6 +1015,79 @@ define({ "api": [ | |||||||
|     "filename": "./api.php", |     "filename": "./api.php", | ||||||
|     "groupTitle": "API" |     "groupTitle": "API" | ||||||
|   }, |   }, | ||||||
|  |   { | ||||||
|  |     "type": "get", | ||||||
|  |     "url": "/api.php?q=node-info", | ||||||
|  |     "title": "21. node-info", | ||||||
|  |     "name": "node_info", | ||||||
|  |     "group": "API", | ||||||
|  |     "description": "<p>Returns details about the node.</p>", | ||||||
|  |     "success": { | ||||||
|  |       "fields": { | ||||||
|  |         "Success 200": [ | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "object", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data", | ||||||
|  |             "description": "<p>A collection of data about the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "string", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.hostname", | ||||||
|  |             "description": "<p>The hostname of the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "string", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.version", | ||||||
|  |             "description": "<p>The current version of the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "string", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.dbversion", | ||||||
|  |             "description": "<p>The database schema version for the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "number", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.accounts", | ||||||
|  |             "description": "<p>The number of accounts known by the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "number", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.transactions", | ||||||
|  |             "description": "<p>The number of transactions known by the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "number", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.mempool", | ||||||
|  |             "description": "<p>The number of transactions in the mempool.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "number", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.masternodes", | ||||||
|  |             "description": "<p>The number of masternodes known by the node.</p>" | ||||||
|  |           } | ||||||
|  |         ] | ||||||
|  |       } | ||||||
|  |     }, | ||||||
|  |     "version": "0.0.0", | ||||||
|  |     "filename": "./api.php", | ||||||
|  |     "groupTitle": "API" | ||||||
|  |   }, | ||||||
|   { |   { | ||||||
|     "type": "get", |     "type": "get", | ||||||
|     "url": "/api.php?q=randomNumber", |     "url": "/api.php?q=randomNumber", | ||||||
| @@ -1073,6 +1146,51 @@ define({ "api": [ | |||||||
|     "filename": "./api.php", |     "filename": "./api.php", | ||||||
|     "groupTitle": "API" |     "groupTitle": "API" | ||||||
|   }, |   }, | ||||||
|  |   { | ||||||
|  |     "type": "get", | ||||||
|  |     "url": "/api.php?q=sanity", | ||||||
|  |     "title": "20. sanity", | ||||||
|  |     "name": "sanity", | ||||||
|  |     "group": "API", | ||||||
|  |     "description": "<p>Returns details about the node's sanity process.</p>", | ||||||
|  |     "success": { | ||||||
|  |       "fields": { | ||||||
|  |         "Success 200": [ | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "object", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data", | ||||||
|  |             "description": "<p>A collection of data about the sanity process.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "boolean", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.sanity_running", | ||||||
|  |             "description": "<p>Whether the sanity process is currently running.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "number", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.last_sanity", | ||||||
|  |             "description": "<p>The timestamp for the last time the sanity process was run.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "boolean", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.sanity_sync", | ||||||
|  |             "description": "<p>Whether the sanity process is currently synchronising.</p>" | ||||||
|  |           } | ||||||
|  |         ] | ||||||
|  |       } | ||||||
|  |     }, | ||||||
|  |     "version": "0.0.0", | ||||||
|  |     "filename": "./api.php", | ||||||
|  |     "groupTitle": "API" | ||||||
|  |   }, | ||||||
|   { |   { | ||||||
|     "type": "get", |     "type": "get", | ||||||
|     "url": "/api.php?q=send", |     "url": "/api.php?q=send", | ||||||
| @@ -1183,6 +1301,34 @@ define({ "api": [ | |||||||
|     "filename": "./api.php", |     "filename": "./api.php", | ||||||
|     "groupTitle": "API" |     "groupTitle": "API" | ||||||
|   }, |   }, | ||||||
|  |   { | ||||||
|  |     "success": { | ||||||
|  |       "fields": { | ||||||
|  |         "Success 200": [ | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "varname1", | ||||||
|  |             "description": "<p>No type.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "String", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "varname2", | ||||||
|  |             "description": "<p>With type.</p>" | ||||||
|  |           } | ||||||
|  |         ] | ||||||
|  |       } | ||||||
|  |     }, | ||||||
|  |     "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", |     "type": "php util.php", | ||||||
|     "url": "balance", |     "url": "balance", | ||||||
| @@ -1689,33 +1835,5 @@ define({ "api": [ | |||||||
|     "version": "0.0.0", |     "version": "0.0.0", | ||||||
|     "filename": "./util.php", |     "filename": "./util.php", | ||||||
|     "groupTitle": "UTIL" |     "groupTitle": "UTIL" | ||||||
|   }, |  | ||||||
|   { |  | ||||||
|     "success": { |  | ||||||
|       "fields": { |  | ||||||
|         "Success 200": [ |  | ||||||
|           { |  | ||||||
|             "group": "Success 200", |  | ||||||
|             "optional": false, |  | ||||||
|             "field": "varname1", |  | ||||||
|             "description": "<p>No type.</p>" |  | ||||||
|           }, |  | ||||||
|           { |  | ||||||
|             "group": "Success 200", |  | ||||||
|             "type": "String", |  | ||||||
|             "optional": false, |  | ||||||
|             "field": "varname2", |  | ||||||
|             "description": "<p>With type.</p>" |  | ||||||
|           } |  | ||||||
|         ] |  | ||||||
|       } |  | ||||||
|     }, |  | ||||||
|     "type": "", |  | ||||||
|     "url": "", |  | ||||||
|     "version": "0.0.0", |  | ||||||
|     "filename": "./doc/main.js", |  | ||||||
|     "group": "_github_node_doc_main_js", |  | ||||||
|     "groupTitle": "_github_node_doc_main_js", |  | ||||||
|     "name": "" |  | ||||||
|   } |   } | ||||||
| ] }); | ] }); | ||||||
|   | |||||||
| @@ -303,7 +303,7 @@ | |||||||
|   { |   { | ||||||
|     "type": "get", |     "type": "get", | ||||||
|     "url": "/api.php?q=getAlias", |     "url": "/api.php?q=getAlias", | ||||||
|     "title": "189. getAlias", |     "title": "19. getAlias", | ||||||
|     "name": "getAlias", |     "name": "getAlias", | ||||||
|     "group": "API", |     "group": "API", | ||||||
|     "description": "<p>Returns the alias of an account</p>", |     "description": "<p>Returns the alias of an account</p>", | ||||||
| @@ -1015,6 +1015,79 @@ | |||||||
|     "filename": "./api.php", |     "filename": "./api.php", | ||||||
|     "groupTitle": "API" |     "groupTitle": "API" | ||||||
|   }, |   }, | ||||||
|  |   { | ||||||
|  |     "type": "get", | ||||||
|  |     "url": "/api.php?q=node-info", | ||||||
|  |     "title": "21. node-info", | ||||||
|  |     "name": "node_info", | ||||||
|  |     "group": "API", | ||||||
|  |     "description": "<p>Returns details about the node.</p>", | ||||||
|  |     "success": { | ||||||
|  |       "fields": { | ||||||
|  |         "Success 200": [ | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "object", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data", | ||||||
|  |             "description": "<p>A collection of data about the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "string", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.hostname", | ||||||
|  |             "description": "<p>The hostname of the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "string", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.version", | ||||||
|  |             "description": "<p>The current version of the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "string", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.dbversion", | ||||||
|  |             "description": "<p>The database schema version for the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "number", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.accounts", | ||||||
|  |             "description": "<p>The number of accounts known by the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "number", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.transactions", | ||||||
|  |             "description": "<p>The number of transactions known by the node.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "number", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.mempool", | ||||||
|  |             "description": "<p>The number of transactions in the mempool.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "number", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.masternodes", | ||||||
|  |             "description": "<p>The number of masternodes known by the node.</p>" | ||||||
|  |           } | ||||||
|  |         ] | ||||||
|  |       } | ||||||
|  |     }, | ||||||
|  |     "version": "0.0.0", | ||||||
|  |     "filename": "./api.php", | ||||||
|  |     "groupTitle": "API" | ||||||
|  |   }, | ||||||
|   { |   { | ||||||
|     "type": "get", |     "type": "get", | ||||||
|     "url": "/api.php?q=randomNumber", |     "url": "/api.php?q=randomNumber", | ||||||
| @@ -1073,6 +1146,51 @@ | |||||||
|     "filename": "./api.php", |     "filename": "./api.php", | ||||||
|     "groupTitle": "API" |     "groupTitle": "API" | ||||||
|   }, |   }, | ||||||
|  |   { | ||||||
|  |     "type": "get", | ||||||
|  |     "url": "/api.php?q=sanity", | ||||||
|  |     "title": "20. sanity", | ||||||
|  |     "name": "sanity", | ||||||
|  |     "group": "API", | ||||||
|  |     "description": "<p>Returns details about the node's sanity process.</p>", | ||||||
|  |     "success": { | ||||||
|  |       "fields": { | ||||||
|  |         "Success 200": [ | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "object", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data", | ||||||
|  |             "description": "<p>A collection of data about the sanity process.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "boolean", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.sanity_running", | ||||||
|  |             "description": "<p>Whether the sanity process is currently running.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "number", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.last_sanity", | ||||||
|  |             "description": "<p>The timestamp for the last time the sanity process was run.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "boolean", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "data.sanity_sync", | ||||||
|  |             "description": "<p>Whether the sanity process is currently synchronising.</p>" | ||||||
|  |           } | ||||||
|  |         ] | ||||||
|  |       } | ||||||
|  |     }, | ||||||
|  |     "version": "0.0.0", | ||||||
|  |     "filename": "./api.php", | ||||||
|  |     "groupTitle": "API" | ||||||
|  |   }, | ||||||
|   { |   { | ||||||
|     "type": "get", |     "type": "get", | ||||||
|     "url": "/api.php?q=send", |     "url": "/api.php?q=send", | ||||||
| @@ -1183,6 +1301,34 @@ | |||||||
|     "filename": "./api.php", |     "filename": "./api.php", | ||||||
|     "groupTitle": "API" |     "groupTitle": "API" | ||||||
|   }, |   }, | ||||||
|  |   { | ||||||
|  |     "success": { | ||||||
|  |       "fields": { | ||||||
|  |         "Success 200": [ | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "varname1", | ||||||
|  |             "description": "<p>No type.</p>" | ||||||
|  |           }, | ||||||
|  |           { | ||||||
|  |             "group": "Success 200", | ||||||
|  |             "type": "String", | ||||||
|  |             "optional": false, | ||||||
|  |             "field": "varname2", | ||||||
|  |             "description": "<p>With type.</p>" | ||||||
|  |           } | ||||||
|  |         ] | ||||||
|  |       } | ||||||
|  |     }, | ||||||
|  |     "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", |     "type": "php util.php", | ||||||
|     "url": "balance", |     "url": "balance", | ||||||
| @@ -1689,33 +1835,5 @@ | |||||||
|     "version": "0.0.0", |     "version": "0.0.0", | ||||||
|     "filename": "./util.php", |     "filename": "./util.php", | ||||||
|     "groupTitle": "UTIL" |     "groupTitle": "UTIL" | ||||||
|   }, |  | ||||||
|   { |  | ||||||
|     "success": { |  | ||||||
|       "fields": { |  | ||||||
|         "Success 200": [ |  | ||||||
|           { |  | ||||||
|             "group": "Success 200", |  | ||||||
|             "optional": false, |  | ||||||
|             "field": "varname1", |  | ||||||
|             "description": "<p>No type.</p>" |  | ||||||
|           }, |  | ||||||
|           { |  | ||||||
|             "group": "Success 200", |  | ||||||
|             "type": "String", |  | ||||||
|             "optional": false, |  | ||||||
|             "field": "varname2", |  | ||||||
|             "description": "<p>With type.</p>" |  | ||||||
|           } |  | ||||||
|         ] |  | ||||||
|       } |  | ||||||
|     }, |  | ||||||
|     "type": "", |  | ||||||
|     "url": "", |  | ||||||
|     "version": "0.0.0", |  | ||||||
|     "filename": "./doc/main.js", |  | ||||||
|     "group": "_github_node_doc_main_js", |  | ||||||
|     "groupTitle": "_github_node_doc_main_js", |  | ||||||
|     "name": "" |  | ||||||
|   } |   } | ||||||
| ] | ] | ||||||
|   | |||||||
| @@ -1,13 +1,14 @@ | |||||||
| define({ | define({ | ||||||
|   "name": "", |   "name": "Arionum Node", | ||||||
|   "version": "0.0.0", |   "version": "0.0.0", | ||||||
|   "description": "", |   "description": "The Arionum Node API and utility documentation.", | ||||||
|  |   "title": "Arionum Node", | ||||||
|   "sampleUrl": false, |   "sampleUrl": false, | ||||||
|   "defaultVersion": "0.0.0", |   "defaultVersion": "0.0.0", | ||||||
|   "apidoc": "0.3.0", |   "apidoc": "0.3.0", | ||||||
|   "generator": { |   "generator": { | ||||||
|     "name": "apidoc", |     "name": "apidoc", | ||||||
|     "time": "2018-08-05T21:17:14.214Z", |     "time": "2018-10-12T11:08:47.065Z", | ||||||
|     "url": "http://apidocjs.com", |     "url": "http://apidocjs.com", | ||||||
|     "version": "0.17.6" |     "version": "0.17.6" | ||||||
|   } |   } | ||||||
|   | |||||||
| @@ -1,13 +1,14 @@ | |||||||
| { | { | ||||||
|   "name": "", |   "name": "Arionum Node", | ||||||
|   "version": "0.0.0", |   "version": "0.0.0", | ||||||
|   "description": "", |   "description": "The Arionum Node API and utility documentation.", | ||||||
|  |   "title": "Arionum Node", | ||||||
|   "sampleUrl": false, |   "sampleUrl": false, | ||||||
|   "defaultVersion": "0.0.0", |   "defaultVersion": "0.0.0", | ||||||
|   "apidoc": "0.3.0", |   "apidoc": "0.3.0", | ||||||
|   "generator": { |   "generator": { | ||||||
|     "name": "apidoc", |     "name": "apidoc", | ||||||
|     "time": "2018-08-05T21:17:14.214Z", |     "time": "2018-10-12T11:08:47.065Z", | ||||||
|     "url": "http://apidocjs.com", |     "url": "http://apidocjs.com", | ||||||
|     "version": "0.17.6" |     "version": "0.17.6" | ||||||
|   } |   } | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user
	 pxgamer
					pxgamer