mirror of
https://github.com/versia-pub/server.git
synced 2026-03-13 05:49:16 +01:00
refactor: 🚚 Begin rebranding to Versia Server
This commit is contained in:
parent
64cef5c6d6
commit
771097d037
58 changed files with 2377 additions and 242 deletions
|
|
@ -1,6 +1,6 @@
|
|||
# Emoji API
|
||||
|
||||
An Emoji API is made available to users to manage custom emoji on the instance. We recommend using Lysand's CLI to manage emoji, but this API is available for those who prefer to use it (both admin and non-admin users).
|
||||
An Emoji API is made available to users to manage custom emoji on the instance. We recommend using Versia Server's CLI to manage emoji, but this API is available for those who prefer to use it (both admin and non-admin users).
|
||||
|
||||
## Create Emoji
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Federation API
|
||||
|
||||
The Federation API contains a variety of endpoints for interacting with the Lysand remote network.
|
||||
The Federation API contains a variety of endpoints for interacting with the Versia Server remote network.
|
||||
|
||||
## Refetch User
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# Frontend API
|
||||
|
||||
The frontend API contains endpoints that are useful for frontend developers. These endpoints are not part of the Mastodon API, but are specific to Lysand.
|
||||
The frontend API contains endpoints that are useful for frontend developers. These endpoints are not part of the Mastodon API, but are specific to Versia Server.
|
||||
|
||||
## Routes that the Frontend must implement
|
||||
|
||||
These routes can be set to a different URL in the Lysand configuration, at `frontend.routes`. The frontend must implement these routes for the instance to function correctly.
|
||||
These routes can be set to a different URL in the Versia Server configuration, at `frontend.routes`. The frontend must implement these routes for the instance to function correctly.
|
||||
|
||||
- `GET /oauth/authorize`: (NOT `POST`): Identifier/password login form, submits to [`POST /api/auth/login`](#sign-in) or OpenID Connect flow.
|
||||
- `GET /oauth/consent`: Consent form, submits to [`POST /api/auth/redirect`](#consent)
|
||||
|
|
@ -15,7 +15,7 @@ These routes can be set to a different URL in the Lysand configuration, at `fron
|
|||
GET /api/v1/frontend/config
|
||||
```
|
||||
|
||||
Retrieves the frontend configuration for the instance. This returns whatever the `frontend.settings` object is set to in the Lysand configuration.
|
||||
Retrieves the frontend configuration for the instance. This returns whatever the `frontend.settings` object is set to in the Versia Server configuration.
|
||||
|
||||
This behaves like the `/api/v1/preferences` endpoint in the Mastodon API, but is specific to the frontend. These values are arbitrary and can be used for anything.
|
||||
|
||||
|
|
@ -23,8 +23,8 @@ For example, the frontend configuration could contain the following:
|
|||
|
||||
```json
|
||||
{
|
||||
"org.lysand.fe:theme": "dark",
|
||||
"org.lysand.fe:custom_css": "body { background-color: black; }",
|
||||
"pub.versia.fe:theme": "dark",
|
||||
"pub.versia.fe:custom_css": "body { background-color: black; }",
|
||||
// Googly is an imaginary frontend that uses the `net.googly.frontend` namespace
|
||||
"net.googly.frontend:spoiler_image": "https://example.com/spoiler.png"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Lysand API Documentation
|
||||
# Versia Server API Documentation
|
||||
|
||||
The Lysand API strictly follows the latest available Mastodon API version (Glitch-Soc version). This means that the Lysand API is a superset of the Mastodon API, with additional endpoints and features.
|
||||
The Versia Server API strictly follows the latest available Mastodon API version (Glitch-Soc version). This means that the Versia Server API is a superset of the Mastodon API, with additional endpoints and features.
|
||||
|
||||
Some more information about the Mastodon API can be found in the [Mastodon API documentation](https://docs.joinmastodon.org/api/).
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Three extra attributes have been added to the `/api/v1/instance` endpoint:
|
|||
{
|
||||
// ...
|
||||
banner: string | null;
|
||||
lysand_version: string;
|
||||
versia_version: string;
|
||||
sso: {
|
||||
forced: boolean;
|
||||
providers: {
|
||||
|
|
@ -26,9 +26,9 @@ Three extra attributes have been added to the `/api/v1/instance` endpoint:
|
|||
|
||||
The URL of the instance's banner image. `null` if there is no banner set.
|
||||
|
||||
### `lysand_version`
|
||||
### `versia_version`
|
||||
|
||||
The version of the Lysand instance.
|
||||
The version of the Versia Server instance.
|
||||
|
||||
The normal `version` field is always set to `"4.3.0+glitch"` or similar, to not confuse clients that expect a Mastodon instance.
|
||||
|
||||
|
|
@ -55,18 +55,18 @@ Two extra attributes has been adding to all returned account objects:
|
|||
```ts
|
||||
{
|
||||
// ...
|
||||
roles: LysandRoles[];
|
||||
roles: VersiaRoles[];
|
||||
uri: string;
|
||||
}
|
||||
```
|
||||
|
||||
### `roles`
|
||||
|
||||
An array of roles from [Lysand Roles](./roles.md).
|
||||
An array of roles from [Versia Server Roles](./roles.md).
|
||||
|
||||
### `uri`
|
||||
|
||||
The URI of the account's Lysand object (for federation). Similar to Mastodon's `uri` field on notes.
|
||||
The URI of the account's Versia object (for federation). Similar to Mastodon's `uri` field on notes.
|
||||
|
||||
## `/api/v1/accounts/update_credentials`
|
||||
|
||||
|
|
|
|||
|
|
@ -3,11 +3,11 @@
|
|||
> [!WARNING]
|
||||
> **NOT IMPLEMENTED**
|
||||
|
||||
The Lysand project uses the Mastodon API to interact with clients. However, the moderation API is custom-made for Lysand Server, as it allows for more fine-grained control over the server's behavior.
|
||||
The Versia Server project uses the Mastodon API to interact with clients. However, the moderation API is custom-made for Versia Server Server, as it allows for more fine-grained control over the server's behavior.
|
||||
|
||||
## Flags, ModTags and ModNotes
|
||||
|
||||
Flags are used by Lysand Server to automatically attribute tags to a status or account based on rules. ModTags and ModNotes are used by moderators to manually tag and take notes on statuses and accounts.
|
||||
Flags are used by Versia Server Server to automatically attribute tags to a status or account based on rules. ModTags and ModNotes are used by moderators to manually tag and take notes on statuses and accounts.
|
||||
|
||||
The difference between flags and modtags is that flags are automatically attributed by the server, while modtags are manually attributed by moderators.
|
||||
|
||||
|
|
@ -22,7 +22,7 @@ The difference between flags and modtags is that flags are automatically attribu
|
|||
|
||||
### ModTag Types
|
||||
|
||||
ModTag do not have set types and can be anything. Lysand Server autosuggest previously used tags when a moderator is adding a new tag to avoid duplicates.
|
||||
ModTag do not have set types and can be anything. Versia Server Server autosuggest previously used tags when a moderator is adding a new tag to avoid duplicates.
|
||||
|
||||
### Data Format
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue