add rest api sparse fieldsets

[sw34]

Summary by CodeRabbit

• Documentation
  • Added a new "Sparse Fieldsets" section to the REST API reference.
  • Describes using the fields[type] query parameter to request specific fields per resource type.
  • Provides two practical examples, including combining include with field restrictions.
  • Links to the JSON:API sparse fieldsets specification for further guidance.
  • Clarifies that no code or public API changes were made.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
zenstack-new-site	Ready	Preview	Comment	Sep 29, 2025 4:39pm

[coderabbitai]

Walkthrough

Adds a "Sparse Fieldsets" section to the REST API reference documenting the fields[type] query parameter per JSON:API sparse fieldsets, with examples showing simple field selection and combined include + field restrictions. No code or public API changes.

Changes

Cohort / File(s)	Summary of changes
REST docs: Sparse Fieldsets docs/reference/server-adapters/api-handlers/rest.mdx	Added a new "Sparse Fieldsets" section explaining fields[type] usage (comma-separated field names), linked to the JSON:API sparse fieldsets spec, and provided two examples (simple field selection; include with field restrictions). Inserted content in two locations within the file.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

• [Feature Request] REST API handler add sparse fields zenstack#2253 — Documentation for JSON:API sparse fieldsets directly aligns with the request in this issue; this PR appears to implement that documentation update.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly describes the addition of sparse fieldsets for the REST API which is the core change in this pull request and is specific enough for readers to understand its purpose without unnecessary detail.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6bc5bd0 and e13b13c.

📒 Files selected for processing (1)

• docs/reference/server-adapters/api-handlers/rest.mdx (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• docs/reference/server-adapters/api-handlers/rest.mdx

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between addfdb3 and 6bc5bd0.

📒 Files selected for processing (1)

• docs/reference/server-adapters/api-handlers/rest.mdx (1 hunks)