code review adjustment

cardano-foundation · Jul 18, 2023 · 79c6ec7 · 79c6ec7
1 parent fd2f3a0
commit 79c6ec7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/lib/wallet/api/http/Cardano/Wallet/Api.hs b/lib/wallet/api/http/Cardano/Wallet/Api.hs
@@ -604,7 +604,7 @@ type ListTransactions n = "wallets"
     :> QueryParam "end" Iso8601Time
     :> QueryParam "order" (ApiT SortOrder)
     :> QueryParam "max_count" ApiLimit
-    :> QueryParam "addressId" (ApiAddressIdT n)
+    :> QueryParam "address" (ApiAddressIdT n)
     :> QueryFlag "simple-metadata"
     :> Get '[JSON] [ApiTransactionT n]
 
@@ -925,7 +925,7 @@ type ListByronTransactions n = "byron-wallets"
     :> QueryParam "end" Iso8601Time
     :> QueryParam "order" (ApiT SortOrder)
     :> QueryParam "max_count" ApiLimit
-    :> QueryParam "addressId" (ApiAddressIdT n)
+    :> QueryParam "address" (ApiAddressIdT n)
     :> Get '[JSON] [ApiTransactionT n]
 
 -- | https://cardano-foundation.github.io/cardano-wallet/api/#operation/getByronTransaction
@@ -1190,7 +1190,7 @@ type ListSharedTransactions n = "shared-wallets"
     :> QueryParam "end" Iso8601Time
     :> QueryParam "order" (ApiT SortOrder)
     :> QueryParam "max_count" ApiLimit
-    :> QueryParam "addressId" (ApiAddressIdT n)
+    :> QueryParam "address" (ApiAddressIdT n)
     :> QueryFlag "simple-metadata"
     :> Get '[JSON] [ApiTransactionT n]
 

diff --git a/specifications/api/swagger.yaml b/specifications/api/swagger.yaml
@@ -4090,6 +4090,10 @@ x-parametersAddress: &parametersAddress
   name: address
   description: |
     An optional address.
+    If given, the list of transactions will be filtered
+    to only contain transactions that refer to this address in their inputs or outputs.
+    This may exclude transactions whose inputs reference outside transactions
+    that are not part of the transaction history of the wallet.
   schema: *addressId
 
 x-parametersAddressState: &parametersAddressState