taler-docs

commit 7c99c54a06b44a1a84987915b9c9dbc87d1bc134
parent 805b53c94ff2a41a0380e2baaacd5216bbe1fec0
Author: Christian Grothoff <grothoff@gnunet.org>
Date:   Sun, 26 May 2024 09:58:50 +0200

address some npderf TODOs

Diffstat:
M
core/api-exchange.rst
 | 
45
+++++++++++++++++++--------------------------

1 file changed, 19 insertions(+), 26 deletions(-)
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
@@ -193,7 +193,7 @@ possibly by using HTTPS.
 
       // List of exchanges that this exchange is partnering
       // with to enable wallet-to-wallet transfers.
-      wads: ExchangePartner[];
+      wads: ExchangePartnerListEntry[];
 
       // Set to true if this exchange allows the use
       // of reserves for rewards.
@@ -655,9 +655,9 @@ possibly by using HTTPS.
       sig: EddsaSignature;
     }
 
-  .. ts:def:: ExchangePartner
+  .. ts:def:: ExchangePartnerListEntry
 
-    interface ExchangePartner {
+    interface ExchangePartnerListEntry {
       // Base URL of the partner exchange.
       partner_base_url: string;
 
@@ -1272,7 +1272,7 @@ Management operations authorized by master key
 
   **Request:**
 
-  The request must be an `ExchangePartner2` message.
+  The request must be an `ExchangePartnerSetupReqest` message.
 
   **Response**
 
@@ -1285,11 +1285,9 @@ Management operations authorized by master key
 
   **Details:**
 
-  .. TODO: Fix this name! There was just a name conflict
+  .. ts:def:: ExchangePartnerSetupRequest
 
-  .. ts:def:: ExchangePartner2
-
-    interface ExchangePartner2 {
+    interface ExchangePartnerSetupRequest {
 
       // Base URL of the partner exchange
       partner_base_url: string;
@@ -1509,7 +1507,7 @@ and freeze or unfreeze accounts suspected of money laundering.
   **Response:**
 
   :http:statuscode:`200 OK`:
-    The responds will be an `AmlDecisions` message.
+    The response will be an `AmlDecisionsResponse` message.
   :http:statuscode:`204 No content`:
     There are no matching AML records.
   :http:statuscode:`403 Forbidden`:
@@ -1521,9 +1519,9 @@ and freeze or unfreeze accounts suspected of money laundering.
 
   **Details:**
 
-  .. ts:def:: AmlDecisions
+  .. ts:def:: AmlDecisionsResponse
 
-    interface AmlDecisions {
+    interface AmlDecisionsResponse {
 
       // Array of AML decisions matching the query.
       records: AmlDecision[];
@@ -1751,7 +1749,7 @@ and freeze or unfreeze accounts suspected of money laundering.
 
   **Request:**
 
-  The request must be an `AmlDecision2` message.
+  The request must be an `AmlDecisionRequest` message.
 
   **Response**
 
@@ -1768,11 +1766,9 @@ and freeze or unfreeze accounts suspected of money laundering.
 
   **Details:**
 
-  .. TODO: This was a duplicated name! This (or the other AmlDecision) should be renamed properly.
-
-  .. ts:def:: AmlDecision2
+  .. ts:def:: AmlDecisionRequest
 
-    interface AmlDecision2 {
+    interface AmlDecisionRequest {
 
       // Human-readable justification for the decision.
       justification: string;
@@ -4416,7 +4412,7 @@ Wallet-to-wallet transfers
   :http:statuscode:`200 OK`:
     The operation succeeded, the exchange confirms that all
     coins were deposited into the purse.
-    The response will include a `PurseDepositSuccess` object.
+    The response will include a `PurseCreateSuccessResponse` object.
   :http:statuscode:`403 Forbidden`:
     A coin, denomination or contract signature is invalid.
     This response comes with a standard `ErrorDetail` response.
@@ -4504,12 +4500,9 @@ Wallet-to-wallet transfers
 
     }
 
-  .. TODO: This name conflicted with another PurseDepositSuccess! I've renamed this one as the other one appeared to have more fields (more up to date?)
-  ..       Please fix appropriately!
-
-  .. ts:def:: PurseDepositSuccess2
+  .. ts:def:: PurseCreateSuccessResponse
 
-     interface PurseDepositSuccess2 {
+     interface PurseCreateSuccessResponse {
 
       // Total amount deposited into the purse so far (without fees).
       total_deposited: Amount;
@@ -4760,7 +4753,7 @@ Wallet-to-wallet transfers
   :http:statuscode:`200 OK`:
     The operation succeeded, the exchange confirms that the
     purse was allocated.
-    The response will include a `PurseDepositSuccess` object.
+    The response will include a `PurseCreateSuccessResponse` object.
   :http:statuscode:`402 Payment Required`:
     The account needs to contain more funding to create more purses.
     This response comes with a standard `ErrorDetail` response.
@@ -4862,7 +4855,7 @@ Wallet-to-wallet transfers
   :http:statuscode:`200 OK`:
     The operation succeeded, the exchange confirms that all
     coins were deposited into the purse.
-    The response will include a `PurseDepositSuccess` object.
+    The response will include a `PurseDepositSuccessResponse` object.
   :http:statuscode:`403 Forbidden`:
     A coin or denomination signature is invalid.
     This response comes with a standard `ErrorDetail` response.
@@ -4924,9 +4917,9 @@ Wallet-to-wallet transfers
 
     }
 
-  .. ts:def:: PurseDepositSuccess
+  .. ts:def:: PurseDepositSuccessResponse
 
-     interface PurseDepositSuccess {
+     interface PurseDepositSuccessResponse {
 
       // Total amount paid into the purse.
       total_deposited: Amount;