Skip to content

docs(authz): add v2 Authorization API request validation limits#325

Merged
marythought merged 5 commits into
mainfrom
DSPX-3319-authz-validation-limits
May 20, 2026
Merged

docs(authz): add v2 Authorization API request validation limits#325
marythought merged 5 commits into
mainfrom
DSPX-3319-authz-validation-limits

Conversation

@marythought
Copy link
Copy Markdown
Contributor

@marythought marythought commented May 20, 2026

Summary

  • Add a Request Validation Limits section to the v2 Authorization Service documentation, documenting all hard-coded protovalidate constraints
  • Include a note about the effective attribute values limit being lower than 20 due to system-added attributes (tagging service, default attributes)
  • Add performant and protovalidate to the Vale vocabulary

Limits documented

Field Min Max Endpoints
EntityIdentifier.entity_chain.entities 1 10 GetDecision, GetDecisionMultiResource, GetDecisionBulk, GetEntitlements
Resource.attribute_values.fqns 1 20 GetDecision, GetDecisionMultiResource, GetDecisionBulk
fulfillable_obligation_fqns 0 50 GetDecision, GetDecisionMultiResource
GetDecisionMultiResourceRequest.resources 1 1,000 GetDecisionMultiResource, GetDecisionBulk
GetDecisionBulkRequest.decision_requests 1 200 GetDecisionBulk

All 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

  • Verify npm run build passes
  • Verify the new section renders correctly on the authorization service page
  • Confirm the :::note admonition renders as expected

🤖 Generated with Claude Code

@marythought marythought requested review from a team as code owners May 20, 2026 17:53
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 2026

Warning

Rate limit exceeded

@marythought has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 50 minutes and 47 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e95a94cb-49e6-40c0-812c-ce55cb546eff

📥 Commits

Reviewing files that changed from the base of the PR and between bf42337 and d36623e.

📒 Files selected for processing (1)
  • docs/components/authorization.md
📝 Walkthrough

Walkthrough

Adds v2 Authorization Service documentation for protovalidate-enforced request validation limits and updates the Vale vocabulary to accept the terms performant and protovalidate.

Changes

v2 Authorization Request Validation

Layer / File(s) Summary
Vale vocabulary configuration
.github/vale-styles/config/vocabularies/Opentdf/accept.txt
Added performant and protovalidate to the accepted vocabulary list to prevent lint warnings.
v2 Authorization Service validation limits documentation
docs/components/authorization.md
Added v2-only "Request Validation Limits" for GetDecision, GetDecisionMultiResource, GetDecisionBulk, and GetEntitlements; added explicit v2 bounds for Entity Identifier (1–10 entities per chain) and Resource attribute value FQNs (1–20); noted effective attribute_values may be lower due to automatic FQN additions and linked to the v2 proto for full definitions.

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly Related Issues

Suggested Reviewers

  • elizabethhealy
  • eugenioenko
  • jp-ayyappan

Poem

🐰 I hopped through docs to make things clear,
Protovalidate boundaries now appear,
Two words accepted, no linting fright,
Requests constrained, all tidy and tight. 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title directly and accurately summarizes the main change: adding v2 Authorization API request validation limits documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DSPX-3319-authz-validation-limits

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/components/authorization.md
Comment thread docs/components/authorization.md Outdated
@github-actions
Copy link
Copy Markdown
Contributor

📄 Preview deployed to https://opentdf-docs-pr-325.surge.sh

@marythought marythought force-pushed the DSPX-3319-authz-validation-limits branch from a0742fc to 0e996c4 Compare May 20, 2026 18:07
marythought and others added 3 commits May 20, 2026 11:48
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>
@marythought marythought force-pushed the DSPX-3319-authz-validation-limits branch from a447db0 to 5364f9b Compare May 20, 2026 18:48
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>
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between a0742fc and bf42337.

📒 Files selected for processing (2)
  • .github/vale-styles/config/vocabularies/Opentdf/accept.txt
  • docs/components/authorization.md
✅ Files skipped from review due to trivial changes (1)
  • .github/vale-styles/config/vocabularies/Opentdf/accept.txt

Comment thread docs/components/authorization.md
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>
Copy link
Copy Markdown
Contributor

@jp-ayyappan jp-ayyappan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants