feat(docs): document SDK.IsHealthy and link unresolved type references#311
Merged
marythought merged 4 commits intomainfrom Apr 30, 2026
Merged
feat(docs): document SDK.IsHealthy and link unresolved type references#311marythought merged 4 commits intomainfrom
marythought merged 4 commits intomainfrom
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughDocumentation-only updates across four SDK docs: authorization, platform-client, policy, and TDF. Changes add internal cross-references, new subsections (ActionsList, GetDecisionMultiResourceRequest, Binding, RequiredObligations), and a Platform IsHealthy health-check section. No code or public API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 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. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces documentation for the IsHealthy health check method in the Go SDK, including a code example and a return values table. The review feedback highlights the need for more accurate error messaging in the example and consistent formatting for status values and error types in the documentation.
Contributor
|
📄 Preview deployed to https://opentdf-docs-pr-311.surge.sh |
marythought
changed the title
Add a Health checks section to platform-client.mdx covering the new IsHealthy(ctx) method shipped in opentdf/platform sdk v0.18.0 (opentdf/platform#3412). Documents the (bool, error) contract, SERVING/NOT_SERVING/UNKNOWN behavior, and the IPC mode and transport error sentinels. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Several PascalCase type cells in SDK reference tables were rendering as
plain text instead of links to their definitions, forcing readers to
scroll or grep to learn the type's shape.
authorization.mdx:
- Link Action cells to /sdks/policy#action
- Add GetDecisionMultiResourceRequest heading inline so its parameter cell
resolves to a real anchor
tdf.mdx:
- Add RequiredObligations entry to the Type Reference and link the
TriggeredObligations cell
- Promote Manifest sub-tables (EncryptionInformation, KeyAccess, Payload)
to H4 subheadings so they have anchors; disambiguate Payload with
{#manifest-payload} since the TDF Reader method already owns #payload
- Fully link the Assertion fields table (AssertionType, Scope,
AppliesToState, Statement, Binding) and add a Binding type-ref entry
- Link AssertionKey in AssertionVerificationKeys.DefaultKey
policy.mdx:
- Link SubjectSet in UpdateSubjectConditionSet parameters
- Link SubjectProperty in MatchSubjectMappings parameters
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
authorization.mdx: - Link map<string, ActionsList> in EntityEntitlements.actionsPerAttributeValueFqn and add a new Type Reference entry explaining the protobuf wrapper (ActionsList exists because protobuf maps cannot have repeated value types directly). The new section documents the actions field and how Go/Java/JS surface the wrapper. - Update obligations link in the GetDecision Returns description to point at /sdks/obligations (the SDK obligations page) instead of /components/policy/obligations. The SDK page is the right target for readers learning how to handle obligations from SDK code. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Address Gemini Code Assist review feedback: the previous example logged "platform unreachable" for any non-nil err, which misrepresents the IPC mode case. Update the comment to enumerate the three error sources (ErrHealthCheckUnsupported, wrapped ErrPlatformUnreachable on transport failure, wrapped ErrPlatformUnreachable on ctx cancellation) and switch the log line to a generic "health check failed" message. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
marythought
force-pushed
the
feat/health-check-docs
branch
from
70742fe to
20a7446
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two related changes in one PR:
1. Document
SDK.IsHealthy(ctx)reachability probeAdds a Health checks section to
docs/sdks/platform-client.mdxcovering the newSDK.IsHealthy(ctx) (bool, error)method shipped in opentdf/platform sdk v0.18.0 (opentdf/platform#3412).The section documents:
(bool, error)contract and when to reach for it (readiness probes, smoke tests, startup gating)SERVING/NOT_SERVING/UNKNOWNreturn semanticsErrHealthCheckUnsupported) and transport failure (ErrPlatformUnreachable) sentinelsGo-only — IsHealthy is a server-side readiness concern and is not planned for the web SDK.
2. Link unresolved type references in SDK reference tables
Several PascalCase type cells in SDK reference tables were rendering as plain text instead of links to their definitions, forcing readers to scroll or grep to learn the type's shape.
authorization.mdxActioncells to/sdks/policy#action### GetDecisionMultiResourceRequestheading so its parameter cell resolves to a real anchortdf.mdxRequiredObligationsto the Type Reference and link theTriggeredObligationscellEncryptionInformation,KeyAccess,Payload) to H4 subheadings; disambiguate Payload with{#manifest-payload}since the TDF Reader method already owns#payloadAssertionfields table (AssertionType,Scope,AppliesToState,Statement,Binding) and add aBindingtype-ref entryAssertionKeyinAssertionVerificationKeys.DefaultKeypolicy.mdxSubjectSetinUpdateSubjectConditionSetparametersSubjectPropertyinMatchSubjectMappingsparametersTest plan
npm run buildpasses — no new broken anchors introducedvale docs/sdks/platform-client.mdxcleanSdkVersionbadge shows0.18.0for Go🤖 Generated with Claude Code
Summary by CodeRabbit