taler-docs

commit e8ce884dc77cacc037fd8cc3f74adc25ed59bf33
parent d0e18a5ef0eb1bc350f99a53b91ff1f199db877c
Author: Christian Grothoff <christian@grothoff.org>
Date:   Fri,  4 Jul 2025 00:09:26 +0200

add product_name to inventory (#9511)

Diffstat:
M
core/api-bank-revenue.rst
 | 
8
++++----
M
core/api-merchant.rst
 | 
34
+++++++++++++++++++++++++++++++---

2 files changed, 35 insertions(+), 7 deletions(-)
diff --git a/core/api-bank-revenue.rst b/core/api-bank-revenue.rst
@@ -81,16 +81,16 @@ Querying the transaction history
 
   :query limit: *Optional.*
     At most return the given number of results. Negative for descending by ``row_id``, positive for ascending by ``row_id``. Defaults to ``-20``. Since protocol v1.
-  :query offset: *Optional.* 
+  :query offset: *Optional.*
     Starting ``row_id`` for :ref:`pagination <row-id-pagination>`. Since protocol v1.
   :query timeout_ms: *Optional.*
     Timeout in milliseconds, for :ref:`long-polling <long-polling>`, to wait for at least one element to be shown. Only useful if *limit* is positive. Since protocol v1.
   :query delta: *Optional.*
-    Deprecated in protocol v1. Use *limit* instead.
+    Deprecated in protocol **v1**. Use *limit* instead.
   :query start: *Optional.*
-    Deprecated in protocol v1. Use *offset* instead.
+    Deprecated in protocol **v1**. Use *offset* instead.
   :query long_poll_ms: *Optional.*
-    Deprecated in protocol v1. Use *timeout_ms* instead.
+    Deprecated in protocol **v1**. Use *timeout_ms* instead.
 
   **Response:**
 
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -143,7 +143,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 **v19**.
+  This specification corresponds to ``current`` protocol being version **v20**.
 
   **Response:**
 
@@ -2334,6 +2334,12 @@ Adding products to the inventory
       // Product ID to use.
       product_id: string;
 
+      // Human-readable product name.
+      // Since API version **v20**.  Optional only for
+      // backwards-compatibility, should be considered mandatory
+      // moving forward!
+      product_name?: string;
+
       // Human-readable product description.
       description: string;
 
@@ -2413,6 +2419,12 @@ Adding products to the inventory
 
     interface ProductPatchDetail {
 
+      // Human-readable product name.
+      // Since API version **v20**.  Optional only for
+      // backwards-compatibility, should be considered mandatory
+      // moving forward!
+      product_name?: string;
+
       // Human-readable product description.
       description: string;
 
@@ -2526,6 +2538,10 @@ Inspecting inventory
 
     interface ProductDetail {
 
+      // Human-readable product name.
+      // Since API version **v20**.
+      product_name: string;
+
       // Human-readable product description.
       description: string;
 
@@ -2614,8 +2630,12 @@ Inspecting inventory
       // A unique numeric ID of the product
       product_serial: number;
 
-      // A merchant-internal unique identifier for the product
-      product_id?: string;
+      // A merchant-internal unique identifier for the product.
+      product_id: string;
+
+      // Human-readable product name.
+      // Since API version **v20**.
+      product_name: string;
 
       // A list of category IDs this product belongs to.
       // Typically, a product only belongs to one category, but more than one is supported.
@@ -3105,6 +3125,7 @@ Creating orders
     // it will override those details (including price or taxes)
     // that the backend would otherwise fill in via the inventory.
     interface MinimalInventoryProduct {
+
       // Which product is requested (here mandatory!).
       product_id: string;
 
@@ -5193,9 +5214,16 @@ It has the following structure:
 .. ts:def:: Product
 
   interface Product {
+
     // Merchant-internal identifier for the product.
     product_id?: string;
 
+    // Name of the product.
+    // Since API version **v20**.  Optional only for
+    // backwards-compatibility, should be considered mandatory
+    // moving forward!
+    product_name?: string;
+
     // Human-readable product description.
     description: string;