From d9e5ad94de157131e36170038025b9d8a8c07ae8 Mon Sep 17 00:00:00 2001 From: Arionum Date: Mon, 6 Aug 2018 00:17:28 +0300 Subject: [PATCH] docs --- doc/api_data.js | 144 +++++++++++++++++++++++++++++++++++++++++++ doc/api_data.json | 144 +++++++++++++++++++++++++++++++++++++++++++ doc/api_project.js | 2 +- doc/api_project.json | 2 +- 4 files changed, 290 insertions(+), 2 deletions(-) diff --git a/doc/api_data.js b/doc/api_data.js index d6b50a6..e2767bc 100644 --- a/doc/api_data.js +++ b/doc/api_data.js @@ -101,6 +101,57 @@ define({ "api": [ "filename": "./api.php", "groupTitle": "API" }, + { + "type": "get", + "url": "/api.php?q=checkSignature", + "title": "17. checkSignature", + "name": "checkSignature", + "group": "API", + "description": "

Checks a signature against a public key

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "public_key", + "description": "

Public key

" + }, + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "signature", + "description": "

signature

" + }, + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "data", + "description": "

signed data

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

true or false

" + } + ] + } + }, + "version": "0.0.0", + "filename": "./api.php", + "groupTitle": "API" + }, { "type": "get", "url": "/api.php?q=currentBlock", @@ -249,6 +300,50 @@ define({ "api": [ "filename": "./api.php", "groupTitle": "API" }, + { + "type": "get", + "url": "/api.php?q=getAlias", + "title": "189. getAlias", + "name": "getAlias", + "group": "API", + "description": "

Returns the alias of an account

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "public_key", + "description": "

Public key

" + }, + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "account", + "description": "

Account id / address

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

alias

" + } + ] + } + }, + "version": "0.0.0", + "filename": "./api.php", + "groupTitle": "API" + }, { "type": "get", "url": "/api.php?q=getBalance", @@ -272,6 +367,13 @@ define({ "api": [ "optional": true, "field": "account", "description": "

Account id / address

" + }, + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "alias", + "description": "

alias

" } ] } @@ -865,6 +967,30 @@ define({ "api": [ "filename": "./api.php", "groupTitle": "API" }, + { + "type": "get", + "url": "/api.php?q=masternodes", + "title": "18. masternodes", + "name": "masternodes", + "group": "API", + "description": "

Returns all the masternode data

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

masternode date

" + } + ] + } + }, + "version": "0.0.0", + "filename": "./api.php", + "groupTitle": "API" + }, { "type": "get", "url": "/api.php?q=mempoolSize", @@ -1269,6 +1395,24 @@ define({ "api": [ "filename": "./util.php", "groupTitle": "UTIL" }, + { + "type": "php util.php", + "url": "clean-blacklist", + "title": "Clean-Blacklist", + "name": "clean_blacklist", + "group": "UTIL", + "description": "

Removes all the peers from blacklist

", + "examples": [ + { + "title": "Example usage:", + "content": "php util.php clean-blacklist", + "type": "cli" + } + ], + "version": "0.0.0", + "filename": "./util.php", + "groupTitle": "UTIL" + }, { "type": "php util.php", "url": "current", diff --git a/doc/api_data.json b/doc/api_data.json index ea1fcdb..52e4c8c 100644 --- a/doc/api_data.json +++ b/doc/api_data.json @@ -101,6 +101,57 @@ "filename": "./api.php", "groupTitle": "API" }, + { + "type": "get", + "url": "/api.php?q=checkSignature", + "title": "17. checkSignature", + "name": "checkSignature", + "group": "API", + "description": "

Checks a signature against a public key

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "public_key", + "description": "

Public key

" + }, + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "signature", + "description": "

signature

" + }, + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "data", + "description": "

signed data

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

true or false

" + } + ] + } + }, + "version": "0.0.0", + "filename": "./api.php", + "groupTitle": "API" + }, { "type": "get", "url": "/api.php?q=currentBlock", @@ -249,6 +300,50 @@ "filename": "./api.php", "groupTitle": "API" }, + { + "type": "get", + "url": "/api.php?q=getAlias", + "title": "189. getAlias", + "name": "getAlias", + "group": "API", + "description": "

Returns the alias of an account

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "public_key", + "description": "

Public key

" + }, + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "account", + "description": "

Account id / address

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

alias

" + } + ] + } + }, + "version": "0.0.0", + "filename": "./api.php", + "groupTitle": "API" + }, { "type": "get", "url": "/api.php?q=getBalance", @@ -272,6 +367,13 @@ "optional": true, "field": "account", "description": "

Account id / address

" + }, + { + "group": "Parameter", + "type": "string", + "optional": true, + "field": "alias", + "description": "

alias

" } ] } @@ -865,6 +967,30 @@ "filename": "./api.php", "groupTitle": "API" }, + { + "type": "get", + "url": "/api.php?q=masternodes", + "title": "18. masternodes", + "name": "masternodes", + "group": "API", + "description": "

Returns all the masternode data

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

masternode date

" + } + ] + } + }, + "version": "0.0.0", + "filename": "./api.php", + "groupTitle": "API" + }, { "type": "get", "url": "/api.php?q=mempoolSize", @@ -1269,6 +1395,24 @@ "filename": "./util.php", "groupTitle": "UTIL" }, + { + "type": "php util.php", + "url": "clean-blacklist", + "title": "Clean-Blacklist", + "name": "clean_blacklist", + "group": "UTIL", + "description": "

Removes all the peers from blacklist

", + "examples": [ + { + "title": "Example usage:", + "content": "php util.php clean-blacklist", + "type": "cli" + } + ], + "version": "0.0.0", + "filename": "./util.php", + "groupTitle": "UTIL" + }, { "type": "php util.php", "url": "current", diff --git a/doc/api_project.js b/doc/api_project.js index 657dda9..b16aaa2 100644 --- a/doc/api_project.js +++ b/doc/api_project.js @@ -7,7 +7,7 @@ define({ "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2018-05-09T23:01:25.347Z", + "time": "2018-08-05T21:17:14.214Z", "url": "http://apidocjs.com", "version": "0.17.6" } diff --git a/doc/api_project.json b/doc/api_project.json index 361fb2b..6ee5d3e 100644 --- a/doc/api_project.json +++ b/doc/api_project.json @@ -7,7 +7,7 @@ "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2018-05-09T23:01:25.347Z", + "time": "2018-08-05T21:17:14.214Z", "url": "http://apidocjs.com", "version": "0.17.6" }