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

docs: ♻️ Rewrite various docs pages, add null fields everywhere they were missing, make some Note and User fields mandatory

Browse source
This commit is contained in:
Jesse Wierzbinski 2025-06-07 22:54:59 +02:00
parent e6f7a27d3e
commit e9b5ccd76c
No known key found for this signature in database
31 changed files with 412 additions and 148 deletions
Download patch file Download diff file Expand all files Collapse all files

28
app/federation/http/page.mdx
View file

@ -8,7 +8,7 @@ export const metadata = {
Versia uses the HTTP protocol for all communications between instances. HTTP requests must conform to certain standards to ensure compatibility between different implementations, as well as to ensure the security and integrity of the data being exchanged.
ALL kinds of HTTP requests/responses between instances **MUST** include a [Signature](/signatures), signed with either the relevant [User](/entities/user)'s private key or the [instance's private key](/entities/instance-metadata).
HTTP requests/responses between instances **must** include a [Signature](/signatures), signed with the [instance's private key](/entities/instance-metadata), as defined in [Signatures](/signatures).
## Requests
@ -16,22 +16,26 @@ ALL kinds of HTTP requests/responses between instances **MUST** include a [Signa
<Col>
<Properties name="HTTP Request">
<Property name="Accept" type="string" required={true}>
Must include `application/vnd.versia+json`, unless specified otherwise.
Must be `application/vnd.versia+json`, unless specified otherwise. Basic `application/json` is **not** allowed.
</Property>
<Property name="Content-Type" type="string" required={true}>
Must include `application/vnd.versia+json; charset=utf-8`, if the request has a body.
Must be `application/vnd.versia+json; charset=utf-8` if the request has a body.
</Property>
<Property name="Versia-Signature" type="string" required={false}>
<Property name="Versia-Signature" type="string" required={true}>
See [Signatures](/signatures) for more information.
</Property>
<Property name="Versia-Signed-By" type="URI" required={false} typeLink="/types#uri">
<Property name="Versia-Signed-By" type="Domain" required={true} typeLink="/api/basics#domain">
See [Signatures](/signatures).
</Property>
<Property name="Versia-Signed-At" type="string" required={false}>
<Property name="Versia-Signed-At" type="number" required={true}>
See [Signatures](/signatures).
</Property>
<Property name="User-Agent" type="string" required={false}>
A string identifying the software making the request.
A string identifying the software making the request. Should contain the name of the software, its version, and a link to its homepage.
``` {{ 'title': 'Example User-Agent' }}
CoolServer/1.0 (https://coolserver.com)
```
</Property>
</Properties>
</Col>
@ -50,9 +54,9 @@ ALL kinds of HTTP requests/responses between instances **MUST** include a [Signa
## Rate limits
Implementations **MUST** respect the rate limits of remote instances.
Implementations **must** respect the rate limits of remote instances.
IETF draft [draft-polli-ratelimit-headers-02](https://www.ietf.org/archive/id/draft-polli-ratelimit-headers-02.html) **MUST** be used to communicate rate limits. Other rate limit headers/formats are not allowed.
IETF draft [draft-polli-ratelimit-headers-02](https://www.ietf.org/archive/id/draft-polli-ratelimit-headers-02.html) **must** be used to communicate rate limits. Other rate limit headers/formats are not allowed.
<Note>
This IETF draft is, well, a draft. However, there are no standards for rate limiting in HTTP, so this is the best we have.
@ -66,13 +70,13 @@ IETF draft [draft-polli-ratelimit-headers-02](https://www.ietf.org/archive/id/dr
<Property name="Content-Type" type="string" required={true}>
Must include `application/vnd.versia+json; charset=utf-8`, unless specified otherwise.
</Property>
<Property name="Versia-Signature" type="string" required={false}>
<Property name="Versia-Signature" type="string" required={true}>
See [Signatures](/signatures) for more information.
</Property>
<Property name="Versia-Signed-By" type="URI" required={false} typeLink="/types#uri">
<Property name="Versia-Signed-By" type="Domain" required={true} typeLink="/api/basics#domain">
See [Signatures](/signatures).
</Property>
<Property name="Versia-Signed-At" type="string" required={false}>
<Property name="Versia-Signed-At" type="number" required={true}>
See [Signatures](/signatures).
</Property>
</Properties>