Add AI Gateway CRD and management API reference - #1118
Closed
blkt wants to merge 2 commits into
Closed
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
blkt
force-pushed
the
chore/ai-gateway-docs-groundwork
branch
from
August 25, 2026 18:19
d3c6fa3 to
3dde018
Compare
The chat assistant was removed from the Cloud UI on 2026-08-04 (`b9a4893fb1ac`, a breaking change that deleted the `/api/chat` route, its system prompt, and the whole `components/chat/` tree). The docs have described it as a live feature ever since. Removes the `AI assistant` page and every reference to it: the feature bullet and Next steps link in `intro.mdx` and `browse-catalog.mdx`, the `OPENROUTER_API_KEY` prerequisite, commented env example, and env-var table row in `configure.mdx`, and the `assistant` directive rows in the Cloud UI feature-flags section and the Enterprise Manager policy index. Both `Feature flags` sections lost their only real content and are gone or reduced accordingly. The deleted page gets a permanent redirect to the Cloud UI section index. Note for a separate platform-repo cleanup: the `assistant` directive still exists server-side (`config-server/config/config.go`) and in cloud-ui's generated types, but nothing consumes it now.
blkt
force-pushed
the
chore/remove-stale-cloud-ui-docs
branch
from
August 25, 2026 18:20
e98501f to
83911a8
Compare
blkt
force-pushed
the
chore/ai-gateway-docs-groundwork
branch
from
August 25, 2026 18:20
3dde018 to
4ac7a98
Compare
blkt
force-pushed
the
chore/ai-gateway-docs-groundwork
branch
from
August 25, 2026 18:22
4ac7a98 to
bafae41
Compare
blkt
marked this pull request as draft
August 25, 2026 18:22
blkt
force-pushed
the
chore/ai-gateway-docs-groundwork
branch
from
August 25, 2026 18:24
bafae41 to
054fbe6
Compare
blkt
force-pushed
the
chore/ai-gateway-docs-groundwork
branch
from
August 25, 2026 18:42
054fbe6 to
97d56e8
Compare
The AI Gateway ships two CRDs, `AIGateway` and `AIPolicy`, and a REST
management API, none of which were documented. Its landing page was a
value-prop page ending in a "documentation in progress" note, so the
navbar tab was a dead end.
Declares a second `crds:` set for the platform project in
.github/upstream-projects.yaml, sourced from the ai-gateway operator-crds
chart, and regenerates. The header comment in that file already
anticipated this case ("enterprise platform + AI gateway"). Sidebar
placement under `Govern the platform` is the one manual step.
Adds `crd-intros.mjs` entries for both kinds, with a new `aiGateway`
group. Without them the landing page files these two under "Shared
configuration", the DocCards read "Is the top-level resource for..." and
truncate mid-sentence, and both pages fall back to a bare "Schema
reference for X" meta description. The overrides also drop the upstream
description's reference to the Envoy Gateway resources the operator
manages.
Registers `management-api.openapi.yaml` as a redocusaurus spec and adds
the reference page, matching the two existing ToolHive specs.
Rewrites the AI Gateway landing page: the admonition is replaced by
pointers to the CRD and API references and to the platform install.
Incidental: regenerating also refreshed three `enterprise-crds` schemas,
which were missing `claimConditions` on the role-binding kinds. That is a
real staleness fix, not churn, but it rides along because generation runs
per project rather than per set. Generated MDX needs a `prettier --write`
pass afterwards or it lands unwrapped.
blkt
force-pushed
the
chore/ai-gateway-docs-groundwork
branch
from
August 25, 2026 18:47
97d56e8 to
14c4581
Compare
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
1 participant
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.
Stacked on #1117. Review that one first; the base will retarget to
mainonce it merges.What
The AI Gateway ships two CRDs (
AIGateway,AIPolicy) and a REST management API, none of which were documented. Its landing page was a value-prop page ending in a "documentation in progress" admonition, so a top-level navbar tab was a dead end.Changes
AI Gateway CRD reference. Declares a second
crds:set for thestacklok-enterprise-platformproject in.github/upstream-projects.yaml, sourced fromenterprise/ai-gateway/charts/operator-crds/files, then regenerates. The header comment in that file already anticipated this exact case ("suites that ship more than one CRD set, e.g. enterprise platform + AI gateway"). Generatesdocs/platform/reference/crds-ai-gateway/forAIGatewayandAIPolicy. Sidebar placement underGovern the platformis the one manual step the pipeline does not do.Management API reference. Registers
management-api.openapi.yamlas aredocusaurusspec and addsdocs/platform/reference/ai-gateway-management-api.mdx, matching the pattern of the two existing ToolHive specs. Covers/v1/info,/v1/mcp-servers,/v1/me,/v1/models, and/v1/policies.Landing page. Replaces the admonition with pointers to the two references and to the platform install sequence. The value-prop copy above it is unchanged.
Incidental change worth a look
Regenerating also refreshed three
enterprise-crdsschemas, which were missingclaimConditionsonPlatformRoleBindingandClusterPlatformRoleBindingand the corresponding narrowing onToolhiveAuthorizationPolicy. That is a real staleness fix rather than churn, but it rides along because generation runs per project, not per set. Say so if you would rather it were split out.Verification
npm run buildsucceeds, so no broken links. New routes render:/platform/reference/crds-ai-gateway/aigateway,/aipolicy, and/platform/reference/ai-gateway-management-api.tsc --noEmitandprettier --checkare clean.Two notes for the pipeline
prettier --writepass is needed afterwards or the generated MDX lands reformatted against the repo style.servers: [{url: management.invalid/}], which Redoc will render verbatim. Left as-is rather than editing a copied upstream asset, but it reads oddly and is worth fixing at the source.