feat: Document inbox endpoint
Some checks failed
Mirror to Codeberg / Mirror (push) Failing after 0s

This commit is contained in:
Jesse Wierzbinski 2025-05-02 15:31:04 +02:00
parent 71064dea2c
commit 51c53824ad
No known key found for this signature in database
2 changed files with 64 additions and 1 deletions

View file

@ -11,6 +11,8 @@ Versia defines a very simple API for server-to-server communication, mainly fetc
Every Versia API endpoint is prefixed with `/.versia/vX/`, where `X` is the version of the API. The current version is `0.6`, so the current API prefix is `/.versia/v0.6/`. This versioning is used to avoid breaking changes in the future, and to allow for backwards compatibility.
Requests not encrypted with TLS (aka HTTPS) **MUST NOT** be sent or responded to. All implementations are required to use TLS 1.2 or higher, and to support HTTP/2.
<Note>
Implementations have no obligations to support more than one Versia version. It is recommended to always support the latest version, as it helps avoid bogging down the network with old versions.
</Note>
@ -24,4 +26,29 @@ The signature mechanism is defined in the [Signatures](/signatures) document.
## Encoding
"URL-encoding" is the mechanism used to encode data containing special characters in URLs. When this specification refers to "URL-encoding", it means the encoding defined in [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-2.1).
"URL-encoding" is the mechanism used to encode data containing special characters in URLs. When this specification refers to "URL-encoding", it means the encoding defined in [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-2.1).
## Redirects
API endpoints **MUST NOT** redirect to other endpoints, with the following exceptions:
- HTTP to HTTPS redirects (upgrading insecure requests).
- When the request does not have an `Accept: application/vnd.versia+json` header, the server **MAY** redirect to an HTML representation of the resource.
This is forbidden:
```http
GET /.versia/v0.6/entities/user/1234
Host: example.com
HTTP/1.1 301 Moved Permanently
Location: https://example.com/users/1234
```
This is allowed:
```http
GET /.versia/v0.6/entities/user/1234
Host: example.com
HTTP/1.1 301 Moved Permanently
Location: https://example.com/.versia/v0.6/entities/user/1234
```

View file

@ -148,3 +148,39 @@ GET /.versia/v0.6/entities/user/1234/collections/followers?offset=10&limit=20
Host: b.social
Accept: application/vnd.versia+json
```
## Inbox
The inbox endpoint is used for other instances to send entities to this instance. It is a single endpoint that can receive messages for every user (also known as a shared inbox).
The delivery mechanism is described further in the [Federation](/federation) document.
<Row>
<Col>
<Properties name="Inbox">
<Property name="endpoint">
Must be `/.versia/v0.6/inbox`.
</Property>
<Property name="method">
Must be `POST`.
</Property>
</Properties>
</Col>
<Col sticky>
```http {{ 'title': 'Example request' }}
POST /.versia/v0.6/inbox
Host: b.social
Accept: application/vnd.versia+json
Content-Type: application/vnd.versia+json
{
"type": "Note",
"id": "1234",
...
}
```
</Col>
</Row>