soundcloud / soundcloud/api

Search endpoints response object does not match documentation - next_href contains deprecated "offset" instead of "cursor"

Open
#167 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Search endpoints response object does not match documentation - next_href contains deprecated offset instead of cursor

Issue found on: November 22nd, 2021

Endpoint(s):
  • GET /tracks?q=b&linked_partitioning=true&limit=10
  • GET /playlists?q=b&linked_partitioning=true&limit=10
  • GET /users?q=b&linked_partitioning=true&limit=10
Scope(s):
  • None (application is not using authentication i.e., implicit flow)
Steps to reproduce:

Call GET on Search endpoints
image

Expected behaviour:

next_href should have cursor param in query string as defined in example response, see: documentation
e.g. "next_href": "https://api.soundcloud.com/collection?page_size=10&cursor=1234567"

Actual behaviour:

next_href contains deprecated query string param offset
e.g. "next_href": "https://api.soundcloud.com/playlists?limit=10&linked_partitioning=true&offset=10&q=b"

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 the behavior on the listed GET /tracks, /playlists, and /users search endpoints with linked_partitioning=true and limit=10. Compare each next_href value with the OpenAPI documentation; done means the response uses the documented cursor query parameter instead of the deprecated offset parameter.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.