Add setting up with entra id guide and update getting started guide for AI Gateway - #400
Merged
Merged
Conversation
- Introduced a new guide for configuring Microsoft Entra ID as an identity provider, detailing application registration, role definitions, and Platform API configuration. - Updated navigation to include the new guide and revised the overview to reference both Asgardeo and Entra ID setup guides for clarity.
- Introduced a new Quick Start Guide for the AI Gateway, detailing setup and deployment processes for LLM providers and proxies. - Updated navigation to include the new guide and revised the title of the section on managing gateway-deployed AI artifacts for clarity. - Enhanced documentation for LLM and MCP proxies to include information on viewing deployed artifacts in AI Workspace.
|
Warning Review limit reached
Next review available in: 23 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (25)
📝 WalkthroughWalkthroughThe documentation adds an AI Gateway quick-start guide, explains gateway artifact synchronization to AI Workspace, and documents Microsoft Entra ID authentication and authorization configuration. ChangesAI Gateway documentation
Microsoft Entra ID authentication
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ 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 |
…ompose up' for consistency across various guides and sections. This change simplifies the command for starting services without the detached mode.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 11
🤖 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 `@en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md`:
- Around line 130-133: Update the earlier MCP proxy YAML sample to include the
metadata.annotations entry for gateway.api-platform.wso2.com/project-id, using
the project identifier referenced by the AI Workspace section. Keep the existing
explanation that the proxy appears in the named project consistent with this
annotation.
In `@en/docs/ai-gateway/next/quick-start-guide.md`:
- Around line 54-64: Update the quick-start commands to use one consistent
version placeholder for the release URL, archive filename, and extracted
directory; ensure the cd target matches the actual extracted directory name,
such as wso2apip-ai-gateway-1.2.0-rc/ for the shown version.
In
`@en/docs/next/ai-workspace/setting-up/authentication/connect-an-identity-provider.md`:
- Line 220: Update the Microsoft Entra ID reference text to state that
authorization uses application roles rather than scope-based authorization,
while explicitly noting that the required API access scope (such as
api://<CLIENT_ID>/access) is still needed for token acquisition.
- Around line 167-169: Rewrite the authorization bullet under “Four things to
get right” in plain language and split its claims into shorter, direct
statements. Explain separately that ai_workspace.auth.authorization must match
platform_api.auth.authorization, that role mode requires mounting the same
mapping file into the ai-workspace container, and that the UI uses /api/session
scopes while AI Workspace derives them from the token and roles mapping.
In `@en/docs/next/ai-workspace/setting-up/authentication/entra-id-setup.md`:
- Line 38: Update the AIW_HOST table description in the authentication
documentation to remove the spaces around the em dash, using the style-compliant
“—for example,” phrasing while preserving the surrounding text.
- Around line 160-168: Update the “Get the OIDC endpoints” section to define
each abbreviation at its first use: write “OpenID Connect (OIDC)” in the step
heading or introductory text and “JSON Web Key Set (JWKS)” in the endpoint table
before using OIDC or JWKS elsewhere.
- Around line 44-52: Reformat the tables in the authentication setup procedures
so they are not embedded within numbered steps, including the sections around
steps 1, 2.2, 5, 8, and 13. Move each table before or after its surrounding
numbered procedure, or convert it to an equivalent list while preserving all
settings and values.
- Around line 86-89: Revise the numbered permission-setup steps around the
repeated “Select” openings, including the corresponding steps later in the
document, by combining compatible actions or varying the phrasing while
preserving the existing navigation and permission choices.
- Line 3: Shorten the frontmatter description in the authentication setup
document to 158 characters or fewer while retaining that it configures Microsoft
Entra ID for production AI Workspace deployments and covers application
registration, app roles, and config.toml settings.
- Around line 47-52: Update the Entra ID registration instructions and
corresponding OIDC configuration reference so the post-logout redirect URL is
registered as a Web redirect URI; ensure the `/login` destination used by
`post_logout_redirect_url` matches one of the documented registered URIs, while
preserving the existing callback URI.
- Around line 196-204: Update the Microsoft Entra ID claim mappings in the
authentication setup documentation so organization metadata uses tenant-level
claims: retain tid for organization identity and replace the oid mappings for
org_handle and org_name with appropriate tenant name and slug claims, or
document dedicated claims if required. Apply the same correction to the second
claim-mapping block and ensure users from the same tenant resolve identical
organization metadata.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: b5b2a74f-73ef-4f35-a6e1-cc55c1ce5832
📒 Files selected for processing (8)
en/docs/ai-gateway/next/llm-proxy/quick-start-guide.mden/docs/ai-gateway/next/mcp-proxy/quick-start-guide.mden/docs/ai-gateway/next/quick-start-guide.mden/docs/next/ai-workspace/setting-up/authentication/connect-an-identity-provider.mden/docs/next/ai-workspace/setting-up/authentication/entra-id-setup.mden/docs/next/ai-workspace/setting-up/authentication/overview.mden/docs/next/ai-workspace/sync-gateway-created-artifacts.mden/mkdocs.yml
- Introduced a new section on streaming responses in the AI Gateway documentation, detailing how the gateway handles streamed responses from upstream services. - Added links to the new streaming responses documentation in both the 1.1.0 and next versions of the AI Gateway overview. - Updated navigation to include the new streaming responses pages for better accessibility.
…racy - Revised the Quick Start Guide for the AI Gateway to specify version `1.2.0-rc` in the setup commands. - Added a `project-id` annotation to the MCP proxy example in the AI Workspace guide for better context. - Enhanced the identity provider setup guide for Microsoft Entra ID by clarifying application registration steps and role definitions, ensuring consistency in terminology and formatting.
Krishanx92
approved these changes
Aug 4, 2026
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
2 participants
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.
$subject