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
This commit is contained in:
Konrad Pozniak 2024-04-02 13:12:15 +02:00 committed by GitHub
parent a610154747
commit ddfe7b4833
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 59 additions and 20 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,9 +36,8 @@ 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"
@ -47,8 +46,7 @@ Translation of status with poll:
"title": "Go" "title": "Go"
} }
] ]
} },
],
"detected_source_language": "ja", "detected_source_language": "ja",
"provider": "DeepL.com" "provider": "DeepL.com"
} }
@ -64,24 +62,24 @@ Translation of status with poll:
**Version history:**\ **Version history:**\
4.0.0 - added 4.0.0 - added
### `spoiler_warning` {#spoiler_warning} ### `spoiler_text` {#spoiler_text}
**Description:** The translated spoiler warning of the status.\ **Description:** The translated spoiler warning of the status.\
**Type:** String\ **Type:** String\
**Version history:**\ **Version history:**\
4.2.0 - added 4.2.0 - added
### `poll` {#poll} ### `poll` {{%optional%}} {#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
### `media_attachments` {#media_attachments} ### `media_attachments` {#media_attachments}
**Description:** The translated media descriptions of the status.\ **Description:** The translated media descriptions of the status.\
**Type:** Array\ **Type:** Array of [Translation::Attachment](#Attachment)\
**Version history:**\ **Version history:**\
4.2.0 - added 4.2.0 - added
@ -99,6 +97,47 @@ 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 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 ## 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" >}}