[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated (40260f5 -> a8c62e1)
From: |
gnunet |
Subject: |
[taler-docs] branch master updated (40260f5 -> a8c62e1) |
Date: |
Fri, 19 Mar 2021 18:40:23 +0100 |
This is an automated email from the git hooks/post-receive script.
ttn pushed a change to branch master
in repository docs.
from 40260f5 add into index
new 4cd4f0e add period at end of sentence
new ea10cd1 add noun: "ID"
new 9cb7982 mark up ‘transaction_uid’
new 887fa1b add period at end of sentence
new 4bd18c8 change markup of ‘row ID’ from " to *
new c31f38f add period at end of sentence (five instances)
new 03d7b25 change markup of ‘row ID’ from " to *
new cc77d69 add period at end of sentence (five instances)
new 594de99 add period at end of sentence
new f8cc7b6 add missing trailing semicolon
new a8c62e1 add noun: "ID"
The 11 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:
core/api-wire.rst | 42 +++++++++++++++++++++---------------------
1 file changed, 21 insertions(+), 21 deletions(-)
diff --git a/core/api-wire.rst b/core/api-wire.rst
index ce8c94e..fbf2746 100644
--- a/core/api-wire.rst
+++ b/core/api-wire.rst
@@ -51,7 +51,7 @@ Making Transactions
:http:statuscode:`200 OK`:
The request has been correctly handled, so the funds have been transferred
to
- the recipient's account. The body is a `TransferResponse`
+ the recipient's account. The body is a `TransferResponse`.
:http:statuscode:`400 Bad request`:
Request malformed. The bank replies with an `ErrorDetail` object.
:http:statuscode:`401 Unauthorized`:
@@ -77,7 +77,7 @@ Making Transactions
// time period a transaction belongs to).
timestamp: Timestamp;
- // Opaque of the transaction that the bank has made.
+ // Opaque ID of the transaction that the bank has made.
row_id: SafeUint64;
}
@@ -86,7 +86,7 @@ Making Transactions
interface TransferRequest {
// Nonce to make the request idempotent. Requests with the same
- // transaction_uid that differ in any of the other fields
+ // ``transaction_uid`` that differ in any of the other fields
// are rejected.
request_uid: HashCode;
@@ -102,7 +102,7 @@ Making Transactions
// associated with this wire transfer.
wtid: ShortHashCode;
- // The recipient's account identifier as a payto URI
+ // The recipient's account identifier as a payto URI.
credit_account: string;
}
@@ -126,7 +126,7 @@ Querying the transaction history
merged into one history.
Transactions are identified by an opaque numeric identifier, referred to here
- as "row ID". The semantics of the row ID (including its sorting order) are
+ as *row ID*. The semantics of the row ID (including its sorting order) are
determined by the bank server and completely opaque to the client.
The list of returned transactions is determined by a row ID *starting point*
@@ -168,7 +168,7 @@ Querying the transaction history
interface IncomingHistory {
- // Array of incoming transactions
+ // Array of incoming transactions.
incoming_transactions : IncomingBankTransaction[];
}
@@ -177,20 +177,20 @@ Querying the transaction history
interface IncomingBankTransaction {
- // Opaque identifier of the returned record
+ // Opaque identifier of the returned record.
row_id: SafeUint64;
- // Date of the transaction
+ // Date of the transaction.
date: Timestamp;
- // Amount transferred
+ // Amount transferred.
amount: Amount;
// Payto URI to identify the receiver of funds.
// This must be one of the exchange's bank accounts.
credit_account: string;
- // Payto URI to identify the sender of funds
+ // Payto URI to identify the sender of funds.
debit_account: string;
// The reserve public key extracted from the transaction details.
@@ -207,8 +207,8 @@ Querying the transaction history
might come from a "virtual" account, where multiple real bank accounts are
merged into one history.
- Transactions are identified by an opaque integer, referred to here as "row
- ID". The semantics of the row ID (including its sorting order) are
+ Transactions are identified by an opaque integer, referred to here as *row
+ ID*. The semantics of the row ID (including its sorting order) are
determined by the bank server and completely opaque to the client.
The list of returned transactions is determined by a row ID *starting point*
@@ -250,7 +250,7 @@ Querying the transaction history
interface OutgoingHistory {
- // Array of outgoing transactions
+ // Array of outgoing transactions.
outgoing_transactions : OutgoingBankTransaction[];
}
@@ -259,19 +259,19 @@ Querying the transaction history
interface OutgoingBankTransaction {
- // Opaque identifier of the returned record
+ // Opaque identifier of the returned record.
row_id: SafeUint64;
- // Date of the transaction
+ // Date of the transaction.
date: Timestamp;
- // Amount transferred
+ // Amount transferred.
amount: Amount;
// Payto URI to identify the receiver of funds.
credit_account: string;
- // Payto URI to identify the sender of funds
+ // Payto URI to identify the sender of funds.
// This must be one of the exchange's bank accounts.
debit_account: string;
@@ -301,8 +301,8 @@ exposed by bank gateways in production.
:http:statuscode:`200 OK`:
The request has been correctly handled, so the funds have been transferred
to
- the recipient's account. The body is a `AddIncomingResponse`
- :http:statuscode:`400 Bad request`:
+ the recipient's account. The body is a `AddIncomingResponse`.
+ :http:statuscode:`400 Bad request`:
The request is malformed. The bank replies with an `ErrorDetail` object.
:http:statuscode:`401 Unauthorized`:
Authentication failed, likely the credentials are wrong.
@@ -317,7 +317,7 @@ exposed by bank gateways in production.
// Reserve public key that is included in the wire transfer details
// to identify the reserve that is being topped up.
- reserve_pub: EddsaPublicKey
+ reserve_pub: EddsaPublicKey;
// Account (as payto URI) that makes the wire transfer to the exchange.
// Usually this account must be created by the test harness before this
API is
@@ -340,6 +340,6 @@ exposed by bank gateways in production.
// time period a transaction belongs to).
timestamp: Timestamp;
- // Opaque of the transaction that the bank has made.
+ // Opaque ID of the transaction that the bank has made.
row_id: SafeUint64;
}
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [taler-docs] branch master updated (40260f5 -> a8c62e1),
gnunet <=
- [taler-docs] 05/11: change markup of ‘row ID’ from " to *, gnunet, 2021/03/19
- [taler-docs] 01/11: add period at end of sentence, gnunet, 2021/03/19
- [taler-docs] 06/11: add period at end of sentence (five instances), gnunet, 2021/03/19
- [taler-docs] 10/11: add missing trailing semicolon, gnunet, 2021/03/19
- [taler-docs] 07/11: change markup of ‘row ID’ from " to *, gnunet, 2021/03/19
- [taler-docs] 02/11: add noun: "ID", gnunet, 2021/03/19
- [taler-docs] 04/11: add period at end of sentence, gnunet, 2021/03/19
- [taler-docs] 09/11: add period at end of sentence, gnunet, 2021/03/19
- [taler-docs] 08/11: add period at end of sentence (five instances), gnunet, 2021/03/19
- [taler-docs] 03/11: mark up ‘transaction_uid’, gnunet, 2021/03/19