Vergara_Tech/zenith
Vergara_Tech/zenith
2
0
Fork 0
Code Issues 32 Pull requests Projects Releases 6 Packages Wiki Activity

docs: info for getoperationstatus

Browse source
This commit is contained in:
Rene Vergara 2024-09-04 11:08:00 -05:00
parent dcdf2e8304
commit f780e996e0
Signed by: pitmutt
GPG key ID: 65122AD495A7F5B2
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
zenith-openrpc.json
View file

@ -610,9 +610,9 @@
"params": [{ "$ref": "#/components/contentDescriptors/OperationId"}],
"paramStructure": "by-position",
"result": {
"name": "Operation status",
"name": "Operation",
"schema": {
"type": "string"
"$ref": "#/components/Schemas/Operation"
}
},
"errors": [
@ -747,6 +747,16 @@
"sapling": { "type": "integer", "description": "Confirmed Sapling balance in zats." },
"orchard": { "type": "integer", "description": "Confirmed Orchard balance in zats." }
}
},
"Operation": {
"type": "object",
"properties": {
"uuid": {"type": "string", "description": "Operation Identifier"},
"start": {"type": "string", "description": "The date and time the operation started"},
"end": {"type": ["string", "null"], "description": "The date and time the operation ended. If the operation is still running, this field is null"},
"status": {"type": "string", "enum": ["Processing", "Failed", "Successful"], "description": "If the operation has started it will show Processing, once it completes it will show Failed or Successful depending on the outcome"},
"result": {"type": "string", "description": "For a succesful transaction operation, the transaction ID. For failed operations, the error message"}
}
}
},
"examples": {},