Docs: Add `/api/v1/instance` information
authorlain <lain@soykaf.club>
Mon, 27 Apr 2020 12:33:21 +0000 (14:33 +0200)
committerlain <lain@soykaf.club>
Mon, 27 Apr 2020 12:33:21 +0000 (14:33 +0200)
docs/API/differences_in_mastoapi_responses.md

index 41ceda26b59e830964b7a0ca1fe8295d5eddd01c..d0a776ebf1af5ad46fe564456aa1214276a8a6c4 100644 (file)
@@ -191,3 +191,17 @@ Has theses additional parameters (which are the same as in Pleroma-API):
 - `captcha_solution`: optional, contains provider-specific captcha solution,
 - `captcha_token`: optional, contains provider-specific captcha token
 - `token`: invite token required when the registrations aren't public.
+
+## Instance
+
+`GET /api/v1/instance` has additional fields
+
+- `max_toot_chars`: The maximum characters per post
+- `poll_limits`: The limits of polls
+- `upload_limit`: The maximum upload file size
+- `avatar_upload_limit`: The same for avatars
+- `background_upload_limit`: The same for backgrounds
+- `banner_upload_limit`: The same for banners
+- `pleroma.metadata.features`: A list of supported features
+- `pleroma.metadata.federation`: The federation restrictions of this instance
+- `vapid_public_key`: The public key needed for push messages