summaryrefslogtreecommitdiff
path: root/doc/sphinx
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-11-16 15:10:46 +0100
committerChristian Grothoff <christian@grothoff.org>2021-11-16 15:10:46 +0100
commit5867f7e4a1df6a502ee590620bbe0ebc14034a01 (patch)
tree1c0714ea51585cb195c6e11625bbb8504f5b0f35 /doc/sphinx
parent7815ced57e8849465e9d821ea8c8e9d705efd0ca (diff)
downloadanastasis-5867f7e4a1df6a502ee590620bbe0ebc14034a01.tar.gz
anastasis-5867f7e4a1df6a502ee590620bbe0ebc14034a01.tar.bz2
anastasis-5867f7e4a1df6a502ee590620bbe0ebc14034a01.zip
add uuid-display to reducer and document it
Diffstat (limited to 'doc/sphinx')
-rw-r--r--doc/sphinx/reducer.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/sphinx/reducer.rst b/doc/sphinx/reducer.rst
index 1c69971..b091c1d 100644
--- a/doc/sphinx/reducer.rst
+++ b/doc/sphinx/reducer.rst
@@ -1307,12 +1307,14 @@ a state where the user can choose which challenges to satisfy:
"challenges": [
{
"uuid": "MW2R3RCBZPHNC78AW8AKWRCHF9KV3Y82EN62T831ZP54S3K5599G",
+ "uuid-display": "MW2R3RC",
"cost": "TESTKUDOS:0",
"type": "question",
"instructions": "q1"
},
{
"uuid": "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0",
+ "uuid-display": "TXYKGE",
"cost": "TESTKUDOS:0",
"type": "email",
"instructions": "e-mail address m?il@f*.bar"
@@ -1347,8 +1349,9 @@ obtained and its ``version`` are also provided. Each challenge comes with
four mandatory fields:
- **uuid**: A unique identifier of the challenge; this is what the
- UUIDs in the policies array refer to, but also this UUID may be
- included in messages sent to the user. They allow the user to
+ UUIDs in the policies array refer to.
+ - **uuid-display**: Shortened idenfier which is included in messages
+ send to the user. Allows the user to
distinguish different PIN/TANs should say the same phone number be
used for SMS-authentication with different providers.
- **cost**: This is the amount the Anastasis provider will charge