From e56d71debdefb0c4e4dd014f66c9f7de33a43e44 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 16 Sep 2025 11:33:26 +0000 Subject: [PATCH 1/8] chore: remove deprecated use cases --- ...ransport-create-device-onboarding-token.md | 59 ------------------- .../use-case-transport-create-device.md | 38 ------------ ...se-transport-get-device-onboarding-info.md | 56 ------------------ ...case-transport-load-item-from-reference.md | 2 +- 4 files changed, 1 insertion(+), 154 deletions(-) delete mode 100644 _docs_use-cases/use-case-transport-create-device-onboarding-token.md delete mode 100644 _docs_use-cases/use-case-transport-create-device.md delete mode 100644 _docs_use-cases/use-case-transport-get-device-onboarding-info.md diff --git a/_docs_use-cases/use-case-transport-create-device-onboarding-token.md b/_docs_use-cases/use-case-transport-create-device-onboarding-token.md deleted file mode 100644 index 0ea824687..000000000 --- a/_docs_use-cases/use-case-transport-create-device-onboarding-token.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -# Start automatic generation -permalink: use-case-transport-create-device-onboarding-token -published: true -title: "Create Device Onboarding Token" -type: use-case -toc: true -sidebar: - - title: "Integrate enmeshed" - nav: "docs_integrate" -properties: - - id: RD5 - - component: Runtime - - layer: Transport - - facade: DevicesFacade - - function: createDeviceOnboardingToken - - description: - - feature category: Multi-device - - tech category: Devices - - status: DONE - - documentation status: DONE - - comments: - - actor: Identity - - trigger: Runtime - - precondition: - - result: - - priority: n/a - - complexity: n/a - - size: n/a - - created_at: - - changed_at: - - api_route_regex: - - published: default - - link: use-case-transport-create-device-onboarding-token -require: -required_by: -# End automatic generation ---- - -{{properties.description}} - -{% include properties_list.html %} - -This use case retrieves the [Token]({% link _docs_integrate/data-model-overview.md %}#token) of a not yet onboarded Device that corresponds to the given Device `id` in order to onboard the Device to the Identity. - -## Parameters - -- `id` of the Device. -- `expiresAt` is the ISODateTime the Token expires at. -- `passwordProtection` can be specified as an object for [PasswordProtection]({% link _docs_integrate/data-model-overview.md %}#passwordprotection) of a Token. If set, only the Identities that know the password specified within the `passwordProtection.password` property of the Token can load it from the Backbone. In addition, the optional property `passwordProtection.passwordIsPin` can be used to configure the UI of the App in case the password is a pin. - -## On Success - -- Returns the Token of the Device to onboard. - -## On Failure - -- The Device was already onboarded. -- In case of password protection of the Token, a `passwordProtection.password` that does not consist of 4 to 16 digits was specified, but the value of `passwordProtection.passwordIsPin` was nevertheless set to `true`. diff --git a/_docs_use-cases/use-case-transport-create-device.md b/_docs_use-cases/use-case-transport-create-device.md deleted file mode 100644 index e5338b236..000000000 --- a/_docs_use-cases/use-case-transport-create-device.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -# Start automatic generation -permalink: use-case-transport-create-device -published: false -title: "Create Device" -type: use-case -toc: true -sidebar: - - title: "Integrate enmeshed" - nav: "docs_integrate" -properties: - - id: RD1 - - component: Runtime - - layer: Transport - - facade: DevicesFacade - - function: createDevice - - description: - - feature category: Multi-device - - tech category: Devices - - status: DONE - - documentation status: - - comments: Internal - - actor: Identity - - trigger: Runtime - - precondition: - - result: - - priority: n/a - - complexity: n/a - - size: n/a - - created_at: - - changed_at: - - api_route_regex: - - published: default - - link: use-case-transport-create-device -require: -required_by: -# End automatic generation ---- diff --git a/_docs_use-cases/use-case-transport-get-device-onboarding-info.md b/_docs_use-cases/use-case-transport-get-device-onboarding-info.md deleted file mode 100644 index fd58e3795..000000000 --- a/_docs_use-cases/use-case-transport-get-device-onboarding-info.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -# Start automatic generation -permalink: use-case-transport-get-device-onboarding-info -published: true -title: "Get Device Onboarding Info" -type: use-case -toc: true -sidebar: - - title: "Integrate enmeshed" - nav: "docs_integrate" -properties: - - id: RD4 - - component: Runtime - - layer: Transport - - facade: DevicesFacade - - function: getDeviceOnboardingInfo - - description: - - feature category: Multi-device - - tech category: Devices - - status: DONE - - documentation status: DONE - - comments: - - actor: Identity - - trigger: Runtime - - precondition: - - result: - - priority: n/a - - complexity: n/a - - size: n/a - - created_at: - - changed_at: - - api_route_regex: - - published: default - - link: use-case-transport-get-device-onboarding-info -require: -required_by: -# End automatic generation ---- - -{{properties.description}} - -{% include properties_list.html %} - -This use case retrieves the onboarding information a so far not-onboarded Device that corresponds to the given Device `id` in order to onboard the Device to the Identity. - -## Parameters - -- `id` of the Device. - -## On Success - -- Returns the onboarding information of the Device. - -## On Failure - -- The Device was already onboarded. diff --git a/_docs_use-cases/use-case-transport-load-item-from-reference.md b/_docs_use-cases/use-case-transport-load-item-from-reference.md index b28d3b367..7583b671c 100644 --- a/_docs_use-cases/use-case-transport-load-item-from-reference.md +++ b/_docs_use-cases/use-case-transport-load-item-from-reference.md @@ -45,6 +45,6 @@ required_by: This use case intends to load an entity by its `reference` received by a peer. Internally, it uses the specific use cases of each entity: -- If the `reference` refers to a [Token]({% link _docs_integrate/data-model-overview.md %}#token), it fetches the Token just like the [Load Token created by others]({% link _docs_use-cases/use-case-transport-load-token-created-by-others.md %}) use case. For example, if the `content` of the Token is a TokenContentDeviceSharedSecret, a DeviceOnboardingInfo is returned after the successful execution of the use case. A TokenContentDeviceSharedSecret is created by the [Create Device Onboarding Token]({% link _docs_use-cases/use-case-transport-create-device-onboarding-token.md %}) use case. +- If the `reference` refers to a [Token]({% link _docs_integrate/data-model-overview.md %}#token), it fetches the Token just like the [Load Token created by others]({% link _docs_use-cases/use-case-transport-load-token-created-by-others.md %}) use case. For example, if the `content` of the Token is a TokenContentDeviceSharedSecret, a DeviceOnboardingInfo is returned after the successful execution of the use case. - If the `reference` refers to a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate), it fetches the RelationshipTemplate just like the [Load RelationshipTemplate created by others]({% link _docs_use-cases/use-case-transport-load-relationshiptemplate-created-by-others.md %}) use case. - If the `reference` refers to a [File]({% link _docs_integrate/data-model-overview.md %}#file), it fetches the File just like the [Load File]({% link _docs_use-cases/use-case-transport-load-file.md %}) use case. From 02f2969b162ad2380272b7fca06c89ee1a854e96 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 16 Sep 2025 11:35:26 +0000 Subject: [PATCH 2/8] chore: run Excel script for metadata of use cases --- ...e-case-transport-delete-device-which-is-not-onboarded-yet.md | 2 +- _docs_use-cases/use-case-transport-get-device.md | 2 +- _docs_use-cases/use-case-transport-query-devices.md | 2 +- ...ase-transport-trigger-device-deletion-of-onboarded-device.md | 2 +- _docs_use-cases/use-case-transport-update-device.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/_docs_use-cases/use-case-transport-delete-device-which-is-not-onboarded-yet.md b/_docs_use-cases/use-case-transport-delete-device-which-is-not-onboarded-yet.md index 1e3bf9a12..418bf379d 100644 --- a/_docs_use-cases/use-case-transport-delete-device-which-is-not-onboarded-yet.md +++ b/_docs_use-cases/use-case-transport-delete-device-which-is-not-onboarded-yet.md @@ -9,7 +9,7 @@ sidebar: - title: "Integrate enmeshed" nav: "docs_integrate" properties: - - id: RD7 + - id: RD4 - component: Runtime - layer: Transport - facade: DevicesFacade diff --git a/_docs_use-cases/use-case-transport-get-device.md b/_docs_use-cases/use-case-transport-get-device.md index 3fa34e44d..c780e0cfd 100644 --- a/_docs_use-cases/use-case-transport-get-device.md +++ b/_docs_use-cases/use-case-transport-get-device.md @@ -9,7 +9,7 @@ sidebar: - title: "Integrate enmeshed" nav: "docs_integrate" properties: - - id: RD3 + - id: RD2 - component: Runtime - layer: Transport - facade: DevicesFacade diff --git a/_docs_use-cases/use-case-transport-query-devices.md b/_docs_use-cases/use-case-transport-query-devices.md index 38c0daed9..c1ac9ef79 100644 --- a/_docs_use-cases/use-case-transport-query-devices.md +++ b/_docs_use-cases/use-case-transport-query-devices.md @@ -9,7 +9,7 @@ sidebar: - title: "Integrate enmeshed" nav: "docs_integrate" properties: - - id: RD2 + - id: RD1 - component: Runtime - layer: Transport - facade: DevicesFacade diff --git a/_docs_use-cases/use-case-transport-trigger-device-deletion-of-onboarded-device.md b/_docs_use-cases/use-case-transport-trigger-device-deletion-of-onboarded-device.md index 464c86e05..18bcf4eb1 100644 --- a/_docs_use-cases/use-case-transport-trigger-device-deletion-of-onboarded-device.md +++ b/_docs_use-cases/use-case-transport-trigger-device-deletion-of-onboarded-device.md @@ -9,7 +9,7 @@ sidebar: - title: "Integrate enmeshed" nav: "docs_integrate" properties: - - id: RD8 + - id: RD5 - component: Runtime - layer: Transport - facade: DevicesFacade diff --git a/_docs_use-cases/use-case-transport-update-device.md b/_docs_use-cases/use-case-transport-update-device.md index 898df215e..04dd14e9f 100644 --- a/_docs_use-cases/use-case-transport-update-device.md +++ b/_docs_use-cases/use-case-transport-update-device.md @@ -9,7 +9,7 @@ sidebar: - title: "Integrate enmeshed" nav: "docs_integrate" properties: - - id: RD9 + - id: RD6 - component: Runtime - layer: Transport - facade: DevicesFacade From 73603b8c937e17ba390ba5356da73aabc6df5e87 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 16 Sep 2025 11:39:50 +0000 Subject: [PATCH 3/8] chore: mention removal of use cases in v7 migration guide --- _docs_integrate/migration-from-v6-to-v7.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 44422fe2f..c844534a3 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -105,3 +105,5 @@ However, the Connector routes associated with these use cases are not affected b - It will be possible to load items not only from truncated references, but also from other references. For this reason, the [Load item from reference]({% link _docs_use-cases/use-case-transport-load-item-from-reference.md %}) use case was already added in version 6 and the use case of loading an item from a truncated reference was marked as deprecated. It has now been deleted with the update to version 7. + +Furthermore, the use cases of creating a [Device]({% link _docs_integrate/data-model-overview.md %}#device), creating a Device onboarding [Token]({% link _docs_integrate/data-model-overview.md %}#token) and getting the Device onboarding information have been removed. From 09e8cef79253893a403bdb77dc493bdc65d88f40 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 16 Sep 2025 11:42:33 +0000 Subject: [PATCH 4/8] chore: mention alternative use case --- _docs_integrate/migration-from-v6-to-v7.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index c844534a3..d335771db 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -107,3 +107,4 @@ However, the Connector routes associated with these use cases are not affected b It has now been deleted with the update to version 7. Furthermore, the use cases of creating a [Device]({% link _docs_integrate/data-model-overview.md %}#device), creating a Device onboarding [Token]({% link _docs_integrate/data-model-overview.md %}#token) and getting the Device onboarding information have been removed. +Instead, the use case of filling a Device onboarding Token with a new Device must be utilized. From b2f0be0071234353446ddece27fce041d3a29599 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 16 Sep 2025 12:38:32 +0000 Subject: [PATCH 5/8] fix: use of non-existing link --- _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 d335771db..df92b2377 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -106,5 +106,5 @@ However, the Connector routes associated with these use cases are not affected b For this reason, the [Load item from reference]({% link _docs_use-cases/use-case-transport-load-item-from-reference.md %}) use case was already added in version 6 and the use case of loading an item from a truncated reference was marked as deprecated. It has now been deleted with the update to version 7. -Furthermore, the use cases of creating a [Device]({% link _docs_integrate/data-model-overview.md %}#device), creating a Device onboarding [Token]({% link _docs_integrate/data-model-overview.md %}#token) and getting the Device onboarding information have been removed. +Furthermore, the use cases of creating a Device, creating a Device onboarding [Token]({% link _docs_integrate/data-model-overview.md %}#token) and getting the Device onboarding information have been removed. Instead, the use case of filling a Device onboarding Token with a new Device must be utilized. From e3ebe20481081619be9a8418f4f7dd253b005428 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Wed, 17 Sep 2025 09:55:15 +0000 Subject: [PATCH 6/8] chore: run Excel script of use cases to update metadata --- ...onymous-load-token-by-reference-without-having-an-account.md | 2 +- ...se-transport-fill-device-onboarding-token-with-new-device.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs_use-cases/use-case-anonymous-load-token-by-reference-without-having-an-account.md b/_docs_use-cases/use-case-anonymous-load-token-by-reference-without-having-an-account.md index aca1e06ae..5b3c25604 100644 --- a/_docs_use-cases/use-case-anonymous-load-token-by-reference-without-having-an-account.md +++ b/_docs_use-cases/use-case-anonymous-load-token-by-reference-without-having-an-account.md @@ -15,7 +15,7 @@ properties: - component: Runtime - layer: Anonymous - facade: AnonymousTokensFacade - - function: loadPeerTokenByReference + - function: loadPeerToken - description: - feature category: Share information over side-channel - tech category: AnonymousTokens diff --git a/_docs_use-cases/use-case-transport-fill-device-onboarding-token-with-new-device.md b/_docs_use-cases/use-case-transport-fill-device-onboarding-token-with-new-device.md index 6aaf4b136..9f66ecaab 100644 --- a/_docs_use-cases/use-case-transport-fill-device-onboarding-token-with-new-device.md +++ b/_docs_use-cases/use-case-transport-fill-device-onboarding-token-with-new-device.md @@ -9,7 +9,7 @@ sidebar: - title: "Integrate enmeshed" nav: "docs_integrate" properties: - - id: RD10 + - id: RD7 - component: Runtime - layer: Transport - facade: DevicesFacade From 453f73d00bf9aa2d2b51b8a1c39fb256b5e89724 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Wed, 17 Sep 2025 10:05:59 +0000 Subject: [PATCH 7/8] feat: improved description in v7 migration guide --- _docs_integrate/migration-from-v6-to-v7.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index df92b2377..29fd7be06 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -105,6 +105,6 @@ However, the Connector routes associated with these use cases are not affected b - It will be possible to load items not only from truncated references, but also from other references. For this reason, the [Load item from reference]({% link _docs_use-cases/use-case-transport-load-item-from-reference.md %}) use case was already added in version 6 and the use case of loading an item from a truncated reference was marked as deprecated. It has now been deleted with the update to version 7. - -Furthermore, the use cases of creating a Device, creating a Device onboarding [Token]({% link _docs_integrate/data-model-overview.md %}#token) and getting the Device onboarding information have been removed. -Instead, the use case of filling a Device onboarding Token with a new Device must be utilized. +- Furthermore, the use cases of creating a Device, creating a Device onboarding [Token]({% link _docs_integrate/data-model-overview.md %}#token) and getting the Device onboarding information have been removed. + Instead, the use cases of [creating an empty Token]({% link _docs_use-cases/use-case-anonymous-create-empty-token.md %}) and [filling a Device onboarding Token with a new Device]({% link _docs_use-cases/use-case-transport-fill-device-onboarding-token-with-new-device.md %}) must be utilized. + As before, these are only used by the App and are not exposed as Connector routes. From d244401058466939f1a07063d51d41294040dc1c Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Wed, 17 Sep 2025 10:45:37 +0000 Subject: [PATCH 8/8] chore: undo v7 migration guide change --- _docs_integrate/migration-from-v6-to-v7.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 29fd7be06..44422fe2f 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -105,6 +105,3 @@ However, the Connector routes associated with these use cases are not affected b - It will be possible to load items not only from truncated references, but also from other references. For this reason, the [Load item from reference]({% link _docs_use-cases/use-case-transport-load-item-from-reference.md %}) use case was already added in version 6 and the use case of loading an item from a truncated reference was marked as deprecated. It has now been deleted with the update to version 7. -- Furthermore, the use cases of creating a Device, creating a Device onboarding [Token]({% link _docs_integrate/data-model-overview.md %}#token) and getting the Device onboarding information have been removed. - Instead, the use cases of [creating an empty Token]({% link _docs_use-cases/use-case-anonymous-create-empty-token.md %}) and [filling a Device onboarding Token with a new Device]({% link _docs_use-cases/use-case-transport-fill-device-onboarding-token-with-new-device.md %}) must be utilized. - As before, these are only used by the App and are not exposed as Connector routes.