summaryrefslogtreecommitdiff
path: root/core/api-merchant.rst
diff options
context:
space:
mode:
authorTorsten Grote <t@grobox.de>2020-03-02 17:34:13 -0300
committerTorsten Grote <t@grobox.de>2020-03-02 17:34:13 -0300
commit1cd31101036559e6a02c10ee2e6e60f283f925c7 (patch)
tree72cacc1daf69026c343dd4f3e2d59f820d6b6555 /core/api-merchant.rst
parentbe60dad5283e0afb0ecbbb167a67fc6ce083d41b (diff)
downloaddocs-1cd31101036559e6a02c10ee2e6e60f283f925c7.tar.gz
docs-1cd31101036559e6a02c10ee2e6e60f283f925c7.tar.bz2
docs-1cd31101036559e6a02c10ee2e6e60f283f925c7.zip
Move to better backwards-compatible i18n format for contract terms
Diffstat (limited to 'core/api-merchant.rst')
-rw-r--r--core/api-merchant.rst27
1 files changed, 11 insertions, 16 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 8ff89d21..f6297ae1 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -734,7 +734,10 @@ The contract terms must have the following structure:
interface ContractTerms {
// Human-readable description of the whole purchase
- summary: TranslatableString;
+ summary: string;
+
+ // Map from IETF BCP 47 language tags to localized summaries
+ summary_i18n?: { [lang_tag: string]: string };
// Unique, free-form identifier for the proposal.
// Must be unique within a merchant instance.
@@ -746,7 +749,7 @@ The contract terms must have the following structure:
// Total price for the transaction.
// The exchange will subtract deposit fees from that amount
- // before transfering it to the merchant.
+ // before transferring it to the merchant.
amount: Amount;
// The URL for this purchase. Every time is is visited, the merchant
@@ -846,8 +849,8 @@ The contract terms must have the following structure:
extra?: any;
}
- The wallet must select a exchange that either the mechant accepts directly by
- listing it in the exchanges arry, or for which the merchant accepts an auditor
+ The wallet must select a exchange that either the merchant accepts directly by
+ listing it in the exchanges array, or for which the merchant accepts an auditor
that audits that exchange by listing it in the auditors array.
The `Product` object describes the product being purchased from the merchant. It has the following structure:
@@ -856,7 +859,10 @@ The contract terms must have the following structure:
interface Product {
// Human-readable product description.
- description: TranslatableString;
+ description: string;
+
+ // Map from IETF BCP 47 language tags to localized descriptions
+ description_i18n?: { [lang_tag: string]: string };
// The quantity of the product to deliver to the customer (optional, if applicable)
quantity?: string;
@@ -880,17 +886,6 @@ The contract terms must have the following structure:
delivery_location: string;
}
-
- .. ts:def:: TranslatableString
-
- interface TranslatableString {
- // default string to be shown when there is no string for the user's locale available
- _: string;
- // [locale] is replaced with an IETF BCP 47 language tag for a localized string (optional)
- // more than one locale might be added, the UI chooses the most suitable one for display
- [locale]?: string;
- }
-
.. ts:def:: Merchant
interface Merchant {