From 9f4682a1ec84ec8cfe4985e0e0b8f3d5dc0a6b76 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht <146106656+britsta@users.noreply.github.com> Date: Wed, 18 Dec 2024 17:47:23 +0100 Subject: [PATCH] Rename GetDeviceOnboardingTokenUseCase to CreateDeviceOnboardingTokenUseCase (#289) * refactor: rename file of use case * chore: renaming use case by running excel script * fix: reference to outdated use case name * fix: broken links * fix: bad wording * feat: restructure because of wrong info without loss of info --- ... use-case-transport-create-device-onboarding-token.md} | 8 ++++---- ...e-case-transport-load-item-from-truncated-reference.md | 7 +++---- 2 files changed, 7 insertions(+), 8 deletions(-) rename _docs_use-cases/{use-case-transport-get-device-onboarding-token.md => use-case-transport-create-device-onboarding-token.md} (84%) diff --git a/_docs_use-cases/use-case-transport-get-device-onboarding-token.md b/_docs_use-cases/use-case-transport-create-device-onboarding-token.md similarity index 84% rename from _docs_use-cases/use-case-transport-get-device-onboarding-token.md rename to _docs_use-cases/use-case-transport-create-device-onboarding-token.md index ab7f22ab1..6edbe8251 100644 --- a/_docs_use-cases/use-case-transport-get-device-onboarding-token.md +++ b/_docs_use-cases/use-case-transport-create-device-onboarding-token.md @@ -1,8 +1,8 @@ --- # Start automatic generation -permalink: use-case-transport-get-device-onboarding-token +permalink: use-case-transport-create-device-onboarding-token published: true -title: "Get Device Onboarding Token" +title: "Create Device Onboarding Token" type: use-case toc: true sidebar: @@ -13,7 +13,7 @@ properties: - component: Runtime - layer: Transport - facade: DevicesFacade - - function: getdeviceOnboardingToken + - function: createDeviceOnboardingToken - description: - feature category: Multi-device - tech category: Devices @@ -31,7 +31,7 @@ properties: - changed_at: - api_route_regex: - published: default - - link: use-case-transport-get-device-onboarding-token + - link: use-case-transport-create-device-onboarding-token require: required_by: # End automatic generation diff --git a/_docs_use-cases/use-case-transport-load-item-from-truncated-reference.md b/_docs_use-cases/use-case-transport-load-item-from-truncated-reference.md index c3f3193ae..fc243b106 100644 --- a/_docs_use-cases/use-case-transport-load-item-from-truncated-reference.md +++ b/_docs_use-cases/use-case-transport-load-item-from-truncated-reference.md @@ -43,7 +43,6 @@ required_by: This use case intends to load an entity by its `reference` received by peer. It is internally using the specific use cases of each entity: -- If the `reference` references a Token, fetches the Token just like [Load Token created by others](use-case-transport-load-token-created-by-others.md). -- If the `reference` references a RelationshipTemplate, fetches the RelationshipTemplate just like [Load RelationshipTemplate created by others](use-case-transport-load-relationshiptemplate-created-by-others.md). -- If the `reference` references a File, fetches the File just like [Get or load File](use-case-transport-get-or-load-file.md). -- If the `reference` references a DeviceOnboardingInformation, fetches the DeviceOnboardingInformation just like [Get Device Onboarding Token](use-case-transport-get-device-onboarding-token.md). +- If the `reference` references a [Token]({% link _docs_integrate/data-model-overview.md %}#token), 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 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` references a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate), 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` references a [File]({% link _docs_integrate/data-model-overview.md %}#file), fetches the File just like the [Get or load File]({% link _docs_use-cases/use-case-transport-get-or-load-file.md %}) use case.