summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLibravatar Vyr Cossont <VyrCossont@users.noreply.github.com>2025-02-12 09:49:33 -0800
committerLibravatar GitHub <noreply@github.com>2025-02-12 09:49:33 -0800
commitfccb0bc102f2a54a21eed343cda64f9a5221b677 (patch)
treeb7c1858f4a92841dfaf59e7102189a635d7136f8 /docs
parent[performance] improved enum migrations (#3782) (diff)
downloadgotosocial-fccb0bc102f2a54a21eed343cda64f9a5221b677.tar.xz
[feature] Implement backfilling statuses thru scheduled_at (#3685)
* Implement backfilling statuses thru scheduled_at * Forbid mentioning others in backfills * Update error messages & codes * Add new tests for backfilled statuses * Test that backfilling doesn't timeline or notify * Fix check for absence of notification * Test that backfills do not cause federation * Fix type of apimodel.StatusCreateRequest.ScheduledAt in tests * Add config file switch and min date check
Diffstat (limited to 'docs')
-rw-r--r--docs/api/swagger.yaml8
-rw-r--r--docs/configuration/instance.md13
2 files changed, 19 insertions, 2 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml
index df8f09321..836df83e8 100644
--- a/docs/api/swagger.yaml
+++ b/docs/api/swagger.yaml
@@ -10397,10 +10397,14 @@ paths:
x-go-name: Federated
- description: |-
ISO 8601 Datetime at which to schedule a status.
- Providing this parameter will cause ScheduledStatus to be returned instead of Status.
+
+ Providing this parameter with a *future* time will cause ScheduledStatus to be returned instead of Status.
Must be at least 5 minutes in the future.
+ This feature isn't implemented yet.
- This feature isn't implemented yet; attemping to set it will return 501 Not Implemented.
+ Providing this parameter with a *past* time will cause the status to be backdated,
+ and will not push it to the user's followers. This is intended for importing old statuses.
+ format: date-time
in: formData
name: scheduled_at
type: string
diff --git a/docs/configuration/instance.md b/docs/configuration/instance.md
index bffec8f70..2a945eed2 100644
--- a/docs/configuration/instance.md
+++ b/docs/configuration/instance.md
@@ -171,4 +171,17 @@ instance-subscriptions-process-every: "24h"
# Options: ["", "zero", "serve", "baffle"]
# Default: ""
instance-stats-mode: ""
+
+# Bool. This flag controls whether local accounts may backdate statuses
+# using past dates with the scheduled_at param to /api/v1/statuses.
+# This flag does not affect scheduling posts in the future
+# (which is currently not implemented anyway),
+# nor can it prevent remote accounts from backdating their own statuses.
+#
+# If true, all local accounts may backdate statuses.
+# If false, status backdating will be disabled and an error will be returned if it's used.
+#
+# Options: [true, false]
+# Default: true
+instance-allow-backdating-statuses: true
```