taler-docs

commit 0b7907daf71e0a87169b6621eaaa3b8a4e1f6b61
parent 4c0ff94d449cdffb0545dbe6cdfd4809a75f95bc
Author: Özgür Kesim <oec-taler@kesim.org>
Date:   Thu,  6 Oct 2022 18:44:40 +0200

correcting type and field names for policies

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

1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
@@ -2174,21 +2174,21 @@ proof to the seller for the escrow of sufficient fund.
   .. ts:def:: DepositPolicy
 
     type DepositPolicy =
-    | PolicyRefund
+    | PolicyMerchantRefund
     | PolicyBrandtVickreyAuction
-    | PolicyEscrow;
+    | PolicyEscrowedPayment;
 
-  .. ts:def:: PolicyRefund
+  .. ts:def:: PolicyMerchantRefund
 
     // CAVEAT: THIS IS STILL WORK IN PROGRESS.
     // This policy is optional and might not be supported by the exchange.
     // If it does, the exchange MUST show support for this policy in the
     // ``extensions`` field in the response to ``/keys``.
-    interface PolicyRefund {
-      type: "refund";
+    interface PolicyMerchantRefund {
+      type: "merchant_refund";
 
-      // EdDSA `public key of the merchant <merchant-pub>`, so that the client can identify the
-      // merchant for refund requests.
+      // EdDSA `public key of the merchant <merchant-pub>`, so that the client
+      // can identify the merchant for refund requests.
       merchant_pub: EddsaPublicKey;
 
       // Date until which the merchant can issue a refund to the customer via
@@ -2254,7 +2254,7 @@ proof to the seller for the escrow of sufficient fund.
       // - Type 2 refers to an auction with two winners, paying
       //   the third-highest price,
       // - etc.
-      type: number;
+      auction_type: number;
 
       // The vector of prices for the Brandt-Vickrey auction.  The values MUST
       // be in strictly increasing order.
@@ -2265,7 +2265,7 @@ proof to the seller for the escrow of sufficient fund.
       // winning price.  This field is not relevant for the replay of a
       // transcript, as the transcript must be provided by the seller who sees
       // the winner(s) and winning price of the auction.
-      is_public: boolean;
+      outcome_public: boolean;
 
       // The public key of the seller.
       pubkey: EddsaPublicKey;
@@ -2275,19 +2275,19 @@ proof to the seller for the escrow of sufficient fund.
     }
 
 
-  .. ts:def:: PolicyEscrow
+  .. ts:def:: PolicyEscrowedPayment
 
     // CAVEAT: THIS IS STILL WORK IN PROGRESS
     // This policy is optional and might not be supported by the exchange.
     // If it does, the exchange MUST show support for this policy in the
     // ``extensions`` field in the response to ``/keys``.
-    interface PolicyEscrow {
-      type: "escrow";
+    interface PolicyEscrowedPayment {
+      type: "escrowed_payment";
 
       // Public key of this trustor, the owner of the coins.
       //
       // To claim the deposit, the merchant must provide the valid signature
-      // of the ``h_contract_terms`` field from the deposit, signed by this
+      // of the ``h_contract_terms`` field from the deposit, signed by _this_
       // key, to the ``/extensions/policy_escrow``-endpoint of the exchange,
       // after the date specified in ``not_before`` and before the date
       // specified in ``not_after``.