10000 Add `wasAutomaticallyDecided` to incoming Requests query by Milena-Czierlinski · Pull Request #349 · nmshd/documentation · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add wasAutomaticallyDecided to incoming Requests query #349

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 2 commits into from
May 26, 2025
Merged

Add wasAutomaticallyDecided to incoming Requests query #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ffc488
feat: add wasAutomaticallyDecided to query
Milena-Czierlinski May 26, 2025
8519531
feat: add info that param only set for recipient
Milena-Czierlinski May 26, 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
22 changes: 11 additions & 11 deletions _docs_integrate/data-model-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,17 +259,17 @@ This chapter explains all of those types, together with their properties.

A LocalRequest contains the local metadata for a [Request](#request).

| Name | Type | Description |
| ----------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| id | `string` | {% include descr_id class="LocalRequest" prefix="REQ" %} |
| isOwn | `boolean` | `true` if you sent the Request, `false` if you received it. |
| peer | `string` | The Identity that sent you the corresponding Request/that you sent the Request to. |
| createdAt | `string` | {% include descr_createdAt class="LocalRequest" %} |
| status | [`LocalRequestStatus`](#localrequeststatus) | The current status of the Request. See [below](#localrequeststatus) for a list of all possible values. |
| content | [`Request`](#request) | The actual Content object this LocalRequest defines the metadata for. |
| source | [`LocalRequestSource`](#localrequestsource) \| `undefined` | Information about the Transport object with which the Request came in/was sent. This property is `undefined` if the Request is not sent yet. |
| response | [`LocalResponse`](#localresponse) \| `undefined` | Metadata + Content object of the response. If there is no response yet, this property is `undefined`. |
| wasAutomaticallyDecided | `true` \| `undefined` | Indicates whether the Request was decided automatically by the [Decider Module]({% link _docs_explore/61-runtime.md %}#decider-module). |
| Name | Type | Description |
| ----------------------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | `string` | {% include descr_id class="LocalRequest" prefix="REQ" %} |
| isOwn | `boolean` | `true` if you sent the Request, `false` if you received it. |
| peer | `string` | The Identity that sent you the corresponding Request/that you sent the Request to. |
| createdAt | `string` | {% include descr_createdAt class="LocalRequest" %} |
| status | [`LocalRequestStatus`](#localrequeststatus) | The current status of the Request. See [below](#localrequeststatus) for a list of all possible values. |
| content | [`Request`](#request) | The actual Content object this LocalRequest defines the metadata for. |
| source | [`LocalRequestSource`](#localrequestsource) \| `undefined` | Information about the Transport object with which the Request came in/was sent. This property is `undefined` if the Request is not sent yet. |
| response | [`LocalResponse`](#localresponse) \| `undefined` | Metadata + Content object of the response. If there is no response yet, this property is `undefined`. |
| wasAutomaticallyDecided | `true` \| `undefined` | Indicates whether the Request was decided automatically by the [Decider Module]({% link _docs_explore/61-runtime.md %}#d 8000 ecider-module). This will only be set for the recipient of the Request. |

### LocalRequestStatus

Expand Down
3 changes: 2 additions & 1 deletion _docs_use-cases/use-case-consumption-query-incoming-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@ This use case is intended to query incoming [LocalRequests]({% link _docs_integr

- The `id` of the LocalRequest.
- The `peer` is the `address` of the [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) that sent the LocalRequest.
- `createdAt` indicates the date of LocalRequest creation.
- `createdAt` indicates the creation date of the LocalRequest.
- The `status` of the LocalRequest.
- `wasAutomaticallyDecided` indicates whether the Request was automatically decided by the [Decider Module]({% link _docs_explore/61-runtime.md %}#decider-module).
- The `content` describes the [Request]({% link _docs_integrate/data-model-overview.md %}#request) wrapped by the LocalRequest.
- The `source` of the LocalRequest.
- The `response` describes the [Response]({% link _docs_integrate/data-model-overview.md %}#response) that might exist for the Request.
Expand Down
Loading
0