fix(docs): standardize Java platformEndpoint() to use absolute URLs#272
fix(docs): standardize Java platformEndpoint() to use absolute URLs#272marythought merged 3 commits intomainfrom
Conversation
Update all Java SDKBuilder.platformEndpoint() snippets in authentication.mdx to use absolute URLs (http:// or https://) instead of bare host:port strings, matching the format used in other SDK examples on the same page. Closes #260 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
📝 WalkthroughWalkthroughAdded Java docs updates to standardize Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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.
Code Review
This pull request updates the Java SDK documentation to include protocol prefixes in the platformEndpoint configuration examples. A review comment suggests adding .useInsecurePlaintextConnection(true) to the custom grant example to maintain consistency with other local development snippets in the documentation.
|
📄 Preview deployed to https://opentdf-docs-pr-272.surge.sh |
…nection Updates vendored OpenAPI specs to match upstream platform and adds missing .useInsecurePlaintextConnection(true) to custom grant Java example for consistency with other localhost examples. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/sdks/authentication.mdx (1)
99-105: Consider extracting these Java examples intocode_samples/.These are substantial inline snippets; moving them to
code_samples/and referencing them from this page will reduce drift and keep cross-SDK docs easier to maintain.As per coding guidelines,
docs/**/*.{md,mdx}: Keep long examples incode_samples/and reference them from docs instead of duplicating.Also applies to: 186-200, 253-263
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/sdks/authentication.mdx` around lines 99 - 105, The inline Java SDK example using SDKBuilder (calls: platformEndpoint, tokenExchange, useInsecurePlaintextConnection, build) should be extracted into a standalone file under code_samples/ (e.g., code_samples/java/authentication.java) and the docs/sdks/authentication.mdx page should be updated to reference/import that sample instead of embedding the snippet; move the other long Java blocks noted (lines ~186-200 and ~253-263) into appropriately named files under code_samples/ and replace each inline example with a brief reference or code import so the MDX page points to the external samples for maintainability.
🤖 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/authentication.mdx`:
- Around line 99-105: The inline Java SDK example using SDKBuilder (calls:
platformEndpoint, tokenExchange, useInsecurePlaintextConnection, build) should
be extracted into a standalone file under code_samples/ (e.g.,
code_samples/java/authentication.java) and the docs/sdks/authentication.mdx page
should be updated to reference/import that sample instead of embedding the
snippet; move the other long Java blocks noted (lines ~186-200 and ~253-263)
into appropriately named files under code_samples/ and replace each inline
example with a brief reference or code import so the MDX page points to the
external samples for maintainability.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 51636db1-4d70-4775-8450-668ea6ab88e7
📒 Files selected for processing (3)
docs/sdks/authentication.mdxspecs/policy/namespaces/namespaces.openapi.yamlspecs/policy/selectors.openapi.yaml
✅ Files skipped from review due to trivial changes (1)
- specs/policy/selectors.openapi.yaml
Summary
SDKBuilder.platformEndpoint()snippets inauthentication.mdxto use absolute URLs (http://orhttps://) instead of barehost:portstringslocalhost:8080→http://localhost:8080, 2xplatform.example.com→https://platform.example.comCloses #260
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Documentation