Fix docs of the Translation entity

The poll attribute is an object, not an array.
This commit is contained in:
Konrad Pozniak 2024-03-29 10:59:46 +01:00 committed by GitHub
parent c20d658062
commit 90b05efa07
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 31 additions and 17 deletions

View File

@ -20,7 +20,7 @@ Translation of status with content warning and media
"spoiler_text": "Greatings ahead", "spoiler_text": "Greatings ahead",
"media_attachments": [ "media_attachments": [
{ {
"id": 22345792, "id": "22345792",
"description": "Status author waving at the camera" "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>", "content": "<p>Should I stay or should I go?</p>",
"spoiler_text": "", "spoiler_text": "",
"media_attachments": [], "media_attachments": [],
"poll": [ "poll": {
{ "id": "34858",
"id": 34858, "options": [
"options": [ {
{ "title": "Stay"
"title": "Stay" },
}, {
{ "title": "Go"
"title": "Go" }
} ]
] },
}
],
"detected_source_language": "ja", "detected_source_language": "ja",
"provider": "DeepL.com" "provider": "DeepL.com"
} }
@ -73,8 +71,8 @@ Translation of status with poll:
### `poll` {#poll} ### `poll` {#poll}
**Description:** The translated poll options of the status.\ **Description:** The translated poll of the status.\
**Type:** Array\ **Type:** [Translation::Poll](#Poll)\
**Version history:**\ **Version history:**\
4.2.0 - added 4.2.0 - added
@ -99,8 +97,24 @@ Translation of status with poll:
**Version history:**\ **Version history:**\
4.0.0 - added 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\
**Version history:**\
4.2.0 - added
## See also ## See also
{{< page-relref ref="methods/statuses#translate" caption="POST /api/v1/statuses/:id/translate" >}} {{< 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" >}} {{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/translation_serializer.rb" caption="app/serializers/rest/translation_serializer.rb" >}}