From 0f9bc67b5d6d3d0170d2f83a2bd63703b3e9dc1e Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 4 Mar 2025 10:37:31 +0000 Subject: [PATCH 1/4] fix: broken link to CreateAttributeRequestItem in data model overview --- _docs_integrate/data-model-overview.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/_docs_integrate/data-model-overview.md b/_docs_integrate/data-model-overview.md index f441af0a9..e8c190236 100644 --- a/_docs_integrate/data-model-overview.md +++ b/_docs_integrate/data-model-overview.md @@ -435,7 +435,12 @@ Content Types can be seen as a data contract between Identities. The medium thro ## Request -A Request allows you to ask another Identity to do something. What this "something" is depends on which of the so called [RequestItems](#requestitems) were added to the Request (e.g. [`CreateAttributeRequestItem`](}#createattributerequestitem), [`ReadAttributeRequestItem`](#readattributerequestitem), ...). The Request is then sent to the peer via Message or RelationshipTemplate. The peer can then review the Request and decide whether they want to accept or reject it. And if they accept it, they can even choose which of the Items they want to accept. You can also put multiple Items into a [RequestItemGroup](#requestitemgroup) in order to display them visually as a unit. +A Request allows you to ask another Identity to do something. +What this "something" is depends on which of the so called [RequestItems](#requestitems) were added to the Request (e.g. [`CreateAttributeRequestItem`](#createattributerequestitem), [`ReadAttributeRequestItem`](#readattributerequestitem), ...). +The Request is then sent to the peer via Message or RelationshipTemplate. +The peer can then review the Request and decide whether they want to accept or reject it. +And if they accept it, they can even choose which of the Items they want to accept. +You can also put multiple Items into a [RequestItemGroup](#requestitemgroup) in order to display them visually as a unit. | Name | Type | Description | | ----------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- | From ae609139d76b50086ffade7c8cfa24436457c27f Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 4 Mar 2025 10:39:40 +0000 Subject: [PATCH 2/4] feat: add title to AuthenticationRequestItem of diagram and fix diagram mistakes --- _docs_integrate/request-and-response-introduction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs_integrate/request-and-response-introduction.md b/_docs_integrate/request-and-response-introduction.md index 66220fb04..716c0ce29 100644 --- a/_docs_integrate/request-and-response-introduction.md +++ b/_docs_integrate/request-and-response-introduction.md @@ -361,7 +361,7 @@ If a RequestItem is accepted, an [AcceptResponseItem]({% link _docs_integrate/da Depending on the kind of RequestItem, it might be a specific AcceptResponseItem, extending the base AcceptResponseItem to answer to RequestItems demanding additional information. For example, a ReadAttributeRequestItem is accepted using a [ReadAttributeAcceptResponseItem]({% link _docs_integrate/data-model-overview.md %}#readattributeacceptresponseitem), additionally transmitting information about the respective Attribute. -
+
If a RequestItem is rejected, however, a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) is created. Lastly, in case the enmeshed Runtime detects a problem, an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) is generated. From 97126613d60f0010534f49cc614ff039590a5e74 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 4 Mar 2025 10:55:12 +0000 Subject: [PATCH 3/4] feat: make title of AuthenticationRequestItem mandatory --- _docs_integrate/data-model-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs_integrate/data-model-overview.md b/_docs_integrate/data-model-overview.md index e8c190236..f3cad8adf 100644 --- a/_docs_integrate/data-model-overview.md +++ b/_docs_integrate/data-model-overview.md @@ -463,7 +463,7 @@ For more information you should check out the section [AuthenticationRequestItem | Name | Type | Description | | --------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | @type | `"AuthenticationRequestItem"` | Specifies the type of the RequestItem for internal processing. | -| title | `string` \| `undefined` | An optional, human readable title for the RequestItem. | +| title | `string` | A human readable title for the AuthenticationRequestItem. In contrast to the title of the other RequestItems, this is not optional because at least one text about the subject of the authentication must be sent. | | 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}
  • If mustBeAccepted is set to true, the peer cannot accept the Request without accepting this RequestItem.
  • If mustBeAccepted is set to false, the peer can accept the Request even though the RequestItem is rejected.
{:/} | @@ -613,7 +613,7 @@ For more information, please consult the respective chapter of the [Request and #### AcceptResponseItem -An AcceptResponseItem can be received as answer to an [AuthenticationRequestItem]({% link _docs_integrate/request-and-response-introduction.md %}#authenticationrequestitem) or [ConsentRequestItem]({% link _docs_integrate/request-and-response-introduction.md %}#consentrequestitem). +An AcceptResponseItem can be received as answer to an [AuthenticationRequestItem]({% link _docs_integrate/request-and-response-introduction.md %}#authenticationrequestitem) or a [ConsentRequestItem]({% link _docs_integrate/request-and-response-introduction.md %}#consentrequestitem). | Name | Type | Description | | ------ | ---------------------- | -------------------------------------------------------- | From fdc2223bf9901185eecc6a5f3f9d9f2e022d5d2d Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 4 Mar 2025 16:48:36 +0000 Subject: [PATCH 4/4] refactor: change formulation of reason for mandatory title --- _docs_integrate/data-model-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs_integrate/data-model-overview.md b/_docs_integrate/data-model-overview.md index f3cad8adf..c053d911a 100644 --- a/_docs_integrate/data-model-overview.md +++ b/_docs_integrate/data-model-overview.md @@ -463,7 +463,7 @@ For more information you should check out the section [AuthenticationRequestItem | Name | Type | Description | | --------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | @type | `"AuthenticationRequestItem"` | Specifies the type of the RequestItem for internal processing. | -| title | `string` | A human readable title for the AuthenticationRequestItem. In contrast to the title of the other RequestItems, this is not optional because at least one text about the subject of the authentication must be sent. | +| title | `string` | A human readable title for the AuthenticationRequestItem. In contrast to the title of the other RequestItems, this is not optional because at least one text about the topic of the authentication must be sent. | | 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}
  • If mustBeAccepted is set to true, the peer cannot accept the Request without accepting this RequestItem.
  • If mustBeAccepted is set to false, the peer can accept the Request even though the RequestItem is rejected.
{:/} |