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-create-device-onboarding-token.md b/_docs_use-cases/use-case-transport-create-device-onboarding-token.md deleted file mode 100644 index 56d8bc553..000000000 --- a/_docs_use-cases/use-case-transport-create-device-onboarding-token.md +++ /dev/null @@ -1,62 +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 is deprecated and will be removed in the next major version. Please use the use case [Fill Device onboarding Token with new Device](use-case-transport-fill-device-onboarding-token-with-new-device) instead. -{: .notice--warning} - -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-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-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 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 5acb96115..000000000 --- a/_docs_use-cases/use-case-transport-get-device-onboarding-info.md +++ /dev/null @@ -1,59 +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 is deprecated and will be removed in the next major version. Please use the use case [Fill Device onboarding Token with new Device](use-case-transport-fill-device-onboarding-token-with-new-device) instead. -{: .notice--warning} - -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-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-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. 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