Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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_explore/42-transport-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The transport layer is located between the Backbone layer and the consumption la

## Data Handling

The transport layer introduces a local storage based on a document database. In this database all relevant data is persisted or cached. In addition to the database, the transport layer takes care of serializing and deserializing data structures.
The transport layer introduces a local storage based on a document database. In this database all relevant data is persisted. In addition to the database, the transport layer takes care of serializing and deserializing data structures.

## Syntactical validation of plaintext data

Expand Down
2 changes: 1 addition & 1 deletion _docs_integrate/data-model-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ A Token has the following properties:
| forIdentity | `string` \| `undefined` | Can be set to an enmeshed address. If set, then only the [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) with that `address` can retrieve the Token from the Backbone. |
| passwordProtection | [`PasswordProtection`](#passwordprotection) \| `undefined` | Information about whether or not the Token is protected by a password or pin. | |
| reference | [`ObjectReference`](#objectreference) | {% include descr_reference class="Token" %} | saved only locally |
| isEphemeral | `boolean` | If set to `true` the Token will not be cached in the database and only displayed once. You will not be able to fetch this Token unless you remember its reference. |
| isEphemeral | `boolean` | If set to `true` the Token will not be persisted in the database and only displayed once. You will not be able to fetch this Token unless you remember its reference. |

### PasswordProtection

Expand Down
1 change: 0 additions & 1 deletion _docs_integrate/error-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,6 @@ Please find a list of enmeshed error codes below. Most often the errors occur on
| {% include anchor a="error.runtime.attributes.<br>noPreviousVersionOfRepositoryAttributeHasBeenSharedWithPeerBefore" %} | No previous version of the given [RepositoryAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) has been shared with this peer before. If you wish to execute an initial sharing of this Attribute, [use 'ShareRepositoryAttribute']({% link _docs_integrate/share-attributes-with-peer.md %}). |
| {% include anchor a="error.runtime.attributes.setDefaultRepositoryAttributesIsDisabled" %} | Setting default RepositoryAttributes is disabled for this Account. |
| {% include anchor a="error.runtime.attributes.repositoryAttributeHasAlreadyBeenSharedWithPeer" %} | The given [RepositoryAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) has already been shared with this peer. |
| {% include anchor a="error.runtime.cacheEmpty" %} | The `cache` of a [File]({% link _docs_integrate/data-model-overview.md %}#file), an [IdentityDeletionProcess]({% link _docs_integrate/data-model-overview.md %}#identitydeletionprocess), a [Message]({% link _docs_integrate/data-model-overview.md %}#message), a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship), a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate) or a [Token]({% link _docs_integrate/data-model-overview.md %}#token) is empty. |
| {% include anchor a="error.runtime.challenges.invalidChallenge" %} | The `challengeString` is invalid. |
| {% include anchor a="error.runtime.challenges.invalidSignature" %} | The `signature` is invalid. |
| {% include anchor a="error.runtime.decide.requestConfigDoesNotMatchResponseConfig" %} | The automation configuration specified when using the [Decider Module]({% link _docs_explore/61-runtime.md %}#decider-module) is invalid because the `requestConfig` does not match the `responseConfig`. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If the [Request Module]({% link _docs_explore/61-runtime.md %}#request-module) i
- Returns a `result` that indicates if a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) can be created with the given parameters.
- If the `isSuccess` property of the `result` has the value `true`, a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) can currently be created to the creator of the RelationshipTemplate. This would then initially have `"Pending"` as `status` until the creator of the RelationshipTemplate [accepts the Relationship]({% link _docs_use-cases/use-case-transport-accept-relationship.md %}).
- If the `isSuccess` property of the `result` has the value `false`, no [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) can currently be created to the creator of the RelationshipTemplate. This can have various causes, for example:
- The `templateId` does not resolve to a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate) or the associated RelationshipTemplate was not cached correctly.<br>
- The `templateId` does not resolve to a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate).<br>
- The [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate) has already expired, which means that the timestamp specified in its `expiresAt` property has been exceeded.<br>
- A [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) with `"Pending"`, `"Active"`, `"Terminated"` or `"DeletionProposed"` as `status` already exists to the creator of the RelationshipTemplate. In particular, the initiation of a new Relationship is prevented if the potential initiator has already [decomposed the former Relationship]({% link _docs_integrate/terminate-relationships.md %}#decompose-a-relationship) to the RelationshipTemplate's creator, but the creator of the RelationshipTemplate has not yet decomposed it and still has the former Relationship with `"DeletionProposed"` as `status`.<br>
- The [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) of the creator of the RelationshipTemplate is in deletion or has already been deleted.<br>
Expand Down
2 changes: 1 addition & 1 deletion _docs_use-cases/use-case-transport-create-own-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Creates a [Token]({% link _docs_integrate/data-model-overview.md %}#token) that

- `content` an arbitrary JSON structure of the data to share via the Token.
- `expiresAt` is the ISODateTime the Token expires at.
- `ephemeral` indicates if the Token should be ephemeral and thus not be stored and cached on the local database. This is especially useful for Tokens which are created regularly, e.g. for RelationshipTemplates and doesn't need to be stored.
- `ephemeral` indicates if the Token should be ephemeral and thus not be stored in the local database. This is especially useful for Tokens which are created regularly, e.g. for RelationshipTemplates and doesn't need to be stored.
- `forIdentity` can be set to an enmeshed address. If set, only the [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) with that `address` can load the Token from the Backbone.
- `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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ To check whether a Relationship can be created without actually creating it, the

## On Failure

- The `templateId` does not resolve to a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate) or the associated RelationshipTemplate was not cached correctly.
- The `templateId` does not resolve to a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate).
- The [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate) has already expired, which means that the timestamp specified in its `expiresAt` property has been exceeded.
- A [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) with `"Pending"`, `"Active"`, `"Terminated"` or `"DeletionProposed"` as `status` already exists to the creator of the RelationshipTemplate. In particular, the initiation of a new Relationship is prevented if the potential initiator has already [decomposed the former Relationship]({% link _docs_integrate/terminate-relationships.md %}#decompose-a-relationship) to the RelationshipTemplate's creator, but the creator of the RelationshipTemplate has not yet decomposed it and still has the former Relationship with `"DeletionProposed"` as `status`.
- The [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) of the creator of the RelationshipTemplate is in deletion or has already been deleted.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Creates a [Token]({% link _docs_integrate/data-model-overview.md %}#token) for a

- `fileId` is the `id` of the File the Token should be created for.
- Optionally, `expiresAt` can be specified, which describes the ISODateTime the Token expires at.
- Optionally, `ephemeral` can be specified, which indicates if the Token should be ephemeral and thus not be stored and cached on the local database. This is especially useful for Tokens which are created regularly, e.g. for [RelationshipTemplates]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate), and don't need to be stored.
- Optionally, `ephemeral` can be specified, which indicates if the Token should be ephemeral and thus not be stored in the local database. This is especially useful for Tokens which are created regularly, e.g. for [RelationshipTemplates]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate), and don't need to be stored.
- Optionally, `forIdentity` can be specified, which names the `address` of the only [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) that will be able to load the Token from the Backbone.
- Optionally, `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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Creates a [Token]({% link _docs_integrate/data-model-overview.md %}#token) for a

- `templateId` is the `id` of the RelationshipTemplate the Token should be created for.
- `expiresAt` is the ISODateTime the Token expires at.
- `ephemeral` indicates if the Token should be ephemeral and thus not be stored and cached on the local database. This is especially useful for Tokens which are created regularly, e.g. for RelationshipTemplates and doesn't need to be stored.
- `ephemeral` indicates if the Token should be ephemeral and thus not be stored in the local database. This is especially useful for Tokens which are created regularly, e.g. for RelationshipTemplates and doesn't need to be stored.
- `forIdentity` can be set to an enmeshed address. If set, only the [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) with that `address` can load the Token from the Backbone. If the RelationshipTemplate is already personalized via its `forIdentity` property, the Token created from it must have the same personalization.
- `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. If the RelationshipTemplate is already password protected via its `passwordProtection` property, the Token created from it must have the same password protection.

Expand Down
2 changes: 1 addition & 1 deletion _docs_use-cases/use-case-transport-download-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ api_route_regex: ^GET /api/v2/Files/{id}/Download$
{% include properties_list.html %}

This use case allows to download the [File's]({% link _docs_integrate/data-model-overview.md %}#file) binary content that corresponds to the `fileId`.
As the File is not stored or cached within the Connector, the encrypted File is downloaded from the Backbone, decrypted and returned every time this use case is called.
As the File is not stored within the Connector, the encrypted File is downloaded from the Backbone, decrypted and returned every time this use case is called.
An [uploaded own File]({% link _docs_use-cases/use-case-transport-upload-own-file.md %}) can be downloaded by this use case in any case.
However, a File from a peer must first be [loaded]({% link _docs_use-cases/use-case-transport-load-file.md %}) before its actual content can be downloaded.

Expand Down
2 changes: 1 addition & 1 deletion _includes/descr_expiresAt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
A timestamp that describes when the {{ include.class }} expires on the Backbone. An expired {{ include.class }} cannot be fetched from the Backbone anymore. However, the cached version of the {{ include.class }} on Connector and App will still be accessible.
A timestamp that describes when the {{ include.class }} expires on the Backbone. An expired {{ include.class }} cannot be fetched from the Backbone anymore. However, the stored version of the {{ include.class }} on Connector and App will still be accessible.