This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
The following commit(s) were added to refs/heads/master by this push:
new ea34713d docs: update ApisixRoute stream support and fix typo (#2662)
ea34713d is described below
commit ea34713dc09e8b9c2563418f396faaa2527b8da5
Author: Traky Deng <[email protected]>
AuthorDate: Thu Nov 27 14:46:10 2025 +0800
docs: update ApisixRoute stream support and fix typo (#2662)
---
api/v2/apisixroute_types.go | 4 ++--
config/crd/bases/apisix.apache.org_apisixroutes.yaml | 4 ++--
docs/en/latest/reference/api-reference.md | 4 ++--
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/api/v2/apisixroute_types.go b/api/v2/apisixroute_types.go
index 9c7bbe86..81b06b9c 100644
--- a/api/v2/apisixroute_types.go
+++ b/api/v2/apisixroute_types.go
@@ -61,7 +61,7 @@ type ApisixRouteStatus = ApisixStatus
// +kubebuilder:printcolumn:name="Target Service
(TCP)",type="string",JSONPath=".spec.tcp[].match.backend.serviceName",description="Backend
Service for TCP",priority=1
//
+kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Creation
time",priority=0
-// ApisixRoute is defines configuration for HTTP and stream routes.
+// ApisixRoute defines configuration for HTTP and stream routes.
type ApisixRoute struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -112,7 +112,7 @@ type ApisixRouteHTTP struct {
Authentication ApisixRouteAuthentication
`json:"authentication,omitempty" yaml:"authentication,omitempty"`
}
-// ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route.
Currently not supported.
+// ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route.
type ApisixRouteStream struct {
// Name is a unique identifier for the route. This field must not be
empty.
Name string `json:"name" yaml:"name"`
diff --git a/config/crd/bases/apisix.apache.org_apisixroutes.yaml
b/config/crd/bases/apisix.apache.org_apisixroutes.yaml
index 51ec52c2..900e658a 100644
--- a/config/crd/bases/apisix.apache.org_apisixroutes.yaml
+++ b/config/crd/bases/apisix.apache.org_apisixroutes.yaml
@@ -47,7 +47,7 @@ spec:
name: v2
schema:
openAPIV3Schema:
- description: ApisixRoute is defines configuration for HTTP and stream
routes.
+ description: ApisixRoute defines configuration for HTTP and stream
routes.
properties:
apiVersion:
description: |-
@@ -360,7 +360,7 @@ spec:
Each rule specifies conditions to match TCP/UDP traffic and
how to forward them.
items:
description: ApisixRouteStream defines the configuration for
a Layer
- 4 (TCP/UDP) route. Currently not supported.
+ 4 (TCP/UDP) route.
properties:
backend:
description: Backend specifies the destination service
to which
diff --git a/docs/en/latest/reference/api-reference.md
b/docs/en/latest/reference/api-reference.md
index ec1882a6..f385468d 100644
--- a/docs/en/latest/reference/api-reference.md
+++ b/docs/en/latest/reference/api-reference.md
@@ -561,7 +561,7 @@ ApisixPluginConfig defines a reusable set of plugin
configuration that can be re
### ApisixRoute
-ApisixRoute is defines configuration for HTTP and stream routes.
+ApisixRoute defines configuration for HTTP and stream routes.
<!-- ApisixRoute resource -->
@@ -1188,7 +1188,7 @@ _Appears in:_
#### ApisixRouteStream
-ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route.
Currently not supported.
+ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route.
