From 3c7c5caed1aa3f2035de3eba0130c83790fa379e Mon Sep 17 00:00:00 2001 From: Mahan Date: Tue, 5 Dec 2023 21:50:37 +0330 Subject: [PATCH] update return empty return types to Empty (#1298) --- content/en/methods/admin/accounts.md | 2 +- content/en/methods/conversations.md | 2 +- content/en/methods/domain_blocks.md | 4 ++-- content/en/methods/emails.md | 2 +- content/en/methods/featured_tags.md | 2 +- content/en/methods/filters.md | 6 +++--- content/en/methods/lists.md | 6 +++--- content/en/methods/notifications.md | 6 +++--- content/en/methods/oauth.md | 2 +- content/en/methods/push.md | 2 +- content/en/methods/scheduled_statuses.md | 2 +- content/en/methods/suggestions.md | 2 +- 12 files changed, 19 insertions(+), 19 deletions(-) diff --git a/content/en/methods/admin/accounts.md b/content/en/methods/admin/accounts.md index 7f53ba32..643a3606 100644 --- a/content/en/methods/admin/accounts.md +++ b/content/en/methods/admin/accounts.md @@ -686,7 +686,7 @@ POST /api/v1/admin/accounts/:id/action HTTP/1.1 Perform an action against an account and log this action in the moderation history. Also resolves any open reports against this account. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `admin:write:accounts`\ **Permissions:** Manage Users, Manage Reports\ **Version history:**\ diff --git a/content/en/methods/conversations.md b/content/en/methods/conversations.md index b7e5cd5d..e5d0de51 100644 --- a/content/en/methods/conversations.md +++ b/content/en/methods/conversations.md @@ -128,7 +128,7 @@ DELETE /api/v1/conversations/:id HTTP/1.1 Removes a conversation from your list of conversations. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:conversations`\ **Version history:**\ 2.6.0 - added diff --git a/content/en/methods/domain_blocks.md b/content/en/methods/domain_blocks.md index 71aa12ab..b61907be 100644 --- a/content/en/methods/domain_blocks.md +++ b/content/en/methods/domain_blocks.md @@ -90,7 +90,7 @@ Block a domain to: - remove all followers from it - prevent following new users from it (but does not remove existing follows) -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:blocks` or `follow`\ **Version:**\ 1.4.0 - added @@ -154,7 +154,7 @@ DELETE /api/v1/domain_blocks HTTP/1.1 Remove a domain block, if it exists in the user's array of blocked domains. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:blocks` or `follow`\ **Version history:**\ 1.4.0 - added diff --git a/content/en/methods/emails.md b/content/en/methods/emails.md index b73db712..baad47aa 100644 --- a/content/en/methods/emails.md +++ b/content/en/methods/emails.md @@ -24,7 +24,7 @@ aliases: [ POST /api/v1/emails/confirmations HTTP/1.1 ``` -**Returns:** Empty object\ +**Returns:** Empty\ **OAuth:** User token issued to the client that created the unconfirmed user\ **Version history:**\ 3.4.0 - added diff --git a/content/en/methods/featured_tags.md b/content/en/methods/featured_tags.md index 793bf62e..15ad5c31 100644 --- a/content/en/methods/featured_tags.md +++ b/content/en/methods/featured_tags.md @@ -133,7 +133,7 @@ DELETE /api/v1/featured_tags/:id HTTP/1.1 Stop promoting a hashtag on your profile. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:accounts`\ **Version history:**\ 3.0.0 - added diff --git a/content/en/methods/filters.md b/content/en/methods/filters.md index 501b394a..657099b7 100644 --- a/content/en/methods/filters.md +++ b/content/en/methods/filters.md @@ -403,7 +403,7 @@ DELETE /api/v2/filters/:id HTTP/1.1 Delete a filter group with the given id. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:filters`\ **Version history:**\ 4.0.0 - added @@ -730,7 +730,7 @@ DELETE /api/v2/filters/keywords/:id HTTP/1.1 Deletes the given filter keyword. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:filters`\ **Version history:**\ 4.0.0 - added @@ -1344,7 +1344,7 @@ If context is not provided properly: DELETE /api/v1/filters/:id HTTP/1.1 ``` -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:filters`\ **Version history:**\ 2.4.3 - added\ diff --git a/content/en/methods/lists.md b/content/en/methods/lists.md index 4ae081ef..46d03a9c 100644 --- a/content/en/methods/lists.md +++ b/content/en/methods/lists.md @@ -299,7 +299,7 @@ If the `replies_policy` is not understood: DELETE /api/v1/lists/:id HTTP/1.1 ``` -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:lists`\ **Version history:**\ 2.1.0 - added @@ -461,7 +461,7 @@ POST /api/v1/lists/:id/accounts HTTP/1.1 Add accounts to the given list. Note that the user must be following these accounts. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:lists`\ **Version history:**\ 2.1.0 - added @@ -530,7 +530,7 @@ DELETE /api/v1/lists/:id/accounts HTTP/1.1 Remove accounts from the given list. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:lists`\ **Version history:**\ 2.1.0 - added diff --git a/content/en/methods/notifications.md b/content/en/methods/notifications.md index 90193341..1dc7ae24 100644 --- a/content/en/methods/notifications.md +++ b/content/en/methods/notifications.md @@ -262,7 +262,7 @@ POST /api/v1/notifications/clear HTTP/1.1 Clear all notifications from the server. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:notifications`\ **Version history:**\ 0.0.0 - added @@ -303,7 +303,7 @@ POST /api/v1/notifications/:id/dismiss HTTP/1.1 Dismiss a single notification from the server. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:notifications`\ **Version history:**\ 1.3.0 - added @@ -350,7 +350,7 @@ POST /api/v1/notifications/dismiss HTTP/1.1 Dismiss a single notification from the server. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:notifications`\ **Version history**:\ 0.0.0 - available\ diff --git a/content/en/methods/oauth.md b/content/en/methods/oauth.md index a2714847..1f03d8b9 100644 --- a/content/en/methods/oauth.md +++ b/content/en/methods/oauth.md @@ -156,7 +156,7 @@ POST /oauth/revoke HTTP/1.1 Revoke an access token to make it no longer valid for use. -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** Public\ **Version history:**\ x.x.x - added diff --git a/content/en/methods/push.md b/content/en/methods/push.md index cac71e9f..12e773cf 100644 --- a/content/en/methods/push.md +++ b/content/en/methods/push.md @@ -298,7 +298,7 @@ DELETE /api/v1/push/subscription HTTP/1.1 Removes the current Web Push API subscription. -**Returns:** none\ +**Returns:** Empty\ **OAuth:** User token + `push`\ **Version history:**\ 2.4.0 - added diff --git a/content/en/methods/scheduled_statuses.md b/content/en/methods/scheduled_statuses.md index 8fa38269..1fe1255b 100644 --- a/content/en/methods/scheduled_statuses.md +++ b/content/en/methods/scheduled_statuses.md @@ -243,7 +243,7 @@ ScheduledStatus is not owned by you or does not exist DELETE /api/v1/scheduled_statuses/:id HTTP/1.1 ``` -**Returns:** empty object\ +**Returns:** Empty\ **OAuth:** User token + `write:statuses`\ **Version history:**\ 2.7.0 - added diff --git a/content/en/methods/suggestions.md b/content/en/methods/suggestions.md index 68744ad9..374f1478 100644 --- a/content/en/methods/suggestions.md +++ b/content/en/methods/suggestions.md @@ -89,7 +89,7 @@ DELETE /api/v1/suggestions/:account_id HTTP/1.1 Remove an account from follow suggestions. -**Returns:** n/a\ +**Returns:** Empty\ **OAuth:** User token + `read`\ **Version history:**\ 2.4.3 - added