Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .github/renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["github>js-soft/renovate-config"],
"reviewers": ["Milena-Czierlinski", "britsta"]
}
30 changes: 15 additions & 15 deletions _docs_integrate/data-model-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -572,15 +572,15 @@ The peer can then review the Request and decide whether they want to accept or r
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 |
| Name | Type | Description |
| ----------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
| @type | "Request" | |
| id | `string` \| `undefined` | Unique identifier of this object. This property is `undefined` if the Request is inside of a RelationshipTemplate. <br>_Remark: the ID of each Request starts with the letters "REQ". This way you can tell apart a Request ID from any other ID just by looking at the prefix._<br> |
| title | `string` \| `undefined` | An optional, human readable title for the Request. |
| description | `string` \| `undefined` | An optional, human readable description for the Request. |
| expiresAt | `string` \| `undefined` | {% include descr_expiresAt class="Request" %} |
| items | `(`[`RequestItemGroup`](#requestitemgroup)` | `[`\*RequestItem`](#requestitems)`)[]` | An array of RequestItems and Groups that are part of the Request. There must be at least one Item or Group per Request. |
| metadata | `object` \| `undefined` | Optional custom metadata that can be sent together with the Request. This property is meant purely for developers who integrate with enmeshed. They can write for example some kind of key into this property, which can be used later to identify the content of this Request. |
| @type | "Request" | |
| id | `string` \| `undefined` | Unique identifier of this object. This property is `undefined` if the Request is inside of a RelationshipTemplate. <br>_Remark: the ID of each Request starts with the letters "REQ". This way you can tell apart a Request ID from any other ID just by looking at the prefix._<br> |
| title | `string` \| `undefined` | An optional, human readable title for the Request. |
| description | `string` \| `undefined` | An optional, human readable description for the Request. |
| expiresAt | `string` \| `undefined` | {% include descr_expiresAt class="Request" %} |
| items | `(`[`RequestItemGroup`](#requestitemgroup)`|`[`\*RequestItem`](#requestitems)`)[]` | An array of RequestItems and Groups that are part of the Request. There must be at least one Item or Group per Request. |
| metadata | `object` \| `undefined` | Optional custom metadata that can be sent together with the Request. This property is meant purely for developers who integrate with enmeshed. They can write for example some kind of key into this property, which can be used later to identify the content of this Request. |

### RequestItems

Expand Down Expand Up @@ -1031,14 +1031,14 @@ There is a list of available values [here]({% link _docs_integrate/attribute-val
RelationshipAttributes describe an Identity in the context of a Relationship.
While there are some types that can be used as a value for a RelationshipAttribute, these types are rather generic (e.g. `ProprietaryString`, `ProprietaryInteger`, ...).

| Name | Type | Description |
| Name | Type | Description |
| --------------- | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| @type | `"RelationshipAttribute"` | |
| owner | `string` | The Identity that owns this Attribute. Only the owner of an Attribute is allowed to change it after its creation. |
| key | `string` | An arbitrary key that is set by the creator of this Attribute. It is used to identify the Attribute in a query, especially by a third party. Example: you could set something like `customerId` in case of a customer id. |
| isTechnical | `boolean` \| `undefined` | Defines whether the RelationshipAttribute contains data that is actually relevant for the user (`isTechnical=false`) or whether it should be hidden in the UI (`isTechnical=true`). |
| value | [`RelationshipAttributeValue`]({% link _docs_integrate/attribute-values.md %}#relationship-attributes) | The Attribute's value. |
| confidentiality | `"public"` \| `"protected"` \| `"private"` | When this property is set to `"private"`, it means that third parties are not able to query this RelationshipAttribute. It therefore only exists in the Relationship it was created in. If the confidentiality is `"protected"`, third parties can query the RelationshipAttribute, but the App shows a warning saying that you should only share it with someone you trust. If the confidentiality is `"public"`, everybody can query the Attribute, without anything special to happen. | |
| @type | `"RelationshipAttribute"` | |
| owner | `string` | The Identity that owns this Attribute. Only the owner of an Attribute is allowed to change it after its creation. |
| key | `string` | An arbitrary key that is set by the creator of this Attribute. It is used to identify the Attribute in a query, especially by a third party. Example: you could set something like `customerId` in case of a customer id. |
| isTechnical | `boolean` \| `undefined` | Defines whether the RelationshipAttribute contains data that is actually relevant for the user (`isTechnical=false`) or whether it should be hidden in the UI (`isTechnical=true`). |
| value | [`RelationshipAttributeValue`]({% link _docs_integrate/attribute-values.md %}#relationship-attributes) | The Attribute's value. |
| confidentiality | `"public"` \| `"protected"` \| `"private"` | When this property is set to `"private"`, it means that third parties are not able to query this RelationshipAttribute. It therefore only exists in the Relationship it was created in. If the confidentiality is `"protected"`, third parties can query the RelationshipAttribute, but the App shows a warning saying that you should only share it with someone you trust. If the confidentiality is `"public"`, everybody can query the Attribute, without anything special to happen. | |

## AttributeQueries

Expand Down
Loading
Loading