docs: add scrobble API description
authorAriadne Conill <ariadne@dereferenced.org>
Fri, 27 Sep 2019 11:04:52 +0000 (11:04 +0000)
committerAriadne Conill <ariadne@dereferenced.org>
Mon, 30 Sep 2019 10:39:17 +0000 (10:39 +0000)
docs/api/pleroma_api.md

index ac5489aa3e9dd73eafbaaf48368275b92fc2ba8e..183cf8a2837fe0594d3c70ea73df23397fc6a718 100644 (file)
@@ -439,3 +439,33 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
 * Params: None
 * Response: the archive of the pack with a 200 status code, 403 if the pack is not set as shared,
   404 if the pack does not exist
+
+## `GET /api/v1/pleroma/accounts/:uid/now-playing`
+### Requests a list of current and recent Listen activities for an account
+* Method `GET`
+* Authentication: not required
+* Params: None
+* Response: An array of media metadata entities.
+* Example response:
+```json
+[
+   {
+       "id": "1234",
+       "title": "Some Title",
+       "artist": "Some Artist",
+       "album": "Some Album",
+       "length": 180000
+   }
+]
+```
+
+## `POST /api/v1/pleroma/now-playing`
+### Creates a new Listen activity for an account
+* Method `POST`
+* Authentication: required
+* Params:
+  * `title`: the title of the media playing
+  * `album`: the album of the media playing [optional]
+  * `artist`: the artist of the media playing [optional]
+  * `length`: the length of the media playing [optional]
+* Response: the newly created media metadata entity representing the Listen activity