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
2 changes: 1 addition & 1 deletion _docs_integrate/examples/example.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"apiKey": {
"keys": {
"<an-api-key-id>": {
"key": "<define-an-apiKey => https://enmeshed.eu/operate/configuration#httpserver>"
"key": "<define-a-valid-API-key => https://enmeshed.eu/operate/configuration#apikey>"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions _docs_integrate/migration-from-v6-to-v7.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ With every version of the Connector, we ship a matching [TypeScript SDK]({% link
import { ApiKeyAuthenticator, ConnectorClient } from "@nmshd/connector-sdk";

const connectorClient = ConnectorClient.create({
baseUrl: "https://<INSERT_YOUR_CONNECTOR_DOMAIN_HERE>",
authenticator: new ApiKeyAuthenticator("<INSERT_YOUR_API_KEY_HERE>")
baseUrl: "<insert-the-base-URL-of-your-Connector-here>",
authenticator: new ApiKeyAuthenticator("<insert-your-valid-API-key-here>")
});
```

Expand Down
10 changes: 5 additions & 5 deletions _docs_operate/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ You want to configure the following values:
"apiKey": {
"keys": {
"default": {
"key": "an-api-key"
"key": "a-valid-API-key"
}
}
}
Expand All @@ -86,7 +86,7 @@ You want to configure the following values:

- The first value can be configured using the variable `infrastructure:httpServer:enabled="true"`. Note that the value is represented as a string in the environment variable and the Connector will rewrite it to its boolean representation.
- The second value can be configured using the variable `infrastructure:httpServer:port="8080"`. Note that the value is represented as a string in the environment variable and the Connector will rewrite it to its number representation.
- The third value can be configured using the variable `infrastructure:httpServer:authentication:apiKey:keys:default:key="an-api-key"`.
- The third value can be configured using the variable `infrastructure:httpServer:authentication:apiKey:keys:default:key="a-valid-API-key"`.

## Configuration options

Expand Down Expand Up @@ -235,7 +235,7 @@ The HTTP server is the base for the `coreHttpApi` Module. It opens an express HT
"apiKey": {
"keys": {
"default": {
"key": "an-api-key"
"key": "a-valid-API-key"
}
}
}
Expand Down Expand Up @@ -312,7 +312,7 @@ If multiple authentication methods are configured, the authentication methods wi
"apiKey": {
"keys": {
"default": {
"key": "an-api-key"
"key": "a-valid-API-key"
}
}
}
Expand All @@ -338,7 +338,7 @@ The `apiKey` authentication method is used to authenticate requests using an API

- **key** `required`

The actual API key that is used to authenticate the request. This key must be kept secret and should not be shared with anyone.
The actual API key that is used to authenticate the request. This key must be kept secret and should not be shared with anyone. A valid API key must be at least 30 characters long and contain at least 2 digits, 2 uppercase letters, 2 lowercase letters and 1 special character out of ``!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~``.

- **description** `optional`

Expand Down
2 changes: 1 addition & 1 deletion _docs_operate/setup-with-docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ To use the api platform hosted on the Connector you need to make the following c
"apiKey": {
"keys": {
"<an-api-key-id>": {
"key": "<an-api-key>"
"key": "<a-valid-API-key>"
}
}
}
Expand Down