commit a84f5a818d9139c175397d41e08f2e15708199f0
parent 7fe8a624a7df611046851db8a8b32d47a4dc65e6
Author: Christian Grothoff <christian@grothoff.org>
Date: Wed, 25 Mar 2026 22:12:05 +0100
rename for consistency
Diffstat:
5 files changed, 60 insertions(+), 60 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -948,13 +948,13 @@ Inspecting pots
.. include:: merchant/get-private-pots.rst
-.. include:: merchant/get-private-pots-POT_SERIAL.rst
+.. include:: merchant/get-private-pots-POT_ID.rst
Removing pots
^^^^^^^^^^^^^
-.. include:: merchant/delete-private-pots-POT_SERIAL.rst
+.. include:: merchant/delete-private-pots-POT_ID.rst
diff --git a/core/merchant/delete-private-pots-POT_ID.rst b/core/merchant/delete-private-pots-POT_ID.rst
@@ -0,0 +1,22 @@
+.. http:delete:: [/instances/$INSTANCE]/private/pots/$POT_ID
+
+ This is used to delete information about a pot. Existing
+ references to the pot will simply be lost and treated as "no pot";
+ there will be no indication that the pot is still in used from the
+ backend.
+
+ **Required permission:** ``pots-write``
+
+ **Response:**
+
+ :http:statuscode:`204 No content`:
+ The backend has successfully deleted the pot.
+ :http:statuscode:`400 Bad Request`:
+ The pot ID parameter is malformed.
+ Returned with ``TALER_EC_GENERIC_PARAMETER_MALFORMED``.
+ :http:statuscode:`404 Not found`:
+ The pot or the instance is unknown to the backend.
+ Returned with ``TALER_EC_MERCHANT_GENERIC_MONEY_POT_UNKNOWN``.
+ :http:statuscode:`500 Internal Server Error`:
+ The server experienced an internal failure.
+ Returned with ``TALER_EC_GENERIC_DB_STORE_FAILED``.
diff --git a/core/merchant/delete-private-pots-POT_SERIAL.rst b/core/merchant/delete-private-pots-POT_SERIAL.rst
@@ -1,22 +0,0 @@
-.. http:delete:: [/instances/$INSTANCE]/private/pots/$POT_SERIAL
-
- This is used to delete information about a pot. Existing
- references to the pot will simply be lost and treated as "no pot";
- there will be no indication that the pot is still in used from the
- backend.
-
- **Required permission:** ``pots-write``
-
- **Response:**
-
- :http:statuscode:`204 No content`:
- The backend has successfully deleted the pot.
- :http:statuscode:`400 Bad Request`:
- The pot ID parameter is malformed.
- Returned with ``TALER_EC_GENERIC_PARAMETER_MALFORMED``.
- :http:statuscode:`404 Not found`:
- The pot or the instance is unknown to the backend.
- Returned with ``TALER_EC_MERCHANT_GENERIC_MONEY_POT_UNKNOWN``.
- :http:statuscode:`500 Internal Server Error`:
- The server experienced an internal failure.
- Returned with ``TALER_EC_GENERIC_DB_STORE_FAILED``.
diff --git a/core/merchant/get-private-pots-POT_ID.rst b/core/merchant/get-private-pots-POT_ID.rst
@@ -0,0 +1,36 @@
+.. http:get:: [/instances/$INSTANCE]/private/pots/$POT_ID
+
+ This is used to obtain detailed information about specific pot.
+
+ **Required permission:** ``pots-read``
+
+ **Response:**
+
+ :http:statuscode:`200 OK`:
+ The backend has successfully returned the detailed information about a specific pot. Returns a `PotDetailResponse`.
+ :http:statuscode:`400 Bad Request`:
+ The pot ID parameter is malformed.
+ Returned with ``TALER_EC_GENERIC_PARAMETER_MALFORMED``.
+ :http:statuscode:`404 Not found`:
+ The pot or instance is unknown to the backend.
+ :http:statuscode:`500 Internal Server Error`:
+ The server experienced an internal failure.
+ Returned with ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
+
+ **Details:**
+
+ .. ts:def:: PotDetailResponse
+
+ interface PotDetailResponse {
+
+ // Description of the pot. Possibly included
+ // in the pot message.
+ description: string;
+
+ // Name of the pot. Must be unique per instance.
+ pot_name: string;
+
+ // Current total amount in the pot.
+ pot_totals: Amount[];
+
+ }
diff --git a/core/merchant/get-private-pots-POT_SERIAL.rst b/core/merchant/get-private-pots-POT_SERIAL.rst
@@ -1,36 +0,0 @@
-.. http:get:: [/instances/$INSTANCE]/private/pots/$POT_SERIAL
-
- This is used to obtain detailed information about specific pot.
-
- **Required permission:** ``pots-read``
-
- **Response:**
-
- :http:statuscode:`200 OK`:
- The backend has successfully returned the detailed information about a specific pot. Returns a `PotDetailResponse`.
- :http:statuscode:`400 Bad Request`:
- The pot ID parameter is malformed.
- Returned with ``TALER_EC_GENERIC_PARAMETER_MALFORMED``.
- :http:statuscode:`404 Not found`:
- The pot or instance is unknown to the backend.
- :http:statuscode:`500 Internal Server Error`:
- The server experienced an internal failure.
- Returned with ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
-
- **Details:**
-
- .. ts:def:: PotDetailResponse
-
- interface PotDetailResponse {
-
- // Description of the pot. Possibly included
- // in the pot message.
- description: string;
-
- // Name of the pot. Must be unique per instance.
- pot_name: string;
-
- // Current total amount in the pot.
- pot_totals: Amount[];
-
- }
