Skip to content

Commit ea34713

Browse files
authored
docs: update ApisixRoute stream support and fix typo (#2662)
1 parent a9513d2 commit ea34713

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

api/v2/apisixroute_types.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ type ApisixRouteStatus = ApisixStatus
6161
// +kubebuilder:printcolumn:name="Target Service (TCP)",type="string",JSONPath=".spec.tcp[].match.backend.serviceName",description="Backend Service for TCP",priority=1
6262
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Creation time",priority=0
6363

64-
// ApisixRoute is defines configuration for HTTP and stream routes.
64+
// ApisixRoute defines configuration for HTTP and stream routes.
6565
type ApisixRoute struct {
6666
metav1.TypeMeta `json:",inline"`
6767
metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -112,7 +112,7 @@ type ApisixRouteHTTP struct {
112112
Authentication ApisixRouteAuthentication `json:"authentication,omitempty" yaml:"authentication,omitempty"`
113113
}
114114

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ spec:
4747
name: v2
4848
schema:
4949
openAPIV3Schema:
50-
description: ApisixRoute is defines configuration for HTTP and stream routes.
50+
description: ApisixRoute defines configuration for HTTP and stream routes.
5151
properties:
5252
apiVersion:
5353
description: |-
@@ -360,7 +360,7 @@ spec:
360360
Each rule specifies conditions to match TCP/UDP traffic and how to forward them.
361361
items:
362362
description: ApisixRouteStream defines the configuration for a Layer
363-
4 (TCP/UDP) route. Currently not supported.
363+
4 (TCP/UDP) route.
364364
properties:
365365
backend:
366366
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
@@ -561,7 +561,7 @@ ApisixPluginConfig defines a reusable set of plugin configuration that can be re
561561
### ApisixRoute
562562

563563

564-
ApisixRoute is defines configuration for HTTP and stream routes.
564+
ApisixRoute defines configuration for HTTP and stream routes.
565565

566566
<!-- ApisixRoute resource -->
567567

@@ -1188,7 +1188,7 @@ _Appears in:_
11881188
#### ApisixRouteStream
11891189

11901190

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

11931193

11941194

0 commit comments

Comments
 (0)