feat: Add unique ID to every property on docs

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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