Add explanation of rate limit in scheduled status entity (#1584)

* Add explanation of rate limit in scheduled status entity * Add deprecated note
mastodon · Jan 9, 2025 · 4afe1ae · 4afe1ae
1 parent 441d374
commit 4afe1ae
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/content/en/entities/ScheduledStatus.md b/content/en/entities/ScheduledStatus.md
@@ -194,9 +194,9 @@ Returned from `GET /api/v1/scheduled_statuses`:
 **Version history:**\
 2.7.0 - added
 
-#### `params[with_rate_limit]` {#params-with_rate_limit}
+#### `params[with_rate_limit]` {{%deprecated%}} {#params-with_rate_limit}
 
-**Description:** Whether the status should be rate limited <!-- TODO: What does this mean -->.\
+**Description:** Whether status creation is subject to rate limiting. Provided for historical compatibility only and can be ignored.\
 **Type:** Boolean\
 **Version history:**\
 2.7.0 - added