Commit 621f6356 authored by noellabo's avatar noellabo

Improved description

parent 2ed6ea7c
......@@ -28,7 +28,7 @@ Returns [ScheduledStatus]({{< relref "entities.md#scheduledstatus" >}})
## PUT /api/v1/scheduled_statuses/:id
Update Scheduled status.
Update Scheduled status. Only `scheduled_at` can be changed. To change the content, delete it and post a new status.
Returns [ScheduledStatus]({{< relref "entities.md#scheduledstatus" >}})
......@@ -40,7 +40,7 @@ Returns [ScheduledStatus]({{< relref "entities.md#scheduledstatus" >}})
|Name|Description|Required|
|----|-----------|:------:|
| `scheduled_at` | Timestamp string to schedule posting of status | Optional |
| `scheduled_at` | Timestamp string to schedule posting of status (ISO 8601) | Optional |
## DELETE /api/v1/scheduled_statuses/:id
......
......@@ -80,7 +80,7 @@ Publish a new status.
Returns [Status]({{< relref "entities.md#status" >}})
When scheduled_at option is present,
When `scheduled_at` option is present,
Returns [ScheduledStatus]({{< relref "entities.md#scheduledstatus" >}})
### Resource information
......@@ -97,7 +97,7 @@ Returns [ScheduledStatus]({{< relref "entities.md#scheduledstatus" >}})
| `sensitive` | Mark the media in the status as sensitive | Optional |
| `spoiler_text` | Text to be shown as a warning before the actual content | Optional |
| `visibility` | One of `direct`, `private`, `unlisted` `public` | Optional |
| `scheduled_at` | Timestamp string to schedule posting of status | Optional |
| `scheduled_at` | Timestamp string to schedule posting of status (ISO 8601) | Optional |
| `language` | Override language code of the toot (ISO 639-2) | Optional |
> You must provide either `status` or `media_ids`, completely empty statuses are not allowed.
......@@ -114,7 +114,7 @@ Allows users to schedule a toot (with media attachments) to be published at a ce
The scheduled date must be at least 5 minutes into the future. At most, 300 toots can be scheduled at the same time. Only 50 toots can be scheduled for any given day.
When scheduled_at option is present, instead of creating a status, we only run status validation, and if it passes, we create an entry in scheduled_statuses which encodes the status attributes. Every 5 minutes, a scheduler iterates over the scheduled_statuses table to fetch the ones due in the next 5 minutes, and push them into a more precise Sidekiq queue. In Sidekiq, the individual statuses are created, with media attachments being unassigned from the scheduled status and assigned to the real one.
When `scheduled_at` option is present, instead of creating a status, we only run status validation, and if it passes, we create an entry in scheduled_statuses which encodes the status attributes. Every 5 minutes, a scheduler iterates over the scheduled_statuses table to fetch the ones due in the next 5 minutes, and push them into a more precise Sidekiq queue. In Sidekiq, the individual statuses are created, with media attachments being unassigned from the scheduled status and assigned to the real one.
This option was added since v2.7.0.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment