chore(docs): update Java/JS examples to use EntityIdentifier helpers#291
chore(docs): update Java/JS examples to use EntityIdentifier helpers#291marythought wants to merge 4 commits intomainfrom
Conversation
|
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 1 minutes and 54 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)
✨ 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 |
marythought
force-pushed
the
chore/entity-identifier-helpers-docs
branch
from
d45435b to
f137e39
Compare
|
📄 Preview deployed to https://opentdf-docs-pr-291.surge.sh |
![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 SDK documentation for authorization and discovery to promote the use of helper functions for entity identification in Java and JavaScript. It replaces manual object and proto construction in examples with these helpers and moves the manual methods into collapsible sections for better readability. The review feedback correctly identifies that the 'Supported entity types' table now omits 'Claims' and 'Registered Resource' types which were previously documented, and notes an inconsistency in the naming convention for Java helpers within that table.
All three SDKs now ship convenience constructors for EntityIdentifier (Go: ForEmail, Java: EntityIdentifiers.forEmail, JS: forEmail). Update the authorization and discovery docs to use these helpers instead of verbose nested proto/object construction. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Update JS examples to use `EntityIdentifiers.forEmail(...)` instead of bare `forEmail(...)` to match opentdf/web-sdk#916. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Address Gemini review feedback: - Restore Claims and Registered Resource rows to entity types table - Add EntityIdentifiers. prefix to Java column for consistency Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
marythought
force-pushed
the
chore/entity-identifier-helpers-docs
branch
from
8908184 to
e921be4
Compare
1 participant
Summary
EntityIdentifiershelper tables and examples for Java and JavaScript to the EntityIdentifier reference section (now in language tabs)EntityIdentifiers.forEmail(...)instead of verboseEntityIdentifier.newBuilder().setEntityChain(...)constructionEntityIdentifiers.forEmail(...)instead of verbose nested object literals<details>blocks for referenceRelated
EntityIdentifiers(deprecates feat(sdk): add EntityIdentifier convenience constructors web-sdk#911)EntityIdentifiersconvenience constructorsEntityIdentifierhelpersTest plan
npm run build) passes🤖 Generated with Claude Code