From e4e88f0fb76950bdcb71f3ba0bc9715f1d1d4f62 Mon Sep 17 00:00:00 2001 From: Lennart Hengstmengel Date: Wed, 20 Sep 2023 10:32:44 +0200 Subject: [PATCH] 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 --- content/en/entities/Admin_Cohort.md | 2 +- content/en/entities/Admin_Dimension.md | 2 +- content/en/entities/FeaturedTag.md | 2 +- content/en/entities/FilterResult.md | 2 +- content/en/entities/Reaction.md | 26 ++++++++++--------- content/en/entities/Role.md | 2 +- content/en/entities/StatusEdit.md | 2 +- .../methods/admin/canonical_email_blocks.md | 10 +++++++ 8 files changed, 30 insertions(+), 18 deletions(-) diff --git a/content/en/entities/Admin_Cohort.md b/content/en/entities/Admin_Cohort.md index 6a79d665..739f4e32 100644 --- a/content/en/entities/Admin_Cohort.md +++ b/content/en/entities/Admin_Cohort.md @@ -77,7 +77,7 @@ Daily retention data for the week between 2022-09-08 and 2022-09-14, given that "value": "1" } ] -}, +} ``` ## Attributes diff --git a/content/en/entities/Admin_Dimension.md b/content/en/entities/Admin_Dimension.md index 1b4cc919..4d67e6cb 100644 --- a/content/en/entities/Admin_Dimension.md +++ b/content/en/entities/Admin_Dimension.md @@ -165,7 +165,7 @@ Show dimensional data about how much space is used by each software in your serv "human_value": "0 Bytes" } ] -}, +} ``` ### `software_versions` {#software_versions} diff --git a/content/en/entities/FeaturedTag.md b/content/en/entities/FeaturedTag.md index 8c245e2d..44c93a9e 100644 --- a/content/en/entities/FeaturedTag.md +++ b/content/en/entities/FeaturedTag.md @@ -50,7 +50,7 @@ aliases: [ ### `statuses_count` {#statuses_count} **Description:** The number of authored statuses containing this hashtag.\ -**Type:** Number\ +**Type:** Integer\ **Version history:**\ 3.0.0 - added diff --git a/content/en/entities/FilterResult.md b/content/en/entities/FilterResult.md index d2323fbc..6b5546d1 100644 --- a/content/en/entities/FilterResult.md +++ b/content/en/entities/FilterResult.md @@ -53,7 +53,7 @@ aliases: [ ### `status_matches` {#status_matches} **Description:** The status ID within the filter that was matched.\ -**Type:** {{}} String, or null\ +**Type:** {{}} Array of String, or null\ **Version history:**\ 4.0.0 - added diff --git a/content/en/entities/Reaction.md b/content/en/entities/Reaction.md index 455cec85..e45f970b 100644 --- a/content/en/entities/Reaction.md +++ b/content/en/entities/Reaction.md @@ -19,18 +19,20 @@ aliases: [ ## Example ```json -{ - "name": "bongoCat", - "count": 9, - "me": false, - "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" -}, -{ - "name": "🤔", - "count": 1, - "me": true -} +[ + { + "name": "bongoCat", + "count": 9, + "me": false, + "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" + }, + { + "name": "🤔", + "count": 1, + "me": true + } +] ``` ## Attributes diff --git a/content/en/entities/Role.md b/content/en/entities/Role.md index 717093d5..679fe02a 100644 --- a/content/en/entities/Role.md +++ b/content/en/entities/Role.md @@ -21,7 +21,7 @@ aliases: [ "color": "#ff3838", "permissions": 1048575, "highlighted": true -}, +} ``` ## Attributes diff --git a/content/en/entities/StatusEdit.md b/content/en/entities/StatusEdit.md index bc8f8453..f58f34d3 100644 --- a/content/en/entities/StatusEdit.md +++ b/content/en/entities/StatusEdit.md @@ -78,7 +78,7 @@ aliases: [ ### `account` {#account} **Description:** The account that published this revision.\ -**Type:** Account\ +**Type:** [Account]({{}})\ **Version history:**\ 3.5.0 - added diff --git a/content/en/methods/admin/canonical_email_blocks.md b/content/en/methods/admin/canonical_email_blocks.md index c8cacb95..cdf44a7d 100644 --- a/content/en/methods/admin/canonical_email_blocks.md +++ b/content/en/methods/admin/canonical_email_blocks.md @@ -94,6 +94,11 @@ GET /api/v1/admin/canonical_email_blocks/:id HTTP/1.1 #### Request +##### Path parameters + +:id +: {{}} String. The ID of the Admin::CanonicalEmailBlock in the database. + ##### Headers Authorization @@ -262,6 +267,11 @@ DELETE /api/v1/admin/canonical_email_blocks/:id HTTP/1.1 #### Request +##### Path parameters + +:id +: {{}} String. The ID of the Admin::CanonicalEmailBlock in the database. + ##### Headers Authorization