Repository navigation
Split enterprise API references by component - #1218
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The API split is coherent and accurate, with only one nonblocking stale internal link remaining.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Splits the combined platform API reference into discoverable, component-specific pages while preserving the existing index and anchors.
Changes:
- Adds dedicated API references with service, port, base URL, and port-forward guidance.
- Adds gateway reference navigation and introduction links.
- Updates Enterprise Manager API links; one stale internal link remains.
| File | Description |
|---|---|
sidebars.ts |
Adds the new API references to navigation. |
docs/platform/enterprise-platform/enterprise-manager-api.mdx |
Adds the Enterprise Manager reference page. |
docs/platform/enterprise-platform/configure-connector-gateway.mdx |
Links directly to the Enterprise Manager API. |
docs/platform/enterprise-platform/api-reference.mdx |
Converts the combined reference into an index. |
docs/connector-gateway/index.mdx |
Links to relevant API references. |
docs/connector-gateway/connector-policies.mdx |
Updates the Enterprise Manager API link. |
docs/connector-gateway/connector-authentication.mdx |
Updates the Enterprise Manager API link. |
docs/connector-gateway/api-reference.mdx |
Adds the Connector Gateway reference page. |
docs/ai-gateway/index.mdx |
Links to the management API reference. |
docs/ai-gateway/api-reference.mdx |
Adds the AI Gateway management reference page. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
rdimitrov
approved these changes
Oct 6, 2026
This branch was successfully deployed
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
The platform API reference embeds three complete specifications on a page with its table of contents disabled, making the gateway APIs difficult to find.
Give AI Gateway management, Connector Gateway, and Enterprise Manager their own reference pages. Add Reference groups to both gateway sidebars and links from their introductions. Keep the existing platform URL as an API index with its original section anchors, and update Enterprise Manager links to point directly to its reference.
Each reference identifies its Kubernetes Service, port, and base URL, provides a local port-forward example, and explains the
localhost:8080address used in rendered requests. Correct the AI Gateway API summary to describe caller identity and catalog reads. Reuse the existing generated specifications.Validation: production build, Prettier and ESLint checks on all changed files, and
git diff --checkpassed. Verified the original platform section anchors in generated HTML. Service names and ports were checked against component chart/operator source; port-forwards were not run against a live deployment.Type of change
Related issues/PRs
Gateway endpoint publishing and verification is tracked separately in #1217 and remains outside this PR's scope.
Submitter checklist
Content and formatting
Navigation
sidebars.ts) updated for added, deleted, reordered, or renamed filesReviewer checklist
Content