diff --git a/app/changelog/page.mdx b/app/changelog/page.mdx index 32ac559..bc745c0 100644 --- a/app/changelog/page.mdx +++ b/app/changelog/page.mdx @@ -11,6 +11,7 @@ This page lists changes since Working Draft 3. {{ className: 'lead' }} ## Since WD 4 - Removed URI from [Report](/extensions/reports), and replaced `reason` with `tags`. +- Docs now use the term "Transient Entity" where appropriate. - Mandated Unix-style `\n` line endings in all text fields. - Renamed the following headers, as per [RFC 6648](https://tools.ietf.org/html/rfc6648): - `X-Signature` to `Versia-Signature` diff --git a/app/entities/delete/page.mdx b/app/entities/delete/page.mdx index b8521df..61d3893 100644 --- a/app/entities/delete/page.mdx +++ b/app/entities/delete/page.mdx @@ -5,7 +5,7 @@ export const metadata = { # Delete -Signals the deletion of an entity. {{ className: 'lead' }} +Signals the deletion of an entity. It is a **transient entity**. {{ className: 'lead' }} ## Authorization @@ -21,7 +21,7 @@ Having the authorization is defined as: - This entity does not have a URI. + This is a **Transient Entity** and does not have a 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). diff --git a/app/entities/follow-accept/page.mdx b/app/entities/follow-accept/page.mdx index 1748d3d..8336474 100644 --- a/app/entities/follow-accept/page.mdx +++ b/app/entities/follow-accept/page.mdx @@ -15,7 +15,7 @@ export const metadata = { - This entity does not have a URI. + This is a **Transient Entity** and does not have a URI. URI of the `User` considered the 'followee', i.e. the user who is being followed. diff --git a/app/entities/follow-reject/page.mdx b/app/entities/follow-reject/page.mdx index bfba74b..a65a26c 100644 --- a/app/entities/follow-reject/page.mdx +++ b/app/entities/follow-reject/page.mdx @@ -25,7 +25,7 @@ But it can also be used when Bob is already following Alice, in the case that: - This entity does not have a URI. + This is a **Transient Entity** and does not have a URI. URI of the `User` considered the 'followee', i.e. the user who is being followed. diff --git a/app/entities/follow/page.mdx b/app/entities/follow/page.mdx index 179200b..26ff12b 100644 --- a/app/entities/follow/page.mdx +++ b/app/entities/follow/page.mdx @@ -57,7 +57,7 @@ Once a follow relationship is established, the **followee**'s instance should se - This entity does not have a URI. + This is a **Transient Entity** and does not have a URI. URI of the `User` considered the 'follower'. diff --git a/app/entities/group/page.mdx b/app/entities/group/page.mdx index 2be98a1..e9cab0e 100644 --- a/app/entities/group/page.mdx +++ b/app/entities/group/page.mdx @@ -83,7 +83,7 @@ Indicates that a [User](/entities/user) wishes to subscribe to a group. - This entity does not have a URI. + This is a **Transient Entity** and does not have a 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. - This entity does not have a URI. + This is a **Transient Entity** and does not have a 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 - This entity does not have a URI. + This is a **Transient Entity** and does not have a 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 - This entity does not have a URI. + This is a **Transient Entity** and does not have a 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 - This entity does not have a URI. + This is a **Transient Entity** and does not have a URI. URI of the note to federate. diff --git a/app/entities/page.mdx b/app/entities/page.mdx index 0ae1ef8..431e246 100644 --- a/app/entities/page.mdx +++ b/app/entities/page.mdx @@ -34,7 +34,9 @@ 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. - **Some entity types may not need a URI. This will be specified in the entity's documentation.** + + **Transient Entities** do not require a URI. + URL of any JSON Schema that the entity adheres to. diff --git a/app/entities/unfollow/page.mdx b/app/entities/unfollow/page.mdx index fe51cff..078db5f 100644 --- a/app/entities/unfollow/page.mdx +++ b/app/entities/unfollow/page.mdx @@ -30,7 +30,7 @@ Sometimes, [Users](/entities/user) want to unsubscribe from each other to stop s - This entity does not have a URI. + This is a **Transient Entity** and does not have a URI. URI of the `User` considered the 'follower', i.e. the user who is unsubscribing from the followee. diff --git a/app/extensions/migration/page.mdx b/app/extensions/migration/page.mdx index 32e5e19..8e2f5a0 100644 --- a/app/extensions/migration/page.mdx +++ b/app/extensions/migration/page.mdx @@ -34,7 +34,7 @@ Migration happens in three steps: - This entity does not have a URI. + This is a **Transient Entity** and does not have a URI. Must be `pub.versia:migration/Migration`. diff --git a/app/extensions/reports/page.mdx b/app/extensions/reports/page.mdx index 13f49e5..68751a7 100644 --- a/app/extensions/reports/page.mdx +++ b/app/extensions/reports/page.mdx @@ -15,7 +15,7 @@ When an instance receives a report, it *should* be reviewed by a moderator or ad - This entity does not have a URI. + This is a **Transient Entity** and does not have a URI. Must be `pub.versia:reports/Report`. diff --git a/app/introduction/page.mdx b/app/introduction/page.mdx index dc51f80..e9cd248 100644 --- a/app/introduction/page.mdx +++ b/app/introduction/page.mdx @@ -35,6 +35,7 @@ The words **MUST**, **MUST NOT**, **SHOULD**, **SHOULD NOT**, and **MAY** are us The Versia Protocol uses the following terms: - **Entity**: A generic term for any JSON object in the protocol, such as a [User](./entities/user), a [Note](./entities/note), or a [Like](./extensions/likes). Entities are uniquely identified by their `id` property. + - **Transient Entity**: A type of **Entity** that is not meant to be stored permanently or referenced by other entities. - **Implementation**: A software application that implements the Versia Protocol. - **Instance**: An application deploying an **Implementation**. - Using the same nomenclature, an ActivityPub Implementation would be `Mastodon`, and an Instance would be `mastodon.social`.