From f780e996e0c6b9c99ad7c1e4f3b8ed3dd2943ee9 Mon Sep 17 00:00:00 2001 From: Rene Vergara Date: Wed, 4 Sep 2024 11:08:00 -0500 Subject: [PATCH] docs: info for getoperationstatus --- zenith-openrpc.json | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/zenith-openrpc.json b/zenith-openrpc.json index 47a9da1..6afd49b 100644 --- a/zenith-openrpc.json +++ b/zenith-openrpc.json @@ -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": {},