Skip to content

Commit 7bc2d6f

Browse files
authored
docs: mention stream is currently not supported in the CRD doc (#237)
1 parent cd8bebb commit 7bc2d6f

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

api/v2/apisixroute_types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ type ApisixRouteSpec struct {
3939
HTTP []ApisixRouteHTTP `json:"http,omitempty" yaml:"http,omitempty"`
4040
// Stream defines a list of stream route rules.
4141
// Each rule specifies conditions to match TCP/UDP traffic and how to forward them.
42+
// Stream is currently not supported.
4243
Stream []ApisixRouteStream `json:"stream,omitempty" yaml:"stream,omitempty"`
4344
}
4445

@@ -106,7 +107,7 @@ type ApisixRouteHTTP struct {
106107
Authentication ApisixRouteAuthentication `json:"authentication,omitempty" yaml:"authentication,omitempty"`
107108
}
108109

109-
// ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route.
110+
// ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route. Currently not supported.
110111
type ApisixRouteStream struct {
111112
// Name is a unique identifier for the route. This field must not be empty.
112113
Name string `json:"name" yaml:"name"`

config/crd/bases/apisix.apache.org_apisixroutes.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,9 +356,10 @@ spec:
356356
description: |-
357357
Stream defines a list of stream route rules.
358358
Each rule specifies conditions to match TCP/UDP traffic and how to forward them.
359+
Stream is currently not supported.
359360
items:
360361
description: ApisixRouteStream defines the configuration for a Layer
361-
4 (TCP/UDP) route.
362+
4 (TCP/UDP) route. Currently not supported.
362363
properties:
363364
backend:
364365
description: Backend specifies the destination service to which

docs/en/latest/reference/api-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1177,7 +1177,7 @@ It defines routing rules for both HTTP and stream traffic.
11771177
| --- | --- |
11781178
| `ingressClassName` _string_ | IngressClassName is the name of the IngressClass this route belongs to. It allows multiple controllers to watch and reconcile different routes. |
11791179
| `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. |
1180-
| `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. |
1180+
| `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. |
11811181

11821182

11831183
_Appears in:_
@@ -1186,7 +1186,7 @@ _Appears in:_
11861186
#### ApisixRouteStream
11871187

11881188

1189-
ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route.
1189+
ApisixRouteStream defines the configuration for a Layer 4 (TCP/UDP) route. Currently not supported.
11901190

11911191

11921192

0 commit comments

Comments
 (0)