summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLibravatar tobi <tobi.smethurst@protonmail.com>2025-05-06 09:58:47 +0000
committerLibravatar tobi <kipvandenbos@noreply.codeberg.org>2025-05-06 09:58:47 +0000
commitcf93d3af0ace59fa618a51537a77f7912e5f1610 (patch)
tree196ab23fdac7871a587f929da2265a8b18476c97 /docs
parent[feature] add ability to change s3 bucket lookup type (#4120) (diff)
downloadgotosocial-cf93d3af0ace59fa618a51537a77f7912e5f1610.tar.xz
[feature] Add `description_limit` to `/api/v2/instance`, increase default limit to 5k (#4140)
Closes https://codeberg.org/superseriousbusiness/gotosocial/issues/4131 by adding `description_limit` to the `api/v2/instance` response. Also increases default sizes to default status length to allow people to more easily describe things like screenshots of text. Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4140 Co-authored-by: tobi <tobi.smethurst@protonmail.com> Co-committed-by: tobi <tobi.smethurst@protonmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/api/swagger.yaml17
-rw-r--r--docs/configuration/media.md6
2 files changed, 20 insertions, 3 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml
index 59e698596..851106398 100644
--- a/docs/api/swagger.yaml
+++ b/docs/api/swagger.yaml
@@ -1593,6 +1593,23 @@ definitions:
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceConfigurationMediaAttachments:
properties:
+ description_limit:
+ description: |-
+ The maximum size of a description, in characters.
+ Omitted for /api/v1/instance response.
+ example: 5000
+ format: int64
+ type: integer
+ x-go-name: DescriptionLimit
+ description_minimum:
+ description: |-
+ The minimum size required for a description, in characters.
+ Omitted if zero/not set.
+ Omitted for /api/v1/instance response.
+ example: 200
+ format: int64
+ type: integer
+ x-go-name: DescriptionMinimum
image_matrix_limit:
description: |-
Max allowed image size in pixels as height*width.
diff --git a/docs/configuration/media.md b/docs/configuration/media.md
index e49b59dd3..b75a94d15 100644
--- a/docs/configuration/media.md
+++ b/docs/configuration/media.md
@@ -50,9 +50,9 @@ media-remote-max-size: 40MiB
media-description-min-chars: 0
# Int. Maximum amount of characters permitted in an image or video description.
-# Examples: [1000, 1500, 3000]
-# Default: 1500
-media-description-max-chars: 1500
+# Examples: [1000, 5000, 10000]
+# Default: 5000
+media-description-max-chars: 5000
# Size. Max size in bytes of emojis uploaded to this instance via the admin API.
#