Update content for 4.0, part 2 (#1060)

* 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

View file

@ -20,7 +20,7 @@ aliases: [
## Get all notifications {#get}
```http
GET https://mastodon.example/api/v1/notifications HTTP/1.1
GET /api/v1/notifications HTTP/1.1
```
Notifications concerning the user. This API returns Link headers containing links to the next/previous page. However, the links can also be constructed dynamically using query params and `id` values.
@ -33,7 +33,7 @@ Types to filter include:
- `follow_request` = Someone requested to follow you
- `favourite` = Someone favourited one of your statuses
- `poll` = A poll you have voted in or created has ended
- `update` = A status you interacted with has been edited
- `update` = A status you boosted with has been edited
- `admin.sign_up` = Someone signed up (optionally sent to admins)
- `admin.report` = A new report has been filed
@ -67,7 +67,7 @@ min_id
: String. Return results immediately newer than this ID
limit
: Integer. Maximum number of results to return. Default: 20.
: Integer. Maximum number of results to return. Defaults to 15 notifications. Max 30 notifications.
types[]
: Array of String. Types to include in the result.
@ -92,7 +92,7 @@ Authorization: Bearer xxx
The response body contains one page of notifications. You can use the HTTP Link header for further pagination.
```http
Link: <https://mastodon.social/api/v1/notifications?max_id=34975535>; rel="next", <https://mastodon.social/api/v1/notifications?min_id=34975861>;
Link: <https://mastodon.example/api/v1/notifications?max_id=34975535>; rel="next", <https://mastodon.example/api/v1/notifications?min_id=34975861>;
```
```json
@ -175,7 +175,7 @@ Invalid or missing Authorization header.
## Get a single notification {#get-one}
```http
GET https://mastodon.example/api/v1/notification/:id HTTP/1.1
GET /api/v1/notification/:id HTTP/1.1
```
View information about a notification with a given ID.
@ -257,7 +257,7 @@ Invalid or missing Authorization header.
## Dismiss all notifications {#clear}
```http
POST https://mastodon.example/api/v1/notifications/clear HTTP/1.1
POST /api/v1/notifications/clear HTTP/1.1
```
Clear all notifications from the server.
@ -298,7 +298,7 @@ Invalid or missing Authorization header.
## Dismiss a single notification {#dismiss}
```http
POST https://mastodon.example/api/v1/notifications/:id/dismiss HTTP/1.1
POST /api/v1/notifications/:id/dismiss HTTP/1.1
```
Dismiss a single notification from the server.
@ -345,7 +345,7 @@ Invalid or missing Authorization header.
## (REMOVED) Dismiss a single notification {#dismiss-deprecated}
```http
POST https://mastodon.example/api/v1/notifications/dismiss HTTP/1.1
POST /api/v1/notifications/dismiss HTTP/1.1
```
Dismiss a single notification from the server.