diff --git a/_docs_integrate/data-model-overview.md b/_docs_integrate/data-model-overview.md index ca691b316..a7dcf13c9 100644 --- a/_docs_integrate/data-model-overview.md +++ b/_docs_integrate/data-model-overview.md @@ -31,7 +31,7 @@ The enmeshed data model can be divided into three parts: The following diagram gives you an overview of all the existing types and how they are connected to each other. The subsequent chapters describe these types in more detail. -
+
(note that you can click on each type in order to navigate to the paragraph with the corresponding description) At a first glance the amount of types is overwhelming. But in the following chapters all of them are explained in detail. @@ -434,16 +434,6 @@ This will be the case, if the peer already accepted the DeleteAttributeRequestIt | deletionStatus | `"DeletionRequestSent"` \| `"DeletionRequestRejected"` \| `"ToBeDeleted"` \| `"ToBeDeletedByPeer"` \| `"DeletedByOwner"` \| `"DeletedByPeer"` | The deletion status of the peer's counterpart of the shared Attribute. For own shared Attributes it may only be set to `"DeletionRequestSent"`, `"DeletionRequestRejected"`, `"ToBeDeletedByPeer"` or `"DeletedByPeer"`, whereas for peer shared Attributes only the values `"ToBeDeleted"` and `"DeletedByOwner"` are allowed. | | deletionDate | `string` | The point in time
{::nomarkdown}{:/} | -## LocalAttributeListener - -A LocalAttributeListener is created when you accept an incoming Request with a [`RegisterAttributeListenerRequestItem`](#registerattributelistenerrequestitem). It is used to keep track of which Attribute Listeners currently exist and what they are listening for. - -| Name | Type | Description | -| ----- | -------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| id | `string` | {% include descr_id class="LocalAttributeListener" prefix="ATL" %} | -| query | [`IdentityAttributeQuery`](#identityattributequery) \| [`ThirdPartyRelationshipAttributeQuery`](#thirdpartyrelationshipattributequery) | The query the Attribute that is listened to must match. Note that you cannot send a [`RelationshipAttributeQuery`](#relationshipattributequery) here, because it doesn't make sense: by definition, both parties know about a RelationshipAttribute right from the beginning, because one party requests its creation, and the other one accepts it. | -| peer | `string` | The address of the peer that requested the Attribute Listener. | - ## AttributeTagCollection The AttributeTagCollection is defined by the Backbone and specifies which `tags` are allowed for which [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) `value.@type`. @@ -657,19 +647,6 @@ For more information you should check out the section [ReadAttributeRequestItem | mustBeAccepted | `boolean` | The mandatory `mustBeAccepted` property is used to differentiate between required and optional RequestItems within the Request.
{::nomarkdown}{:/} | | requireManualDecision | `boolean` \| `undefined` | To block the automated acceptance of Requests, the requireManualDecision property can be set to true. The default is, that each RequestItem may be automatically processed on the peer side. If the sender would like to have an enforced manual acceptance step, the requireManualDecision property can be set to true. | -#### RegisterAttributeListenerRequestItem - -For more information you should check out the section [RegisterAttributeListenerRequestItem of the Request and Response introduction]({% link _docs_integrate/request-and-response-introduction.md %}#registerattributelistenerrequestitem). - -| Name | Type | Description | -| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| @type | `"RegisterAttributeListenerRequestItem"` | Specifies the type of the RequestItem for internal processing. | -| query | [`IdentityAttributeQuery`]({% link _docs_integrate/data-model-overview.md %}#identityattributequery) \| [`ThirdPartyRelationshipAttributeQuery`]({% link _docs_integrate/data-model-overview.md %}#thirdpartyrelationshipattributequery) | The structured query of the Attribute the sender would like to query. | -| description | `string` \| `undefined` | An optional, human readable description for the RequestItem. | -| metadata | `object` \| `undefined` | The metadata property can be used to provide arbitrary JSON content by the sender of the Request. The metadata is not processed by enmeshed. It is a great way to use your own process descriptors at the time of sending the Request which helps you identify the correct internal process at the time of receiving the Response. | -| mustBeAccepted | `boolean` | The mandatory `mustBeAccepted` property is used to differentiate between required and optional RequestItems within the Request.
{::nomarkdown}{:/} | -| requireManualDecision | `boolean` \| `undefined` | To block the automated acceptance of Requests, the requireManualDecision property can be set to true. The default is, that each RequestItem may be automatically processed on the peer side. If the sender would like to have an enforced manual acceptance step, the requireManualDecision property can be set to true. | - #### ShareAttributeRequestItem For more information you should check out the section [ShareAttributeRequestItem of the Request and Response introduction]({% link _docs_integrate/request-and-response-introduction.md %}#shareattributerequestitem). Furthermore, all details on how to use the ShareAttributeRequestItem and examples of use cases for it can be found in the [Share Attributes with peer]({% link _docs_integrate/share-attributes-with-peer.md %}) guide. @@ -807,14 +784,6 @@ Receiving an AttributeSuccessionAcceptResponseItem, the respective shared LocalA | attribute | [`IdentityAttribute`]({% link _docs_integrate/data-model-overview.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute that will be shared with the peer. | | thirdPartyAddress | `string` \| `undefined` | If the Attribute to be shared is an already existing [RelationshipAttribute](#relationshipattribute) of another [Relationship](#relationship), this property must contain the address of the `peer` with whom the sender of the Attribute has the Relationship in which context the RelationshipAttribute exists. | -##### RegisterAttributeListenerAcceptResponseItem - -| Name | Type | Description | -| ---------- | ----------------------------------------------- | -------------------------------------------------------- | -| @type | `"RegisterAttributeListenerAcceptResponseItem"` | The type of the ResponseItem. | -| result | `"Accepted"` | The only possible value here is the string `"Accepted"`. | -| listenerId | `string` | The id of the created AttributeListener. | - ##### ShareAttributeAcceptResponseItem | Name | Type | Description | diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 1c1cdb5c7..964419be3 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -54,6 +54,7 @@ The step-by-step instructions can be consulted to start the migration to version The property `reference` was introduced to group the property `truncated` with the additional property `url`, improving structure and better organizing related data. - The `title` property of the [File]({% link _docs_integrate/data-model-overview.md %}#file) became optional and should no longer be relied upon to be set. - The `ownershipToken` property of the [TransferFileOwnershipRequestItem]({% link _docs_integrate/data-model-overview.md %}#transferfileownershiprequestitem) became mandatory. This ensures that the ownership of the original File on the Backbone is transferred instead of applying a copy-based workaround. If the ownership of a [File]({% link _docs_integrate/data-model-overview.md %}#file) ought to be transferred, that doesn't have an `ownershipToken` yet, it will need to be [regenerated]({% link _docs_use-cases/use-case-transport-regenerate-file-ownership-token.md %}). +- All data structures around the Attribute listener feature were removed (`LocalAttributeListener`, `RegisterAttributeListenerRequestItem`, `RegisterAttributeListenerAcceptResponseItem`). ### Changed Behavior of Known Features diff --git a/_docs_integrate/request-and-response-introduction.md b/_docs_integrate/request-and-response-introduction.md index 42d3438dd..b18909f81 100644 --- a/_docs_integrate/request-and-response-introduction.md +++ b/_docs_integrate/request-and-response-introduction.md @@ -161,23 +161,6 @@ After the Recipient has responded to the ReadAttributeRequestItem, a suitable [R - After rejecting this RequestItem, a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) will be transferred. - In case of an error, an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) will be transferred. -#### RegisterAttributeListenerRequestItem - -This item is used to register a [Listener]({% link _docs_integrate/data-model-overview.md %}#localattributelistener) for a specific Attribute. The Listener will create a Request in status `Draft` if an Attribute was created that matches the given query and the user is able to send the Request to the creator of the [RegisterAttributeListenerRequestItem]({% link _docs_integrate/data-model-overview.md %}#registerattributelistenerrequestitem). Possible examples are: - -- Asking for a specific RelationshipAttribute of a partner organization. - -Depending on whether the RegisterAttributeListenerRequestItem is to be accepted or rejected, its Recipient has different parameters to choose from for responding to it: - -- To accept this RequestItem, the [AcceptRequestItemParameters]({% link _docs_integrate/data-model-overview.md %}#acceptrequestitemparameters) can be utilized. -- To reject this RequestItem, the [RejectRequestItemParameters]({% link _docs_integrate/data-model-overview.md %}#rejectrequestitemparameters) can be utilized. - -After the Recipient has responded to the RegisterAttributeListenerRequestItem, a suitable [ResponseItem]({% link _docs_integrate/data-model-overview.md %}#responseitems) is generated and transferred to the Sender of the Request: - -- After accepting this RequestItem, a [RegisterAttributeListenerAcceptResponseItem]({% link _docs_integrate/data-model-overview.md %}#registerattributelisteneracceptresponseitem) will be transferred. -- After rejecting this RequestItem, a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) will be transferred. -- In case of an error, an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) will be transferred. - #### ShareAttributeRequestItem If you want to share the own DisplayName and possibly other Attributes, this is done with the [ShareAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#shareattributerequestitem). To share own IdentityAttributes (owner = self) an Identity uses the ShareAttributeRequestItem. The Identity needs to create the IdentityAttribute separately before the Attribute can be shared. All details on how to use the ShareAttributeRequestItem and examples of use cases for it can be found in the [Share Attributes with peer]({% link _docs_integrate/share-attributes-with-peer.md %}) guide. @@ -213,7 +196,7 @@ After the Recipient has responded to the TransferFileOwnershipRequestItem, a sui Please note that the rendering of the [RequestItems]({% link _docs_integrate/data-model-overview.md %}#requestitems) in the App is currently being revised. As soon as the changes to the App have been made, the example here will also be adapted. {: .notice--warning} -This section gives an example of a [Request]({% link _docs_integrate/data-model-overview.md %}#request) that contains various [RequestItems]({% link _docs_integrate/data-model-overview.md %}#requestitems), namely an [AuthenticationRequestItem]({% link _docs_integrate/data-model-overview.md %}#authenticationrequestitem), a [ConsentRequestItem]({% link _docs_integrate/data-model-overview.md %}#consentrequestitem), a [CreateAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#createattributerequestitem), a [ProposeAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#proposeattributerequestitem), a [ReadAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#readattributerequestitem), a [RegisterAttributeListenerRequestItem]({% link _docs_integrate/data-model-overview.md %}#registerattributelistenerrequestitem) and a [ShareAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#shareattributerequestitem), within its `items` property. This Request can be sent from a Sender to an App user. A screenshot from the App showing how the Request is displayed to the App user is provided afterwards. +This section gives an example of a [Request]({% link _docs_integrate/data-model-overview.md %}#request) that contains various [RequestItems]({% link _docs_integrate/data-model-overview.md %}#requestitems), namely an [AuthenticationRequestItem]({% link _docs_integrate/data-model-overview.md %}#authenticationrequestitem), a [ConsentRequestItem]({% link _docs_integrate/data-model-overview.md %}#consentrequestitem), a [CreateAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#createattributerequestitem), a [ProposeAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#proposeattributerequestitem), a [ReadAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#readattributerequestitem) and a [ShareAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#shareattributerequestitem), within its `items` property. This Request can be sent from a Sender to an App user. A screenshot from the App showing how the Request is displayed to the App user is provided afterwards. ```json { @@ -275,16 +258,6 @@ This section gives an example of a [Request]({% link _docs_integrate/data-model- "tags": [""] } }, - { - "@type": "RegisterAttributeListenerRequestItem", - "mustBeAccepted": false, - "description": "", - "query": { - "@type": "IdentityAttributeQuery", - "valueType": "StreetAddress", - "tags": [""] - } - }, { "@type": "ShareAttributeRequestItem", "mustBeAccepted": true, diff --git a/_docs_integrate/terminate-relationships.md b/_docs_integrate/terminate-relationships.md index e91141aca..39688ee19 100644 --- a/_docs_integrate/terminate-relationships.md +++ b/_docs_integrate/terminate-relationships.md @@ -66,7 +66,7 @@ Decomposing a [Relationship]({% link _docs_integrate/data-model-overview.md %}#r - 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 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). +- Furthermore, the corresponding [Tokens]({% link _docs_integrate/data-model-overview.md %}#token). The use case is [Decompose Relationship]({% link _docs_use-cases/use-case-transport-decompose-relationship.md %}), which takes the `relationshipId` as input. For the peer, the Relationship is not deleted, but its `status` now is `"DeletionProposed"`. If the peer uses a Connector, they receive a `transport.relationshipChanged` [event]({% link _docs_integrate/connector-events.md %}). You receive a `transport.relationshipDecomposedBySelf` event. The peer is expected to follow suit once the shared data is no longer needed. Only after both Identities involved in the Relationship have decomposed it, the Relationship itself and data transmitted during it are deleted from the Backbone. To get to an active Relationship again after one involved Identity has decomposed, the other Identity must decompose as well. After that, the two have to start from scratch to [establish a Relationship]({% link _docs_integrate/establish-relationships.md %}), as reactivation of the former Relationship is no longer possible. diff --git a/_docs_use-cases/use-case-consumption-delete-attributelistener.md b/_docs_use-cases/use-case-consumption-delete-attributelistener.md deleted file mode 100644 index 9193fc686..000000000 --- a/_docs_use-cases/use-case-consumption-delete-attributelistener.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -# Start automatic generation -permalink: use-case-consumption-delete-attributelistener -published: false -title: "Delete AttributeListener" -type: use-case -toc: true -sidebar: - - title: "Integrate enmeshed" - nav: "docs_integrate" -properties: - - id: RAL3 - - component: Runtime - - layer: Consumption - - facade: - - function: - - description: - - feature category: Attribute automation - - tech category: AttributeListeners - - status: OPEN - - documentation status: - - comments: - - actor: Identity - - trigger: - - precondition: - - result: - - priority: LOW - - complexity: LOW - - size: S - - created_at: - - changed_at: - - api_route_regex: - - published: - - link: use-case-consumption-delete-attributelistener -require: -required_by: -# End automatic generation ---- diff --git a/_docs_use-cases/use-case-consumption-get-attributelistener.md b/_docs_use-cases/use-case-consumption-get-attributelistener.md deleted file mode 100644 index 4f1ec6c1d..000000000 --- a/_docs_use-cases/use-case-consumption-get-attributelistener.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -# Start automatic generation -permalink: use-case-consumption-get-attributelistener -published: true -title: "Get AttributeListener" -type: use-case -toc: true -sidebar: - - title: "Integrate enmeshed" - nav: "docs_integrate" -properties: - - id: RAL2 - - component: Runtime - - layer: Consumption - - facade: AttributeListenersFacade - - function: getAttributeListener - - description: - - feature category: Attribute automation - - tech category: AttributeListeners - - status: PRERELEASE - - documentation status: DONE - - comments: - - actor: Identity - - trigger: Runtime - - precondition: - - result: - - priority: n/a - - complexity: n/a - - size: n/a - - created_at: - - changed_at: - - api_route_regex: - - published: - - link: use-case-consumption-get-attributelistener -require: -required_by: -# End automatic generation ---- - -{{properties.description}} - -{% include properties_list.html %} - -This use case is intended to retrieve an [Attribute Listener]({% link _docs_integrate/data-model-overview.md %}#localattributelistener) by its id. - -## Parameter - -- The unique `id` identifying the Attribute Listener. - -## On Success - -- Returns the [LocalAttributeListener]({% link _docs_integrate/data-model-overview.md %}#localattributelistener) that corresponds to the `id`. - -## On Failure - -- There is no such Attribute Listener. diff --git a/_docs_use-cases/use-case-consumption-query-attributelisteners.md b/_docs_use-cases/use-case-consumption-query-attributelisteners.md deleted file mode 100644 index 39981b319..000000000 --- a/_docs_use-cases/use-case-consumption-query-attributelisteners.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -# Start automatic generation -permalink: use-case-consumption-query-attributelisteners -published: true -title: "Query AttributeListeners" -type: use-case -toc: true -sidebar: - - title: "Integrate enmeshed" - nav: "docs_integrate" -properties: - - id: RAL1 - - component: Runtime - - layer: Consumption - - facade: AttributeListenersFacade - - function: getAttributeListeners - - description: - - feature category: Attribute automation - - tech category: AttributeListeners - - status: PRERELEASE - - documentation status: DONE - - comments: - - actor: Identity - - trigger: Runtime - - precondition: - - result: - - priority: n/a - - complexity: n/a - - size: n/a - - created_at: - - changed_at: - - api_route_regex: - - published: - - link: use-case-consumption-query-attributelisteners -require: -required_by: -# End automatic generation ---- - -{{properties.description}} - -{% include properties_list.html %} - -This use case is intended to query all [Attribute Listeners]({% link _docs_integrate/data-model-overview.md %}#localattributelistener) -based on a query. - -## Parameter - -- The `query` optionally describes the searched Attribute Listeners. If no query is given all Attribute Listeners are returned. - -## On Success - -- Returns a list of [LocalAttributeListeners]({% link _docs_integrate/data-model-overview.md %}#localattributelistener) that match the query. - -## On Failure - -- The parameters are malformed.