aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/spec.md94
1 files changed, 45 insertions, 49 deletions
diff --git a/docs/spec.md b/docs/spec.md
index 9036835..ab557ac 100644
--- a/docs/spec.md
+++ b/docs/spec.md
@@ -137,7 +137,7 @@ The following list specifies, how to configure a parameter and in which priority
2. You can refer to a specific profile in `mzs:DeliveryRequest/Config/ProfileID`, where the value of `ProfileID` refers to a profile that was configured in `application.yaml`.
MOA ZS looks up the profile by the chosen ID and uses all parameters from this profile.
- To create a profile in `application.yaml` copy the template from below or copy an existing profile from `application.yaml`, set a new `ProfileID` and adapt parameters.
+ To create a profile in `application.yaml`, copy, paste, and indent the template from below or copy an existing profile from `application.yaml`, set a new `ProfileID` and adapt parameters.
The key of each child in `delivery-request-configuration-profiles` is the `ProfileID` of the underlying profile.
If a parameter is missing, MOA ZS falls back to the parameter in the `default` profile.
@@ -150,57 +150,53 @@ Otherwise, a parameter may be unconfigured, in which case MOA ZS rejects the del
The following listing shows the structure of a delivery request configuration profile and serves as a template.
You find a description and examples of the individual parameters in `application.yaml`.
-```
- <ProfileID-string>:
-
- service-timeout: <integer>
-
- perform-query-person-request: <boolean>
-
- tnvz-client:
- url: <string>
- connection-timeout: <integer>
- receive-timeout: <integer>
- ssl: ...
- custom-http-headers: ...
-
- msg-client:
- url: <string>
- connection-timeout: <integer>
- receive-timeout: <integer>
- ssl: ...
- custom-http-headers: ...
-
- msg-response-sinks:
- save-response-to-file:
- active: <boolean>
- path: <string>
- log-response: <boolean>
- forward-response-to-service:
- active: <boolean>
- app-client:
- url: <string>
- connection-timeout: <integer>
- receive-timeout: <integer>
- ssl: ...
- custom-http-headers: ...
-```
+ <ProfileID-string>:
+
+ service-timeout: <integer>
+
+ perform-query-person-request: <boolean>
+
+ tnvz-client:
+ url: <string>
+ connection-timeout: <integer>
+ receive-timeout: <integer>
+ ssl: ...
+ custom-http-headers: ...
+
+ msg-client:
+ url: <string>
+ connection-timeout: <integer>
+ receive-timeout: <integer>
+ ssl: ...
+ custom-http-headers: ...
+
+ msg-response-sinks:
+ save-response-to-file:
+ active: <boolean>
+ path: <string>
+ log-response: <boolean>
+ forward-response-to-service:
+ active: <boolean>
+ app-client:
+ url: <string>
+ connection-timeout: <integer>
+ receive-timeout: <integer>
+ ssl: ...
+ custom-http-headers: ...
This listing shows, how a connection of a client can be protected with SSL and how client authentication can be activated:
-```
- ssl:
- trust-all: <boolean>
- lax-hostname-verification: <boolean>
- key-store:
- filename: <string>
- password: <string>
- type: <string>
- trust-store:
- filename: <string>
- password: <string>
- type: <string>
-```
+ ssl:
+ trust-all: <boolean>
+ lax-hostname-verification: <boolean>
+ key-store:
+ filename: <string>
+ password: <string>
+ type: <string>
+ trust-store:
+ filename: <string>
+ password: <string>
+ type: <string>
### Server