feat: ✨ Add unique ID to every property on docs

2026-03-13 02:49:16 +01:00 · 2024-12-24 14:01:09 +01:00 · 2024-12-24 14:01:09 +01:00 · 9db7cfccda
commit 9db7cfccda
parent f27f206e2d
28 changed files with 144 additions and 116 deletions
--- a/app/entities/delete/page.mdx
+++ b/app/entities/delete/page.mdx
@ -19,7 +19,7 @@ Having the authorization is defined as:

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Delete">
            <Property name="uri" type="null" required={false}>
                This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
            </Property>
--- a/app/entities/follow-accept/page.mdx
+++ b/app/entities/follow-accept/page.mdx
@ -13,7 +13,7 @@ export const metadata = {

 <Row>
    <Col>
-        <Properties>
+        <Properties name="FollowAccept">
            <Property name="uri" type="null" required={false}>
                This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
            </Property>
--- a/app/entities/follow-reject/page.mdx
+++ b/app/entities/follow-reject/page.mdx
@ -23,7 +23,7 @@ But it can also be used when Bob is already following Alice, in the case that:

 <Row>
    <Col>
-        <Properties>
+        <Properties name="FollowReject">
            <Property name="uri" type="null" required={false}>
                This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
            </Property>
--- a/app/entities/follow/page.mdx
+++ b/app/entities/follow/page.mdx
@ -55,7 +55,7 @@ Once a follow relationship is established, the **followee**'s instance should se

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Follow">
            <Property name="uri" type="null" required={false}>
                This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
            </Property>
--- a/app/entities/instance-metadata/page.mdx
+++ b/app/entities/instance-metadata/page.mdx
@ -17,7 +17,7 @@ Check the entity's documentation page to see if it supports this (it will be not

 <Row>
    <Col>
-        <Properties>
+        <Properties name="InstanceMetadata">
            <Property name="id" type="null">
                This entity does not have an ID.
            </Property>
--- a/app/entities/note/page.mdx
+++ b/app/entities/note/page.mdx
@ -15,7 +15,7 @@ Notes represent a piece of content on a Versia instance. They can be posted by [

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Note">
            <Property name="attachments" type="ContentFormat[]" required={false} typeLink="/structures/content-format">
                Media attachments to the note. May be any format. **Must** be remote.
            </Property>
--- a/app/entities/page.mdx
+++ b/app/entities/page.mdx
@ -17,7 +17,7 @@ Any field in an entity not marked as `required` may be omitted or set to `null`.
 <Row>
  <Col>

-    <Properties>
+    <Properties name="Entity">
        <Property name="id" type="string" required={true}>
            Unique identifier for the entity. Must be unique within the instance. Can be any string. Max of 512 UTF-8 characters.
        </Property>
--- a/app/entities/unfollow/page.mdx
+++ b/app/entities/unfollow/page.mdx
@ -28,7 +28,7 @@ Sometimes, [Users](/entities/user) want to unsubscribe from each other to stop s

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Unfollow">
            <Property name="uri" type="null" required={false}>
                This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
            </Property>
--- a/app/entities/user/page.mdx
+++ b/app/entities/user/page.mdx
@ -42,7 +42,7 @@ Instance **must** be the host of the instance the user is on (hostname with opti
 <Row>
  <Col>

-    <Properties>
+    <Properties name="User">
        <Property name="avatar" type="ContentFormat" required={false} typeLink="/structures/content-format">
            The user's avatar. Must be an image format (`image/*`).
        </Property>
--- a/app/extensions/custom-emojis/page.mdx
+++ b/app/extensions/custom-emojis/page.mdx
@ -11,7 +11,7 @@ The Custom Emojis extension adds support for adding personalized emojis to feder

 <Row>
    <Col>
-        <Properties>
+        <Properties name="CustomEmoji">
            <Property name="name" type="string" required={true}>
                Emoji name, surrounded by identification characters (for example, colons: `:happy_face:`).

@ -72,7 +72,7 @@ Custom Emojis can be added to any entity with text content. The extension ID is

 <Row>
    <Col>
-        <Properties>
+        <Properties name="CustomEmojisExtension">
            <Property name="emojis" type="CustomEmoji[]" required={true} typeLink="/extensions/custom-emoji#structure-definition">
                [Custom emojis](/extensions/custom-emoji#structure-definition) to be added to the note.
            </Property>
--- a/app/extensions/groups/page.mdx
+++ b/app/extensions/groups/page.mdx
@ -13,7 +13,7 @@ Refer to [Note](/entities/note#entity-definition)'s `group` property for how not

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Group">
            <Property name="type" type="string" required={true}>
                Must be `pub.versia:groups/Group`.
            </Property>
@ -84,7 +84,7 @@ Indicates that a [User](/entities/user) wishes to subscribe to a group.

 <Row>
    <Col>
-        <Properties>
+        <Properties name="GroupSubscribe">
            <Property name="type" type="string" required={true}>
                Must be `pub.versia:groups/Subscribe`.
            </Property>
@ -121,7 +121,7 @@ Indicates that a [User](/entities/user) wishes to unsubscribe from a group.

 <Row>
    <Col>
-        <Properties>
+        <Properties name="GroupUnsubscribe">
            <Property name="type" type="string" required={true}>
                Must be `pub.versia:groups/Unsubscribe`.
            </Property>
@ -158,7 +158,7 @@ Indicates that a [Group](#entity-definition) has accepted a [User](/entities/use

 <Row>
    <Col>
-        <Properties>
+        <Properties name="GroupSubscribeAccept">
            <Property name="type" type="string" required={true}>
                Must be `pub.versia:groups/SubscribeAccept`.
            </Property>
@ -195,7 +195,7 @@ Indicates that a [Group](#entity-definition) has rejected a [User](/entities/use

 <Row>
    <Col>
-        <Properties>
+        <Properties name="GroupSubscribeReject">
            <Property name="type" type="string" required={true}>
                Must be `pub.versia:groups/SubscribeReject`.
            </Property>
@ -240,7 +240,7 @@ The `GroupFederate` entity allows a group to federate a note to all of its membe

 <Row>
    <Col>
-        <Properties>
+        <Properties name="GroupFederate">
            <Property name="type" type="string" required={true}>
                Must be `pub.versia:groups/Federate`.
            </Property>
--- a/app/extensions/instance-messaging/page.mdx
+++ b/app/extensions/instance-messaging/page.mdx
@ -29,7 +29,7 @@ This extension adds the following metadata to instances:

 <Row>
    <Col>
-        <Properties>
+        <Properties name="InstanceMessagingExtension">
            <Property name="endpoint" type="string" required={true}>
                The endpoint to send federation debug messages to.

--- a/app/extensions/interaction-controls/page.mdx
+++ b/app/extensions/interaction-controls/page.mdx
@ -40,7 +40,7 @@ The entity defined in this document must be inserted in the `pub.versia:interact

 <Row>
    <Col>
-        <Properties>
+        <Properties name="InteractionControls">
            <Property name="interaction_type">
                Describes permissions for a specific interaction.

--- a/app/extensions/likes/page.mdx
+++ b/app/extensions/likes/page.mdx
@ -18,7 +18,7 @@ Likes are a way for users to show appreciation for a note, like Twitter's "heart

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Like">
            <Property name="type" type="string" required={true}>
                Must be `pub.versia:likes/Like`.
            </Property>
@ -55,7 +55,7 @@ Dislikes are a way for users to show disapproval for a note, like YouTube's "dis

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Dislike">
            <Property name="type" type="string" required={true}>
                Must be `pub.versia:likes/Dislike`.
            </Property>
--- a/app/extensions/migration/page.mdx
+++ b/app/extensions/migration/page.mdx
@ -32,7 +32,7 @@ Migration happens in three steps:

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Migration">
            <Property name="uri" type="null" required={false}>
                This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
            </Property>
@ -69,7 +69,7 @@ The following extensions to [User](/entities/user) are used by the migration ext

 <Row>
    <Col>
-        <Properties>
+        <Properties name="MigrationExtension">
            <Property name="previous" type="URI" required={true} typeLink="/types#uri">
                If this user has migrated from another instance, this property **MUST** be set to the URI of the user on the previous instance.
            </Property>
--- a/app/extensions/page.mdx
+++ b/app/extensions/page.mdx
@ -44,7 +44,7 @@ Extensions can be found in two places: an [Entity](/entities#entity-definition)'

 <Row>
    <Col>
-        <Properties>
+        <Properties name="EntityExtension">
            <Property name="extensions" type="Record<string, JSONData>" required={false}>
                Custom extensions to the entity.

@ -85,7 +85,7 @@ Extensions can be found in two places: an [Entity](/entities#entity-definition)'

 <Row>
    <Col>
-        <Properties>
+        <Properties name="CustomEntity">
            <Property name="type" type="string" required={true}>
                The extension type. [Must follow naming conventions](#naming).
            </Property>
--- a/app/extensions/polls/page.mdx
+++ b/app/extensions/polls/page.mdx
@ -19,7 +19,7 @@ Note that there is no `question` field: the question should be included in the `

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Polls">
            <Property name="options" type="ContentFormat[]" required="true">
                Array of options for the poll. Each option is a [ContentFormat](/structures/content-format) that can contain the same properties as a Note's `content` (e.g. [Custom Emojis](/extensions/custom-emojis) or HTML hyperlinks).
            </Property>
@ -98,7 +98,7 @@ If a vote is cast to a poll that is closed, the vote should be rejected with a `

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Vote">
            <Property name="type" type="string" required="true">
                Must be `pub.versia:polls/Vote`.
            </Property>
--- a/app/extensions/reactions/page.mdx
+++ b/app/extensions/reactions/page.mdx
@ -15,7 +15,7 @@ User reactions are (like every other entity) federated to all followers, and can

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Reaction">
            <Property name="type" type="string" required>
                Must be `pub.versia:reactions/Reaction`.
            </Property>
--- a/app/extensions/reports/page.mdx
+++ b/app/extensions/reports/page.mdx
@ -13,7 +13,7 @@ When an instance receives a report, it *should* be reviewed by a moderator or ad

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Report">
            <Property name="uri" type="null" required={false}>
                This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
            </Property>
--- a/app/extensions/share/page.mdx
+++ b/app/extensions/share/page.mdx
@ -17,7 +17,7 @@ When a user shares a note, the note's original author **must** receive the entit

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Share">
            <Property name="type" type="string" required={true}>
                Must be `pub.versia:share/Share`.
            </Property>
--- a/app/extensions/vanity/page.mdx
+++ b/app/extensions/vanity/page.mdx
@ -14,7 +14,7 @@ All properties are optional.

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Vanity">
            <Property name="avatar_overlays" type="ContentFormat[]" typeLink="/structures/content-format" required={false}>
                Overlay images to be placed on top of the user's avatar, like this: [example overlay from Discord](https://cdn.discordapp.com/avatar-decoration-presets/a_949a575b693c81ced8f56a7579d0969f.png).

--- a/app/extensions/websockets/page.mdx
+++ b/app/extensions/websockets/page.mdx
@ -22,7 +22,7 @@ Messages sent over the WebSocket connection are JSON objects.

 <Row>
    <Col>
-        <Properties>
+        <Properties name="WebSocketMessage">
            <Property name="signature" type="string" required={true}>
                Same as the `Versia-Signature` header in HTTP requests.
            </Property>
--- a/app/federation/http/page.mdx
+++ b/app/federation/http/page.mdx
@ -14,7 +14,7 @@ ALL kinds of HTTP requests/responses between instances **MUST** include a [Signa

 <Row>
    <Col>
-        <Properties>
+        <Properties name="HTTP Request">
            <Property name="Accept" type="string" required={true}>
                Must include `application/json`.
            </Property>
@ -61,7 +61,7 @@ IETF draft [draft-polli-ratelimit-headers-02](https://www.ietf.org/archive/id/dr

 <Row>
    <Col>
-        <Properties>
+        <Properties name="HTTP Response">
            <Property name="Content-Type" type="string" required={true}>
                Must include `application/json; charset=utf-8`.
            </Property>
--- a/app/links/page.mdx
+++ b/app/links/page.mdx
@ -12,7 +12,7 @@ Versia Links are a way to reference entities in the Versia Protocol, in a way th

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Versia Link">
            <Property name="scheme" type="string" required={true}>
                Must be `web+versia://` so that browsers and applications can recognize it.

--- a/app/structures/collection/page.mdx
+++ b/app/structures/collection/page.mdx
@ -17,7 +17,7 @@ Pages should be limited to a reasonable number of entities, such as 20 or 80.

 <Row>
    <Col>
-        <Properties>
+        <Properties name="Collection">
            <Property name="author" type="URI | null" required={true} typeLink="/types#uri">
                Author of the collection. Usually the user who owns the collection. [Can be set to `null` to represent the instance](/entities/instance-metadata#the-null-author).
            </Property>
@ -88,7 +88,7 @@ URI Collections are identical to regular collections, but they contain only URIs

 <Row>
    <Col>
-        <Properties>
+        <Properties name="URICollection">
            <Property name="author" type="URI | null" required={true} typeLink="/types#uri">
                Author of the collection. Usually the user who owns the collection. [Can be set to `null` to represent the instance](/entities/instance-metadata#the-null-author).
            </Property>
--- a/app/structures/content-format/page.mdx
+++ b/app/structures/content-format/page.mdx
@ -71,7 +71,7 @@ It is a good idea to provide at least two versions of an image (if possible): on
 <Row>
  <Col>

-    <Properties>
+    <Properties name="ContentFormat">
        <Property name="content" type="string | URI" required={true}>
            Structure data. If `Content-Type` is a binary format, this field should be a URI to the binary data. Otherwise, it should be the content itself. Refer to the `remote` property for more information.
        </Property>