diff options
| author | Christian Grothoff <christian@grothoff.org> | 2020-04-04 17:22:51 +0200 |
|---|---|---|
| committer | Christian Grothoff <christian@grothoff.org> | 2020-04-04 17:22:51 +0200 |
| commit | a42a6a69879208f8960384e4ecf2426bc467e67e (patch) | |
| tree | 35acb374bbc32967f4cd2716982243d8e4787adc /core | |
| parent | bf0a7c8dac654f250aae565efafdef79b27a2552 (diff) | |
| download | docs-a42a6a69879208f8960384e4ecf2426bc467e67e.tar.gz docs-a42a6a69879208f8960384e4ecf2426bc467e67e.tar.bz2 docs-a42a6a69879208f8960384e4ecf2426bc467e67e.zip | |
update docs
Diffstat (limited to 'core')
| -rw-r--r-- | core/api-exchange.rst | 2 | ||||
| -rw-r--r-- | core/api-merchant.rst | 37 |
2 files changed, 38 insertions, 1 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst index c6186284..536458ec 100644 --- a/core/api-exchange.rst +++ b/core/api-exchange.rst @@ -96,7 +96,7 @@ possibly by using HTTPS. .. ts:def:: ExchangeKeysResponse interface ExchangeKeysResponse { - // libtool-style representation of the Taler protocol version, see + // libtool-style representation of the Exchange protocol version, see // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning // The format is "current:revision:age". version: string; diff --git a/core/api-merchant.rst b/core/api-merchant.rst index b9dac413..e60ea8b0 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -25,6 +25,22 @@ Merchant Backend API .. contents:: Table of Contents + +-------------------- +Compatibility Checks +-------------------- + +.. http:get:: /config + + Return the protocol version and currency supported by this merchant backend. + This endpoint is deprecated, clients should migrate to the (identical) + /public/version API. + + **Response:** + + :status 200 OK: + The exchange accepted all of the coins. The body is a `VersionResponse`. + ------------------ Receiving Payments ------------------ @@ -973,6 +989,27 @@ The ``/public/*`` endpoints are publicly exposed on the internet and accessed both by the user's browser and their wallet. +.. http:get:: /public/config + + Return the protocol version and currency supported by this merchant backend. + + **Response:** + + :status 200 OK: + The exchange accepted all of the coins. The body is a `VersionResponse`. + + .. ts:def:: VersionResponse + + interface VersionResponse { + // libtool-style representation of the Merchant protocol version, see + // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning + // The format is "current:revision:age". + version: string; + + // Currency supported by this backend. + currency: string; + } + .. http:post:: /public/pay Pay for a proposal by giving a deposit permission for coins. Typically used by |