From 42f301e14120560bbe48d601f157c2ddfba1bd93 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Wed, 10 Dec 2025 15:47:08 +0000 Subject: [PATCH 1/2] chore: run Excel script for adding new use cases --- .../use-case-transport-delete-file.md | 2 +- ...e-transport-delete-relationshiptemplate.md | 39 +++++++++++++++++++ .../use-case-transport-delete-token.md | 39 +++++++++++++++++++ 3 files changed, 79 insertions(+), 1 deletion(-) create mode 100644 _docs_use-cases/use-case-transport-delete-relationshiptemplate.md create mode 100644 _docs_use-cases/use-case-transport-delete-token.md diff --git a/_docs_use-cases/use-case-transport-delete-file.md b/_docs_use-cases/use-case-transport-delete-file.md index 681e30aa7..e3ef63b68 100644 --- a/_docs_use-cases/use-case-transport-delete-file.md +++ b/_docs_use-cases/use-case-transport-delete-file.md @@ -14,7 +14,7 @@ properties: - layer: Transport - facade: FilesFacade - function: deleteFile - - description: Deletes the File with the fiven `id`. + - description: Deletes the File with the given `id`. - feature category: Arbitrary large data support - tech category: Files - status: DONE diff --git a/_docs_use-cases/use-case-transport-delete-relationshiptemplate.md b/_docs_use-cases/use-case-transport-delete-relationshiptemplate.md new file mode 100644 index 000000000..35b62af5a --- /dev/null +++ b/_docs_use-cases/use-case-transport-delete-relationshiptemplate.md @@ -0,0 +1,39 @@ +--- +# Start automatic generation +permalink: use-case-transport-delete-relationshiptemplate +published: true +title: "Delete RelationshipTemplate" +type: use-case +toc: true +sidebar: + - title: "Integrate enmeshed" + nav: "docs_integrate" +properties: + - id: RT8 + - component: Runtime + - layer: Transport + - facade: RelationshipTemplatesFacade + - function: deleteRelationshipTemplate + - description: Deletes the RelationshipTemplate with the given `id`. + - feature category: Consent required before any data is shared + - tech category: RelationshipTemplates + - status: DONE + - documentation status: DONE + - comments: + - actor: Identity + - trigger: + - precondition: + - result: + - priority: n/a + - complexity: n/a + - size: n/a + - created_at: + - changed_at: + - api_route_regex: DELETE /api/core/v1/RelationshipTemplates/{id} + - published: default + - link: use-case-transport-delete-relationshiptemplate +require: +required_by: +api_route_regex: ^DELETE /api/core/v1/RelationshipTemplates/{id}$ +# End automatic generation +--- diff --git a/_docs_use-cases/use-case-transport-delete-token.md b/_docs_use-cases/use-case-transport-delete-token.md new file mode 100644 index 000000000..e47b00252 --- /dev/null +++ b/_docs_use-cases/use-case-transport-delete-token.md @@ -0,0 +1,39 @@ +--- +# Start automatic generation +permalink: use-case-transport-delete-token +published: true +title: "Delete Token" +type: use-case +toc: true +sidebar: + - title: "Integrate enmeshed" + nav: "docs_integrate" +properties: + - id: RK6 + - component: Runtime + - layer: Transport + - facade: TokensFacade + - function: deleteToken + - description: Deletes the Token with the given `id`. + - feature category: Share structured information over side-channel + - tech category: Tokens + - status: DONE + - documentation status: DONE + - comments: + - actor: Identity + - trigger: REST API + - precondition: + - result: + - priority: n/a + - complexity: n/a + - size: n/a + - created_at: + - changed_at: + - api_route_regex: DELETE /api/core/v1/Tokens/{id} + - published: default + - link: use-case-transport-delete-token +require: +required_by: +api_route_regex: ^DELETE /api/core/v1/Tokens/{id}$ +# End automatic generation +--- From 9e3af8a911f52fbe65d12d7446c15ef979dd7a4a Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Wed, 10 Dec 2025 15:51:38 +0000 Subject: [PATCH 2/2] feat: add content for new deleting use cases --- ...e-transport-delete-relationshiptemplate.md | 19 +++++++++++++++++++ .../use-case-transport-delete-token.md | 19 +++++++++++++++++++ 2 files changed, 38 insertions(+) diff --git a/_docs_use-cases/use-case-transport-delete-relationshiptemplate.md b/_docs_use-cases/use-case-transport-delete-relationshiptemplate.md index 35b62af5a..5a90efcda 100644 --- a/_docs_use-cases/use-case-transport-delete-relationshiptemplate.md +++ b/_docs_use-cases/use-case-transport-delete-relationshiptemplate.md @@ -37,3 +37,22 @@ required_by: api_route_regex: ^DELETE /api/core/v1/RelationshipTemplates/{id}$ # End automatic generation --- + +{{properties.description}} + +{% include properties_list.html %} + +This use case allows you to delete a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate). + +## Parameters + +- `id` of the RelationshipTemplate that should be deleted. + +## On Success + +- The RelationshipTemplate is deleted locally. +- If `isOwn` of the [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate) is `true`, the RelationshipTemplate will be deleted from the Backbone, too. + +## On Failure + +- No RelationshipTemplate can be deleted if there is no RelationshipTemplate that corresponds to the given `id`. diff --git a/_docs_use-cases/use-case-transport-delete-token.md b/_docs_use-cases/use-case-transport-delete-token.md index e47b00252..6e94a7cf5 100644 --- a/_docs_use-cases/use-case-transport-delete-token.md +++ b/_docs_use-cases/use-case-transport-delete-token.md @@ -37,3 +37,22 @@ required_by: api_route_regex: ^DELETE /api/core/v1/Tokens/{id}$ # End automatic generation --- + +{{properties.description}} + +{% include properties_list.html %} + +This use case allows you to delete a [Token]({% link _docs_integrate/data-model-overview.md %}#token). + +## Parameters + +- `id` of the Token that should be deleted. + +## On Success + +- The Token is deleted locally. +- If `isOwn` of the [Token]({% link _docs_integrate/data-model-overview.md %}#token) is `true`, the Token will be deleted from the Backbone, too. + +## On Failure + +- No Token can be deleted if there is no Token that corresponds to the given `id`.