Clarify AVP request shape requirements and compatibility testing results in README

[kjdev]

Summary by CodeRabbit

• Documentation
  • Clarified which top-level request parameters are required versus optional in API documentation.
  • Updated parameter descriptions to specify required parameters (policyStoreId, principal, action, resource) and optional parameters (context, entities).
  • Added compatibility statement describing behavioral parity and conformance testing results with the upstream system.

[coderabbitai]

📝 Walkthrough

Walkthrough

README documentation clarifies which request keys are required versus optional for AVP-compatible authorization calls and adds a compatibility guarantee asserting behavioral parity with the upstream nxe-cedar snapshot via official conformance testing results.

Changes

AVP Documentation

Layer / File(s)	Summary
AVP-compatible request shape documentation README.md	The request shape example inline comments are updated to clarify required vs. optional top-level keys (policyStoreId, principal, action, resource, context), marking entities as optional. A new paragraph documents that policyStoreId, principal (for isAuthorized()), action, and resource are required, while context and entities are optional and may be omitted; requests with only required keys remain valid.
AVP compatibility guarantee README.md	A new paragraph asserts the evaluation engine is logically identical to the upstream nxe-cedar snapshot, inheriting 100% C-vs-reference parity across the official conformance corpus, with the guarantee explicitly scoped to the supported subset and excluding unsupported features such as entity tags, policy templates, schema validation, and dynamic identity sources.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• kjdev/php-ext-cedar#6: Both PRs clarify AVP compatibility documentation for isAuthorizedWithToken() request handling—main PR documents required vs. optional keys, while the related PR clarifies token precedence and ignored inputs.

Poem

🐰 With clarity hopping through each line,
The AVP request shape now shines so fine!
Required keys marked, optional ones too,
Conformance parity proves we're true—
Documentation blooms like clover in spring! 🍀

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
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.
Title check	✅ Passed	The title clearly and specifically describes the main changes: updating documentation about AVP request shape requirements and compatibility testing results in the README.

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

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/readme

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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