Allow passing a list of fields when retrieving data
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- api
Research direction
Start with the /users/{id}/tracks endpoint and review how responses are defined for the other endpoints that return data. Determine the scope and behavior of an optional fields query parameter, including nested fields such as user[username]; done means responses contain only the requested fields and request size is reduced.
Written by the indexing model from the issue text.
Description
Title: Allow passing a list of fields when retrieving data
Issue found of: 10/13/2021
Endpoint(s):
- Any endpoint that returns data
Expected behaviour:
As an example, with the /users/{id}/tracks endpoint, it is currently returning a whole bunch of fields that I do not need for my application. It would be nice to have an optional fields querystring parameter, something along the lines of /users/{id}/tracks?fields=id,title,uri,permalink,user[username],... to get only the fields that are needed in the result. This could help greatly reduce request size.
Actual behaviour:
Currently, we get all of the data, even if we don't need all of it.
- Dominant language
- JavaScript
- Stars
- 254
- Forks
- 53
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from soundcloud/api
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 35/100
soundcloud/api#581 · 1 comment ·
-
widget
Difficulty 5/5 Over a week Newbie friendliness 35/100
soundcloud/api#557 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 38/100
soundcloud/api#548 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
soundcloud/api#547 · 2 reactions ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
soundcloud/api#545 · 2 comments · 1 reaction ·
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
docToolchain/docToolchain#1705 ·
-
Timezone select lists one option per character; duplicate "Failed" reason; shared tracker popover id Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
nightscout/nocturne#1414 ·
-
bug v2
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/inspector#2458 · 1 comment ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
carbon-design-system/ibm-products#9907 ·