docs(rpc): update the deshieldfunds method

zenith-openrpc.json

@@ -732,7 +732,7 @@
     {
       "name": "deshieldfunds",
       "summary": "De-shield the given amount of ZEC from the given account",
-      "description": "",
+      "description": "Creates a new internal transaction with the requested amount of ZEC to the transparent pool.",
       "tags": [{ "$ref": "#/components/tags/draft"}, { "$ref": "#/components/tags/wip"}],
       "params": [
         { "$ref": "#/components/contentDescriptors/AccountId"},
@@ -740,12 +740,52 @@
       ],
       "paramStructure": "by-position",
       "result": {
-        "name": "Operation ID(s)",
+        "name": "Operation ID",
         "schema": {
-          "type": "array",
-          "items": { "$ref": "#/components/contentDescriptors/OperationId"}
+          "$ref": "#/components/contentDescriptors/OperationId"
         }
       },
+      "examples": [
+        {
+          "name": "De-Shield funds",
+          "summary": "De-shield funds",
+          "description": "Move the given amount of ZEC for the given acount from the shielded pool to the transparent pool",
+          "params": [
+            {
+              "name": "Account index", 
+              "summary": "The index for the account to use",
+              "value": "3"
+            },
+            {
+              "name": "Amount",
+              "summary": "The amount of ZEC to use",
+              "value": 1.23
+            }
+          ],
+          "result": {
+            "name": "Deshield funds result",
+            "value": "ab350df0-9f57-44c0-9e0d-f7b8af1f4231"
+          }
+        },
+        {
+          "name": "No transparent funds",
+          "summary": "Shield transparent notes with no transparent funds",
+          "description": "Attempt to shield the transparent notes in a given account, when account has none",
+          "params": [
+            {
+              "name": "Account index", 
+              "summary": "The index for the account to use",
+              "value": "3"
+            }
+          ],
+          "result": {
+            "name": "ShieldNotes result",
+            "value": [
+              "InsufficientFunds"
+            ]
+          }
+        }
+      ],
       "errors": [
         { "$ref": "#/components/errors/ZebraNotAvailable" },
         { "$ref": "#/components/errors/ZenithBusy" },