summaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2020-06-23 23:12:59 +0200
committerChristian Grothoff <christian@grothoff.org>2020-06-23 23:12:59 +0200
commit5d3aef5d035c1a78c930b44d19485396d190e09e (patch)
treecfd30015d26c596bd786d4d6facc179073c4c0d3 /core
parentccf586100520ea3c56651403d005c78115f42497 (diff)
downloaddocs-5d3aef5d035c1a78c930b44d19485396d190e09e.tar.gz
docs-5d3aef5d035c1a78c930b44d19485396d190e09e.tar.bz2
docs-5d3aef5d035c1a78c930b44d19485396d190e09e.zip
fix RST warnings
Diffstat (limited to 'core')
-rw-r--r--core/api-common.rst8
-rw-r--r--core/api-exchange.rst3
-rw-r--r--core/api-merchant.rst37
-rw-r--r--core/api-sync.rst4
4 files changed, 31 insertions, 21 deletions
diff --git a/core/api-common.rst b/core/api-common.rst
index 93d6d09..272dfd6 100644
--- a/core/api-common.rst
+++ b/core/api-common.rst
@@ -267,6 +267,14 @@ Integers
// JavaScript numbers restricted to integers
type Integer = number;
+Objects
+^^^^^^^
+
+.. ts:def:: Object
+
+ // JavaScript objects, no further restrictions
+ type Object = object;
+
Keys
^^^^
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index 979eca8..9b18a18 100644
--- a/core/api-exchange.rst
+++ b/core/api-exchange.rst
@@ -1330,11 +1330,12 @@ typically also view the balance.)
}
+.. _exchange_refund:
+
-------
Refunds
-------
-.. _refund:
.. http:POST:: /coins/$COIN_PUB/refund
Undo deposit of the given coin, restoring its value.
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 1c99a79..5c50709 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -325,8 +325,7 @@ Dynamic Merchant Instances
**Response**
:status 204 No content:
- The backend has successfully removed the instance. The response is a
- `PostInstanceRemoveResponse`.
+ The backend has successfully removed the instance. The body is empty.
:status 404 Not found:
The instance is unknown to the backend.
:status 409 Conflict:
@@ -991,7 +990,7 @@ Payment processing
The backend will return an `abort response <AbortResponse>`, which includes
verbatim the error codes received from the exchange's
- :ref:`refund <_refund>` API. The frontend should pass the replies verbatim to
+ :ref:`refund <exchange_refund>` API. The frontend should pass the replies verbatim to
the browser/wallet.
.. ts:def:: AbortRequest
@@ -1038,12 +1037,12 @@ Payment processing
// can generate a substantially shorter response.
interface RefundResult {
// HTTP status of the request to the exchange.
- exchange_http_status: integer;
+ exchange_http_status: Integer;
// The full reply from the exchange. Note only actually
- // a <RefundSuccess> if the `exchange_status` is 200, otherwise
+ // a <RefundSuccess> if the \exchange_http_status\ is 200, otherwise
// the error message as defined by the refund API. For
- // aborts, the `rtransaction_id` is always 0.
+ // aborts, the \rtransaction_id\ is always 0.
exchange_reply: RefundSuccess;
}
@@ -1278,7 +1277,7 @@ Payment processing
exchange_code?: Integer;
// If available, HTTP reply from the exchange.
- exchange_reply?: json;
+ exchange_reply?: Object;
// Refund transaction ID.
rtransaction_id: Integer;
@@ -1299,8 +1298,8 @@ Payment processing
// to the wallet and thus not included.
interface RefundConfirmation {
- // HTTP status of the exchange request, 200 required for refund confirmations.
- exchange_status: 200;
+ // HTTP status of the exchange request, 200 (integer) required for refund confirmations.
+ exchange_status: "200";
// the EdDSA :ref:`signature` (binary-only) with purpose
// `TALER_SIGNATURE_EXCHANGE_CONFIRM_REFUND` using a current signing key of the
@@ -1342,7 +1341,7 @@ Payment processing
The backend refuses to delete the order.
-.. _refund:
+.. _merchant_refund:
--------------
Giving Refunds
@@ -1502,7 +1501,7 @@ Tracking Wire Transfers
// and should probably return it here as well.
interface WireFeeConflictDetails {
// Numerical `error code <error-codes>`:
- code: TALER_EC_POST_TRANSFERS_JSON_BAD_WIRE_FEE;
+ code: "TALER_EC_POST_TRANSFERS_JSON_BAD_WIRE_FEE";
// Text describing the issue for humans.
hint: string;
@@ -1540,7 +1539,7 @@ Tracking Wire Transfers
interface TrackTransferConflictDetails {
// Numerical `error code <error-codes>`
- code: TALER_EC_POST_TRANSFERS_CONFLICTING_REPORTS;
+ code: "TALER_EC_POST_TRANSFERS_CONFLICTING_REPORTS";
// Text describing the issue for humans.
hint: string;
@@ -1558,15 +1557,15 @@ Tracking Wire Transfers
// hardly needed _here_. Once we add automated reports for
// the Taler auditor, we need to generate this data anyway
// and should probably return it here as well.
- exchange_transfer: TrackTransferResponse?;
+ exchange_transfer?: TrackTransferResponse;
// Public key of the exchange used to sign the response to
// our deposit request.
- deposit_exchange_pub: EdDSAPublicKey;
+ deposit_exchange_pub: EddsaPublicKey;
// Signature of the exchange signing the (conflicting) response.
- // Signs over a `struct TALER_DepositConfirmationPS`.
- deposit_exchange_sig: EdDSASignature;
+ // Signs over a \struct TALER_DepositConfirmationPS\.
+ deposit_exchange_sig: EddsaSignature;
// Hash of the merchant's bank account the wire transfer went to
h_wire: HashCode;
@@ -1575,10 +1574,10 @@ Tracking Wire Transfers
h_contract_terms: HashCode;
// At what time the exchange received the deposit. Needed
- // to verify the `exchange_sig`.
+ // to verify the \exchange_sig\.
deposit_timestamp: Timestamp;
- // At what time the refund possibility expired (needed to verify ``exchange_sig``).
+ // At what time the refund possibility expired (needed to verify \exchange_sig\).
refund_deadline: Timestamp;
// Public key of the coin for which we have conflicting information.
@@ -1717,7 +1716,7 @@ Giving Customer Tips
:status 200 OK:
The backend is waiting for the reserve to be established. The merchant
must now perform the wire transfer indicated in the `ReserveCreateConfirmation`.
- :status 408 Timeout:
+ :status 408 Request Timeout:
The exchange did not respond on time.
:status 409 Conflict:
The exchange does not support the requested wire method.
diff --git a/core/api-sync.rst b/core/api-sync.rst
index 2add73e..67d1e21 100644
--- a/core/api-sync.rst
+++ b/core/api-sync.rst
@@ -411,4 +411,6 @@ Web Security Considerations
To ensure that the Taler Web extension (and others) can access the
service despite Web "security", all service endpoints must set the
-"Access-Control-Allow-Origin: *".
+header::
+
+ Access-Control-Allow-Origin: *