summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2024-03-09 20:48:08 +0100
committerChristian Grothoff <christian@grothoff.org>2024-03-09 20:48:08 +0100
commitb974b4dc18a0010db78f5982a97e120b056b8632 (patch)
treebb293a6c58d8592e7bf8e300c978a60b7d8c2de5
parentf7836f5bf9010c7546fb132fdcc6659072729f5a (diff)
downloaddocs-b974b4dc18a0010db78f5982a97e120b056b8632.tar.gz
docs-b974b4dc18a0010db78f5982a97e120b056b8632.tar.bz2
docs-b974b4dc18a0010db78f5982a97e120b056b8632.zip
spec for #8608
-rw-r--r--core/api-merchant.rst26
1 files changed, 25 insertions, 1 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index d21d8073..ebd5647d 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -123,7 +123,7 @@ such as the implemented version of the protocol and the currency used.
.. http:get:: /config
Return the protocol version and currency supported by this merchant backend.
- This specification corresponds to ``current`` protocol being version **10**.
+ This specification corresponds to ``current`` protocol being version **11**.
**Response:**
@@ -3048,6 +3048,30 @@ Removing template
Using template
----------------
+.. http:get:: [/instances/$INSTANCE]/templates/$TEMPLATE_ID
+
+ This is used to obtain information about a specific template by wallets
+ before they ask the user to fill in details.
+ This endpoint is available since protocol **v11**.
+
+ **Response:**
+
+ :http:statuscode:`200 OK`:
+ The backend has successfully returned the detailed information about a specific template.
+ Returns a `WalletTemplateDetails`.
+ :http:statuscode:`404 Not found`:
+ The instance or template(ID) is unknown to the backend.
+
+ .. ts:def:: WalletTemplateDetails
+
+ interface WalletTemplateDetails {
+
+ // Hard-coded information about the contrac terms
+ // for this template.
+ template_contract: TemplateContractDetails;
+ }
+
+
.. http:post:: [/instances/$INSTANCES]/templates/$TEMPLATE_ID
This using template can be modified by everyone and will be used to create order.