Docs: rename Ingress WithRoute to WithPath (K8s 13.4)#1060
Open
mitchdenny wants to merge 4 commits into
Open
Conversation
Aspire.Hosting.Kubernetes renamed the Ingress routing extension from WithRoute to WithPath. Gateway API kept WithRoute. Update the only live code samples that still showed ingress.WithRoute (the 13.3 what's-new ingress sample in English and Japanese) and add a short breaking-change note to the 13.4 what's-new page. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add a 'Routing paths to services' section to the Ingress/Gateway overview showing path-based routing with the new WithPath API, including a brief note about the WithRoute -> WithPath rename and that the Gateway API equivalent keeps the original name. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add a tip callout near the top of kubernetes-ingress.mdx linking to the upstream Kubernetes Gateway API page and the Gateway API concepts overview, encouraging readers to prefer AddGateway(...) over AddIngress(...) for new deployments. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Aspire Kubernetes documentation to reflect the Ingress routing API rename from WithRoute(...) to WithPath(...) in Aspire.Hosting.Kubernetes 13.4, while clarifying that the Gateway API remains WithRoute(...).
Changes:
- Added an Ingress/Gateway path-routing overview section (C# + TypeScript) to the Kubernetes Ingress docs, including notes about defaults/overloads and the rename.
- Added a breaking-change note to the Aspire 13.4 “What’s new” page describing the rename.
- Updated existing Ingress sample code in the Aspire 13.3 “What’s new” pages (EN/JA) to use
WithPath(...).
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/whats-new/aspire-13-4.mdx | Adds a breaking-change note documenting the WithRoute → WithPath rename for Ingress. |
| src/frontend/src/content/docs/whats-new/aspire-13-3.mdx | Updates an Ingress sample to WithPath(...) (but this conflicts with 13.3 API reality). |
| src/frontend/src/content/docs/ja/whats-new/aspire-13-3.mdx | Same as above for the Japanese 13.3 page. |
| src/frontend/src/content/docs/deployment/kubernetes-ingress.mdx | Adds a new “Routing paths to services” section with C#/TypeScript examples and rename context. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 4/4 changed files
- Comments generated: 4
Comment on lines
+75
to
+78
| var web = builder.AddProject<Projects.Web>("web"); | ||
|
|
||
| var ingress = k8s.AddIngress("public") | ||
| .WithIngressClass("nginx") |
Comment on lines
+69
to
+71
| Use `WithPath` on an Ingress (or `WithRoute` on a Gateway) to forward traffic for a URL path to one of your Aspire services. Each call adds a rule to the generated `Ingress` (or `HTTPRoute`) resource pointing at the named endpoint's backing Kubernetes service. | ||
|
|
||
| <Tabs syncKey='aspire-lang'> |
Comment on lines
392
to
396
| .WithTls("api-cert"); | ||
|
|
||
| // Route requests at "/" to the project's HTTP endpoint. | ||
| ingress.WithRoute("/", api.GetEndpoint("http")); | ||
| ingress.WithPath("/", api.GetEndpoint("http")); | ||
| ``` |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Aspire.Hosting.Kubernetes renamed the Ingress routing extension from
WithRoutetoWithPath. The Gateway API equivalent (gateway.WithRoute(...)) kept its name to match theHTTPRouteresource it generates.Changes
deployment/kubernetes-ingress.mdx— new Routing paths to services section with C# + TypeScriptWithPathexamples, a note about path-type defaults / host overload /WithDefaultBackendcomposition, and a callout explaining theWithRoute→WithPathrename and why Gateway API kept the original name.whats-new/aspire-13-4.mdx— added a short breaking-change subsection covering the rename.whats-new/aspire-13-3.mdx+ja/whats-new/aspire-13-3.mdx— updated the only liveingress.WithRoute(...)code samples toingress.WithPath(...).Verified
deployment/kubernetes/aks.mdxanddeployment/kubernetes-gateway-aks.mdxonly useWithRouteonAddGateway— left untouched.deployment/kubernetes-ingress.mdxanddeployment/kubernetes-ingress-aks.mdxpreviously didn't useWithRoute(they showedWithDefaultBackend); the overview now also covers path-based routing viaWithPath.update-integrationsskill once 13.4 ships.