Skip to content

Remove validity dates from Attributes #310

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 3 commits into from
Mar 6, 2025
Merged

Remove validity dates from Attributes #310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c02080a
feat: remove validFrom and validTo from Attributes and AttributeQueries
britsta Mar 6, 2025
fec9f31
refactoring: remove onlyValid parameter from use cases
britsta Mar 6, 2025
bcea1b2
Merge branch 'release/v7' into refactoring/remove-validity-dates-from…
mergify[bot] Mar 6, 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
4 changes: 1 addition & 3 deletions _docs_integrate/create-attributes-for-yourself.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ To create a RepositoryAttribute, proceed as described in the [Create a Repositor
```jsonc
{
"content": {
"validFrom": "<start of IdentityAttribute's validity>",
"validTo": "<end of IdentityAttribute's validity>",
"value": {
// IdentityAttribute value
...
Expand All @@ -53,7 +51,7 @@ To create a RepositoryAttribute, proceed as described in the [Create a Repositor
```

You need to replace the placeholders marked with `<...>` appropriately.
Note that the properties `validFrom`, `validTo` and `tags` are optional, so you can omit them.
Note that the property `tags` is optional, so you can omit it.
It is necessary that you insert one of the available [IdentityAttributeValues]({% link _docs_integrate/attribute-values.md %}#identity-attributes) into the `value` property.
If there is already an existing RepositoryAttribute with an undefined `succeededBy` property and which therefore represents the latest version, whose `content.value` exactly matches the specified `value` in the payload for creating a new RepositoryAttribute, an error with [error code]({% link _docs_integrate/error-codes.md %}) `error.runtime.attributes.cannotCreateDuplicateRepositoryAttribute` is thrown.
This is to prevent several latest RepositoryAttributes with the same `content.value` from existing in parallel.
Expand Down
22 changes: 6 additions & 16 deletions _docs_integrate/data-model-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -814,14 +814,12 @@ An Attribute is some piece of information about an Identity itself (e.g. its nam

IdentityAttributes describe an Identity itself. Their values are strongly normalized. There is a list of available values [here]({% link _docs_integrate/attribute-values.md %}).

| Name | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| @type | `"IdentityAttribute"` | |
| owner | `string` | The Identity that owns this Attribute. Only the owner of an Attribute is allowed to change it after its creation. |
| validFrom | `string` \| `undefined` | The date from which on the Attribute is valid. Could be in the future if the Attribute is not yet valid. |
| validTo | `string` \| `undefined` | The date until this Attribute is valid. Could be in the past if the Attribute is already expired. |
| value | [`IdentityAttributeValue`]({% link _docs_integrate/attribute-values.md %}#identity-attributes) | The Attribute's value. |
| tags | `string[]` \| `undefined` | To specify additional information. |
| Name | Type | Description |
| ----- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| @type | `"IdentityAttribute"` | |
| owner | `string` | The Identity that owns this Attribute. Only the owner of an Attribute is allowed to change it after its creation. |
| value | [`IdentityAttributeValue`]({% link _docs_integrate/attribute-values.md %}#identity-attributes) | The Attribute's value. |
| tags | `string[]` \| `undefined` | To specify additional information. |

### RelationshipAttribute

Expand All @@ -831,8 +829,6 @@ RelationshipAttributes describe an Identity in the context of a Relationship. Wh
| --------------- | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| @type | `"RelationshipAttribute"` | |
| owner | `string` | The Identity that owns this Attribute. Only the owner of an Attribute is allowed to change it after its creation. |
| validFrom | `string` \| `undefined` | The date from which on the Attribute is valid. Could be in the future if the Attribute is not yet valid. |
| validTo | `string` \| `undefined` | The date until this Attribute is valid. Could be in the past if the Attribute is already expired. |
| 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. |
Expand All @@ -849,8 +845,6 @@ An `IdentityAttributeQuery` is used to query for IdentityAttributes. For that, i
| Name | Type | Description |
| --------- | -------------------------- | --------------------------------------------------------------------------------------------------- |
| @type | `"IdentityAttributeQuery"` | |
| validFrom | `string` \| `undefined` | The start date of the time frame the returned Attribute should be valid in. |
| validTo | `string` \| `undefined` | The end date of the time frame the returned Attribute should be valid in. |
| valueType | `string` | The type of value that should be queried, e.g. `"StreetAddress"`, `"BirthDate"` or `"Nationality"`. |
| tags | `string[]` \| `undefined` | To specify additional information. |

Expand All @@ -863,8 +857,6 @@ There are cases in which you want to query some data from your peer that is not
| Name | Type | Description |
| ---------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| @type | `"RelationshipAttributeQuery"` | |
| validFrom | `string` \| `undefined` | The start date of the time frame the returned Attribute should be valid in. |
| validTo | `string` \| `undefined` | The end date of the time frame the returned Attribute should be valid in. |
| key | `string` | The key of the RelationshipAttribute that should be queried. |
| owner | `string` | The owner of the queried RelationshipAttribute. |
| attributeCreationHints | [`RelationshipAttributeCreationHints`](#relationshipattributecreationhints) | Contains information about the value that will be created, like the value type or its confidentiality. |
Expand Down Expand Up @@ -910,8 +902,6 @@ If you want to query RelationshipAttributes the Recipient has in the context of
| Name | Type | Description |
| ---------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| @type | `"ThirdPartyRelationshipAttributeQuery"` | |
| validFrom | `string` \| `undefined` | The start date of the time frame the returned RelationshipAttribute should be valid in. |
| validTo | `string` \| `undefined` | The end date of the time frame the returned RelationshipAttribute should be valid in. |
| key | `string` | The `key` of the RelationshipAttribute that should be queried. |
| owner | `"recipient"` \| `"thirdParty"` \| `""` | The `owner` of the queried RelationshipAttribute. Specify the string `"recipient"` if the Recipient should be the `owner` of the queried RelationshipAttribute. Use the string `"thirdParty"` if any of the third parties specified in the array string `thirdParty` should be the `owner`. If both the Recipient and each of the given third parties may be the `owner`, an empty string `""` must be specified. Using this option is useful if the `owner` of the queried RelationshipAttribute is not known in advance. |
| thirdParty | `string[]` | The third parties the RelationshipAttribute should be queried from. An `address` from this array will match the `shareInfo.thirdPartyAddress` property of a [ThirdPartyRelationshipAttribute](#localattribute). |
Expand Down
4 changes: 1 addition & 3 deletions _docs_integrate/exchange-files-using-attributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,11 @@ By [sending a suitable Request]({% link _docs_integrate/share-attributes-with-pe
## Create an IdentityFileReference

After [uploading the File](#upload-a-file), an [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) with an [IdentityFileReference]({% link _docs_integrate/attribute-values.md %}#identityfilereference) as its `value.@type` and the `truncatedReference` of the uploaded [File]({% link _docs_integrate/data-model-overview.md %}#file) as its `value.value` can be created by proceeding as described in the documentation on how to [create an IdentityAttribute for yourself]({% link _docs_integrate/create-attributes-for-yourself.md %}#create-an-identityattribute-for-yourself).
The following `content` can be used during the creation process, with its properties `validFrom`, `validTo` and `tags` being optional:
The following `content` can be used during the creation process, with its property `tags` being optional:

```jsonc
{
"content": {
"validFrom": "<start of IdentityFileReference's validity>",
"validTo": "<end of IdentityFileReference's validity>",
"value": {
"@type": "IdentityFileReference",
"value": "<truncatedReference of File>"
Expand Down
Loading