feat(docs): document SDK v0.16.0 changes#302
Conversation
- Add KAS error classification section (breaking change): ErrTampered vs ErrKASRequestError distinction with migration guide - Add OIDC trailing-slash issuer troubleshooting for Authentik-style IDPs - Add GetObligationTrigger RPC documentation with Go/JS examples Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 46 minutes and 20 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughDocumentation expanded with two additions: API reference for GetObligationTrigger operation across Go and JavaScript SDKs, and troubleshooting guides addressing OIDC Discovery issuer URL handling and KAS error classification changes in Go SDK v0.16.0+. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Code Review
This pull request updates the SDK documentation by adding a 'Get an Obligation Trigger' section to the obligations guide and two new troubleshooting entries regarding OIDC discovery issues and KAS error classification changes in Go SDK v0.16.0. Feedback suggests clarifying whether the OIDC fix applies to non-Go SDKs and improving consistency in the error classification table by adding the 'sdk.' prefix to sentinel names.
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/sdks/troubleshooting.mdx (1)
36-38: Scope the affected SDK explicitly in the cause text.Line 36 says “SDK versions before v0.16.0,” but this fix appears Go-specific (Line 38). Please explicitly state “Go SDK versions before v0.16.0” in the cause section to avoid ambiguity for JavaScript/Java readers.
Suggested wording
-**Cause**: Some identity providers (e.g., [Authentik](https://goauthentik.io/)) include a trailing slash in their OIDC issuer URL (e.g., `https://idp.example/app/`). SDK versions before v0.16.0 concatenated this with `/.well-known/openid-configuration`, producing a double-slash URL that returned a redirect instead of JSON. +**Cause**: Some identity providers (e.g., [Authentik](https://goauthentik.io/)) include a trailing slash in their OIDC issuer URL (e.g., `https://idp.example/app/`). **Go SDK versions before v0.16.0** concatenated this with `/.well-known/openid-configuration`, producing a double-slash URL that returned a redirect instead of JSON.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/sdks/troubleshooting.mdx` around lines 36 - 38, Change the ambiguous phrase "SDK versions before v0.16.0" in the Cause section to explicitly read "Go SDK versions before v0.16.0" so readers of other SDK docs (JS/Java) won't be confused; likewise ensure the Solution line that mentions url.JoinPath remains or is clarified to reference the Go SDK (e.g., keep "Go SDK v0.16.0+" and the mention of url.JoinPath) so both the Cause and Solution consistently identify the Go SDK.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/sdks/troubleshooting.mdx`:
- Around line 36-38: Change the ambiguous phrase "SDK versions before v0.16.0"
in the Cause section to explicitly read "Go SDK versions before v0.16.0" so
readers of other SDK docs (JS/Java) won't be confused; likewise ensure the
Solution line that mentions url.JoinPath remains or is clarified to reference
the Go SDK (e.g., keep "Go SDK v0.16.0+" and the mention of url.JoinPath) so
both the Cause and Solution consistently identify the Go SDK.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8bda6d3e-8158-4bd6-a185-254cb7ce5e1c
📒 Files selected for processing (2)
docs/sdks/obligations.mdxdocs/sdks/troubleshooting.mdx
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
📄 Preview deployed to https://opentdf-docs-pr-302.surge.sh |
GetObligationTrigger is only available in the Go SDK as of v0.16.0. The JS web-sdk has not yet generated this method. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Clarify OIDC trailing-slash issue is Go SDK specific (JS unaffected) - Add sdk. prefix to error sentinels in KAS classification table Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
Documents user-facing changes from the SDK v0.16.0 release:
ErrKASRequestErrorsentinel distinguishes misconfiguration from tamper. Adds migration guide with error classification table and code snippet for Go SDK consumers who checkErrTampered. (opentdf/platform#3166)unexpected end of JSON inputduring OIDC discovery with IDPs like Authentik that use trailing-slash issuer URLs. (opentdf/platform#3261)Test plan
npx docusaurus buildsucceedsvalepasses with 0 errors/warnings/suggestions🤖 Generated with Claude Code