diff options
author | Thien-Thi Nguyen <ttn@gnuvola.org> | 2021-03-18 06:04:20 -0400 |
---|---|---|
committer | Thien-Thi Nguyen <ttn@gnuvola.org> | 2021-03-18 06:04:20 -0400 |
commit | 45b717c42782beb521149a2b773cc56107257400 (patch) | |
tree | b11bbcce503dd6e05b1396a425319bb80a75f2a8 /core | |
parent | 9ce1d243df39470e6c7fe7e3197751581ba859c5 (diff) | |
download | docs-45b717c42782beb521149a2b773cc56107257400.tar.gz docs-45b717c42782beb521149a2b773cc56107257400.tar.bz2 docs-45b717c42782beb521149a2b773cc56107257400.zip |
rework "forgettable" marking documentation
- add anchor prior for "Private order data cleanup"
- remove FIXME blurb
- drop ‘ContractTerms._forgettable’
- add para describing "peer ‘_forgettable’" fields
- add internal link to ‘private-order-data-cleanup’
Diffstat (limited to 'core')
-rw-r--r-- | core/api-merchant.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst index b2b2b2ff..38a99ad6 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -1912,6 +1912,8 @@ Inspecting orders +.. _private-order-data-cleanup: + Private order data cleanup -------------------------- @@ -2763,9 +2765,6 @@ This section describes the overall structure of the contract terms that are the foundation for Taler payments. -FIXME: the "forgettable" attribute is not -properly specified here! - .. _contract-terms: The contract terms must have the following structure: @@ -2891,10 +2890,6 @@ The contract terms must have the following structure: // Useful when the merchant needs to store extra information on a // contract without storing it separately in their database. extra?: any; - - // List of forgettable fields. Each element in the list is - // a jq(1)-style path. - _forgettable: String[]; } The wallet must select a exchange that either the merchant accepts directly by @@ -3019,3 +3014,9 @@ It has the following structure: // Master public key of the exchange. master_pub: EddsaPublicKey; } + +In addition to the fields described above, +each object (from ``ContractTerms`` down) +can mark certain fields as "forgettable" by listing the names of those fields +in a special peer field ``_forgettable``. +(See :ref:`Private order data cleanup <private-order-data-cleanup>`.) |