soundcloud / soundcloud/api

Playlists and Users returned by the API do not include a flag to show if they had been Liked or Followed by the authenticated user.

Open
#194 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
254
Forks
53
PR merge metrics
No merged PRs in 30d

Description

Title: Playlists and Users returned by the API do not include a flag to show if they had been Liked or Followed by the authenticated user.

Issue found of: March 24th, 2022

Endpoint(s):
  • GET /me/activites
  • GET /me/followings
Scope(s):
  • None (application is not using authentication i.e., implicit flow)
Steps to reproduce:
curl --request GET \
  --url 'curl -X GET "https://api.soundcloud.com/me/activities?access=playable%2Cpreview&limit=20" -H  "accept: application/json; charset=utf-8"'
curl --request GET \
  --url 'curl -X GET "https://api.soundcloud.com/me/followings?limit=20" -H  "accept: application/json; charset=utf-8"'
Expected behaviour:

It would be great if Playlists and Users returned by the API had a flag to show if they had been Liked or Followed by the authenticated user. The same way user_favorite is there for Tracks.

Actual behaviour:

Playlists and Users do not contain an object that indicates whether the authenticated user has Liked or Followed them.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing GET /me/activities and GET /me/followings with an authenticated request, then compare their Playlist and User responses with Track responses containing user_favorite. Done means the returned Playlists and Users clearly indicate whether the authenticated user liked or followed them.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.