versia-pub/docs
2
0
Fork 0
mirror of https://github.com/versia-pub/docs.git synced 2025-12-06 06:18:19 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix: update Versia Links

Browse source
This commit is contained in:
April John 2024-11-19 19:19:16 +00:00 committed by GitHub
parent 1fe84674de
commit 10b5328247
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
app/links/page.mdx
View file

@ -18,20 +18,22 @@ Versia Links are a way to reference entities in the Versia Protocol, in a way th
An IANA registration for the `versia://` scheme will be requested in the future. An IANA registration for the `versia://` scheme will be requested in the future.
</Property> </Property>
<Property name="instance" type="string" required={true}>
Instance host, including the port if it is not the default (i.e. `443` for HTTPS).
</Property>
<Property name="action" type="string" required={true}> <Property name="action" type="string" required={true}>
Action to take on the entity. Can have multiple slashes as a way to segment the action. Action to take on the entity. Can have multiple slashes as a way to segment the action.
Links that reference instance-specific content (like Entities) **must** reference a Instance.
Possible actions: Possible actions:
- `users/:username`: Open a user profile. - `users/:instance/:id`: Open a user profile.
- `notes/:id`: Open a note. - `notes/:instance/:id`: Open a note.
- `groups/:id`: Open a group. - `groups/:instance/:id`: Open a group.
- `reply/:id`: Open the composer to reply to a note. - `reply/:instance/:id`: Open the composer to reply to a note.
- `quote/:id`: Open the composer to quote a note. - `quote/:instance/:id`: Open the composer to quote a note.
- `share/:id`: Share a note. - `share/:instance/:id`: Share a note.
- `compose/:text`: Compose a new note. Text passed at the end will be added in the note compose field. Used for "Share with Versia" buttons on websites.
</Property>
<Property name="instance" type="string" required={false}>
Instance hosting the referenced content, including the port if it is not the default (i.e. `443` for HTTPS).
</Property> </Property>
</Properties> </Properties>
</Col> </Col>
@ -60,4 +62,6 @@ The default client ("frontend") on a Versia instance **should** also display Ver
- Notes - Notes
- Groups - Groups
This **could** be used for easier following of users from remote instances.
Clients **should** ask users to confirm any action that is not a simple view action, such as replying to a note or sharing a note. Clients **should** ask users to confirm any action that is not a simple view action, such as replying to a note or sharing a note.