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

Improve API documentation

Browse source
This commit is contained in:
Eugen Rochko 2018-10-06 01:28:20 +02:00
parent b2023264a2
commit 320d51a4d9
5 changed files with 32 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

9
content/en/api/rest/accounts.md
View file

@ -18,7 +18,7 @@ Returns [Account]({{< relref "entities.md#account" >}})
User's own account.
Returns [Account]({{< relref "entities.md#account" >}}) with an extra `source` attribute.
Returns [Account]({{< relref "entities.md#account" >}}) with an extra [`source` attribute]({{< relref "entities.md#source" >}}).
### Resource information
@ -43,8 +43,10 @@ Returns [Account]({{< relref "entities.md#account" >}})
| `avatar` | Avatar encoded using `multipart/form-data` | Optional |
| `header` | Header image encoded using `multipart/form-data` | Optional |
| `locked` | Enable follow requests | Optional |
| `source` | Extra preferences | Optional |
| `fields_attributes` | Profile metadata | Optional |
| `source[privacy]` | Default post privacy preference | Optional |
| `source[sensitive]`| Whether to mark statuses as sensitive by default | Optional |
| `source[language]` | Override language on statuses by default (ISO6391) | Optional |
| `fields_attributes` | Profile metadata (max. 4) | Optional |
## GET /api/v1/accounts/:id/followers
@ -105,6 +107,7 @@ Returns array of [Status]({{< relref "entities.md#status" >}})
| `exclude_replies` | Skip statuses that reply to other statuses | Optional |false|
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
| `min_id` | Return results immediately newer than ID | Optional ||
| `limit` | Maximum number of results | Optional | 20 |
### Pagination