diff --git a/_docs_integrate/examples/example.config.json b/_docs_integrate/examples/example.config.json index ad0a30b2a..bc97b625e 100644 --- a/_docs_integrate/examples/example.config.json +++ b/_docs_integrate/examples/example.config.json @@ -14,7 +14,7 @@ "apiKey": { "keys": { "": { - "key": " https://enmeshed.eu/operate/configuration#httpserver>" + "key": " https://enmeshed.eu/operate/configuration#apikey>" } } } diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index ccf62e9d3..44422fe2f 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -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://", - authenticator: new ApiKeyAuthenticator("") + baseUrl: "", + authenticator: new ApiKeyAuthenticator("") }); ``` diff --git a/_docs_operate/configuration.md b/_docs_operate/configuration.md index 1ff7407ed..c61c11918 100644 --- a/_docs_operate/configuration.md +++ b/_docs_operate/configuration.md @@ -74,7 +74,7 @@ You want to configure the following values: "apiKey": { "keys": { "default": { - "key": "an-api-key" + "key": "a-valid-API-key" } } } @@ -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 @@ -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" } } } @@ -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" } } } @@ -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` diff --git a/_docs_operate/setup-with-docker-compose.md b/_docs_operate/setup-with-docker-compose.md index 423331aa6..3d3f59854 100644 --- a/_docs_operate/setup-with-docker-compose.md +++ b/_docs_operate/setup-with-docker-compose.md @@ -141,7 +141,7 @@ To use the api platform hosted on the Connector you need to make the following c "apiKey": { "keys": { "": { - "key": "" + "key": "" } } }