summaryrefslogtreecommitdiff
path: root/anastasis.rst
diff options
context:
space:
mode:
authorDennis Neufeld <dennis.neufeld@students.bfh.ch>2020-11-06 15:31:50 +0100
committerDennis Neufeld <dennis.neufeld@students.bfh.ch>2020-11-06 18:03:16 +0100
commit9feb9cfffb51e344c25fb3458fd8550a4cf8ab58 (patch)
tree6dafcaf651630c70871ec0e61a3d040c8af9f246 /anastasis.rst
parentacb799f34f2d576b39203012d0c603ffaf31a232 (diff)
downloaddocs-9feb9cfffb51e344c25fb3458fd8550a4cf8ab58.tar.gz
docs-9feb9cfffb51e344c25fb3458fd8550a4cf8ab58.tar.bz2
docs-9feb9cfffb51e344c25fb3458fd8550a4cf8ab58.zip
restructured reducer documentation
Diffstat (limited to 'anastasis.rst')
-rw-r--r--anastasis.rst102
1 files changed, 39 insertions, 63 deletions
diff --git a/anastasis.rst b/anastasis.rst
index c312a04..22e66d1 100644
--- a/anastasis.rst
+++ b/anastasis.rst
@@ -899,7 +899,29 @@ Backup Reducer
The illustration above shows the different states the reducer can have during a backup
process.
-In the following, the individual transitions in the backup process will be specified in more detail.
+
+
+Recovery Reducer
+^^^^^^^^^^^^^^^^
+.. figure:: anastasis_reducer_recovery.png
+ :name: fig-anastasis_reducer_recovery
+ :alt: fig-anastasis_reducer_recovery
+ :scale: 35 %
+ :align: center
+
+ Recovery states and their transitions.
+
+
+The illustration above shows the different states the reducer can have during a recovery
+process.
+
+
+Reducer transitions
+^^^^^^^^^^^^^^^^^^^
+In the following, the individual transitions will be specified in more detail.
+
+Common transitions
+""""""""""""""""""
**select_continent:**
@@ -910,6 +932,12 @@ Arguments (example):
"continent": "Europe"
}
+Expected new state:
+::
+
+ {
+
+ }
**select_country:**
@@ -939,6 +967,14 @@ Arguments (example):
}
+**next**, **back**, **pay:**
+
+No Arguments needed.
+
+
+Backup transitions
+""""""""""""""""""
+
**add_authentication:**
Arguments (example):
@@ -1009,63 +1045,8 @@ Arguments (example):
- type: *data* (secret must be a Crockford-Base32 encoded string of some data, e.g. a private key)
-**next**, **back**, **pay:**
-
-No Arguments needed.
-
-
-Recovery Reducer
-^^^^^^^^^^^^^^^^
-.. figure:: anastasis_reducer_recovery.png
- :name: fig-anastasis_reducer_recovery
- :alt: fig-anastasis_reducer_recovery
- :scale: 35 %
- :align: center
-
- Recovery states and their transitions.
-
-
-The illustration above shows the different states the reducer can have during a recovery
-process.
-In the following, the individual transitions in the backup process will be specified in more detail.
-
-**select_continent:**
-
-Arguments (example):
-::
-
- {
- "continent": "Europe"
- }
-
-
-**select_country:**
-
-Arguments (example):
-::
-
- {
- "country": "Germany",
- "country_code": "de",
- "currency": "EUR"
- }
-
-
-**enter_user_attributes:**
-
-Arguments (example):
-::
-
- {
- "identity_attributes": {
- "full_name": "Max Musterman",
- "social_security_number": "123456789",
- "birth_year": "2000",
- "birth_month": "01",
- "birth_day": "01"
- }
- }
-
+Recovery transitions
+""""""""""""""""""""
**select_challenge:**
@@ -1088,11 +1069,6 @@ Arguments (example):
}
-**back**, **pay:**
-
-No Arguments needed.
-
-
.. _anastasis-auth-methods:
----------------------