docs(guides): make authentication and authorization guides SDK-agnostic#360
Conversation
The authentication and authorization REST API guides are vendored into
downstream documentation sites where they apply to multiple SDKs, not just
OpenTDF. Neutralize OpenTDF-centric framing ("your OpenTDF integration",
"The OpenTDF platform is...") to "the platform" while keeping all auth
mechanics intact — OIDC, client credentials, DPoP, ConnectRPC endpoints,
and decision values are unchanged. OpenTDF is still named where it refers
to the actual product (quickstart, the reference IdP, otdfctl CLI example).
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
|
Warning Review limit reached
Next review available in: 47 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe authentication and Authorization REST API guides were revised to use generic platform terminology, clarify HTTP and CLI authentication flows, and expand CORS and audience-claim guidance. ChangesAuthentication documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in authentication-guide.mdx and authorization-rest-api.mdx to simplify and generalize the terminology, replacing specific references to 'OpenTDF' with 'the platform' or 'platform SDKs'. It also clarifies CLI authentication usage. There are no review comments to address, so no feedback is provided.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/guides/authentication-guide.mdx`:
- Line 157: Update the “Configure CORS” checklist item in the authentication
guide to explicitly apply only to browser-based applications or clients with a
browser origin, while preserving the existing requirement to register that
origin in both the IdP and platform.
In `@docs/guides/authorization-rest-api.mdx`:
- Line 115: Update the authorization guide sentence to refer to the JWT field as
the exact `aud` claim, while retaining “audience mapper” when describing the
Keycloak client configuration.
🪄 Autofix (Beta)
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
Run ID: 1df73dfc-9846-4db0-a1af-5d5dfb1a166b
📒 Files selected for processing (2)
docs/guides/authentication-guide.mdxdocs/guides/authorization-rest-api.mdx
|
📄 Preview deployed to https://opentdf-docs-pr-360.surge.sh |
Address review feedback: the CORS checklist item applies only to browser-based clients, and the JWT claim is `aud` (keeping "audience mapper" for the Keycloak client config). Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
) ## Summary Follow-up to the auth-guides PR (#360). Neutralizes OpenTDF-centric **framing prose** to "the platform" on the remaining pages that are vendored into the Virtru developer-docs site (`sdks: [opentdf, data-harbor]`), so the same source renders correctly on both opentdf.io and secure.virtru.com. Same **balanced** approach as #360: only framing is generalized. Real product/spec names, GitHub source links, quickstart references, the reference IdP, and the TDF spec/schema itself are left intact. `otdfctl` / "OpenTDF CLI" references are out of scope (tracked under a separate CLI ticket). ## Changes - **`docs/guides/subject-mapping-guide.md`** — 9 framing edits (intro, architecture description, diagram labels, admin/troubleshooting prose, FAQ). Kept: all `opentdf/platform` source links, the `opentdf-app` JSON example, and the Quickstart references. - **`docs/components/`** — 3 framing edits: `key_access.md`, `policy/subject_mappings.md`, `policy/keymanagement/key_managers.md`. ## Assessed, no changes needed - **`docs/spec/`** — every "OpenTDF" mention names the specification/format itself (spec title, "OpenTDF (Trusted Data Format)", reference implementation, schema paths). No-op, same finding as the SDK reference pages. - **`docs/components/`** (remainder) — all other mentions are source links, `/spec/schema/opentdf/` paths, version references, and CLI references (deferred). ## Testing - `npm run build` — succeeds (broken-anchor warnings are all pre-existing on untouched lines). - `npm run check-vendored-yaml` — passes. - Vale — no new findings on changed lines. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated Key Access Server, key manager, and subject mapping documentation to use consistent platform terminology. * Refined the subject mapping guide’s architecture, scaling, troubleshooting, and FAQ language for improved clarity. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Mary Dickson <mary.dickson@virtru.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2 participants
Summary
The Authentication Decision Guide and Authorization REST API Guide are vendored into downstream documentation sites where they apply to multiple SDKs, not just OpenTDF. This rewrites the prose to be SDK-agnostic so the same source reads correctly for any reader, while keeping all auth mechanics intact.
## How Authentication Works in OpenTDF→## How Authentication Works, and the mermaidPlatformparticipant label.otdfctlexample (it's the real OpenTDF CLI in this repo).Test plan
vale— 0 errors/warnings on both filesnpm run build— completes; no new broken links or anchors on either pagecheck-vendored-yamlpasses🤖 Generated with Claude Code
Summary by CodeRabbit