From 2cdfc88c80256e2078f9c70dd5992b4f7e702468 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 17 Dec 2024 10:14:33 +0000 Subject: [PATCH] feat: use more appropriate links --- _docs_integrate/data-model-overview.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/_docs_integrate/data-model-overview.md b/_docs_integrate/data-model-overview.md index 640ab0c10..0bf33e55c 100644 --- a/_docs_integrate/data-model-overview.md +++ b/_docs_integrate/data-model-overview.md @@ -86,14 +86,14 @@ A RelationshipTemplate serves two purposes: ### PasswordProtection -A [RelationshipTemplate](#relationshiptemplate) can be protected by a password to ensure that it is protected from unauthorized access. -Indeed, in order for a peer to [establish a Relationship]({% link _docs_integrate/establish-relationships.md %}) to the creator of the password protected RelationshipTemplate, it must enter the correct password when loading the RelationshipTemplate. -Whether a RelationshipTemplate is protected by a password or not is recorded within its `passwordProtection` property. - -| Name | Type | Description | Remarks | -| ------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -| password | `string` | The password of the RelationshipTemplate. | | -| passwordIsPin | `true` \| `undefined` | If the password of the RelationshipTemplate consists only of numbers, the value of the `passwordIsPin` property can be set to `true`. In this case, the password is interpreted as a pin and a corresponding input field is displayed in the UI of the App when the pin needs to be entered. However, if the value is `undefined`, a regular input field for entering the password is displayed regardless of whether the password could also be interpreted as a pin because it only consists of numbers. | | +A [RelationshipTemplate can be protected by a password]({% link _docs_integrate/establish-relationships.md %}#password-protection-of-a-relationshiptemplate) to ensure that it is protected from unauthorized access. +Indeed, in order for a peer to [establish a Relationship]({% link _docs_integrate/establish-relationships.md %}) to the creator of the password protected RelationshipTemplate, it must enter the correct password when [loading the RelationshipTemplate]({% link _docs_use-cases/use-case-transport-load-relationshiptemplate-created-by-others.md %}). +Information about the password protection of a [RelationshipTemplate](#relationshiptemplate) is recorded within its optional `passwordProtection` property. + +| Name | Type | Description | Remarks | +| ------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | +| password | `string` | The password of the RelationshipTemplate. | | +| passwordIsPin | `true` \| `undefined` | If the password of the RelationshipTemplate consists of 4 to 16 digits, the value of the `passwordIsPin` property can be set to `true`. In this case, the password is interpreted as a pin and a corresponding input field is displayed in the UI of the App when the pin needs to be entered. However, if the value is `undefined`, a regular input field for entering the password is displayed regardless of whether the password could also be interpreted as a pin. | | ## Relationship