sido/node
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Arionum
2018-08-06 00:17:28 +03:00
parent 8b006fc26a
commit d9e5ad94de
4 changed files with 290 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
doc/api_data.js
View File

@@ -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": "<p>Checks a signature against a public key</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "public_key",
"description": "<p>Public key</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "signature",
"description": "<p>signature</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "data",
"description": "<p>signed data</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "boolean",
"optional": false,
"field": "data",
"description": "<p>true or false</p>"
}
]
}
},
"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": "<p>Returns the alias of an account</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "public_key",
"description": "<p>Public key</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "account",
"description": "<p>Account id / address</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data",
"description": "<p>alias</p>"
}
]
}
},
"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": "<p>Account id / address</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "alias",
"description": "<p>alias</p>"
}
]
}
@@ -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": "<p>Returns all the masternode data</p>",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "boolean",
"optional": false,
"field": "data",
"description": "<p>masternode date</p>"
}
]
}
},
"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": "<p>Removes all the peers from blacklist</p>",
"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",

144
doc/api_data.json
View File

@@ -101,6 +101,57 @@
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=checkSignature",
"title": "17. checkSignature",
"name": "checkSignature",
"group": "API",
"description": "<p>Checks a signature against a public key</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "public_key",
"description": "<p>Public key</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "signature",
"description": "<p>signature</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "data",
"description": "<p>signed data</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "boolean",
"optional": false,
"field": "data",
"description": "<p>true or false</p>"
}
]
}
},
"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": "<p>Returns the alias of an account</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "public_key",
"description": "<p>Public key</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "account",
"description": "<p>Account id / address</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data",
"description": "<p>alias</p>"
}
]
}
},
"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": "<p>Account id / address</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "alias",
"description": "<p>alias</p>"
}
]
}
@@ -865,6 +967,30 @@
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=masternodes",
"title": "18. masternodes",
"name": "masternodes",
"group": "API",
"description": "<p>Returns all the masternode data</p>",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "boolean",
"optional": false,
"field": "data",
"description": "<p>masternode date</p>"
}
]
}
},
"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": "<p>Removes all the peers from blacklist</p>",
"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",

2
doc/api_project.js
View File

@@ -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"
}

2
doc/api_project.json
View File

@@ -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"
}