Skip to content

Add validation for IdentityAttribute tags #331

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
britsta merged 13 commits into from
May 9, 2025
Merged

Add validation for IdentityAttribute tags #331

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
20836bb
fix: swapped links
britsta May 6, 2025
e26a86e
feat: add invalidTags consumption error code
britsta May 6, 2025
453a1b1
Merge branch 'release/v7' into feature/add-validation-of-tags
britsta May 8, 2025
158219b
feat: change tense to present as tag validation is active now
britsta May 8, 2025
255f5eb
Merge branch 'release/v7' into feature/add-validation-of-tags
britsta May 8, 2025
1dd90d7
feat: add description of valid tags to data objects
britsta May 8, 2025
48a2b69
feat: mention tag validation in Attribute introduction
britsta May 8, 2025
ab96411
feat: mention tag validation in File upload use case
britsta May 8, 2025
4b59bec
feat: add how tags of File are used during ownership transfer
britsta May 9, 2025
da3d860
refactor: be more clear on when tags of Files are used for IdentityAt…
britsta May 9, 2025
3556f7b
Merge branch 'release/v7' into feature/add-validation-of-tags
mergify[bot] May 9, 2025
8c20ae1
Merge branch 'release/v7' into feature/add-validation-of-tags
mergify[bot] May 9, 2025
8a5bf0e
feat: specify what AttributeTagCollection is relevant for Files
britsta May 9, 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
30 changes: 15 additions & 15 deletions _docs_integrate/data-model-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,21 +176,21 @@ Its metadata information is stored in a data object of type File.
A File further has its content, of course. But since this is not a JSON property, it is not included in the following table.
The content of the File can be downloaded separately by executing the [Download File]({% link _docs_use-cases/use-case-transport-download-file.md %}) use case.

| Name | Type | Description | Remarks |
| ------------------ | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| id | `string` | {% include descr_id class="File" prefix="FIL" %} | |
| createdAt | `string` | {% include descr_createdAt class="File" %} | |
| createdBy | `string` | {% include descr_createdBy class="File" %} | |
| createdByDevice | `string` | {% include descr_createdByDevice class="File" %} | |
| expiresAt | `string` | {% include descr_expiresAt class="File" %} | |
| filename | `string` | The name of the file as it was on the device that uploaded it. | will be encrypted before sent to the Backbone |
| filesize | `number` | The size of the plaintext file in bytes. | will be encrypted before sent to the Backbone |
| tags | `string[]` \| `undefined` | To specify additional information in case an associated [IdentityAttribute](#identityattribute) with [IdentityFileReference]({% link _docs_integrate/attribute-values.md %}#identityfilereference) as `value.@type` is created for the File that should have `tags`. A tag is valid if it is contained in the [AttributeTagCollection](#attributetagcollection) or if it starts with the custom tag prefix `x+%+` or `X+%+`. | will be encrypted before sent to the Backbone |
| mimetype | `string` | The [mimetype](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) of the file. | will be encrypted before sent to the Backbone |
| title | `string` \| `undefined` | A human readable title of the file, which can be defined when uploading the File. | will be encrypted before sent to the Backbone |
| description | `string` \| `undefined` | A human readable description of the file, which can be defined when uploading the File. | will be encrypted before sent to the Backbone |
| isOwn | `boolean` | {% include descr_isOwn class="File" %} | saved only locally |
| truncatedReference | `string` | {% include descr_truncatedReference class="File" %} | saved only locally |
| Name | Type | Description | Remarks |
| ------------------ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| id | `string` | {% include descr_id class="File" prefix="FIL" %} | |
| createdAt | `string` | {% include descr_createdAt class="File" %} | |
| createdBy | `string` | {% include descr_createdBy class="File" %} | |
| createdByDevice | `string` | {% include descr_createdByDevice class="File" %} | |
| expiresAt | `string` | {% include descr_expiresAt class="File" %} | |
| filename | `string` | The name of the file as it was on the device that uploaded it. | will be encrypted before sent to the Backbone |
| filesize | `number` | The size of the plaintext file in bytes. | will be encrypted before sent to the Backbone |
| tags | `string[]` \| `undefined` | To specify additional information. A tag is valid if it is contained in the [AttributeTagCollection](#attributetagcollection) or if it starts with the custom tag prefix `x+%+` or `X+%+`. This validation is needed as an associated [IdentityAttribute](#identityattribute) with [IdentityFileReference]({% link _docs_integrate/attribute-values.md %}#identityfilereference) as `value.@type` will have these `tags` as well if it is created for the File during [transferring its ownership to a peer]({% link _docs_integrate/exchange-files-using-attributes.md %}#transfer-the-ownership-of-a-file-to-a-peer). | will be encrypted before sent to the Backbone |
| mimetype | `string` | The [mimetype](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) of the file. | will be encrypted before sent to the Backbone |
| title | `string` \| `undefined` | A human readable title of the file, which can be defined when uploading the File. | will be encrypted before sent to the Backbone |
| description | `string` \| `undefined` | A human readable description of the file, which can be defined when uploading the File. | will be encrypted before sent to the Backbone |
| isOwn | `boolean` | {% include descr_isOwn class="File" %} | saved only locally |
| truncatedReference | `string` | {% include descr_truncatedReference class="File" %} | saved only locally |

## Identity

Expand Down
1 change: 1 addition & 0 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 @@ -205,6 +205,7 @@ If the recipient agrees to receive the ownership of one of the sender's Files, t
The [AcceptRequestItemParameters]({% link _docs_integrate/data-model-overview.md %}#acceptrequestitemparameters) must be used for this.
The acceptance of a TransferFileOwnershipRequestItem leads to the transfer of the ownership of the File on the Backbone.
Additionally, a [RepositoryAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) will be created for the recipient, whose `content` is an [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) with [IdentityFileReference]({% link _docs_integrate/attribute-values.md %}#identityfilereference) as `value.@type`.
If the File has `tags`, the IdentityAttribute will have the same `tags`.
The `value` of the IdentityFileReference is the `truncatedReference` of the File that is now owned by the recipient.
Also, the newly created RepositoryAttribute of the recipient will be shared with the sender, i.e. an own shared IdentityAttribute will be created for the recipient.
Based on this, an appropriate AcceptResponseItem of type [TransferFileOwnershipAcceptResponseItem]({% link _docs_integrate/data-model-overview.md %}#transferfileownershipacceptresponseitem) is generated.
Expand Down
Loading