Skip to content

Update data model #306

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 5, 2025
Merged

Update data model #306

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf184cb
feat: make title of a file optional
jkoenig134 Mar 5, 2025
c52ced4
refactor: template -> templateId
jkoenig134 Mar 5, 2025
e8937e7
Merge branch 'release/v7' into update-data-model
jkoenig134 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
4 changes: 2 additions & 2 deletions _docs_integrate/data-model-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ A Relationship between two Identities is the prerequisite for them to exchange M
| Name | Type | Description | Remarks |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| id | `string` | {% include descr_id class="Relationship" prefix="REL" %} | |
| template | [`RelationshipTemplate`](#relationshiptemplate) | The RelationshipTemplate that was used to establish this Relationship. | |
| templateId | `string` | The ID of the RelationshipTemplate that was used to establish this Relationship. | |
Copy link
Contributor

@britsta britsta Mar 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are still places to which this change must be applied, such as for the Query Relationships use case or the Establish Relationships scenario where this use case is called.

Copy link
Member Author

@jkoenig134 jkoenig134 Mar 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you do that?

Copy link
Contributor

@britsta britsta Mar 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure!

| status | `"Pending"` \| `"Active"` \| `"Rejected"` \| `"Revoked"` \| `"Terminated"` \| `"DeletionProposed"` | The status of this Relationship. <br>{::nomarkdown}<ul><li>Pending: the Relationship was created, but not yet accepted by the recipient. In this state you cannot send Messages yet.</li><li>Active: this means that the Relationship is active. As long as it is active, both participants can exchange Messages.</li><li>Rejected: the Relationship was rejected by the recipient.</li><li>Revoked: the Relationship was revoked by the sender.</li><li>Terminated: No Messages can be sent. Either side can request reactivation from the peer.</li><li>Deletion Proposed: Your peer has decomposed the Relationship, i. e. locally deleted the Relationship and data transmitted during it.</li></ul>{:/} | |
| creationContent | [`RelationshipCreationContent`](#relationshipcreationcontent) \| [`ArbitraryRelationshipCreationContent`](#arbitraryrelationshipcreationcontent) | The content sent along when the Relationship is initiated. If the `template` contains a [RelationshipTemplateContent](#relationshiptemplatecontent), `RelationshipCreationContent` has to be used. Otherwise, an `ArbitraryRelationshipCreationContent` is used, which can be filled with anything. | will be encrypted before sent to the Backbone |
| peer | `string` | The `address` of the [Identity](#identity) with which you have this Relationship. | |
Expand Down Expand Up @@ -186,7 +186,7 @@ The content of the File can be downloaded separately by executing the [Download
| 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 |
| 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` | A human readable title of the file, which can be defined when uploading 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 |
Expand Down