fix: 📝 Add more information on what a transient entity is

This commit is contained in:
Jesse Wierzbinski 2024-12-10 17:44:51 +01:00
parent 29f7ccba99
commit 46297d538c
No known key found for this signature in database
10 changed files with 21 additions and 15 deletions

View file

@ -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: