diff --git a/doc/SpecifyingApplications/CreatingConfigFile/CreatingConfigFile.md b/doc/SpecifyingApplications/CreatingConfigFile/CreatingConfigFile.md index 508aeca3..96f6ed9c 100644 --- a/doc/SpecifyingApplications/CreatingConfigFile/CreatingConfigFile.md +++ b/doc/SpecifyingApplications/CreatingConfigFile/CreatingConfigFile.md @@ -65,6 +65,8 @@ Several need to be added, and it is recommended to copy and paste the existing o - After you updated the OperationClients at all the HttpClients, double check whether the ordering of the OperationClients is consistent with the ServiceList. - After assuring that, double check, whether the abbreviation of the application's name inside the UUIDs of all the OperationClients, HttpClients and TcpClients is correct. - Finally, double check the sequence number inside the UUIDs of all the OperationClients, HttpClients and TcpClients. + +- Also ensure that the [operationKey](./OperationKeys.md) fields of OperationClients and OperationServers are set correctly. #### ForwardingConstructs diff --git a/doc/SpecifyingApplications/CreatingConfigFile/OperationKeys.md b/doc/SpecifyingApplications/CreatingConfigFile/OperationKeys.md new file mode 100644 index 00000000..cc8b68c4 --- /dev/null +++ b/doc/SpecifyingApplications/CreatingConfigFile/OperationKeys.md @@ -0,0 +1,32 @@ +# Setting the correct operationKeys in the CONFIGfile + +This document describes how to assign the correct operationKeys to OperationClients and OperationServers in the configFile. + + +### Concept + +- For some operations an operationKey needs to be provided, whereas other operations do not require an operationKey to be provided. +- Whether providing an operationKey is required is defined in the `security` section of a given operations specification. +- Currently the following three options are available: + 1. `apiAuthKey`: an operationKey needs to be provided + - operationKey = default operationKey = "Operation key not yet provided." + 2. `basicAuth`: instead of an operationKey an authorization code needs to be provided upon request execution + - operationKey = "n.a." + 3. no security tag at all: no authentication is required. + - operationKey = "n.a." + +#### Examples +The following code snippets show OAS examples for all three options: + +| OAS Example | Info | +|------------------------------------------------------|--------------------------------------------------------------------------| +| ![apiKeyAuth](./pictures/example_oas_apiKeyAuth.png) | operationKey required,
operationKey = default operationKey | +| ![basicAuth](./pictures/example_oas_basicAuth.png) | requires authorizationCode instead of operationKey,
operationKey = n.a. | +| ![noAuth](./pictures/example_oas_noAuth.png) | operationKey = n.a. | + +Examples from ConfigFile: +| ConfigFile Example | ConfigFile | +|---------------|-----------------------------------------------------------------| +| 1. apiKeyAuth | ![apiKeyAuthConf](./pictures/example_configFile_apiKeyAuth.png) | +| 2. basicAuth | ![basicAuthConf](./pictures/example_configFile_basicAuth.png) | +| 3. noAuth | ![noAuthConf](./pictures/example_configFile_noAuth.png) | \ No newline at end of file diff --git a/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_configFile_apiKeyAuth.png b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_configFile_apiKeyAuth.png new file mode 100644 index 00000000..85e5524f Binary files /dev/null and b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_configFile_apiKeyAuth.png differ diff --git a/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_configFile_basicAuth.png b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_configFile_basicAuth.png new file mode 100644 index 00000000..546a6997 Binary files /dev/null and b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_configFile_basicAuth.png differ diff --git a/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_configFile_noAuth.png b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_configFile_noAuth.png new file mode 100644 index 00000000..187b1455 Binary files /dev/null and b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_configFile_noAuth.png differ diff --git a/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_oas_apiKeyAuth.png b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_oas_apiKeyAuth.png new file mode 100644 index 00000000..6f761fad Binary files /dev/null and b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_oas_apiKeyAuth.png differ diff --git a/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_oas_basicAuth.png b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_oas_basicAuth.png new file mode 100644 index 00000000..f53d2a34 Binary files /dev/null and b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_oas_basicAuth.png differ diff --git a/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_oas_noAuth.png b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_oas_noAuth.png new file mode 100644 index 00000000..5f0cef32 Binary files /dev/null and b/doc/SpecifyingApplications/CreatingConfigFile/pictures/example_oas_noAuth.png differ