taler-docs

commit c694d7bdcadbe054db1bde682f717d3c42609ed7
parent d555c7f61a4e44b6e41aaa454f3aa0b4e9c23cb6
Author: Christian Grothoff <grothoff@gnunet.org>
Date:   Fri, 11 Apr 2025 14:52:37 +0200

spec read_only flag properly (#9725)

Diffstat:
M
core/api-challenger.rst
 | 
13
++++++++++++-

1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/core/api-challenger.rst b/core/api-challenger.rst
@@ -157,7 +157,9 @@ Setup
   The body can be an address in JSON encoding to pre-initialize the address to
   be used by challenger for this process. If the body is absent, the user will
   have to enter the full address details.  The specific address format depends
-  on the address type.
+  on the address type.  However, `ChallengeSetupRequest` defines the shared
+  ``read_only`` bit that has a special meaning independent of the address type:
+  it informs Challenger that the address should not be editable.
 
   Passing an address in the ``/setup`` body is supported @since protocol **v4**.
 
@@ -171,6 +173,15 @@ Setup
 
   **Details::**
 
+  .. ts:def:: ChallengeSetupRequest
+
+    interface ChallengeSetupResponse {
+      // If true, the given address should not be edited.
+      // Defaults to 'false' if not specified.
+      read_only: boolean;
+    }
+
+
   .. ts:def:: ChallengeSetupResponse
 
     interface ChallengeSetupResponse {