Skip to content

Commit

Permalink
Clarify API docs for transactions-balance fields inputs & `redeem…
Browse files Browse the repository at this point in the history
…ers` (#4684)

- Document recent changes to the `transactions-balance` `inputs` field
(#4630 )
- Clarify semantics of the `transactions-balance` `redeemers` field

### Rendered

<img width="739" alt="Skärmavbild 2024-07-16 kl 16 55 27"
src="https://github.com/user-attachments/assets/9b92879b-e11e-4d80-9c04-7f2e4f7cdae2">
  • Loading branch information
Anviking committed Jul 17, 2024
2 parents b6e9fb0 + 77685a7 commit 0e59ac1
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions specifications/api/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4060,7 +4060,10 @@ components:
properties:
transaction: *serialisedTransactionEncoded
inputs:
description: A list of additional transaction inputs foreign to the wallet.
description: |
Mapping from inputs (`id`, `ix`) in the supplied `transaction` binary to outputs (`amount`, `assets`, ...). It is not required to include inputs present in the `cardano-node` UTxO, as `cardano-wallet` will automatically query for them.
In other words, this field can be left empty unless the supplied `transaction` contains inputs referring to pending transactions.
type: array
items:
type: object
Expand All @@ -4080,7 +4083,7 @@ components:
datum: *datum
assets: *walletAssets
redeemers:
description: A list of redeemers data with their purpose.
description: A list of redeemers data with their purpose. The redeemers in the `transaction` binary will be overwritten by this value.
type: array
items: *ApiRedeemer
encoding:
Expand Down

0 comments on commit 0e59ac1

Please sign in to comment.