feat(ai-gateway): Align AI entity docs with the changed API schema#5658
Open
tomek-labuk wants to merge 2 commits into
Open
feat(ai-gateway): Align AI entity docs with the changed API schema#5658tomek-labuk wants to merge 2 commits into
tomek-labuk wants to merge 2 commits into
Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
tomek-labuk
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the AI Gateway entity reference pages to align terminology and guidance with the “AI Entity” naming (AI Model/Provider/Policy/etc.), expands several pages with additional explanatory sections (for example, provider auth details and model capability mappings), and standardizes metadata like min_version.
Changes:
- Standardize AI Gateway entity terminology (headings, FAQs, related resources) to consistently use “AI …” naming.
- Add/expand conceptual guidance sections (for example, AI Provider authentication details; AI Vault backend selection; AI Model capability/path mapping; AI Gateway control plane vs data plane overview).
- Adjust frontmatter metadata across entity pages (notably
min_versionformatting andtoolslists).
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| app/_ai_gateway_entities/ai-vault.md | Renames content to “AI Vault”, adds backend selection guidance, and adjusts metadata/tooling references. |
| app/_ai_gateway_entities/ai-provider.md | Renames to “AI Provider”, expands auth documentation, and updates cross-links/metadata. |
| app/_ai_gateway_entities/ai-policy.md | Renames to “AI Policy”, expands scope/lifecycle narrative, and updates references/metadata. |
| app/_ai_gateway_entities/ai-model.md | Renames to “AI Model”, updates capability enums/mapping details, adds proxy/logging sections, and improves schema cross-links. |
| app/_ai_gateway_entities/ai-mcp-server.md | Renames to “AI MCP Server” and updates many schema cross-links and explanatory text. |
| app/_ai_gateway_entities/ai-gateway.md | Updates entity naming, adds control-plane vs data-plane section, and adjusts FAQs/metadata. |
| app/_ai_gateway_entities/ai-data-plane-node.md | Expands conceptual explanation and adds schema cross-links for key fields. |
| app/_ai_gateway_entities/ai-data-plane-certificate.md | Adjusts metadata/tools and hides an on-prem equivalence note. |
| app/_ai_gateway_entities/ai-consumer.md | Updates schema cross-links and revises membership/policy guidance (currently inconsistent—see comments). |
| app/_ai_gateway_entities/ai-consumer-group.md | Updates schema cross-links and revises membership guidance (currently inconsistent—see comments). |
| app/_ai_gateway_entities/ai-consumer-credential.md | Improves schema cross-links and clarifies credential-type descriptions. |
| app/_ai_gateway_entities/ai-agent.md | Renames to “AI Agent”, adds type explanation, and improves schema cross-linking throughout. |
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.
Description
Fixes #issue
Preview Links
-AI Consumer: https://deploy-preview-5658--kongdeveloper.netlify.app/ai-gateway/entities/ai-consumer/
Checklist
descriptionentry in frontmatter.