[GNUnet-SVN] [taler-api] branch master updated (65f4bc1 -> 1c6acf3)

[gnunet]

This is an automated email from the git hooks/post-receive script.

marcello pushed a change to branch master
in repository api.

    from 65f4bc1  move exchange operator manual as texinfo into exchange.git
     new 64f2825  Specing new /track/transfer and /track/order responses.
     new 80210f0  /track/transaction -> /track/order.
     new 1c6acf3  fix compilation error

The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 api/api-merchant.rst | 62 +++++++++++++++++++++++++++++++++++++++++++++++-----
 docs/conf.py         |  2 +-
 2 files changed, 57 insertions(+), 7 deletions(-)

diff --git a/api/api-merchant.rst b/api/api-merchant.rst
index 705a320..71e4007 100644
--- a/api/api-merchant.rst
+++ b/api/api-merchant.rst
@@ -243,7 +243,7 @@ The following API are made available by the merchant's 
`backend` to the merchant
 
   :status 200 OK:
     The wire transfer is known to the exchange, details about it follow in the 
body.
-    The body of the response is a :ref:`TrackTransferResponse 
<TrackTransferResponse>`.  Note that
+    The body of the response is a `MerchantTrackTransferResponse`_.  Note that
     the similarity to the response given by the exchange for a /track/transfer
     is completely intended.
 
@@ -255,6 +255,55 @@ The following API are made available by the merchant's 
`backend` to the merchant
     details don't match the details stored in merchant's database about the 
same keyed coin.
     The response body contains the `TrackTransferConflictDetails`_.
 
+  .. _MerchantTrackTransferResponse:
+  .. _tsref-type-TrackTransferResponse:
+  .. code-block:: tsref
+
+    interface TrackTransferResponse {
+      // Total amount transferred
+      total: Amount;
+
+      // Applicable wire fee that was charged
+      wire_fee: Amount;
+
+      // public key of the merchant (identical for all deposits)
+      merchant_pub: EddsaPublicKey;
+
+      // hash of the wire details (identical for all deposits)
+      H_wire: HashCode;
+
+      // Time of the execution of the wire transfer by the exchange
+      execution_time: Timestamp;
+
+      // details about the deposits
+      deposits_sums: TrackTransferDetail[];
+
+      // signature from the exchange made with purpose
+      // `TALER_SIGNATURE_EXCHANGE_CONFIRM_WIRE_DEPOSIT`
+      exchange_sig: EddsaSignature;
+
+      // public EdDSA key of the exchange that was used to generate the 
signature.
+      // Should match one of the exchange's signing keys from /keys.  Again 
given
+      // explicitly as the client might otherwise be confused by clock skew as 
to
+      // which signing key was used.
+      exchange_pub: EddsaSignature;
+    }
+
+  .. _tsref-type-TrackTransferDetail:
+  .. code-block:: tsref
+
+    interface TrackTransferDetail {
+      // Business activity associated with the wire tranfered amount
+      // `deposit_value`.
+      order_id: string;
+
+      // The total amount the exchange paid back for `order_id`.
+      deposit_value: Amount;
+
+      // applicable fees for the deposit
+      deposit_fee: Amount;
+    }
+
 
   **Details:**
 
@@ -298,7 +347,7 @@ The following API are made available by the merchant's 
`backend` to the merchant
     }
 
 
-.. http:get:: /track/transaction
+.. http:get:: /track/order
 
   Provide the wire transfer identifier associated with an (existing) deposit 
operation.
 
@@ -319,7 +368,7 @@ The following API are made available by the merchant's 
`backend` to the merchant
     executed.  Hence the exchange does not yet have a wire transfer identifier.
     The merchant should come back later and ask again.
     The response body is a :ref:`TrackTransactionAcceptedResponse 
<TrackTransactionAcceptedResponse>`.  Note that
-    the similarity to the response given by the exchange for a 
/track/transaction
+    the similarity to the response given by the exchange for a /track/order
     is completely intended.
 
   :status 404 Not Found: The transaction is unknown to the backend.
@@ -344,8 +393,9 @@ The following API are made available by the merchant's 
`backend` to the merchant
       // execution time of the wire transfer
       execution_time: Timestamp;
 
-      // Array of data about coins
-      coins: CoinWireTransfer[];
+      // Total amount that has been wire transfered
+      // to the merchant
+      amount: Amount;
     }
 
   .. _tsref-type-CoinWireTransfer:
@@ -383,7 +433,7 @@ The following API are made available by the merchant's 
`backend` to the merchant
 
       // The current claim by the exchange that the given
       // transaction is included in the above WTID.
-      // (A response from `/track/transaction`).
+      // (A response from `/track/order`).
       transaction_tracking_claim: TrackTransactionResponse;
 
       // Public key of the coin for which we got conflicting information.
diff --git a/docs/conf.py b/docs/conf.py
index 78c6ba0..2fafeb9 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -64,7 +64,7 @@ source_suffix = '.rst'
 #source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'operate-exchange'
+master_doc = 'index'
 
 # General information about the project.
 project = u'Taler'

-- 
To stop receiving notification emails like this one, please contact
address@hidden