docs: info for getoperationstatus
This commit is contained in:
parent
dcdf2e8304
commit
f780e996e0
1 changed files with 12 additions and 2 deletions
|
@ -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": {},
|
||||
|
|
Loading…
Reference in a new issue