Skip to content

Make title of AuthenticationRequestItem mandatory #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 5, 2025
Merged

Make title of AuthenticationRequestItem mandatory #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0f9bc67
fix: broken link to CreateAttributeRequestItem in data model overview
britsta Mar 4, 2025
ae60913
feat: add title to AuthenticationRequestItem of diagram and fix diagr…
britsta Mar 4, 2025
9712661
feat: make title of AuthenticationRequestItem mandatory
britsta Mar 4, 2025
fdc2223
refactor: change formulation of reason for mandatory title
britsta Mar 4, 2025
9c40c91
Merge branch 'main' into feature/make-title-of-authenticationrequesti…
mergify[bot] Mar 5, 2025
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
11 changes: 8 additions & 3 deletions _docs_integrate/data-model-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| ----------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
Expand All @@ -458,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 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.<br>{::nomarkdown}<ul><li>If <code>mustBeAccepted</code> is set to <code>true</code>, the peer cannot <a href="https://enmeshed.eu/use-case-consumption-accept-incoming-request">accept the Request</a> without accepting this RequestItem.</li><li>If <code>mustBeAccepted</code> is set to <code>false</code>, the peer can <a href="https://enmeshed.eu/use-case-consumption-accept-incoming-request">accept the Request</a> even though the RequestItem is rejected.</ul>{:/} |
Expand Down Expand Up @@ -608,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 |
| ------ | ---------------------- | -------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion _docs_integrate/request-and-response-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<div style="width: 640px; height: 480px; margin: 10px; position: relative;"><iframe allowfullscreen frameborder="0" style="width:640px; height:480px" src="https://lucid.app/documents/embedded/1d3f3866-4d85-46b5-8523-ecc581052f4b" id="NCvNTKLN71pl"></iframe></div>
<div style="width: 640px; height: 480px; margin: 10px; position: relative;"><iframe allowfullscreen frameborder="0" style="width:640px; height:480px" src="https://lucid.app/documents/embedded/fd7932ee-c69a-4c31-9968-b9331ba780ba" id="VccYnn65H3tW"></iframe></div>

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.
Expand Down