soundcloud / soundcloud/api

Deprecated API warning - /users/{id}/followings/{id}

Open
#56 3 comments 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: Deprecated API warning - /users/{id}/followings/{id}

Endpoint(s):
  • GET /users/{id}/followings/{id}

https://developers.soundcloud.com/docs/api/explorer/open-api#/users/get_users__user_id__followings__following_id_

Scope(s):
  • None (application is not using authentication i.e., implicit flow)

I noticed that this endpoint is marked as deprecated in the SoundCloud API docs above. This endpoint is useful to perform a quick check to see if a user is already following another user. This is useful for providing a visual indication on 3rd party integrations if a user follows another user.

If this endpoint is removed, then this check can only be performed by paging through all of a users followings, and searching to see if the other user id is present in the collection. This collection could be up to 2000 users, and therefore require 10 API calls in order to perform this check.

As it stands, a very lightweight check can be done as this method actually issues a HTTP 303 (Redirect Method) to the /users/{id} endpoint meaning no data even needs to be requested from the API.

Can I request that this method is not deprecated?

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 with the linked SoundCloud API Explorer entry for GET /users/{id}/followings/{id} and review its deprecated status and documented behavior. Done would require a maintainer decision about whether this endpoint should remain supported; the issue provides no repository file or test to change.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.