docs(authz): add v2 Authorization API request validation limits#325
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ 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 (1)
📝 WalkthroughWalkthroughAdds v2 Authorization Service documentation for protovalidate-enforced request validation limits and updates the Vale vocabulary to accept the terms Changesv2 Authorization Request Validation
Estimated Code Review Effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly Related Issues
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 |
There was a problem hiding this comment.
Code Review
This pull request introduces documentation for v2 Authorization API request validation limits and updates the project's vocabulary list. Review feedback focuses on improving the documentation's accuracy and readability by defining the PEP acronym, ensuring consistent formatting with backticks, and correcting the list of endpoints affected by specific validation limits.
|
📄 Preview deployed to https://opentdf-docs-pr-325.surge.sh |
a0742fc to
0e996c4
Compare
Document the hard-coded protovalidate constraints on v2 Authorization API requests (entity chain size, attribute values count, obligation FQNs, batch sizes). These limits were previously only visible in the proto source and auto-generated OpenAPI specs. Refs: opentdf/platform#3500, opentdf/platform#3502 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
- Add GetDecisionBulk to fulfillable_obligation_fqns endpoints (bulk requests contain GetDecisionMultiResourceRequest objects) - Expand PEP acronym on first use Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
The tagging service doesn't exist in opentdf — clarify it's Virtru's. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
a447db0 to
5364f9b
Compare
Surface the limits where developers will see them — in the Entity Identifier, Resource, and endpoint descriptions — not just in the summary table below. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/components/authorization.md`:
- Line 158: The documentation is inconsistent: the table row for
`fulfillable_obligation_fqns` lists `GetDecision`, `GetDecisionMultiResource`,
and `GetDecisionBulk`, but the endpoint breakdown only documents it for
`GetDecision` and `GetDecisionMultiResource`; update the docs so both places
match—either add `GetDecisionBulk` to the endpoint breakdown or remove it from
the table row—by editing the `fulfillable_obligation_fqns` entries so the list
of endpoints (`GetDecision`, `GetDecisionMultiResource`, `GetDecisionBulk`) is
consistent across the `fulfillable_obligation_fqns` field documentation and the
endpoint breakdown.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1492429e-964f-4268-8383-2dda5f50597c
📒 Files selected for processing (2)
.github/vale-styles/config/vocabularies/Opentdf/accept.txtdocs/components/authorization.md
✅ Files skipped from review due to trivial changes (1)
- .github/vale-styles/config/vocabularies/Opentdf/accept.txt
Each inner GetDecisionMultiResourceRequest carries its own fulfillable_obligation_fqns — make the endpoint breakdown consistent with the summary table. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
Summary
performantandprotovalidateto the Vale vocabularyLimits documented
EntityIdentifier.entity_chain.entitiesGetDecision,GetDecisionMultiResource,GetDecisionBulk,GetEntitlementsResource.attribute_values.fqnsGetDecision,GetDecisionMultiResource,GetDecisionBulkfulfillable_obligation_fqnsGetDecision,GetDecisionMultiResourceGetDecisionMultiResourceRequest.resourcesGetDecisionMultiResource,GetDecisionBulkGetDecisionBulkRequest.decision_requestsGetDecisionBulkAll limits verified against the v2 authorization proto.
Context
A customer encountered the 20-attribute-value limit when using Virtru for Microsoft Outlook with 19 user-defined attribute values — the PEP added system attributes that pushed the total over 20. An audit of all v2 Authorization API validation limits confirmed that none were documented in prose documentation.
Related
Test plan
npm run buildpasses🤖 Generated with Claude Code