mirror of
https://git.pleroma.social/pleroma/pleroma.git
synced 2024-12-22 16:16:34 +00:00
Mark /api/v1/pleroma/accounts/:id/subscribe
/unsubscribe
as deprecated
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
This commit is contained in:
parent
540e62c5fc
commit
c1c0f0b144
3 changed files with 13 additions and 2 deletions
1
changelog.d/deprecate-subscribe.change
Normal file
1
changelog.d/deprecate-subscribe.change
Normal file
|
@ -0,0 +1 @@
|
|||
Deprecate `/api/v1/pleroma/accounts/:id/subscribe`/`unsubscribe`
|
|
@ -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:
|
||||
|
|
|
@ -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"]}],
|
||||
|
|
Loading…
Reference in a new issue