From c6037300249069192501ffbd336ca8be56347e52 Mon Sep 17 00:00:00 2001 From: Eugen Date: Sun, 20 Nov 2016 00:47:16 +0100 Subject: [PATCH] Updated API (markdown) --- API.md | 52 ++++++++++++++++++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 20 deletions(-) diff --git a/API.md b/API.md index 89794ad..7bf01b1 100644 --- a/API.md +++ b/API.md @@ -169,26 +169,38 @@ ___ ## Status -* `id` -* `uri` - fediverse-unique resource ID -* `url` - URL to the status page (can be remote) -* `account` - Account -* `in_reply_to_id` - null or ID of status it replies to -* `reblog` - null or Status -* `content` - Body of the status. This will contain HTML (remote HTML already sanitized) -* `created_at` -* `reblogs_count` -* `favourites_count` -* `reblogged` - Boolean for authenticated user -* `favourited` - Boolean for authenticated user -* `media_attachments` - array of: - * `url` - URL of the original image (can be remote) - * `preview_url` - URL of the preview image - * `type` - Image or video -* `mentions` - array of: - * `url` - URL of user's profile (can be remote) - * `acct` - Username for local or username@domain for remote users - * `id` - Account ID +| Attribute | Description | +|---------------------|-------------| +| `id` || +| `uri` | fediverse-unique resource ID | +| `url` | URL to the status page (can be remote) | +| `account` | Account | +| `in_reply_to_id` | null or ID of status it replies to | +| `reblog` | null or Status| +| `content` | Body of the status. This will contain HTML (remote HTML already sanitized) | +| `created_at` || +| `reblogs_count` || +| `favourites_count` || +| `reblogged` | Boolean for authenticated user | +| `favourited` | Boolean for authenticated user | +| `media_attachments` | array of MediaAttachments | +| `mentions` | array of Mentions | + +Media Attachment: + +| Attribute | Description | +|---------------------|-------------| +| `url` | URL of the original image (can be remote) | +| `preview_url` | URL of the preview image | +| `type` | Image or video | + +Mention: + +| Attribute | Description | +|---------------------|-------------| +| `url` | URL of user's profile (can be remote) | +| `acct` | Username for local or username@domain for remote users | +| `id` | Account ID | ## Account