mirrors/catstodon
1
0
Fork 0
mirror of https://git.kescher.at/CatCatNya/catstodon.git synced 2024-11-23 05:18:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update some API docs

Browse source
This commit is contained in:
Eugen 2017-01-29 14:40:57 +01:00 committed by GitHub
parent a30e669df2
commit 2165a0ec63
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/Using-the-API/API.md
View file

@ -50,6 +50,7 @@ Form data:
- `media_ids` (optional): array of media IDs to attach to the status (maximum 4) - `media_ids` (optional): array of media IDs to attach to the status (maximum 4)
- `sensitive` (optional): set this to mark the media of the status as NSFW - `sensitive` (optional): set this to mark the media of the status as NSFW
- `visibility` (optional): either `private`, `unlisted` or `public` - `visibility` (optional): either `private`, `unlisted` or `public`
- `spoiler_text` (optional): text to be shown as a warning before the actual content
Returns the new status. Returns the new status.
@ -258,6 +259,9 @@ ___
| `favourites_count` || | `favourites_count` ||
| `reblogged` | Boolean for authenticated user | | `reblogged` | Boolean for authenticated user |
| `favourited` | Boolean for authenticated user | | `favourited` | Boolean for authenticated user |
| `sensitive` | Boolean, true if media attachments should be hidden by default |
| `spoiler_text` | If not empty, warning text that should be displayed before the actual content |
| `visibility` | Either `public`, `unlisted` or `private` |
| `media_attachments` | array of MediaAttachments | | `media_attachments` | array of MediaAttachments |
| `mentions` | array of Mentions | | `mentions` | array of Mentions |
| `application` | Application from which the status was posted | | `application` | Application from which the status was posted |
@ -297,6 +301,7 @@ Application:
| `url` | URL of the user's profile page (can be remote) | | `url` | URL of the user's profile page (can be remote) |
| `avatar` | URL to the avatar image | | `avatar` | URL to the avatar image |
| `header` | URL to the header image | | `header` | URL to the header image |
| `locked` | Boolean for when the account cannot be followed without waiting for approval first |
| `followers_count` || | `followers_count` ||
| `following_count` || | `following_count` ||
| `statuses_count` || | `statuses_count` ||