Add a description of the shortfall object in errNotEnoughMoney.

In response to review feedback: #4348 (comment)
cardano-foundation · Dec 22, 2023 · 0432db5 · 0432db5
1 parent 885a999
commit 0432db5
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/specifications/api/swagger.yaml b/specifications/api/swagger.yaml
@@ -4461,8 +4461,11 @@ x-errNotEnoughMoney: &errNotEnoughMoney
     message:
       type: string
       description: |
-        Indicates that there's not enough money in the wallet to cover a
-        requested payment.
+        Indicates that there's not enough money in the wallet for the operation
+        to succeed.
+
+        The 'shortfall' object indicates the additional quantity of each asset
+        that would be needed in order for the operation to succeed.
     code:
       type: string
       enum: ['not_enough_money']
@@ -4472,6 +4475,9 @@ x-errNotEnoughMoney: &errNotEnoughMoney
         - shortfall
       properties:
         shortfall:
+          description: |
+            The additional quantity of each asset that would be needed in order
+            for the operation to succeed.
           type: object
           required:
             - ada