Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _docs_use-cases/use-case-transport-delete-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
# 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
---

{{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`.
58 changes: 58 additions & 0 deletions _docs_use-cases/use-case-transport-delete-token.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
# 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
---

{{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`.