docs(rpc): add params and result to shieldnotes

This commit is contained in:
Rene Vergara 2024-12-09 08:47:32 -06:00
parent 9e3eeee78e
commit e91fe22473
Signed by: pitmutt
SSH key fingerprint: SHA256:vNa8FIqbBZjV9hOCkXyOzd7gqWCMCfkcfiPH2zaGfQ0

View file

@ -675,18 +675,28 @@
"summary": "Shield all transparent notes into the Orchard pool for the given account", "summary": "Shield all transparent notes into the Orchard pool for the given account",
"description": "Creates one or more transactions, grouping all the unspent transparent notes for the given account by their transparent address to avoid associating different transparent addresses. These notes are sent to the given account's internal change address as shielded Orchard notes.", "description": "Creates one or more transactions, grouping all the unspent transparent notes for the given account by their transparent address to avoid associating different transparent addresses. These notes are sent to the given account's internal change address as shielded Orchard notes.",
"tags": [{ "$ref": "#/components/tags/draft"}, { "$ref": "#/components/tags/wip"}], "tags": [{ "$ref": "#/components/tags/draft"}, { "$ref": "#/components/tags/wip"}],
"params": [], "params": [
{ "$ref": "#/components/contentDescriptors/AccountId"}
],
"paramStructure": "by-position", "paramStructure": "by-position",
"result": { "result": {
"name": "Operation ID(s)",
"schema": {
"type": "array",
"items": { "$ref": "#/components/contentDescriptors/OperationId"}
}
}, },
"errors": [ "errors": [
{ "$ref": "#/components/errors/ZebraNotAvailable" },
{ "$ref": "#/components/errors/ZenithBusy" },
{ "$ref": "#/components/errors/InvalidAccount" }
] ]
}, },
{ {
"name": "deshieldfunds", "name": "deshieldfunds",
"summary": "De-shield the given amount of ZEC from the given account", "summary": "De-shield the given amount of ZEC from the given account",
"description": "", "description": "",
"tags": [], "tags": [{ "$ref": "#/components/tags/draft"}],
"params": [], "params": [],
"paramStructure": "by-position", "paramStructure": "by-position",
"result": { "result": {