Feature Request: Ability to select fields to return and population depth on queries.

Open
#640 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
18/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
api, backend

Research direction

The issue names no files or entry points. Start by finding where collection entries are queried and returned through the REST API, and how the existing query parameters are parsed. Decide how field selection and population depth should be specified in the URL, which the issue leaves open, and confirm that with a maintainer first. Done means a /blogs-style request returns only the requested fields, with tests covering it.

Written by the indexing model from the issue text.

Description

area: api enhancement priority: P2

A collection entry may have many fields not used in certain circumstances - for example a /blogs route will need the article name, the slug, and the except, but it doesn't need the full body content. The ability to select this by URL flags, rather than writing a custom route that uses the same collection.

Dominant language
TypeScript
Stars
1.8k
Forks
219
Avg merge
2d 21h
Merged PRs (30d)
67

Getting set up

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.

More from SonicJs-Org/sonicjs

All issues in SonicJs-Org/sonicjs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.