Document proofs include value for getReport

[smar-ivan-sandev]

Documents proofs as a valid include value on GetReportQueryParameters.include, completing the proofs work across the SDKs (Java #186, C# #216, Python #159/#161).

The JS SDK already supported include=proofs at runtime (the include field is a free-form string and the Proof type + Row.proof already exist and are reused by report rows) — this is a docs-only JSDoc + CHANGELOG change for discoverability.

DEVECO-2197

Summary by CodeRabbit

• Documentation
  • Clarified the valid values for the getReport include parameter.
  • Documented support for including proofs, along with attachments, discussions, formatting, object values, scope, source, and source sheets.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f229d2a0-3140-4f40-a948-50bca5b3e01f

📥 Commits

Reviewing files that changed from the base of the PR and between 290af66 and 2431ceb.

📒 Files selected for processing (2)

• CHANGELOG.md
• lib/reports/types.ts

---

📝 Walkthrough

Walkthrough

The getReport include-parameter documentation now lists all supported values, including proofs. The Unreleased changelog records proofs as a valid include value.

Changes

getReport documentation

Layer / File(s)	Summary
Document valid include values lib/reports/types.ts, CHANGELOG.md	The include parameter documentation now enumerates supported comma-separated values, and the changelog notes that proofs is accepted.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: ggoranov-smar, astrinski-smartsheet

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the main change: documenting proofs as a valid include value for getReport.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch add-proofs-getreport-jsdoc

---

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

[coveralls]

Coverage Report for CI Build 29828892843

Warning

No base build found for commit 290af66 on mainline.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 95.44%

Details

• Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →

---

Coverage Stats

Relevant Lines:	1289
Covered Lines:	1244
Line Coverage:	96.51%
Relevant Branches:	246
Covered Branches:	221
Branch Coverage:	89.84%
Branches in Coverage %:	Yes
Coverage Strength:	1750.47 hits per line

---

💛 - Coveralls