[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated (ccc0473 -> 1eeb894)
From: |
gnunet |
Subject: |
[taler-docs] branch master updated (ccc0473 -> 1eeb894) |
Date: |
Wed, 17 Mar 2021 09:55:24 +0100 |
This is an automated email from the git hooks/post-receive script.
ttn pushed a change to branch master
in repository docs.
from ccc0473 capitalize first word in sentence; add period at end of
sentence
new fcf8999 capitalize first word in sentence
new 801ccf8 add period at end of sentence
new 5e22095 add period at end of sentence
new 7a964a6 fix typo: s/planches/planchets/
new d4736a9 add period at end of sentence
new 0e23496 capitalize first word in sentence; add period at end of
sentence
new 25e3f83 diction: s/at/for/
new 7fee7ec mark up ‘default’
new 060b990 remove spurious space
new 7adddb0 change markup of ‘default’ from ' to ``
new 3aa9813 change markup of ‘default’ from ' to ``
new 0e83faf mark up ‘payto_uri’
new 39d9368 complete/rewrite sentence
new b133303 remove spurious space
new 03efe19 diction: s/at/for/
new 84ea1ac mark up ‘default’
new a76b0dd add period at end of sentence
new a7ef13f add period at end of sentence
new 643a5c8 change markup of ‘default’ from ' to ``
new adf7c78 remove spurious space
new 7a8215d add period at end of sentence
new f37c8a8 capitalize first word in sentence; add period at end of
sentence
new 0ab77e5 change markup of ‘default’ from ' to ``
new 0f51441 change markup of ‘default’ from ' to ``
new 1eeb894 mark up ‘TAX_RECORD_EXPIRATION’ (two instances)
The 25 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-merchant.rst | 49 +++++++++++++++++++++++++------------------------
1 file changed, 25 insertions(+), 24 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 406743b..94ab7fd 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -777,7 +777,7 @@ a website.
// wallet to determine denominations, fees, etc.
exchange_url: string;
- // (remaining) amount of the tip (including fees).
+ // (Remaining) amount of the tip (including fees).
tip_amount: Amount;
// Timestamp indicating when the tip is set to expire (may be in the
past).
@@ -797,7 +797,7 @@ a website.
**Response:**
:http:statuscode:`200 OK`:
- A tip is being returned. The backend responds with a `TipResponse`
+ A tip is being returned. The backend responds with a `TipResponse`.
:http:statuscode:`401 Unauthorized`:
The tip amount requested exceeds the tip.
:http:statuscode:`404 Not found`:
@@ -811,7 +811,7 @@ a website.
interface TipPickupRequest {
- // List of planches the wallet wants to use for the tip
+ // List of planchets the wallet wants to use for the tip.
planchets: PlanchetDetail[];
}
@@ -819,10 +819,10 @@ a website.
interface PlanchetDetail {
// Hash of the denomination's public key (hashed to reduce
- // bandwidth consumption)
+ // bandwidth consumption).
denom_pub_hash: HashCode;
- // coin's blinded public key
+ // Coin's blinded public key.
coin_ev: CoinEnvelope;
}
@@ -859,7 +859,7 @@ Setting up instances
.. http:post:: /private/instances
This request will be used to create a new merchant instance in the backend.
- It is only available at the implicit default instance.
+ It is only available for the implicit ``default`` instance.
**Request:**
@@ -912,7 +912,7 @@ Setting up instances
// Can be overridden by the frontend on a per-order basis.
default_max_deposit_fee: Amount;
- // If the frontend does NOT specify an execution date, how long should
+ // If the frontend does NOT specify an execution date, how long should
// we tell the exchange to wait to aggregate transactions before
// executing the wire transfer? This delay is added to the current
// time when we generate the advisory execution time for the exchange.
@@ -931,7 +931,7 @@ Setting up instances
Update the authentication settings for an instance. POST operations against
an instance are authenticated by checking that an authorization is provided
that matches either the credential required by the instance being modified
- OR the 'default' instance, depending on the access path used.
+ OR the ``default`` instance, depending on the access path used.
**Request** the request must be an `InstanceAuthConfigurationMessage`.
@@ -967,12 +967,12 @@ Setting up instances
Update the configuration of a merchant instance. PATCH operations against
an instance are authenticated by checking that an authorization is provided
that matches either the credential required by the instance being modified
- OR the 'default' instance, depending on the access path used.
+ OR the ``default`` instance, depending on the access path used.
**Request**
The request must be a `InstanceReconfigurationMessage`.
- Removing an existing payto_uri deactivates
+ Removing an existing ``payto_uri`` deactivates
the account (it will no longer be used for future contracts).
**Response:**
@@ -986,8 +986,9 @@ Setting up instances
interface InstanceReconfigurationMessage {
// The URI where the wallet will send coins. A merchant may have
- // multiple accounts, thus this is an array. Note that by
- // removing URIs from this list
+ // multiple accounts, thus this is an array. Note that removing
+ // URIs from this list deactivates the specified accounts
+ // (they will no longer be used for future contracts).
payto_uris: string[];
// Merchant name corresponding to this instance.
@@ -1012,7 +1013,7 @@ Setting up instances
// Can be overridden by the frontend on a per-order basis.
default_max_deposit_fee: Amount;
- // If the frontend does NOT specify an execution date, how long should
+ // If the frontend does NOT specify an execution date, how long should
// we tell the exchange to wait to aggregate transactions before
// executing the wire transfer? This delay is added to the current
// time when we generate the advisory execution time for the exchange.
@@ -1032,7 +1033,7 @@ Inspecting instances
.. http:get:: /private/instances
This is used to return the list of all the merchant instances.
- It is only available at the implicit default instance.
+ It is only available for the implicit ``default`` instance.
**Response:**
@@ -1044,7 +1045,7 @@ Inspecting instances
.. ts:def:: InstancesResponse
interface InstancesResponse {
- // List of instances that are present in the backend (see `Instance`)
+ // List of instances that are present in the backend (see `Instance`).
instances: Instance[];
}
@@ -1058,7 +1059,7 @@ Inspecting instances
// Merchant name corresponding to this instance.
name: string;
- // Merchant instance this response is about ($INSTANCE)
+ // Merchant instance this response is about ($INSTANCE).
id: string;
// Public key of the merchant/instance, in Crockford Base32 encoding.
@@ -1078,7 +1079,7 @@ Inspecting instances
This is used to query a specific merchant instance. GET operations against
an instance are authenticated by checking that an authorization is provided
that matches either the credential required by the instance being modified
- OR the 'default' instance, depending on the access path used.
+ OR the ``default`` instance, depending on the access path used.
**Response:**
@@ -1118,7 +1119,7 @@ Inspecting instances
// Can be overridden by the frontend on a per-order basis.
default_max_deposit_fee: Amount;
- // If the frontend does NOT specify an execution date, how long should
+ // If the frontend does NOT specify an execution date, how long should
// we tell the exchange to wait to aggregate transactions before
// executing the wire transfer? This delay is added to the current
// time when we generate the advisory execution time for the exchange.
@@ -1143,10 +1144,10 @@ Inspecting instances
// payto:// URI of the account.
payto_uri: string;
- // Hash over the wire details (including over the salt)
+ // Hash over the wire details (including over the salt).
h_wire: HashCode;
- // salt used to compute h_wire
+ // Salt used to compute h_wire.
salt: HashCode;
// true if this account is active,
@@ -1168,7 +1169,7 @@ Deleting instances
and makes the instance unusable for new orders or payments.
For deletion, the authentication credentials must match
- the instance that is being deleted or the 'default'
+ the instance that is being deleted or the ``default``
instance, depending on the access path used.
**Request:**
@@ -1182,13 +1183,13 @@ Deleting instances
The backend has successfully removed the instance. The body is empty.
:http:statuscode:`401 Unauthorized`:
The request is unauthorized. Note that for already deleted instances,
- the request must be authorized using the 'default' instance.
+ the request must be authorized using the ``default`` instance.
:http:statuscode:`404 Not found`:
The instance is unknown to the backend.
:http:statuscode:`409 Conflict`:
The instance cannot be deleted because it has pending offers, or
the instance cannot be purged because it has successfully processed
- payments that have not passed the TAX_RECORD_EXPIRATION time.
+ payments that have not passed the ``TAX_RECORD_EXPIRATION`` time.
The latter case only applies if ``purge`` was set.
@@ -1967,7 +1968,7 @@ the contract!) to minimize risks from information leakage.
.. http:delete:: [/instances/$INSTANCE]/private/orders/$ORDER_ID
Delete information about an order. Fails if the order was paid in the
- last 10 years (or whatever TAX_RECORD_EXPIRATION is set to) or was
+ last 10 years (or whatever ``TAX_RECORD_EXPIRATION`` is set to) or was
claimed but is unpaid and thus still a valid offer.
**Response:**
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [taler-docs] branch master updated (ccc0473 -> 1eeb894),
gnunet <=
- [taler-docs] 01/25: capitalize first word in sentence, gnunet, 2021/03/17
- [taler-docs] 03/25: add period at end of sentence, gnunet, 2021/03/17
- [taler-docs] 07/25: diction: s/at/for/, gnunet, 2021/03/17
- [taler-docs] 02/25: add period at end of sentence, gnunet, 2021/03/17
- [taler-docs] 04/25: fix typo: s/planches/planchets/, gnunet, 2021/03/17
- [taler-docs] 05/25: add period at end of sentence, gnunet, 2021/03/17
- [taler-docs] 06/25: capitalize first word in sentence; add period at end of sentence, gnunet, 2021/03/17
- [taler-docs] 14/25: remove spurious space, gnunet, 2021/03/17
- [taler-docs] 08/25: mark up ‘default’, gnunet, 2021/03/17
- [taler-docs] 10/25: change markup of ‘default’ from ' to ``, gnunet, 2021/03/17