From ddfe7b483316a3d5760805d2c0409384e8a65a83 Mon Sep 17 00:00:00 2001
From: Konrad Pozniak <connyduck@users.noreply.github.com>
Date: Tue, 2 Apr 2024 13:12:15 +0200
Subject: [PATCH] Fix docs of the Translation entity (#1423)

* Fix docs of the Translation entity

The poll attribute is an object, not an array.

* Update Translation.md

* add more information about the atachment and poll option types
---
 content/en/entities/Translation.md | 79 ++++++++++++++++++++++--------
 1 file changed, 59 insertions(+), 20 deletions(-)

diff --git a/content/en/entities/Translation.md b/content/en/entities/Translation.md
index 0b664c1c..1b88f814 100644
--- a/content/en/entities/Translation.md
+++ b/content/en/entities/Translation.md
@@ -20,7 +20,7 @@ Translation of status with content warning and media
   "spoiler_text": "Greatings ahead",
   "media_attachments": [
     {
-      "id": 22345792,
+      "id": "22345792",
       "description": "Status author waving at the camera"
     }
   ],
@@ -36,19 +36,17 @@ Translation of status with poll:
   "content": "<p>Should I stay or should I go?</p>",
   "spoiler_text": "",
   "media_attachments": [],
-  "poll": [
-    {
-      "id": 34858,
-      "options": [
-        {
-          "title": "Stay" 
-        },
-        {
-          "title": "Go"
-        }
-      ]
-    }
-  ],
+  "poll": {
+    "id": "34858",
+    "options": [
+      {
+        "title": "Stay" 
+      },
+      {
+        "title": "Go"
+      }
+    ]
+  },
   "detected_source_language": "ja",
   "provider": "DeepL.com"
 }
@@ -64,24 +62,24 @@ Translation of status with poll:
 **Version history:**\
 4.0.0 - added
 
-### `spoiler_warning` {#spoiler_warning}
+### `spoiler_text` {#spoiler_text}
 
 **Description:** The translated spoiler warning of the status.\
 **Type:** String\
 **Version history:**\
 4.2.0 - added
 
-### `poll` {#poll}
+### `poll` {{%optional%}} {#poll}
 
-**Description:** The translated poll options of the status.\
-**Type:** Array\
+**Description:** The translated poll of the status.\
+**Type:** [Translation::Poll](#Poll)\
 **Version history:**\
 4.2.0 - added
 
 ### `media_attachments` {#media_attachments}
 
 **Description:** The translated media descriptions of the status.\
-**Type:** Array\
+**Type:** Array of [Translation::Attachment](#Attachment)\
 **Version history:**\
 4.2.0 - added
 
@@ -99,8 +97,49 @@ Translation of status with poll:
 **Version history:**\
 4.0.0 - added
 
+## Translation::Poll attributes {#Poll}
+
+### `id` {#Poll-id}
+
+**Description:** The ID of the poll.\
+**Type:** String (cast from an integer, but not guaranteed to be a number)\
+**Version history:**\
+4.2.0 - added
+
+### `options` {#Poll-options}
+
+**Description:** The translated poll options.\
+**Type:** Array of [Translation::Poll::Option](#Option)\
+**Version history:**\
+4.2.0 - added
+
+## Translation::Poll::Option attributes {#Option}
+
+### `title` {#Option-title}
+
+**Description:** The translated title of the poll option.\
+**Type:** String\
+**Version history:**\
+4.2.0 - added
+
+## Translation::Attachment attributes {#Attachment}
+
+### `id` {#Attachment-id}
+
+**Description:** The id of the attachment.\
+**Type:** String (cast from an integer, but not guaranteed to be a number)\
+**Version history:**\
+4.2.0 - added
+
+### `description` {#Attachment-description}
+
+**Description:** The translated description of the attachment.\
+**Type:** String\
+**Version history:**\
+4.2.0 - added
+
 ## See also
 
 {{< page-relref ref="methods/statuses#translate" caption="POST /api/v1/statuses/:id/translate" >}}
 
-{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/translation_serializer.rb" caption="app/serializers/rest/translation_serializer.rb" >}}
\ No newline at end of file
+{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/translation_serializer.rb" caption="app/serializers/rest/translation_serializer.rb" >}}