Skip to content

Add proofs support for getSheet and getReport#186

Merged
smar-ivan-sandev merged 2 commits into
mainlinefrom
add-proofs-support
Jul 21, 2026
Merged

Add proofs support for getSheet and getReport#186
smar-ivan-sandev merged 2 commits into
mainlinefrom
add-proofs-support

Conversation

@smar-ivan-sandev

@smar-ivan-sandev smar-ivan-sandev commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Adds proofs inclusion support to getSheet and getReport.

Changes

  • New Proof model (com.smartsheet.api.models.Proof) and ProofType enum (DOCUMENT, IMAGE, MIXED, NONE, VIDEO)
  • Added proof property to AbstractRow, so it surfaces on both Row and ReportRow
  • Added PROOFS include value to SheetInclusion and ReportInclusion
  • Unit test for Proof (getters/setters + wire-name serialization) and extended ReportResourcesImplTest to assert row-level proof deserialization
  • CHANGELOG entry under Unreleased

No changes needed to method signatures or query serialization — the new enum value flows through QueryUtil and serializes to proofs automatically.

DEVECO-2197

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Added a new Proof model and ProofType enum.
    • Rows returned from sheet and report retrieval can now include proof metadata when requested.
    • Added PROOFS inclusion options for sheets, reports, and rows.
  • Tests

    • Expanded unit and serialization tests to validate proof fields and JSON output.
    • Updated report/row fixtures and assertions for proof-enabled responses.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

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: ffbc3bb1-6518-459a-9f27-5d9e60621d88

📥 Commits

Reviewing files that changed from the base of the PR and between fadbe2f and 2593690.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • src/main/java/com/smartsheet/api/models/enums/RowInclusion.java
  • src/test/java/com/smartsheet/api/sdktest/RowTest.java
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md

📝 Walkthrough

Walkthrough

Adds a Proof model and ProofType enum, exposes proofs on row objects, adds PROOFS inclusion values for sheets, reports, and rows, and extends model and retrieval tests with proof data.

Changes

Proof SDK support

Layer / File(s) Summary
Proof model contract
src/main/java/com/smartsheet/api/models/Proof.java, src/main/java/com/smartsheet/api/models/enums/ProofType.java, src/test/java/com/smartsheet/api/models/ProofTest.java
Adds proof metadata fields, fluent accessors, proof type values, and tests for accessors and JSON wire names.
Row and inclusion integration
src/main/java/com/smartsheet/api/models/AbstractRow.java, src/main/java/com/smartsheet/api/models/enums/*Inclusion.java, src/test/java/com/smartsheet/api/internal/ReportResourcesImplTest.java, src/test/java/com/smartsheet/api/sdktest/RowTest.java, src/test/resources/getReport.json, CHANGELOG.md
Adds proof accessors to rows, enables proofs inclusions, verifies parsed row and report proof values, updates the fixture, and documents the additions.

Estimated code review effort: 3 (Moderate) | ~20 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding proofs support for getSheet and getReport.
Description check ✅ Passed The description includes a clear summary, change list, and issue reference, so it is mostly complete despite lacking the checklist section.
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-support

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

@smar-ivan-sandev
smar-ivan-sandev merged commit 7643e90 into mainline Jul 21, 2026
3 checks passed
@smar-ivan-sandev
smar-ivan-sandev deleted the add-proofs-support branch July 21, 2026 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants