mirror of
https://github.com/versia-pub/docs.git
synced 2026-03-13 02:49:16 +01:00
fix: 📝 Add more information on what a transient entity is
This commit is contained in:
parent
29f7ccba99
commit
46297d538c
10 changed files with 21 additions and 15 deletions
|
|
@ -5,7 +5,7 @@ export const metadata = {
|
|||
|
||||
# Delete
|
||||
|
||||
Signals the deletion of an entity. It is a **transient entity**. {{ className: 'lead' }}
|
||||
Signals the deletion of an entity. It is a [**Transient Entity**](/entities#transient-entities). {{ className: 'lead' }}
|
||||
|
||||
## Authorization
|
||||
|
||||
|
|
@ -21,7 +21,7 @@ Having the authorization is defined as:
|
|||
<Col>
|
||||
<Properties>
|
||||
<Property name="uri" type="null" required={false}>
|
||||
This is a **Transient Entity** and does not have a URI.
|
||||
This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
|
||||
</Property>
|
||||
<Property name="author" type="URI | null" required={true} typeLink="/types#uri">
|
||||
URI of the `User` who is deleting the entity. [Can be set to `null` to represent the instance](/entities/instance-metadata#the-null-author).
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ export const metadata = {
|
|||
<Col>
|
||||
<Properties>
|
||||
<Property name="uri" type="null" required={false}>
|
||||
This is a **Transient Entity** and does not have a URI.
|
||||
This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
|
||||
</Property>
|
||||
<Property name="author" type="URI" required={true} typeLink="/types#uri">
|
||||
URI of the `User` considered the 'followee', i.e. the user who is being followed.
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ But it can also be used when Bob is already following Alice, in the case that:
|
|||
<Col>
|
||||
<Properties>
|
||||
<Property name="uri" type="null" required={false}>
|
||||
This is a **Transient Entity** and does not have a URI.
|
||||
This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
|
||||
</Property>
|
||||
<Property name="author" type="URI" required={true} typeLink="/types#uri">
|
||||
URI of the `User` considered the 'followee', i.e. the user who is being followed.
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ Once a follow relationship is established, the **followee**'s instance should se
|
|||
<Col>
|
||||
<Properties>
|
||||
<Property name="uri" type="null" required={false}>
|
||||
This is a **Transient Entity** and does not have a URI.
|
||||
This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
|
||||
</Property>
|
||||
<Property name="author" type="URI" required={true} typeLink="/types#uri">
|
||||
URI of the `User` considered the 'follower'.
|
||||
|
|
|
|||
|
|
@ -83,7 +83,7 @@ Indicates that a [User](/entities/user) wishes to subscribe to a group.
|
|||
<Col>
|
||||
<Properties>
|
||||
<Property name="uri" type="null" required={false}>
|
||||
This is a **Transient Entity** and does not have a URI.
|
||||
This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
|
||||
</Property>
|
||||
<Property name="subscriber" type="URI" required={true} typeLink="/types#uri">
|
||||
URI of the [User](/entities/user) subscribing to the group.
|
||||
|
|
@ -117,7 +117,7 @@ Indicates that a [User](/entities/user) wishes to unsubscribe from a group.
|
|||
<Col>
|
||||
<Properties>
|
||||
<Property name="uri" type="null" required={false}>
|
||||
This is a **Transient Entity** and does not have a URI.
|
||||
This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
|
||||
</Property>
|
||||
<Property name="subscriber" type="URI" required={true} typeLink="/types#uri">
|
||||
URI of the [User](/entities/user) unsubscribing from the group.
|
||||
|
|
@ -151,7 +151,7 @@ Indicates that a [Group](#entity-definition) has accepted a [User](/entities/use
|
|||
<Col>
|
||||
<Properties>
|
||||
<Property name="uri" type="null" required={false}>
|
||||
This is a **Transient Entity** and does not have a URI.
|
||||
This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
|
||||
</Property>
|
||||
<Property name="subscriber" type="URI" required={true} typeLink="/types#uri">
|
||||
URI of the [User](/entities/user) subscribing to the group.
|
||||
|
|
@ -185,7 +185,7 @@ Indicates that a [Group](#entity-definition) has rejected a [User](/entities/use
|
|||
<Col>
|
||||
<Properties>
|
||||
<Property name="uri" type="null" required={false}>
|
||||
This is a **Transient Entity** and does not have a URI.
|
||||
This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
|
||||
</Property>
|
||||
<Property name="subscriber" type="URI" required={true} typeLink="/types#uri">
|
||||
URI of the [User](/entities/user) subscribing to the group.
|
||||
|
|
@ -227,7 +227,7 @@ The `GroupFederate` entity allows a group to federate a note to all of its membe
|
|||
<Col>
|
||||
<Properties>
|
||||
<Property name="uri" type="null" required={false}>
|
||||
This is a **Transient Entity** and does not have a URI.
|
||||
This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
|
||||
</Property>
|
||||
<Property name="note" type="URI" required={true} typeLink="/types#uri">
|
||||
URI of the note to federate.
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ Any field in an entity not marked as `required` may be omitted or set to `null`.
|
|||
URI of the entity. Should be unique and resolve to the entity. Must be an absolute URI.
|
||||
|
||||
<Note>
|
||||
**Transient Entities** do not require a URI.
|
||||
[**Transient Entities**](/entities#transient-entities) do not require a URI.
|
||||
</Note>
|
||||
</Property>
|
||||
<Property name="$schema" type="string" required={false}>
|
||||
|
|
@ -86,6 +86,12 @@ Any field in an entity not marked as `required` may be omitted or set to `null`.
|
|||
</Col>
|
||||
</Row>
|
||||
|
||||
## Transient Entities
|
||||
|
||||
Some entities are transient, meaning they do not have a URI. These entities are used for actions that do not require a permanent record, such as deletions or migrations.
|
||||
|
||||
Implementations **must not** rely on other implementations to store transient entities in their database.
|
||||
|
||||
## Serialization
|
||||
|
||||
When serialized to a string, the JSON representation of an entity must follow the following rules:
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ Sometimes, [Users](/entities/user) want to unsubscribe from each other to stop s
|
|||
<Col>
|
||||
<Properties>
|
||||
<Property name="uri" type="null" required={false}>
|
||||
This is a **Transient Entity** and does not have a URI.
|
||||
This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
|
||||
</Property>
|
||||
<Property name="author" type="URI" required={true} typeLink="/types#uri">
|
||||
URI of the `User` considered the 'follower', i.e. the user who is unsubscribing from the followee.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue