versia-pub/docs
2
0
Fork 0
mirror of https://github.com/versia-pub/docs.git synced 2026-03-13 02:49:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: ✨ Add unique ID to every property on docs

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-12-24 14:01:09 +01:00
parent f27f206e2d
commit 9db7cfccda
No known key found for this signature in database
28 changed files with 144 additions and 116 deletions
Download patch file Download diff file Expand all files Collapse all files

4
app/extensions/custom-emojis/page.mdx
View file

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

12
app/extensions/groups/page.mdx
View file

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

2
app/extensions/instance-messaging/page.mdx
View file

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

2
app/extensions/interaction-controls/page.mdx
View file

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

4
app/extensions/likes/page.mdx
View file

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

4
app/extensions/migration/page.mdx
View file

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

4
app/extensions/page.mdx
View file

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

4
app/extensions/polls/page.mdx
View file

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

2
app/extensions/reactions/page.mdx
View file

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

2
app/extensions/reports/page.mdx
View file

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

2
app/extensions/share/page.mdx
View file

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

2
app/extensions/vanity/page.mdx
View file

@ -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).

2
app/extensions/websockets/page.mdx
View file

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