Merged
Conversation
- Change json code fences to http for blocks containing HTTP request lines (POST /path)
- Clarify endpoint paths: evaluation/search endpoints use /stores/{store_id}/access/v1/ but Get Configuration uses /.well-known/authzen-configuration/{store_id}
- Standardize X-Request-ID capitalization to match the spec throughout
https://claude.ai/code/session_015k651SaBn8rbLzynHrxuaB
Contributor
WalkthroughA new documentation page describing the AuthZEN API (experimental) has been added, detailing how to enable the feature, its endpoints, request/response semantics, ABAC support, batch evaluation behavior, and implementation notes. The sidebar configuration was updated to include this documentation. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Contributor
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/content/interacting/authzen.mdx (2)
22-22: Tighten wording in the integration recommendation sentence.The sentence is a bit awkward (
"and you use AuthZEN when you are integrating..."). Consider a shorter, clearer rewrite for readability.Suggested wording
-We recommend that you use the native API when integrating your application with <ProductName format={ProductNameFormat.ShortForm}/>, and you use AuthZEN when you are integrating an AuthZEN-compatible product like an API/MCP Gateway, or an Identity Provider. +We recommend using the native API when integrating your application with <ProductName format={ProductNameFormat.ShortForm}/>, and using AuthZEN when integrating with an AuthZEN-compatible product such as an API/MCP gateway or an identity provider.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/interacting/authzen.mdx` at line 22, Tighten the integration recommendation sentence: replace the awkward clause that reads "We recommend that you use the native API when integrating your application with <ProductName format={ProductNameFormat.ShortForm}/>, and you use AuthZEN when you are integrating an AuthZEN-compatible product..." with a concise alternative that uses the same symbols (<ProductName format={ProductNameFormat.ShortForm}/> and AuthZEN) and clearly contrasts use cases—for example: "Use the native API to integrate applications with <ProductName format={ProductNameFormat.ShortForm}/>; use AuthZEN only for AuthZEN-compatible products such as API/MCP Gateways or Identity Providers." Ensure the new sentence still includes the following note that AuthZEN cannot replace the native API for Write and Read endpoints (links to update-tuples.mdx and relationship-queries.mdx).
68-73: Use consistent header casing for product naming.
Openfga-Authorization-Model-Idworks technically, butOpenFGA-Authorization-Model-Idis clearer and aligns with product naming used elsewhere in docs.Suggested consistency update
-By default, AuthZEN endpoints use the latest authorization model in the store. To pin requests to a specific model version, pass the `Openfga-Authorization-Model-Id` header: +By default, AuthZEN endpoints use the latest authorization model in the store. To pin requests to a specific model version, pass the `OpenFGA-Authorization-Model-Id` header: @@ -Openfga-Authorization-Model-Id: 01G50QVV17PECNVAHX1GG4Y5NC +OpenFGA-Authorization-Model-Id: 01G50QVV17PECNVAHX1GG4Y5NC @@ -The AuthZEN spec does not define a standard way to pin requests to a specific model version. <ProductName format={ProductNameFormat.ShortForm}/> adds `Openfga-Authorization-Model-Id` as an OpenFGA-specific request header extension. +The AuthZEN spec does not define a standard way to pin requests to a specific model version. <ProductName format={ProductNameFormat.ShortForm}/> adds `OpenFGA-Authorization-Model-Id` as an OpenFGA-specific request header extension.Also applies to: 425-425
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/interacting/authzen.mdx` around lines 68 - 73, Update the header casing to match product naming by replacing `Openfga-Authorization-Model-Id` with `OpenFGA-Authorization-Model-Id` wherever it appears (e.g., the example POST block and the other occurrence flagged), ensuring the exact header string `OpenFGA-Authorization-Model-Id` is used consistently in the content and examples.
🤖 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/content/interacting/authzen.mdx`:
- Line 22: Tighten the integration recommendation sentence: replace the awkward
clause that reads "We recommend that you use the native API when integrating
your application with <ProductName format={ProductNameFormat.ShortForm}/>, and
you use AuthZEN when you are integrating an AuthZEN-compatible product..." with
a concise alternative that uses the same symbols (<ProductName
format={ProductNameFormat.ShortForm}/> and AuthZEN) and clearly contrasts use
cases—for example: "Use the native API to integrate applications with
<ProductName format={ProductNameFormat.ShortForm}/>; use AuthZEN only for
AuthZEN-compatible products such as API/MCP Gateways or Identity Providers."
Ensure the new sentence still includes the following note that AuthZEN cannot
replace the native API for Write and Read endpoints (links to update-tuples.mdx
and relationship-queries.mdx).
- Around line 68-73: Update the header casing to match product naming by
replacing `Openfga-Authorization-Model-Id` with `OpenFGA-Authorization-Model-Id`
wherever it appears (e.g., the example POST block and the other occurrence
flagged), ensuring the exact header string `OpenFGA-Authorization-Model-Id` is
used consistently in the content and examples.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 824ef3c9-b73b-4cbc-8784-dd6ece686fbf
📒 Files selected for processing (2)
docs/content/interacting/authzen.mdxdocs/sidebars.js
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for OpenFGA’s experimental AuthZEN interoperability API and exposes it in the Docusaurus sidebar under “Interacting with the API”.
Changes:
- Adds a new “AuthZEN API” doc entry to the docs sidebar navigation.
- Introduces a new MDX page documenting enabling the feature, available endpoints, request/response shapes, and implementation notes.
Reviewed changes
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/sidebars.js | Adds the new AuthZEN doc page to the “Interacting with the API” sidebar section. |
| docs/content/interacting/authzen.mdx | New documentation page describing the experimental AuthZEN API, endpoints, and behavior notes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit