aboutsummaryrefslogtreecommitdiff
path: root/docs/spec.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/spec.md')
-rw-r--r--docs/spec.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/spec.md b/docs/spec.md
index ab557ac..f0bab39 100644
--- a/docs/spec.md
+++ b/docs/spec.md
@@ -58,7 +58,7 @@ Not all changes are backward compatible and require adjustments in app2mzs-1.5.3
This change is *not backward compatible*.
- The optional `Config` element was added to the `DeliveryRequest` element.
This element allows overriding individual configuration parameters for the ongoing request.
- This change is *backward compatible*: You do not need to specify any parameters in the `Config`-element since you can also configure delivery requests in `application.yaml`.
+ This change is *backward compatible*: You do not need to specify any parameters in the `Config`-element since you can also configure delivery requests in [application.yaml](../src/test/resources/config/application.yaml).
See [Chapter Configuration](#configuration) for more details.
- The element `XMLDocument` was replaced as this element was dropped from [zusemsg] in favor of the `msg:Payload` element.
@@ -135,9 +135,9 @@ The following list specifies, how to configure a parameter and in which priority
For parameters that are missing from the `Config` element, MOA ZS falls back to the parameter from the *referred profile*.
The scope of a parameter in the `Config` element is always limited to the current delivery request.
-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`.
+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](../src/test/resources/config/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, paste, and indent 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](../src/test/resources/config/application.yaml), copy, paste, and indent the template from below or copy an existing profile from [application.yaml](../src/test/resources/config/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.
@@ -145,10 +145,10 @@ The following list specifies, how to configure a parameter and in which priority
It is recommended to specify all mandatory parameters in this default profile.
Otherwise, a parameter may be unconfigured, in which case MOA ZS rejects the delivery request.
-### Structure of a Delivery Request Configuration Profile in `application.yaml`
+### Structure of a Delivery Request Configuration Profile in [application.yaml](../src/test/resources/config/application.yaml)
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`.
+You find a description and examples of the individual parameters in [application.yaml](../src/test/resources/config/application.yaml).
<ProfileID-string>:
@@ -205,7 +205,7 @@ This listing shows, how a connection of a client can be protected with SSL and h
### Logging
MOA ZS uses Spring Boot's default logging backend, which is logback.
-In `application.yaml` you can choose which loggers should log which levels.
+In [application.yaml](../src/test/resources/config/application.yaml) you can choose which loggers should log which levels.
You can choose between the following five log levels (sorted by descending importance and ascending level of detail): `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`.
You may specify if MOA ZS should log events to a file appender via the `logging.file` parameter.
You can specify the logging format in `logback.xml`.