This is an automated email from the ASF dual-hosted git repository.
traky pushed a commit to branch fix-docs-stream
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
commit d5f560713ae6f23464b95165e2bed5f5c8bcb006
Author: traky <trakyd...@gmail.com>
AuthorDate: Thu Aug 21 17:26:29 2025 +0800
mention stream is currently not supported
---
api/v2/apisixroute_types.go | 3 ++-
config/crd/bases/apisix.apache.org_apisixroutes.yaml | 3 ++-
docs/en/latest/reference/api-reference.md | 4 ++--
3 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/api/v2/apisixroute_types.go b/api/v2/apisixroute_types.go
index 5f7ef7b1..35e0483c 100644
--- a/api/v2/apisixroute_types.go
+++ b/api/v2/apisixroute_types.go
@@ -39,6 +39,7 @@ type ApisixRouteSpec struct {
HTTP []ApisixRouteHTTP `json:"http,omitempty" yaml:"http,omitempty"`
// Stream defines a list of stream route rules.
// Each rule specifies conditions to match TCP/UDP traffic and how to
forward them.
+ // Stream is currently not supported.
Stream []ApisixRouteStream `json:"stream,omitempty"
yaml:"stream,omitempty"`
}
@@ -106,7 +107,7 @@ type ApisixRouteHTTP struct {
Authentication ApisixRouteAuthentication
`json:"authentication,omitempty" yaml:"authentication,omitempty"`
}
-// ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route.
+// ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route.
Currently not supported.
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 c1c30d7d..86d8a1ed 100644
--- a/config/crd/bases/apisix.apache.org_apisixroutes.yaml
+++ b/config/crd/bases/apisix.apache.org_apisixroutes.yaml
@@ -355,9 +355,10 @@ spec:
description: |-
Stream defines a list of stream route rules.
Each rule specifies conditions to match TCP/UDP traffic and
how to forward them.
+ Stream is currently not supported.
items:
description: ApisixRouteStream defines the configuration for
a Layer
- 4 (TCP/UDP) route.
+ 4 (TCP/UDP) route. Currently not supported.
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 4ff8c06d..bd360a84 100644
--- a/docs/en/latest/reference/api-reference.md
+++ b/docs/en/latest/reference/api-reference.md
@@ -1177,7 +1177,7 @@ It defines routing rules for both HTTP and stream traffic.
| --- | --- |
| `ingressClassName` _string_ | IngressClassName is the name of the
IngressClass this route belongs to. It allows multiple controllers to watch and
reconcile different routes. |
| `http` _[ApisixRouteHTTP](#apisixroutehttp) array_ | HTTP defines a list of
HTTP route rules. Each rule specifies conditions to match HTTP requests and how
to forward them. |
-| `stream` _[ApisixRouteStream](#apisixroutestream) array_ | Stream defines a
list of stream route rules. Each rule specifies conditions to match TCP/UDP
traffic and how to forward them. |
+| `stream` _[ApisixRouteStream](#apisixroutestream) array_ | Stream defines a
list of stream route rules. Each rule specifies conditions to match TCP/UDP
traffic and how to forward them. Stream is currently not supported. |
_Appears in:_
@@ -1186,7 +1186,7 @@ _Appears in:_
#### ApisixRouteStream
-ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route.
+ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route.
Currently not supported.
