Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
32 changes: 32 additions & 0 deletions doc/SpecifyingApplications/CreatingConfigFile/OperationKeys.md
Original file line number Diff line number Diff line change
@@ -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, <br> operationKey = default operationKey |
| ![basicAuth](./pictures/example_oas_basicAuth.png) | requires authorizationCode instead of operationKey, <br> 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) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.