From 2fe50aacb2e17131a631ec5586f41b8debf3c701 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Sat, 7 Nov 2020 17:22:10 +0100 Subject: update docs to match EC changes --- core/api-exchange.rst | 6 +++--- core/api-merchant.rst | 32 ++++++++++++++++---------------- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/core/api-exchange.rst b/core/api-exchange.rst index 2b4f3b2d..29035eac 100644 --- a/core/api-exchange.rst +++ b/core/api-exchange.rst @@ -638,7 +638,7 @@ denomination. residual value, or because the same public key of the coin has been previously used with a different denomination. Which case it is can be decided by looking at the error code - (``TALER_EC_DEPOSIT_INSUFFICIENT_FUNDS`` or ``TALER_EC_COIN_CONFLICTING_DENOMINATION_KEY``). + (``TALER_EC_EXCHANGE_DEPOSIT_INSUFFICIENT_FUNDS`` or ``TALER_EC_EXCHANGE_GENERIC_COIN_CONFLICTING_DENOMINATION_KEY``). The fields of the response are the same in both cases. The request should not be repeated again with this coin. In this case, the response is a `DepositDoubleSpendError`. @@ -874,7 +874,7 @@ the API during normal operation. residual value, or because the same public key of the coin has been previously used with a different denomination. Which case it is can be decided by looking at the error code - (``TALER_EC_MELT_INSUFFICIENT_FUNDS`` or ``TALER_EC_COIN_CONFLICTING_DENOMINATION_KEY``). + (``TALER_EC_EXCHANGE_MELT_INSUFFICIENT_FUNDS`` or ``TALER_EC_EXCHANGE_GENERIC_COIN_CONFLICTING_DENOMINATION_KEY``). The response is `MeltForbiddenResponse` in both cases. **Details:** @@ -1153,7 +1153,7 @@ in using this API. residual value, or because the same public key of the coin has been previously used with a different denomination. Which case it is can be decided by looking at the error code - (``TALER_EC_RECOUP_COIN_BALANCE_ZERO`` or ``TALER_EC_COIN_CONFLICTING_DENOMINATION_KEY``). + (``TALER_EC_EXCHANGE_RECOUP_COIN_BALANCE_ZERO`` or ``TALER_EC_EXCHANGE_GENERIC_COIN_CONFLICTING_DENOMINATION_KEY``). The response is a `DepositDoubleSpendError`. **Details:** diff --git a/core/api-merchant.rst b/core/api-merchant.rst index 8282ce01..77e347e7 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -66,7 +66,7 @@ such as the implemented version of the protocol and the currency used. currency: string; } - + ---------- Wallet API @@ -139,7 +139,7 @@ claim orders (say in a case where stocks are limited). // Signature by the merchant over the contract terms. sig: EddsaSignature; } - + Making the payment ------------------ @@ -188,7 +188,7 @@ Making the payment :http:statuscode:`412 Precondition failed`: The given exchange is not acceptable for this merchant, as it is not in the list of accepted exchanges and not audited by an approved auditor. - :http:statuscode:`424 Failed dependency`: + :http:statuscode:`502 Bad gateway`: The merchant's interaction with the exchange failed in some way. The client might want to try later again. This includes failures like the denomination key of a coin not being @@ -341,7 +341,7 @@ Querying payment status fulfillment_url: string; } - + Demonstrating payment --------------------- @@ -406,7 +406,7 @@ again. session_id: string; } - + Aborting incomplete payments ---------------------------- @@ -458,7 +458,7 @@ are for incomplete payments for an order and never for established contracts. Aborting the payment is not allowed, as the original payment did succeed. It is possible that a different wallet succeeded with the payment. This wallet should thus try to refresh all of the coins involved in the payment. - :http:statuscode:`424 Failed dependency`: + :http:statuscode:`502 Bad gateway`: The merchant's interaction with the exchange failed in some way. The error from the exchange is included. @@ -1028,7 +1028,7 @@ Inspecting instances active: boolean; } - + Deleting instances ------------------ @@ -1612,7 +1612,7 @@ Inspecting orders Returns a `MerchantOrderStatusResponse`, whose format can differ based on the status of the payment. :http:statuscode:`404 Not found`: The order or instance is unknown to the backend. - :http:statuscode:`424 Failed dependency`: + :http:statuscode:`502 Bad gateway`: We failed to obtain a response from the exchange (about the wire transfer status). .. ts:def:: MerchantOrderStatusResponse @@ -1760,7 +1760,7 @@ Inspecting orders coin_pub: CoinPublicKey; } - + Private order data cleanup -------------------------- @@ -1937,7 +1937,7 @@ Informing the backend about incoming wire transfers :http:statuscode:`409 Conflict`: The wire transfer identifier is already known to us, but for a different amount, wire method or exchange. - :http:statuscode:`424 Failed dependency`: + :http:statuscode:`502 Bad gateway`: The exchange returned an error when we asked it about the "GET /transfer" status for this wire transfer. Details of the exchange error are returned. @@ -2008,7 +2008,7 @@ Informing the backend about incoming wire transfers // and should probably return it here as well. interface WireFeeConflictDetails { // Numerical `error code `: - code: "TALER_EC_POST_TRANSFERS_JSON_BAD_WIRE_FEE"; + code: "TALER_EC_MERCHANT_PRIVATE_POST_TRANSFERS_BAD_WIRE_FEE"; // Text describing the issue for humans. hint: string; @@ -2045,7 +2045,7 @@ Informing the backend about incoming wire transfers interface TrackTransferConflictDetails { // Numerical `error code ` - code: "TALER_EC_POST_TRANSFERS_CONFLICTING_REPORTS"; + code: "TALER_EC_MERCHANT_PRIVATE_POST_TRANSFERS_CONFLICTING_REPORTS"; // Text describing the issue for humans. hint: string; @@ -2248,7 +2248,7 @@ funds to the exchange. The exchange did not respond on time. :http:statuscode:`409 Conflict`: The exchange does not support the requested wire method. - :http:statuscode:`424 Failed dependency`: + :http:statuscode:`502 Bad gateway`: We could not obtain /wire details from the specified exchange base URL. .. ts:def:: ReserveCreateRequest @@ -2326,7 +2326,7 @@ funds to the exchange. active: boolean; } - + Query funds remaining --------------------- @@ -2344,7 +2344,7 @@ Query funds remaining Returns the `ReserveDetail`. :http:statuscode:`404 Not found`: The tipping reserve is not known. - :http:statuscode:`424 Failed dependency`: + :http:statuscode:`502 Bad gateway`: We are having trouble with the request because of a problem with the exchange. Likely returned with an "exchange_code" in addition to a "code" and an "exchange_http_status" in addition to our own HTTP status. Also usually @@ -2474,7 +2474,7 @@ Authorizing tips Deleting reserves ----------------- - + .. http:delete:: /private/reserves/$RESERVE_PUB Delete information about a reserve. Fails if the reserve still has -- cgit v1.2.3