docs(rpc): add placeholder for getincomingvk
This commit is contained in:
parent
e3797f2494
commit
4d8fb534f4
1 changed files with 39 additions and 0 deletions
|
@ -831,6 +831,45 @@
|
|||
"errors": [
|
||||
{ "$ref": "#/components/errors/InvalidAccount" }
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "getincomingvk",
|
||||
"summary": "Get the incoming viewing key for the given account.",
|
||||
"description": "Derives the incoming viewing key for the given account per ZIP-316.",
|
||||
"tags": [
|
||||
{ "$ref": "#/components/tags/draft"}
|
||||
],
|
||||
"params": [
|
||||
{ "$ref": "#/components/contentDescriptors/AccountId"}
|
||||
],
|
||||
"paramStructure": "by-position",
|
||||
"result": {
|
||||
"name": "Full viewing key",
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ViewingKey"
|
||||
}
|
||||
},
|
||||
"examples": [
|
||||
{
|
||||
"name": "Get incoming viewing key",
|
||||
"summary": "Get the incoming viewing key",
|
||||
"description": "Get the incoming viewing key for the give account, encoded per ZIP-316",
|
||||
"params": [
|
||||
{
|
||||
"name": "Account index",
|
||||
"summary": "The index for the account to use",
|
||||
"value": 1
|
||||
}
|
||||
],
|
||||
"result": {
|
||||
"name": "Incoming Viewing key",
|
||||
"value": "uivk199qcjxrj73n7fapg79a2ltah6f3j83haljcux5t5kvn5unn7rpfmvglttdt9g6na3llkefnd3pn0x9ky6lh8s42trj0vfg5wtv0nrerq0wsq5v4q7lt5j4l9svppspr6h7407ztgsuvkfk977c3tj408nx5phxap8fn3ecdmdrah9spp76md9tel89tuqz6m0xplqp83wj33qf7s3hwfe79t04rq49g24nr3emlpm298wpqla2dvh4rr584kwdtxc9ahse5x0drcjr95tt4k0hxr32l6yturje7dptlgjnr4cm6uk29ysu9l5xwgz40p6alyedzzqltqf5nswy48ekru4ahapw"
|
||||
}
|
||||
}
|
||||
],
|
||||
"errors": [
|
||||
{ "$ref": "#/components/errors/InvalidAccount" }
|
||||
]
|
||||
}
|
||||
],
|
||||
"components": {
|
||||
|
|
Loading…
Reference in a new issue