zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Clean up the tables

This commit is contained in:
Eugen Rochko 2018-10-06 00:42:15 +02:00
parent f5bec620d2
commit 7be0f6d651
9 changed files with 77 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
content/en/api/rest/apps.md
View File

@ -18,9 +18,11 @@ Returns [App]({{< relref "entities.md#app" >}}) with `client_id` and `client_sec
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `client_name` | Name of your application | Required ||
| `redirect_uris` | Where the user should be redirected after authorization (for no redirect, use `urn:ietf:wg:oauth:2.0:oob`) | Required ||
| `scopes` | Space separated list of [scopes]({{< relref "permissions.md" >}}) | Required ||
| `website` | URL to the homepage of your app | Optional ||
|Name|Description|Required|
|----|-----------|:------:|
| `client_name` | Name of your application | Required |
| `redirect_uris` | Where the user should be redirected after authorization | Required |
| `scopes` | Space separated list of [scopes]({{< relref "permissions.md" >}}) | Required |
| `website` | URL to the homepage of your app | Optional |
> To display the authorization code to the end-user instead of redirecting to a web page, use `urn:ietf:wg:oauth:2.0:oob` in `redirect_uris`

12
content/en/api/rest/domain-blocks.md
View File

@ -36,9 +36,9 @@ Block a domain to hide all public posts from it, all notifications from it, and
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `domain` | Domain to block| Required ||
|Name|Description|Required|
|----|-----------|:------:|
| `domain` | Domain to block| Required |
## DELETE /api/v1/domain_blocks
@ -50,6 +50,6 @@ Remove a domain block.
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `domain` | Domain to block| Required ||
|Name|Description|Required|
|----|-----------|:------:|
| `domain` | Domain to unblock| Required |

28
content/en/api/rest/filters.md
View File

@ -28,13 +28,13 @@ Returns [Filter]({{< relref "entities.md#filter" >}})
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `phrase` | Keyword or phrase to filter | Required ||
| `context` | Array of strings that means filtering context. Each string is one of `home`, `notifications`, `public`, `thread`. At least one context must be specified. | Required ||
| `irreversible` | Irreversible filtering will only work in `home` and `notifications` contexts by fully dropping the records. Otherwise, filtering is up to the client. | Optional ||
| `whole_word` | Whether to consider word boundaries when matching | Optional ||
| `expires_in` | Number that indicates seconds. Filter will be expire in seconds after API processed. Null or blank string means "don't change" | Optional | Unlimited |
|Name|Description|Required|
|----|-----------|:------:|
| `phrase` | Keyword or phrase to filter | Required |
| `context` | Array of strings that means filtering context. Each string is one of `home`, `notifications`, `public`, `thread`. At least one context must be specified. | Required |
| `irreversible` | Irreversible filtering will only work in `home` and `notifications` contexts by fully dropping the records. Otherwise, filtering is up to the client. | Optional |
| `whole_word` | Whether to consider word boundaries when matching | Optional |
| `expires_in` | Number that indicates seconds. Filter will be expire in seconds after API processed. Null or blank string means "don't change" | Optional |
## GET /api/v1/filters/:id
@ -58,13 +58,13 @@ Returns [Filter]({{< relref "entities.md#filter" >}})
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `phrase` | Keyword or phrase to filter | Required ||
| `context` | Array of strings that means filtering context. Each string is one of `home`, `notifications`, `public`, `thread`. At least one context must be specified. | Required ||
| `irreversible` | Irreversible filtering will only work in `home` and `notifications` contexts by fully dropping the records. Otherwise, filtering is up to the client. | Optional ||
| `whole_word` | Whether to consider word boundaries when matching | Optional ||
| `expires_in` | Number that indicates seconds. Filter will be expire in seconds after API processed. Null or blank string means "don't change" | Optional | Unlimited |
|Name|Description|Required|
|----|-----------|:------:|
| `phrase` | Keyword or phrase to filter | Required |
| `context` | Array of strings that means filtering context. Each string is one of `home`, `notifications`, `public`, `thread`. At least one context must be specified. | Required |
| `irreversible` | Irreversible filtering will only work in `home` and `notifications` contexts by fully dropping the records. Otherwise, filtering is up to the client. | Optional |
| `whole_word` | Whether to consider word boundaries when matching | Optional |
| `expires_in` | Number that indicates seconds. Filter will be expire in seconds after API processed. Null or blank string means "don't change" | Optional |
## DELETE /api/v1/filters/:id

24
content/en/api/rest/lists.md
View File

@ -68,9 +68,9 @@ Returns [List]({{< relref "entities.md#list" >}})
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `title` | The title of the list | Required ||
|Name|Description|Required|
|----|-----------|:------:|
| `title` | The title of the list | Required |
## PUT /api/v1/lists/:id
@ -84,9 +84,9 @@ Returns [List]({{< relref "entities.md#list" >}})
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `title` | The title of the list | Required ||
|Name|Description|Required|
|----|-----------|:------:|
| `title` | The title of the list | Required |
## DELETE /api/v1/lists/:id
@ -108,9 +108,9 @@ Add accounts to a list.
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `account_ids` | Array of account IDs | Required ||
|Name|Description|Required|
|----|-----------|:------:|
| `account_ids` | Array of account IDs | Required |
## DELETE /api/v1/lists/:id/accounts
@ -122,6 +122,6 @@ Remove accounts from a list.
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `account_ids` | Array of account IDs | Required ||
|Name|Description|Required|
|----|-----------|:------:|
| `account_ids` | Array of account IDs | Required |

18
content/en/api/rest/media.md
View File

@ -18,11 +18,11 @@ Returns [Attachment]({{< relref "entities.md#attachment" >}})
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `file` | Media to be uploaded (encoded using `multipart/form-data`) | Required ||
| `description` | A plain-text description of the media for accessibility (max 420 chars) | Optional ||
| `focus` | Two floating points, comma-delimited. See [focal points](#focal-points) | Optional ||
|Name|Description|Required|
|----|-----------|:------:|
| `file` | Media file encoded using `multipart/form-data` | Required |
| `description` | A plain-text description of the media for accessibility (max 420 chars) | Optional |
| `focus` | Two floating points, comma-delimited. See [focal points](#focal-points) | Optional |
## PUT /api/v1/media/:id
@ -36,10 +36,10 @@ Returns [Attachment]({{< relref "entities.md#attachment" >}})
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `description` | A plain-text description of the media for accessibility (max 420 chars) | Optional ||
| `focus` | Two floating points, comma-delimited. See [focal points](#focal-points) | Optional ||
|Name|Description|Required|
|----|-----------|:------:|
| `description` | A plain-text description of the media for accessibility (max 420 chars) | Optional |
| `focus` | Two floating points, comma-delimited. See [focal points](#focal-points) | Optional |
## Focal points

36
content/en/api/rest/notifications.md
View File

@ -55,9 +55,9 @@ Delete a single notification from the server.
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `id` | Notification ID | Required ||
|Name|Description|Required|
|----|-----------|:------:|
| `id` | Notification ID | Required |
## POST /api/v1/push/subscription
@ -73,15 +73,15 @@ Returns [Push Subscription]({{< relref "entities.md#push-subscription" >}})
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `subscription[endpoint]` | Endpoint URL that called when notification is happen. | Required ||
| `subscription[keys][p256dh]` | User agent public key. Base64 encoded string of public key of ECDH key using 'prime256v1' curve. | Required ||
| `subscription[keys][auth]` | Auth secret. Base64 encoded string of 16 bytes of random data. | Required ||
| `data[alerts][follow]` | Boolean of whether you want to receive follow notification event. | Optional ||
| `data[alerts][favourite]` | Boolean of whether you want to receive favourite notification event. | Optional ||
| `data[alerts][reblog]` | Boolean of whether you want to receive reblog notification event. | Optional ||
| `data[alerts][mention]` | Boolean of whether you want to receive mention notification event. | Optional ||
|Name|Description|Required|
|----|-----------|:------:|
| `subscription[endpoint]` | Endpoint URL that called when notification is happen. | Required |
| `subscription[keys][p256dh]` | User agent public key. Base64 encoded string of public key of ECDH key using 'prime256v1' curve. | Required |
| `subscription[keys][auth]` | Auth secret. Base64 encoded string of 16 bytes of random data. | Required |
| `data[alerts][follow]` | Boolean of whether you want to receive follow notification event. | Optional |
| `data[alerts][favourite]` | Boolean of whether you want to receive favourite notification event. | Optional |
| `data[alerts][reblog]` | Boolean of whether you want to receive reblog notification event. | Optional |
| `data[alerts][mention]` | Boolean of whether you want to receive mention notification event. | Optional |
## GET /api/v1/push/subscription
@ -103,12 +103,12 @@ Returns [Push Subscription]({{< relref "entities.md#push-subscription" >}})
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `data[alerts][follow]` | Boolean of whether you want to receive follow notification event. | Optional ||
| `data[alerts][favourite]` | Boolean of whether you want to receive favourite notification event. | Optional ||
| `data[alerts][reblog]` | Boolean of whether you want to receive reblog notification event. | Optional ||
| `data[alerts][mention]` | Boolean of whether you want to receive mention notification event. | Optional ||
|Name|Description|Required|
|----|-----------|:------:|
| `data[alerts][follow]` | Boolean of whether you want to receive follow notification event. | Optional |
| `data[alerts][favourite]` | Boolean of whether you want to receive favourite notification event. | Optional |
| `data[alerts][reblog]` | Boolean of whether you want to receive reblog notification event. | Optional |
| `data[alerts][mention]` | Boolean of whether you want to receive mention notification event. | Optional |
## DELETE /api/v1/push/subscription

10
content/en/api/rest/reports.md
View File

@ -16,8 +16,8 @@ Report an account.
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `account_id` | The ID of the account to report | Required ||
| `status_ids` | The IDs of statuses to report as array | Optional ||
| `comment` | Reason for the report (up to 1,000 characters) | Optional ||
|Name|Description|Required|
|----|-----------|:------:|
| `account_id` | The ID of the account to report | Required |
| `status_ids` | The IDs of statuses to report as array | Optional |
| `comment` | Reason for the report (up to 1,000 characters) | Optional |

2
content/en/api/rest/search.md
View File

@ -21,4 +21,4 @@ Returns [Results]({{< relref "entities.md#results" >}})
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `q` | The search query | Required ||
| `resolve` | | Optional ||
| `resolve` | Attempt WebFinger look-up | Optional |false|

8
content/en/api/rest/timelines.md
View File

@ -42,8 +42,8 @@ Returns array of [Status]({{< relref "entities.md#status" >}})
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `local` | Only local statuses | Optional ||
| `only_media` | Only statuses with media attachments | Optional ||
| `local` | Only local statuses | Optional |false|
| `only_media` | Only statuses with media attachments | Optional |false|
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
| `limit` | Maximum number of results | Optional | 20 |
@ -66,8 +66,8 @@ Returns array of [Status]({{< relref "entities.md#status" >}})
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `local` | Only local statuses | Optional ||
| `only_media` | Only statuses with media attachments | Optional ||
| `local` | Only local statuses | Optional |false|
| `only_media` | Only statuses with media attachments | Optional |false|
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
| `limit` | Maximum number of results | Optional | 20 |