From bbc80ec20c7e308ae2963dcdfcf1e3af2257dbf2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=B6nig?= Date: Wed, 9 Jul 2025 08:27:32 +0200 Subject: [PATCH 1/5] feat: update migration guide --- _docs_integrate/migration-from-v6-to-v7.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 964419be3..3663d7d4f 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -67,6 +67,9 @@ The step-by-step instructions can be consulted to start the migration to version - For the same reason, the `onlyValid` parameter was removed from the use cases [Get Attributes]({% link _docs_use-cases/use-case-consumption-get-attributes.md %}), [Get own shared Attributes]({% link _docs_use-cases/use-case-consumption-get-own-shared-attributes.md %}) and [Get peer shared Attributes]({% link _docs_use-cases/use-case-consumption-get-peer-shared-attributes.md %}). Accordingly, it was removed from the associated Connector routes as well. +### TypeScript SDK changes + +With every version of the Connector we ship a matching [TypeScript SDK]({% link _docs_integrate/access-the-connector.md %}#accessing-the-connector-by-software-development-kits-sdk). With version 7 of the SDK the deprecated field `apiKey` was removed. To access the Connector using an api key, you can configure the SDK now as follows: ## Runtime-Specific Breaking Changes As an Integrator of a Connector, the following changes do not need to be taken into account during migration to version 7, as they are Runtime-specific breaking changes handled internally by the Connector. From c233fa84a08394cb731fbda5e57de966ba5f9487 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=B6nig?= Date: Wed, 9 Jul 2025 08:27:40 +0200 Subject: [PATCH 2/5] feat: add example --- _docs_integrate/migration-from-v6-to-v7.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 3663d7d4f..18399b6d5 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -70,6 +70,16 @@ The step-by-step instructions can be consulted to start the migration to version ### TypeScript SDK changes With every version of the Connector we ship a matching [TypeScript SDK]({% link _docs_integrate/access-the-connector.md %}#accessing-the-connector-by-software-development-kits-sdk). With version 7 of the SDK the deprecated field `apiKey` was removed. To access the Connector using an api key, you can configure the SDK now as follows: + +```typescript +import { ApiKeyAuthenticator, ConnectorClient } from "@nmshd/connector-sdk"; + +const connectorClient = ConnectorClient.create({ + baseUrl: "https://", + authenticator: new ApiKeyAuthenticator("") +}); +``` + ## Runtime-Specific Breaking Changes As an Integrator of a Connector, the following changes do not need to be taken into account during migration to version 7, as they are Runtime-specific breaking changes handled internally by the Connector. From acc9a74c876ea2d1c696c9133e8dc304a80badc2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=B6nig?= <33655937+jkoenig134@users.noreply.github.com> Date: Wed, 9 Jul 2025 13:44:57 +0200 Subject: [PATCH 3/5] chore: update title Co-authored-by: Britta Stallknecht <146106656+britsta@users.noreply.github.com> --- _docs_integrate/migration-from-v6-to-v7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 18399b6d5..16f0c486b 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -67,7 +67,7 @@ The step-by-step instructions can be consulted to start the migration to version - For the same reason, the `onlyValid` parameter was removed from the use cases [Get Attributes]({% link _docs_use-cases/use-case-consumption-get-attributes.md %}), [Get own shared Attributes]({% link _docs_use-cases/use-case-consumption-get-own-shared-attributes.md %}) and [Get peer shared Attributes]({% link _docs_use-cases/use-case-consumption-get-peer-shared-attributes.md %}). Accordingly, it was removed from the associated Connector routes as well. -### TypeScript SDK changes +### TypeScript SDK Changes With every version of the Connector we ship a matching [TypeScript SDK]({% link _docs_integrate/access-the-connector.md %}#accessing-the-connector-by-software-development-kits-sdk). With version 7 of the SDK the deprecated field `apiKey` was removed. To access the Connector using an api key, you can configure the SDK now as follows: From 7a38b6bd2737d94db3d269de895a5a85ed305523 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=B6nig?= <33655937+jkoenig134@users.noreply.github.com> Date: Wed, 9 Jul 2025 13:45:42 +0200 Subject: [PATCH 4/5] chore: commas Co-authored-by: Britta Stallknecht <146106656+britsta@users.noreply.github.com> --- _docs_integrate/migration-from-v6-to-v7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 16f0c486b..047e10cc7 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -69,7 +69,7 @@ The step-by-step instructions can be consulted to start the migration to version ### TypeScript SDK Changes -With every version of the Connector we ship a matching [TypeScript SDK]({% link _docs_integrate/access-the-connector.md %}#accessing-the-connector-by-software-development-kits-sdk). With version 7 of the SDK the deprecated field `apiKey` was removed. To access the Connector using an api key, you can configure the SDK now as follows: +With every version of the Connector, we ship a matching [TypeScript SDK]({% link _docs_integrate/access-the-connector.md %}#accessing-the-connector-by-software-development-kits-sdk). With version 7 of the SDK, the deprecated field `apiKey` was removed. To access the Connector using an api key, you can configure the SDK now as follows: ```typescript import { ApiKeyAuthenticator, ConnectorClient } from "@nmshd/connector-sdk"; From 243f22422ab9ad60b968c45a349a0e3b603048c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=B6nig?= Date: Wed, 9 Jul 2025 13:46:19 +0200 Subject: [PATCH 5/5] chore: casing --- _docs_integrate/migration-from-v6-to-v7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 047e10cc7..58e770844 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -69,7 +69,7 @@ The step-by-step instructions can be consulted to start the migration to version ### TypeScript SDK Changes -With every version of the Connector, we ship a matching [TypeScript SDK]({% link _docs_integrate/access-the-connector.md %}#accessing-the-connector-by-software-development-kits-sdk). With version 7 of the SDK, the deprecated field `apiKey` was removed. To access the Connector using an api key, you can configure the SDK now as follows: +With every version of the Connector, we ship a matching [TypeScript SDK]({% link _docs_integrate/access-the-connector.md %}#accessing-the-connector-by-software-development-kits-sdk). With version 7 of the SDK, the deprecated field `apiKey` was removed. To access the Connector using an API key, you can configure the SDK now as follows: ```typescript import { ApiKeyAuthenticator, ConnectorClient } from "@nmshd/connector-sdk";