Fixed some consistency issues in the documentation (#1274)
* fixed invalid json examples * correct type: integer for a count, not number * correct type: array of string, not string * add square brackets around entity return type * added missing path parameter definition * spacing fix * PR comment: add link
This commit is contained in:
parent
1d15e379a4
commit
e4e88f0fb7
8 changed files with 30 additions and 18 deletions
|
@ -77,7 +77,7 @@ Daily retention data for the week between 2022-09-08 and 2022-09-14, given that
|
||||||
"value": "1"
|
"value": "1"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Attributes
|
## Attributes
|
||||||
|
|
|
@ -165,7 +165,7 @@ Show dimensional data about how much space is used by each software in your serv
|
||||||
"human_value": "0 Bytes"
|
"human_value": "0 Bytes"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### `software_versions` {#software_versions}
|
### `software_versions` {#software_versions}
|
||||||
|
|
|
@ -50,7 +50,7 @@ aliases: [
|
||||||
### `statuses_count` {#statuses_count}
|
### `statuses_count` {#statuses_count}
|
||||||
|
|
||||||
**Description:** The number of authored statuses containing this hashtag.\
|
**Description:** The number of authored statuses containing this hashtag.\
|
||||||
**Type:** Number\
|
**Type:** Integer\
|
||||||
**Version history:**\
|
**Version history:**\
|
||||||
3.0.0 - added
|
3.0.0 - added
|
||||||
|
|
||||||
|
|
|
@ -53,7 +53,7 @@ aliases: [
|
||||||
### `status_matches` {#status_matches}
|
### `status_matches` {#status_matches}
|
||||||
|
|
||||||
**Description:** The status ID within the filter that was matched.\
|
**Description:** The status ID within the filter that was matched.\
|
||||||
**Type:** {{<nullable>}} String, or null\
|
**Type:** {{<nullable>}} Array of String, or null\
|
||||||
**Version history:**\
|
**Version history:**\
|
||||||
4.0.0 - added
|
4.0.0 - added
|
||||||
|
|
||||||
|
|
|
@ -19,18 +19,20 @@ aliases: [
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
[
|
||||||
|
{
|
||||||
"name": "bongoCat",
|
"name": "bongoCat",
|
||||||
"count": 9,
|
"count": 9,
|
||||||
"me": false,
|
"me": false,
|
||||||
"url": "https://files.mastodon.social/custom_emojis/images/000/067/715/original/fdba57dff7576d53.png",
|
"url": "https://files.mastodon.social/custom_emojis/images/000/067/715/original/fdba57dff7576d53.png",
|
||||||
"static_url": "https://files.mastodon.social/custom_emojis/images/000/067/715/static/fdba57dff7576d53.png"
|
"static_url": "https://files.mastodon.social/custom_emojis/images/000/067/715/static/fdba57dff7576d53.png"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "🤔",
|
"name": "🤔",
|
||||||
"count": 1,
|
"count": 1,
|
||||||
"me": true
|
"me": true
|
||||||
}
|
}
|
||||||
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
## Attributes
|
## Attributes
|
||||||
|
|
|
@ -21,7 +21,7 @@ aliases: [
|
||||||
"color": "#ff3838",
|
"color": "#ff3838",
|
||||||
"permissions": 1048575,
|
"permissions": 1048575,
|
||||||
"highlighted": true
|
"highlighted": true
|
||||||
},
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Attributes
|
## Attributes
|
||||||
|
|
|
@ -78,7 +78,7 @@ aliases: [
|
||||||
### `account` {#account}
|
### `account` {#account}
|
||||||
|
|
||||||
**Description:** The account that published this revision.\
|
**Description:** The account that published this revision.\
|
||||||
**Type:** Account\
|
**Type:** [Account]({{<relref "entities/Account">}})\
|
||||||
**Version history:**\
|
**Version history:**\
|
||||||
3.5.0 - added
|
3.5.0 - added
|
||||||
|
|
||||||
|
|
|
@ -94,6 +94,11 @@ GET /api/v1/admin/canonical_email_blocks/:id HTTP/1.1
|
||||||
|
|
||||||
#### Request
|
#### Request
|
||||||
|
|
||||||
|
##### Path parameters
|
||||||
|
|
||||||
|
:id
|
||||||
|
: {{<required>}} String. The ID of the Admin::CanonicalEmailBlock in the database.
|
||||||
|
|
||||||
##### Headers
|
##### Headers
|
||||||
|
|
||||||
Authorization
|
Authorization
|
||||||
|
@ -262,6 +267,11 @@ DELETE /api/v1/admin/canonical_email_blocks/:id HTTP/1.1
|
||||||
|
|
||||||
#### Request
|
#### Request
|
||||||
|
|
||||||
|
##### Path parameters
|
||||||
|
|
||||||
|
:id
|
||||||
|
: {{<required>}} String. The ID of the Admin::CanonicalEmailBlock in the database.
|
||||||
|
|
||||||
##### Headers
|
##### Headers
|
||||||
|
|
||||||
Authorization
|
Authorization
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue