Add method descriptions to RPC

This commit is contained in:
Rene Vergara 2024-08-05 15:44:11 -05:00
parent 606c25c2c3
commit dbe352acac
Signed by: pitmutt
GPG key ID: 65122AD495A7F5B2

View file

@ -19,6 +19,8 @@
"methods": [ "methods": [
{ {
"name": "getinfo", "name": "getinfo",
"summary": "Get basic Zenith information",
"description": "Get basic information about Zenith, such as the network it is running on and the version of Zebra it is connected to",
"tags": [ { "$ref": "#/components/tags/information" }], "tags": [ { "$ref": "#/components/tags/information" }],
"result" : { "result" : {
"name": "Zenith information", "name": "Zenith information",
@ -48,6 +50,8 @@
}, },
{ {
"name": "listwallets", "name": "listwallets",
"summary": "Get the list of available wallets",
"description": "Returns a list of available wallets per the network that the Zebra node is running on.",
"tags": [ { "$ref": "#/components/tags/wallet" }], "tags": [ { "$ref": "#/components/tags/wallet" }],
"result": { "result": {
"name": "Wallets", "name": "Wallets",
@ -94,6 +98,8 @@
}, },
{ {
"name": "listaccounts", "name": "listaccounts",
"summary": "DRAFT: List existing accounts for a wallet ID",
"description": "List existing accounts for the given wallet ID or provide an error if none",
"tags": [ { "$ref": "#/components/tags/wallet" }], "tags": [ { "$ref": "#/components/tags/wallet" }],
"result": { "result": {
"name": "Accounts", "name": "Accounts",