wholetrans/docs-mastodon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update content for 4.0, part 2 (#1060)

Browse source 
* fix relrefs around trends and related entities

* revert moving caption-links to middle of page

* hide empty menu in table of contents

* clarify edit notifs are only for boosted statuses

* following/followers no longer need auth

* fix typo

* specify cooldown period for account Move

* use the correct cooldown

* add missing parameters to accounts/id/statuses

* link to account_statuses_filter.rb

* fix typo (#1072)

* fix typo (#1073)

* fix link to http sig spec (#1067)

* simply HTTP request examples in api methods docs

* add missing client_secret to oauth/token (#1062)

* Add any, all, none to hashtag timeline

* minor formatting changes

* Update signature requirements and advice

* fix public key -> private key

* clarify use of RSA with SHA256

* Add note about saving your profile after adding rel-me link

* v2 filters api

* comment out params that shouldn't be used in v2 filter api

* admin trends

* remove old todo

* canonical email blocks + scheduled statuses

* remove under-construction warnings from finished pages

* verify api method params with source code

* fix typo (#1088)

* fix broken caption-links (#1100)

* fix formatting of entities (#1094)

* Remove keybase section from user guide (#1093)

* fix typos (#1092)

* Verify limits are accurate (#1086)

* add mention of iframe limitation (#1084)

* Add CORS header to WEB_DOMAIN example (#1083)

* Fix typo (#1081)

* pin http sigs spec at draft 8

* Revert "pin http sigs spec at draft 8"

This reverts commit 9fd5f7032b69b29e77599dd62adfe8d2f5cd4f20.

* add case sensitivity warning to 4.0 roles

* Add url length note to bio (#1087)

* remove follow scope from examples (#1103)

* clarify usage of update_credentials to update profile fields

* add noindex to Account entitity

* remove required hint from technically not required property
This commit is contained in:
trwnh 2022-12-14 15:55:30 -06:00 • committed by GitHub
parent 1dad33b87b
commit ffbe66a389
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
90 changed files with 2217 additions and 637 deletions
Download patch file Download diff file Expand all files Collapse all files

92
content/en/methods/statuses.md
View file

@ -17,13 +17,13 @@ aliases: [
#TableOfContents ul ul ul {display: none}
</style>
## Publish new status {#create}
## Post a new status {#create}
```http
POST https://mastodon.example/api/v1/statuses HTTP/1.1
POST /api/v1/statuses HTTP/1.1
```
Post a new status.
Publish a status with the given parameters.
**Returns:** [Status]({{<relref "entities/status">}}). When `scheduled_at` is present, [ScheduledStatus]({{<relref "entities/scheduledstatus">}}) is returned instead.\
**OAuth:** User + `write:statuses`\
@ -78,7 +78,7 @@ language
: String. ISO 639 language code for this status.
scheduled_at
: String. ISO 8601 Datetime at which to schedule a status. Providing this paramter will cause ScheduledStatus to be returned instead of Status. Must be at least 5 minutes in the future.
: String. ISO 8601 Datetime at which to schedule a status. Providing this parameter will cause ScheduledStatus to be returned instead of Status. Must be at least 5 minutes in the future.
#### Response
##### 200: OK
@ -145,7 +145,7 @@ Invalid or missing Authorization header.
## View a single status {#get}
```http
GET https://mastodon.example/api/v1/statuses/:id HTTP/1.1
GET /api/v1/statuses/:id HTTP/1.1
```
Obtain information about a status.
@ -259,7 +259,7 @@ Status does not exist or is private.
## Delete a status {#delete}
```http
DELETE https://mastodon.example/api/v1/statuses/:id HTTP/1.1
DELETE /api/v1/statuses/:id HTTP/1.1
```
Delete one of your own statuses.
@ -449,7 +449,7 @@ Status is not owned by you or does not exist
## Get parent and child statuses in context {#context}
```http
GET https://mastodon.example/api/v1/statuses/:id/context HTTP/1.1
GET /api/v1/statuses/:id/context HTTP/1.1
```
View statuses above and below this status in the thread.
@ -526,7 +526,7 @@ Status is private or does not exist
## See who boosted a status {#reblogged_by}
```http
GET https://mastodon.example/api/v1/statuses/:id/reblogged_by HTTP/1.1
GET /api/v1/statuses/:id/reblogged_by HTTP/1.1
```
View who boosted a given status.
@ -548,6 +548,20 @@ View who boosted a given status.
Authorization
: Provide this header with `Bearer <user token>` to gain authorized access to this API method.
##### Query parameters
max_id
: **Internal parameter.** Use HTTP `Link` header for pagination.
since_id
: **Internal parameter.** Use HTTP `Link` header for pagination.
min_id
: **Internal parameter.** Use HTTP `Link` header for pagination.
limit
: Integer. Maximum number of results to return. Defaults to 40 accounts. Max 80 accounts.
#### Response
##### 200: OK
@ -565,6 +579,12 @@ A list of statuses that boosted the status
]
```
Because reblogged Status IDs are generally not known ahead of time, you will have to parse the HTTP `Link` header to load older or newer results. See [Paginating through API responses]({{<relref "api/guidelines#pagination">}}) for more information.
```http
Link: <https://mastodon.example/api/v1/statuses/109404970108594430/reblogged_by?limit=2&max_id=109406336446186031>; rel="next", <https://mastodon.example/api/v1/statuses/109404970108594430/reblogged_by?limit=2&since_id=109408462939099398>; rel="prev"
```
##### 404: Not found
Status does not exist or is private
@ -580,7 +600,7 @@ Status does not exist or is private
## See who favourited a status {#favourited_by}
```http
GET https://mastodon.example/api/v1/statuses/:id/favourited_by HTTP/1.1
GET /api/v1/statuses/:id/favourited_by HTTP/1.1
```
View who favourited a given status.
@ -602,6 +622,20 @@ View who favourited a given status.
Authorization
: Provide this header with `Bearer <user token>` to gain authorized access to this API method.
##### Query parameters
max_id
: **Internal parameter.** Use HTTP `Link` header for pagination.
since_id
: **Internal parameter.** Use HTTP `Link` header for pagination.
min_id
: **Internal parameter.** Use HTTP `Link` header for pagination.
limit
: Integer. Maximum number of results to return. Defaults to 40 accounts. Max 80 accounts.
#### Response
##### 200: OK
@ -619,6 +653,12 @@ A list of accounts who favourited the status
]
```
Because Favourite IDs are generally not exposed via any API responses, you will have to parse the HTTP `Link` header to load older or newer results. See [Paginating through API responses]({{<relref "api/guidelines#pagination">}}) for more information.
```http
Link: <https://mastodon.example/api/v1/statuses/109419880690343548/favourited_by?limit=1&max_id=53286827>; rel="next", <https://mastodon.example/api/v1/statuses/109419880690343548/favourited_by?limit=1&since_id=53286827>; rel="prev"
```
##### 404: Not found
Status does not exist or is private
@ -634,7 +674,7 @@ Status does not exist or is private
## Favourite a status {#favourite}
```http
POST https://mastodon.example/api/v1/statuses/:id/favourite HTTP/1.1
POST /api/v1/statuses/:id/favourite HTTP/1.1
```
Add a status to your favourites list.
@ -700,7 +740,7 @@ Status does not exist or is private
## Undo favourite of a status {#unfavourite}
```http
POST https://mastodon.example/api/v1/statuses/:id/unfavourite HTTP/1.1
POST /api/v1/statuses/:id/unfavourite HTTP/1.1
```
Remove a status from your favourites list.
@ -766,7 +806,7 @@ Status does not exist or is private
## Boost a status {#boost}
```http
POST https://mastodon.example/api/v1/statuses/:id/reblog HTTP/1.1
POST /api/v1/statuses/:id/reblog HTTP/1.1
```
Reshare a status on your own profile.
@ -849,7 +889,7 @@ Status does not exist or is private
## Undo boost of a status {#unreblog}
```http
POST https://mastodon.example/api/v1/statuses/:id/unreblog HTTP/1.1
POST /api/v1/statuses/:id/unreblog HTTP/1.1
```
Undo a reshare of a status.
@ -915,7 +955,7 @@ Status does not exist or is private
## Bookmark a status {#bookmark}
```http
POST https://mastodon.example/api/v1/statuses/:id/bookmark HTTP/1.1
POST /api/v1/statuses/:id/bookmark HTTP/1.1
```
Privately bookmark a status.
@ -971,7 +1011,7 @@ Invalid or missing Authorization header.
## Undo bookmark of a status {#unbookmark}
```http
POST https://mastodon.example/api/v1/statuses/:id/unbookmark HTTP/1.1
POST /api/v1/statuses/:id/unbookmark HTTP/1.1
```
Remove a status from your private bookmarks.
@ -1037,7 +1077,7 @@ Status does not exist or is private.
## Mute a conversation {#mute}
```http
POST https://mastodon.example/api/v1/statuses/:id/mute HTTP/1.1
POST /api/v1/statuses/:id/mute HTTP/1.1
```
Do not receive notifications for the thread that this status is part of. Must be a thread in which you are a participant.
@ -1103,7 +1143,7 @@ Status does not exist or is private.
## Unmute a conversation {#unmute}
```http
POST https://mastodon.example/api/v1/statuses/:id/unmute HTTP/1.1
POST /api/v1/statuses/:id/unmute HTTP/1.1
```
Start receiving notifications again for the thread that this status is part of.
@ -1169,7 +1209,7 @@ Status does not exist or is private.
## Pin status to profile {#pin}
```http
POST https://mastodon.example/api/v1/statuses/:id/pin HTTP/1.1
POST /api/v1/statuses/:id/pin HTTP/1.1
```
Feature one of your own public statuses at the top of your profile.
@ -1263,7 +1303,7 @@ Prior to 3.5.0, you could not pin one of your private statuses because private s
## Unpin status from profile {#unpin}
```http
POST https://mastodon.example/api/v1/statuses/:id/unpin HTTP/1.1
POST /api/v1/statuses/:id/unpin HTTP/1.1
```
Unfeature a status from the top of your profile.
@ -1338,7 +1378,7 @@ Status does not exist or is private.
## Edit a status {#edit}
```http
PUT https://mastodon.example/api/v1/statuses/:id HTTP/1.1
PUT /api/v1/statuses/:id HTTP/1.1
```
Edit a given status to change its text, sensitivity, media attachments, or poll. Note that editing a poll's options will reset the votes.
@ -1346,7 +1386,8 @@ Edit a given status to change its text, sensitivity, media attachments, or poll.
**Returns:** [Status]({{< relref "entities/status" >}})\
**OAuth:** User token + `write:statuses`\
**Version history:**\
3.5.0 - added
3.5.0 - added\
4.0.0 - add `language`
#### Request
@ -1371,6 +1412,9 @@ spoiler_text
sensitive
: Boolean. Whether the status should be marked as sensitive.
language
: String. ISO 639 language code for the status.
media_ids[]
: Array of String. Include Attachment IDs to be attached as media. If provided, `status` becomes optional, and `poll` cannot be used.
@ -1468,7 +1512,7 @@ Status does not exist, is private, or is not owned by you.
## View edit history of a status {#history}
```http
GET https://mastodon.example/api/v1/statuses/:id/history HTTP/1.1
GET /api/v1/statuses/:id/history HTTP/1.1
```
Get all known versions of a status, including the initial and current states.
@ -1614,7 +1658,7 @@ Status does not exist or is private.
## View status source {#source}
```http
GET https://mastodon.example/api/v1/statuses/:id/source HTTP/1.1
GET /api/v1/statuses/:id/source HTTP/1.1
```
Obtain the source properties for a status so that it can be edited.
@ -1672,7 +1716,7 @@ Status does not exist or is private.
## (DEPRECATED) Fetch preview card {#card}
```http
GET https://mastodon.example/api/v1/statuses/:id/card HTTP/1.1
GET /api/v1/statuses/:id/card HTTP/1.1
```
**Returns:** [PreviewCard]({{< relref "entities/PreviewCard" >}})\