Skip to content

docs(sdks): document sdk version for ForAction helper - #384

Merged
marythought merged 2 commits into
mainfrom
docs/DSPX-4247-foraction-sdk-version
Aug 11, 2026
Merged

docs(sdks): document sdk version for ForAction helper#384
marythought merged 2 commits into
mainfrom
docs/DSPX-4247-foraction-sdk-version

Conversation

@marythought

@marythought marythought commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds an ### Action subsection to docs/sdks/authorization.mdx, matching the existing EntityIdentifier/Resource pattern
  • Notes ForAction (Go, authorization/v2) requires SDK v0.30.0+ via the <SdkVersion> component
  • Links the existing action parameter-table mentions to the new section

Test plan

  • vale clean on changed file
  • npx docusaurus build succeeds; no new broken anchors introduced

Summary by CodeRabbit

  • Documentation
    • Added guidance for constructing actions in Go, Java, and JavaScript.
    • Documented the Go ForAction helper.
    • Updated decision and bulk-request parameter references to link to the new Action section.

Adds an Action subsection to authorization.mdx (parity with
EntityIdentifier/Resource) noting ForAction requires Go SDK v0.30.0+,
and links the existing parameter-table mentions to it.
@marythought
marythought requested review from a team as code owners August 11, 2026 16:36
@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: cd6e291a-f41c-40a3-a69a-be23e611910c

📥 Commits

Reviewing files that changed from the base of the PR and between 9fb2091 and c66028f.

📒 Files selected for processing (1)
  • docs/sdks/authorization.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/sdks/authorization.mdx

📝 Walkthrough

Walkthrough

The authorization SDK documentation adds action construction examples for Go, Java, and JavaScript. It also documents the Go ForAction helper and links action parameters to the new section.

Changes

Authorization Actions

Layer / File(s) Summary
Action construction documentation and references
docs/sdks/authorization.mdx
Adds Go, Java, and JavaScript action construction examples, including Go proto construction and the ForAction helper. Links action parameters in decision and bulk decision request tables to the new section.

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

Poem

I’m a rabbit with docs in my paws,
I link every action without flaws.
Go hops with ForAction in view,
Java and JavaScript join too.
Decision paths now point right—
Clear action guidance shines bright.

🚥 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 identifies the SDK documentation change for the ForAction helper and its version requirement.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/DSPX-4247-foraction-sdk-version

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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/sdks/authorization.mdx`:
- Line 245: Update the authorization documentation’s action example to use the
standard read action for TDF decryption flows; only retain decrypt when
explicitly labeled as a custom action.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 09ff61bf-74e0-465c-b0ef-e5c8e0f76445

📥 Commits

Reviewing files that changed from the base of the PR and between 60c14c6 and 9fb2091.

📒 Files selected for processing (1)
  • docs/sdks/authorization.mdx

Comment thread docs/sdks/authorization.mdx Outdated
@github-actions

Copy link
Copy Markdown
Contributor

📄 Preview deployed to https://opentdf-docs-pr-384.surge.sh

Comment thread docs/sdks/authorization.mdx Outdated
Comment thread docs/sdks/authorization.mdx
Comment thread docs/sdks/authorization.mdx Outdated
Comment thread docs/sdks/authorization.mdx Outdated
Comment thread docs/sdks/authorization.mdx Outdated
Comment thread docs/sdks/authorization.mdx Outdated
decrypt isn't a real action name — read, create, update, delete are
the standard actions (docs/components/policy/actions.md); read is what
covers TDF decrypt flows. Also clarifies that the action must already
be defined in policy — ForAction/manual construction only build the
reference, they don't create or validate it.

Addresses review from CodeRabbit and jp-ayyappan on PR #384.

@jp-ayyappan jp-ayyappan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@marythought
marythought merged commit 0104c04 into main Aug 11, 2026
10 checks passed
@marythought
marythought deleted the docs/DSPX-4247-foraction-sdk-version branch August 11, 2026 23:17
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