summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-09-30 14:42:53 +0200
committerChristian Grothoff <christian@grothoff.org>2021-09-30 14:42:53 +0200
commitedd65b2fa2ee029fb670150f92513d20edce0bf1 (patch)
treed08889a3400117b13abd178523752a3404b9b46b /doc
parenta16b1544ffb8d5a62fb06795abfd9490c6a4376c (diff)
downloadanastasis-edd65b2fa2ee029fb670150f92513d20edce0bf1.tar.gz
anastasis-edd65b2fa2ee029fb670150f92513d20edce0bf1.tar.bz2
anastasis-edd65b2fa2ee029fb670150f92513d20edce0bf1.zip
allow providers to be enabled/disabled
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/reducer.rst32
1 files changed, 19 insertions, 13 deletions
diff --git a/doc/sphinx/reducer.rst b/doc/sphinx/reducer.rst
index 320db48..defd088 100644
--- a/doc/sphinx/reducer.rst
+++ b/doc/sphinx/reducer.rst
@@ -358,7 +358,7 @@ providers that accept payments in the selected currency:
},
{
"type": "string",
- "name": "tax_number",
+ "name": "tax_number",
"label": "Taxpayer identification number",
"label_i18n":{
"de_DE": "Steuerliche Identifikationsnummer",
@@ -366,7 +366,7 @@ providers that accept payments in the selected currency:
"en": "German taxpayer identification number"
},
"widget": "anastasis_gtk_ia_tax_de",
- "uuid": "dae48f85-e3ff-47a4-a4a3-ed981ed8c3c6",
+ "uuid": "dae48f85-e3ff-47a4-a4a3-ed981ed8c3c6",
"validation-regex": "^[0-9]{11}$",
"validation-logic": "DE_TIN_check"
},
@@ -381,8 +381,8 @@ providers that accept payments in the selected currency:
"en": "Social security number"
},
"widget": "anastasis_gtk_ia_ssn",
- "validation-regex": "^[0-9]{8}[[:upper:]][0-9]{3}$",
- "validation-logic": "DE_SVN_check"
+ "validation-regex": "^[0-9]{8}[[:upper:]][0-9]{3}$",
+ "validation-logic": "DE_SVN_check"
"optional" : true
}
],
@@ -494,22 +494,23 @@ adds one or more Anastasis providers to the list of providers the reducer
should henceforth consider. Note that removing providers is not possible at
this time.
-Here, the client must provide an array with the base URLs of the
-providers to add, for example:
+Here, the client must provide an object with the base URLs of the
+providers to add or disable. The object maps the
+URLs to status information about the provider to
+use. For example:
.. code-block:: json
{
- "urls": [
- "http://localhost:8888/",
- "http://localhost:8089/"
- ]
+ "http://localhost:8088/" : { "disabled" : false },
+ "http://localhost:8089/" : { "disabled" : false }
+ "http://localhost:8090/" : { "disabled" : true },
}
-Note that existing providers will remain in the state. The following is an
+Note that existing providers will remain in the state they were in. The following is an
example for an expected new state where the service on port 8089 is
-unreachable, the service on port 8088 was previously known, and service on
-port 8888 was now added:
+unreachable, the services on port 8088 and 8888 were previously known, and service on
+port 8088 was now added, and on 8090 is disabled:
.. code-block:: json
@@ -517,10 +518,15 @@ port 8888 was now added:
"backup_state": "USER_ATTRIBUTES_COLLECTING",
"authentication_providers": {
"http://localhost:8089/": {
+ "disabled": false,
"error_code": 11,
"http_status": 0
},
+ "http://localhost:8090/": {
+ "disabled": true
+ },
"http://localhost:8088/": {
+ "disabled": false,
"http_status": 200,
"methods": [
{ "type" : "question",