From 53fccb8af8943aa63e557cbd54d2c19c75b63174 Mon Sep 17 00:00:00 2001
From: tobi <31960611+tsmethurst@users.noreply.github.com>
Date: Thu, 22 Aug 2024 19:47:10 +0200
Subject: [feature] Use `local_only` field, deprecate `federated` field (#3222)

* [feature] Use `local_only` field, deprecate `federated` field

* use `deprecated` comment for form.Federated

* nolint
---
 docs/api/swagger.yaml | 24 +++++++++++++++++++-----
 1 file changed, 19 insertions(+), 5 deletions(-)

(limited to 'docs/api')

diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml
index 9c21a0a31..99e1e5c0e 100644
--- a/docs/api/swagger.yaml
+++ b/docs/api/swagger.yaml
@@ -2635,6 +2635,10 @@ definitions:
                 example: en
                 type: string
                 x-go-name: Language
+            local_only:
+                description: Set to "true" if status is not federated, ie., a "local only" status; omitted from response otherwise.
+                type: boolean
+                x-go-name: LocalOnly
             media_attachments:
                 description: Media that is attached to this status.
                 items:
@@ -2828,6 +2832,10 @@ definitions:
                 example: en
                 type: string
                 x-go-name: Language
+            local_only:
+                description: Set to "true" if status is not federated, ie., a "local only" status; omitted from response otherwise.
+                type: boolean
+                x-go-name: LocalOnly
             media_attachments:
                 description: Media that is attached to this status.
                 items:
@@ -8654,6 +8662,17 @@ paths:
                   name: visibility
                   type: string
                   x-go-name: Visibility
+                - default: false
+                  description: If set to true, this status will be "local only" and will NOT be federated beyond the local timeline(s). If set to false (default), this status will be federated to your followers beyond the local timeline(s).
+                  in: formData
+                  name: local_only
+                  type: boolean
+                  x-go-name: LocalOnly
+                - description: '***DEPRECATED***. Included for back compat only. Only used if set and local_only is not yet. If set to true, this status will be federated beyond the local timeline(s). If set to false, this status will NOT be federated beyond the local timeline(s).'
+                  in: formData
+                  name: federated
+                  type: boolean
+                  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.
@@ -8677,11 +8696,6 @@ paths:
                   name: content_type
                   type: string
                   x-go-name: ContentType
-                - description: This status will be federated beyond the local timeline(s).
-                  in: formData
-                  name: federated
-                  type: boolean
-                  x-go-name: Federated
             produces:
                 - application/json
             responses:
-- 
cgit v1.2.3