Conversation
|
📄 Preview deployed to https://opentdf-docs-pr-276.surge.sh |
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation and code samples for the KAS Registry, covering server registration and key management across Go, Java, and JavaScript. The review feedback identifies a consistent error in the Java code examples where .execute() is incorrectly called on blocking service methods that already return the response object directly.
| var resp = sdk.getServices().kasRegistry() | ||
| .createKeyAccessServerBlocking(req, Collections.emptyMap()).execute(); |
There was a problem hiding this comment.
The Java SDK's blocking service methods return the response object directly. Calling .execute() on the result of createKeyAccessServerBlocking is incorrect as it contradicts the method signature provided in the documentation above.
var resp = sdk.getServices().kasRegistry()
.createKeyAccessServerBlocking(req, Collections.emptyMap());
| var resp = sdk.getServices().kasRegistry() | ||
| .listKeyAccessServersBlocking(req, Collections.emptyMap()).execute(); |
| var resp = sdk.getServices().kasRegistry() | ||
| .getKeyAccessServerBlocking(req, Collections.emptyMap()).execute(); |
| var resp = sdk.getServices().kasRegistry() | ||
| .updateKeyAccessServerBlocking(req, Collections.emptyMap()).execute(); |
There was a problem hiding this comment.
| var resp = sdk.getServices().kasRegistry() | ||
| .deleteKeyAccessServerBlocking(req, Collections.emptyMap()).execute(); |
There was a problem hiding this comment.
| var resp = sdk.getServices().kasRegistry() | ||
| .listKeysBlocking(req, Collections.emptyMap()).execute(); |
| var resp = sdk.getServices().kasRegistry() | ||
| .getKeyBlocking(req, Collections.emptyMap()).execute(); |
| var resp = sdk.getServices().kasRegistry() | ||
| .rotateKeyBlocking(req, Collections.emptyMap()).execute(); |
| var resp = sdk.getServices().kasRegistry() | ||
| .setBaseKeyBlocking(req, Collections.emptyMap()).execute(); |
| var resp = sdk.getServices().kasRegistry() | ||
| .getBaseKeyBlocking(req, Collections.emptyMap()).execute(); |
|
❌ Surge preview build failed — no preview was deployed. Check the workflow logs for details. Once the build passes, the preview will be at: https://opentdf-docs-pr-276.surge.sh Common cause: If the build failed on vendored YAML validation, run the following locally and commit the result: |
|
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 5 minutes and 43 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 (3)
📝 WalkthroughWalkthroughAdded comprehensive documentation for Key Access Server (KAS) Registry operations, including CreateKeyAccessServer and ListKeyAccessServers guides, plus a full KAS Registry reference covering server and key management operations. Also added OpenAPI schema support for attribute sorting and clarified timestamp parameter bounds in authorization specifications. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/sdks/kas-registry.mdx (1)
123-1240: Move long inline SDK examples intocode_samples/and include them here.This page still embeds very large per-language examples inline (Line 123 through Line 1240), which will be harder to maintain and keep consistent with SDK changes. Prefer extracting these examples to
code_samples/and importing them likeCreateKas/ListKas.As per coding guidelines, "Keep long examples in
code_samples/directory and reference them from docs instead of duplicating content."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/sdks/kas-registry.mdx` around lines 123 - 1240, The page currently embeds very long per-language examples (the Example blocks for GetKeyAccessServer, UpdateKeyAccessServer, CreateKey, ListKeys, GetKey, RotateKey, SetBaseKey, GetBaseKey and their TabItem/Tab code blocks), so extract each language-specific code sample into separate files under code_samples/ (one file per API + language), replace the inline fenced-code TabItem blocks with imports/references to those sample files (same pattern used by CreateKas/ListKas), and ensure the MDX imports reference the new sample filenames and the original example headings (e.g., GetKeyAccessServer, CreateKey, RotateKey) so the docs render the samples in place without duplicating large inline blocks.
🤖 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/kas-registry.mdx`:
- Around line 123-1240: The page currently embeds very long per-language
examples (the Example blocks for GetKeyAccessServer, UpdateKeyAccessServer,
CreateKey, ListKeys, GetKey, RotateKey, SetBaseKey, GetBaseKey and their
TabItem/Tab code blocks), so extract each language-specific code sample into
separate files under code_samples/ (one file per API + language), replace the
inline fenced-code TabItem blocks with imports/references to those sample files
(same pattern used by CreateKas/ListKas), and ensure the MDX imports reference
the new sample filenames and the original example headings (e.g.,
GetKeyAccessServer, CreateKey, RotateKey) so the docs render the samples in
place without duplicating large inline blocks.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1bdb2ce7-30d7-4e47-907d-bd66e87e3a09
📒 Files selected for processing (5)
code_samples/policy_code/create_kas.mdxcode_samples/policy_code/list_kas.mdxdocs/sdks/kas-registry.mdxspecs/authorization/authorization.openapi.yamlspecs/policy/attributes/attributes.openapi.yaml
Adds a new standalone SDK docs page covering all KeyAccessServerRegistry service methods across Go, Java, and JavaScript SDKs. Includes Setup section, KAS server CRUD, and key management operations. Each method follows the Signature/Parameters/Example/Returns/Errors pattern. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
e32a8c4 to
86aa54c
Compare
Summary
/sdks/kas-registry) covering the fullKeyAccessServerRegistryservice API https://opentdf-docs-pr-276.surge.sh/sdks/kas-registryTest plan
/sdks/kas-registry<details>blocks expand and language tabs switch properly🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
API Updates