taler-docs

commit 21e9b0e4fe2c7f3fd8e07e59e49f4267c2153d48
parent a6a507a2c16a22f12d61c88b0b84fb81dcd9afcf
Author: Antoine A <>
Date:   Thu, 20 Mar 2025 20:03:24 +0100

corebank: update api doc

Diffstat:
M
core/api-corebank.rst
 | 
22
++++++++++++++++------

1 file changed, 16 insertions(+), 6 deletions(-)
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
@@ -207,11 +207,16 @@ The user ``admin`` is a special, hard-coded username. Some requests require the 
 
   **Request:**
 
+  :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 v5.
+  :query offset: *Optional.*
+    Starting ``cashout_id`` for :ref:`pagination <row-id-pagination>`. Since protocol v5.
   :query delta: *Optional.*
-    Takes value of the form ``N (-N)``, so that at most ``N`` values strictly older (younger) than ``start`` are returned.  Defaults to ``-20`` to return the last 20 entries.
+    Deprecated in protocol v5. Use *limit* instead.
   :query start: *Optional.*
-    Row number threshold, see ``delta`` for its interpretation. Defaults to smallest or biggest row id possible according to ``delta`` sign.
+    Deprecated in protocol v5. Use *offset* instead.
 
+    
   **Response:**
 
   :http:statuscode:`200 OK`:
@@ -641,7 +646,7 @@ Account Management
 
       // Is the account locked.
       // Defaults to false.
-      // @since **v7**
+      // @deprecated since **v7**
       is_locked?: boolean;
 
       // Opaque unique ID used for pagination.
@@ -650,11 +655,13 @@ Account Management
 
       // Current status of the account
       // active: the account can be used
+      // locked: the account can be used but cannot create new tokens
+      // @since **v7**
       // deleted: the account has been deleted but is retained for compliance
       // reasons, only the administrator can access it
       // Defaults to 'active' is missing
       // @since **v4**, will become mandatory in the next version.
-      status?: "active" | "deleted";
+      status?: "active" | "locked" | "deleted";
     }
 
 .. _bank-account-info:
@@ -722,19 +729,22 @@ Account Management
 
       // Is the account locked.
       // Defaults to false.
-      // @since **v7**
+      // @deprecated since **v7**
       is_locked?: boolean;
 
       // Is 2FA enabled and what channel is used for challenges?
       tan_channel?: TanChannel;
 
+    
       // Current status of the account
       // active: the account can be used
+      // locked: the account can be used but cannot create new tokens
+      // @since **v7**
       // deleted: the account has been deleted but is retained for compliance
       // reasons, only the administrator can access it
       // Defaults to 'active' is missing
       // @since **v4**, will become mandatory in the next version.
-      status?: "active" | "deleted";
+      status?: "active" | "locked" | "deleted";
     }
 
 Transactions