moon
/
honkoma
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Deprecate audio scrobbling

This commit is contained in:
Haelwenn (lanodan) Monnier 2023-07-04 03:34:51 +02:00
parent 2b9cd25cf4
commit 3d79ceb23a
3 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/deprecate-scrobbles.remove Normal file
View File

@ -0,0 +1 @@
Deprecate Pleroma's audio scrobbling

6
docs/development/API/pleroma_api.md
View File

@ -577,6 +577,9 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
404 if the pack does not exist 404 if the pack does not exist
## `GET /api/v1/pleroma/accounts/:id/scrobbles` ## `GET /api/v1/pleroma/accounts/:id/scrobbles`
Audio scrobbling in Pleroma is **deprecated**.
### Requests a list of current and recent Listen activities for an account ### Requests a list of current and recent Listen activities for an account
* Method `GET` * Method `GET`
* Authentication: not required * Authentication: not required
@ -598,6 +601,9 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
``` ```
## `POST /api/v1/pleroma/scrobble` ## `POST /api/v1/pleroma/scrobble`
Audio scrobbling in Pleroma is **deprecated**.
### Creates a new Listen activity for an account ### Creates a new Listen activity for an account
* Method `POST` * Method `POST`
* Authentication: required * Authentication: required

2
lib/pleroma/web/api_spec/operations/pleroma_scrobble_operation.ex
View File

@ -22,6 +22,7 @@ def create_operation do
summary: "Creates a new Listen activity for an account", summary: "Creates a new Listen activity for an account",
security: [%{"oAuth" => ["write"]}], security: [%{"oAuth" => ["write"]}],
operationId: "PleromaAPI.ScrobbleController.create", operationId: "PleromaAPI.ScrobbleController.create",
deprecated: true,
requestBody: request_body("Parameters", create_request(), requried: true), requestBody: request_body("Parameters", create_request(), requried: true),
responses: %{ responses: %{
200 => Operation.response("Scrobble", "application/json", scrobble()) 200 => Operation.response("Scrobble", "application/json", scrobble())
@ -34,6 +35,7 @@ def index_operation do
tags: ["Scrobbles"], tags: ["Scrobbles"],
summary: "Requests a list of current and recent Listen activities for an account", summary: "Requests a list of current and recent Listen activities for an account",
operationId: "PleromaAPI.ScrobbleController.index", operationId: "PleromaAPI.ScrobbleController.index",
deprecated: true,
parameters: [ parameters: [
%Reference{"$ref": "#/components/parameters/accountIdOrNickname"} | pagination_params() %Reference{"$ref": "#/components/parameters/accountIdOrNickname"} | pagination_params()
], ],