feat: incorporate review comments

nmshd · Jan 10, 2025 · 2133e22 · 2133e22
1 parent 984a8ee
commit 2133e22
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 12 deletions.
diff --git a/_docs_integrate/data-model-overview.md b/_docs_integrate/data-model-overview.md
@@ -1062,9 +1062,9 @@ This Identity must be sufficiently familiar to them, which means that it must be
 The common CRUD operations for handling IdentityMetadata are provided by different [use cases]({% link _docs_integrate/use-cases.md %}).
 To be more precise, there is the [Upsert IdentityMetadata]({% link _docs_use-cases/use-case-consumption-upsert-identitymetadata.md %}) use case for creating and updating IdentityMetadata, as well as the [Get IdentityMetadata]({% link _docs_use-cases/use-case-consumption-get-identitymetadata.md %}) use case and the [Delete IdentityMetadata]({% link _docs_use-cases/use-case-consumption-delete-identitymetadata.md %}) use case.
 
-| Name      | Type                    | Description                                                                                                                                                                                  | Remarks            |
-| --------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
-| id        | `string`                | {% include descr_id class="IdentityMetadata" prefix="IDM" %}                                                                                                                                 |                    |
-| reference | `string`                | The `address` of the [Identity](#identity) about which metadata is stored.                                                                                                                   | saved only locally |
-| key       | `string` \| `undefined` | An optional additional identifier to store and distinguish multiple IdentityMetadata for the same Identity. There can be at most one IdentityMetadata per `reference` and `key` combination. | saved only locally |
-| value     | `unknown`               | Feel free to insert whatever you want or need.                                                                                                                                               | saved only locally |
+| Name      | Type                    | Description                                                                                                                                                                         | Remarks            |
+| --------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
+| id        | `string`                | {% include descr_id class="IdentityMetadata" prefix="IDM" %}                                                                                                                        |                    |
+| reference | `string`                | The `address` of the [Identity](#identity) about which metadata is stored.                                                                                                          | saved only locally |
+| key       | `string` \| `undefined` | An additional identifier to store and distinguish multiple IdentityMetadata for the same Identity. There can be at most one IdentityMetadata per `reference` and `key` combination. | saved only locally |
+| value     | `unknown`               | Feel free to insert whatever you want or need.                                                                                                                                      | saved only locally |
diff --git a/_docs_integrate/terminate-relationships.md b/_docs_integrate/terminate-relationships.md
@@ -64,7 +64,7 @@ Decomposing a [Relationship]({% link _docs_integrate/data-model-overview.md %}#r
 - The [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate) used to establish the Relationship if it was for single use, which means that the value of its `maxNumberOfAllocations` property is one, or is owned by the peer. A RelationshipTemplate must be exchanged again to establish a new Relationship.
 - In any case, all RelationshipTemplates of the peer. During a Relationship, several RelationshipTemplates may have been exchanged, as [Requests can be sent via RelationshipTemplates]({% link _docs_integrate/requests-via-relationshiptemplates.md %}#create-the-relationshiptemplate) both when establishing new Relationships and for existing Relationships.
 - Both the sent and the received shared [Attributes]({% link _docs_integrate/data-model-overview.md %}#attributes), [Notifications]({% link _docs_integrate/data-model-overview.md %}#notification) and [Requests]({% link _docs_integrate/data-model-overview.md %}#request).
-- Sent and received [Messages]({% link _docs_integrate/data-model-overview.md %}#message) with one exception: If a Message has been sent to multiple `recipients`, the Message is not deleted but the peer's address is replaced with a pseudonym. The pseudonym is the same for every peer.
+- Sent and received [Messages]({% link _docs_integrate/data-model-overview.md %}#message) with one exception: If a Message has been sent to multiple `recipients`, the Message is not deleted but the peer's address is replaced with a pseudonym. The pseudonym is the same for every peer whose Relationship was decomposed.
 - The [IdentityMetadata]({% link _docs_integrate/data-model-overview.md %}#identitymetadata) that have the peer as their `reference`.
 - Furthermore, the corresponding [Tokens]({% link _docs_integrate/data-model-overview.md %}#token) and [AttributeListeners]({% link _docs_integrate/data-model-overview.md %}#localattributelistener).
 

diff --git a/_docs_use-cases/use-case-consumption-delete-identitymetadata.md b/_docs_use-cases/use-case-consumption-delete-identitymetadata.md
@@ -43,13 +43,13 @@ api_route_regex: ^DELETE /api/v2/IdentityMetadata$
 {% include properties_list.html %}
 
 [IdentityMetadata]({% link _docs_integrate/data-model-overview.md %}#identitymetadata) is used to store arbitrary auxiliary metadata related to an [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) within the Connector.
-This use case deletes the IdentityMetadata for a given `reference` or a given combination of `reference` and `key` if the IdentityMetadata is equipped with the optional additional `key` identifier.
+This use case deletes the IdentityMetadata for a given `reference` or a given combination of `reference` and `key` if the IdentityMetadata is equipped with the additional `key` identifier.
 As there is at most one IdentityMetadata per `reference` and `key` combination, the IdentityMetadata that can be deleted by this use case is uniquely determined.
 
 ## Parameters
 
 - `reference` is the `address` of the Identity about which the IdentityMetadata is to be deleted.
-- `key` is the optional additional identifier of the IdentityMetadata to be deleted.
+- Optionally, `key` is the additional identifier of the IdentityMetadata to be deleted.
 
 ## On Success
 

diff --git a/_docs_use-cases/use-case-consumption-get-identitymetadata.md b/_docs_use-cases/use-case-consumption-get-identitymetadata.md
@@ -43,13 +43,13 @@ api_route_regex: ^GET /api/v2/IdentityMetadata$
 {% include properties_list.html %}
 
 [IdentityMetadata]({% link _docs_integrate/data-model-overview.md %}#identitymetadata) is used to store arbitrary auxiliary metadata related to an [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) within the Connector.
-This use case retrieves the IdentityMetadata for a given `reference` or a given combination of `reference` and `key` if the IdentityMetadata is equipped with the optional additional `key` identifier.
+This use case retrieves the IdentityMetadata for a given `reference` or a given combination of `reference` and `key` if the IdentityMetadata is equipped with the additional `key` identifier.
 As there is at most one IdentityMetadata per `reference` and `key` combination, the return value of this use case is uniquely determined.
 
 ## Parameters
 
 - `reference` is the `address` of the Identity about which the IdentityMetadata is to be retrieved.
-- `key` is the optional additional identifier of the IdentityMetadata to be retrieved.
+- Optionally, `key` is the additional identifier of the IdentityMetadata to be retrieved.
 
 ## On Success
 

diff --git a/_docs_use-cases/use-case-consumption-upsert-identitymetadata.md b/_docs_use-cases/use-case-consumption-upsert-identitymetadata.md
@@ -45,7 +45,7 @@ api_route_regex: ^PUT /api/v2/IdentityMetadata$
 [IdentityMetadata]({% link _docs_integrate/data-model-overview.md %}#identitymetadata) is used to store arbitrary auxiliary metadata related to an [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) within the Connector.
 This use case creates or updates an IdentityMetadata that relates to the Identity whose `address` is specified within the `reference` property of the IdentityMetadata.
 IdentityMetadata may only be created or updated for a `peer` of a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) or the own Identity, or in other words, sufficiently familiar Identities.
-If there is no IdentityMetadata for a given `reference` and `key` combination, a new IdentityMetadata is created.
+If there is no IdentityMetadata for a given `reference` and `key` combination, a new IdentityMetadata will be created.
 Otherwise, the existing IdentityMetadata is updated with the new `value` provided.
 Therefore, there can be at most one IdentityMetadata per `reference` and `key` combination.
 In particular, there can be at most one IdentityMetadata without a `key` for each Identity.