pleroma

commit: f87aa8b83cb5f089a51bf2f5ad065a53f7d30a0b
parent c29441f30d0229192868ec4149a46fea562b0997
Author: feld <feld@feld.me>
Date:   Mon, 12 Aug 2024 21:27:12 +0000

Merge branch 'deprecate-subscribe' into 'develop'

Mark `/api/v1/pleroma/accounts/:id/subscribe`/`unsubscribe` as deprecated

See merge request pleroma/pleroma!4216
Diffstat:
A
changelog.d/deprecate-subscribe.change
2
++
M
docs/development/API/pleroma_api.md
6
++++++
M
lib/pleroma/web/api_spec/operations/pleroma_account_operation.ex
8
++++++--

3 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/changelog.d/deprecate-subscribe.change b/changelog.d/deprecate-subscribe.change
@@ -0,0 +1 @@
+Deprecate `/api/v1/pleroma/accounts/:id/subscribe`/`unsubscribe`
+\ No newline at end of file
diff --git a/docs/development/API/pleroma_api.md b/docs/development/API/pleroma_api.md
@@ -145,6 +145,9 @@ See [Admin-API](admin_api.md)
 
 ## `/api/v1/pleroma/accounts/:id/subscribe`
 ### Subscribe to receive notifications for all statuses posted by a user
+
+Deprecated. `notify` parameter in `POST /api/v1/accounts/:id/follow` should be used instead.
+
 * Method `POST`
 * Authentication: required
 * Params:
@@ -171,6 +174,9 @@ See [Admin-API](admin_api.md)
 
 ## `/api/v1/pleroma/accounts/:id/unsubscribe`
 ### Unsubscribe to stop receiving notifications from user statuses
+
+Deprecated. `notify` parameter in `POST /api/v1/accounts/:id/follow` should be used instead.
+
 * Method `POST`
 * Authentication: required
 * Params:
diff --git a/lib/pleroma/web/api_spec/operations/pleroma_account_operation.ex b/lib/pleroma/web/api_spec/operations/pleroma_account_operation.ex
@@ -85,9 +85,11 @@ defmodule Pleroma.Web.ApiSpec.PleromaAccountOperation do
 
   def subscribe_operation do
     %Operation{
+      deprecated: true,
       tags: ["Account actions"],
       summary: "Subscribe",
-      description: "Receive notifications for all statuses posted by the account.",
+      description:
+        "Receive notifications for all statuses posted by the account. Deprecated, use `notify: true` in follow operation instead.",
       operationId: "PleromaAPI.AccountController.subscribe",
       parameters: [id_param()],
       security: [%{"oAuth" => ["follow", "write:follows"]}],
@@ -100,9 +102,11 @@ defmodule Pleroma.Web.ApiSpec.PleromaAccountOperation do
 
   def unsubscribe_operation do
     %Operation{
+      deprecated: true,
       tags: ["Account actions"],
       summary: "Unsubscribe",
-      description: "Stop receiving notifications for all statuses posted by the account.",
+      description:
+        "Stop receiving notifications for all statuses posted by the account.  Deprecated, use `notify: false` in follow operation instead.",
       operationId: "PleromaAPI.AccountController.unsubscribe",
       parameters: [id_param()],
       security: [%{"oAuth" => ["follow", "write:follows"]}],