From d70f4e166dd9ce2f11a6ac2d7a2e500515657041 Mon Sep 17 00:00:00 2001
From: tobi <31960611+tsmethurst@users.noreply.github.com>
Date: Mon, 8 Jul 2024 15:47:03 +0200
Subject: [feature/frontend] Allow setting alt-text for avatar + header (#3086)

---
 docs/api/swagger.yaml | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

(limited to 'docs/api')

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
-- 
cgit v1.2.3