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

[thesubdelta]

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

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"

[obrhoff]

Might be related to #165

[thesubdelta]

@obrhoff - looked at that one too and this is something different. That one is related to SC design with private tracks. This one is related to the API returning a different response than in the documentation. API should return cursor but is returning offset which is marked as deprecated

[obrhoff]

No not really. If you look closer you will see that the cursor in the next_href just mirrors the limit parameter. Calling the supplied next_href parameter will then lead to a Cursor is not a valid UUID. error.

I know it's not the exact issue but I think they are related since both involve the cursor behavior of the pagination.

[thesubdelta]

@obrhoff oh my bad, I was referring to the one that was linked in a comment on your issue: #139 which is the private tracks - responded in your issue directly.

[thesubdelta]

Same issue is present on these endpoints:
next_href contains deprecated query string param offset instead of expected cursor param

• GET /tracks/540750015/related?limit=10&linked_partitioning=true
• GET /tracks/540750015/comments?limit=10&?threaded=1&filter_replies=0&limit=10&linked_partitioning=true

[dasha-kobzeva]

Hello,
search endpoints provide offset-based pagination, and not cursor-based. The example in the documentation is a generic one and does not match the real one In this case. We will update the doc