[taler-docs] branch master updated: document new ADDRESS_RESTRICTIONS regex option

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 05edb08e document new ADDRESS_RESTRICTIONS regex option
05edb08e is described below

commit 05edb08e886c55dd9200a42e52e1bcb7007d13f4
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Tue Mar 5 22:47:11 2024 +0100

    document new ADDRESS_RESTRICTIONS regex option
---
 manpages/challenger.conf.5.rst | 2 ++
 taler-challenger-manual.rst    | 3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/manpages/challenger.conf.5.rst b/manpages/challenger.conf.5.rst
index a46b8461..66c46e80 100644
--- a/manpages/challenger.conf.5.rst
+++ b/manpages/challenger.conf.5.rst
@@ -71,6 +71,8 @@ AUTH_COMMAND
 ADDRESS_TYPE
   Type of the address that is being collected, returned as part of the 
``address_type`` in the ``/info`` endpoint. Examples include ``email`` or 
``phone``.
 
+ADDRESS_RESTRICTIONS
+  JSON object with a map of keys (names of the fields of the address to be 
entered by the user) to objects with a "regex" (string) containing an extended 
Posix regular expression for allowed address field values, and a 
"hint"/"hint_i18n" giving a human-readable explanation to display if the value 
entered by the user does not match the regex. Keys that are not mapped to such 
an object have no restriction on the value provided by the user. Examples would 
be '{"email":{"hint":"valid e-mail  [...]
 
 
 SEE ALSO
diff --git a/taler-challenger-manual.rst b/taler-challenger-manual.rst
index a7a7169f..39b06710 100644
--- a/taler-challenger-manual.rst
+++ b/taler-challenger-manual.rst
@@ -1,7 +1,7 @@
 ..
   This file is part of GNU TALER.
 
-  Copyright (C) 2023 Taler Systems SA
+  Copyright (C) 2023, 2024 Taler Systems SA
 
   TALER is free software; you can redistribute it and/or modify it under the
   terms of the GNU Affero General Public License as published by the Free 
Software
@@ -558,6 +558,7 @@ file) is also supported.
 
 The template is instantiated using the following information:
 
+  * restrictions: Object; map of keys (names of the fields of the address to 
be entered by the user) to objects with a "regex" (string) containing an 
extended Posix regular expression for allowed address field values, and a 
"hint"/"hint_i18n" giving a human-readable explanation to display if the value 
entered by the user does not match the regex. Keys that are not mapped to such 
an object have no restriction on the value provided by the user.  See 
"ADDRESS_RESTRICTIONS" in the challenger [...]
   * fix_address: boolean; indicates if the given address cannot be changed
     anymore, the form should be read-only if set to true.
 

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.