summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2024-07-08 15:47:03 +0200
committerLibravatar GitHub <noreply@github.com>2024-07-08 15:47:03 +0200
commitd70f4e166dd9ce2f11a6ac2d7a2e500515657041 (patch)
tree256f2a4423742a41adceb00dbec0cd56c568e908 /docs/api
parent[chore]: Bump github.com/minio/minio-go/v7 from 7.0.72 to 7.0.73 (#3083) (diff)
downloadgotosocial-d70f4e166dd9ce2f11a6ac2d7a2e500515657041.tar.xz
[feature/frontend] Allow setting alt-text for avatar + header (#3086)
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/swagger.yaml30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml
index 367dae72f..4ce234374 100644
--- a/docs/api/swagger.yaml
+++ b/docs/api/swagger.yaml
@@ -193,6 +193,11 @@ definitions:
example: https://example.org/media/some_user/avatar/original/avatar.jpeg
type: string
x-go-name: Avatar
+ avatar_description:
+ description: Description of this account's avatar, for alt text.
+ example: A cute drawing of a smiling sloth.
+ type: string
+ x-go-name: AvatarDescription
avatar_static:
description: |-
Web location of a static version of the account's avatar.
@@ -259,6 +264,11 @@ definitions:
example: https://example.org/media/some_user/header/original/header.jpeg
type: string
x-go-name: Header
+ header_description:
+ description: Description of this account's header, for alt text.
+ example: A sunlit field with purple flowers.
+ type: string
+ x-go-name: HeaderDescription
header_static:
description: |-
Web location of a static version of the account's header.
@@ -1948,6 +1958,11 @@ definitions:
example: https://example.org/media/some_user/avatar/original/avatar.jpeg
type: string
x-go-name: Avatar
+ avatar_description:
+ description: Description of this account's avatar, for alt text.
+ example: A cute drawing of a smiling sloth.
+ type: string
+ x-go-name: AvatarDescription
avatar_static:
description: |-
Web location of a static version of the account's avatar.
@@ -2014,6 +2029,11 @@ definitions:
example: https://example.org/media/some_user/header/original/header.jpeg
type: string
x-go-name: Header
+ header_description:
+ description: Description of this account's header, for alt text.
+ example: A sunlit field with purple flowers.
+ type: string
+ x-go-name: HeaderDescription
header_static:
description: |-
Web location of a static version of the account's header.
@@ -4072,10 +4092,20 @@ paths:
in: formData
name: avatar
type: file
+ - allowEmptyValue: true
+ description: Description of avatar image, for alt-text.
+ in: formData
+ name: avatar_description
+ type: string
- description: Header of the user.
in: formData
name: header
type: file
+ - allowEmptyValue: true
+ description: Description of header image, for alt-text.
+ in: formData
+ name: header_description
+ type: string
- description: Require manual approval of follow requests.
in: formData
name: locked