Skip to content

docs: update ApisixRoute stream support and fix typo (#2662) (ea34713) #358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update ApisixRoute stream support and fix typo (#2662) (ea34713) #358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api/v2/apisixroute_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"`
Expand Down Expand Up @@ -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"`
Expand Down
4 changes: 2 additions & 2 deletions config/crd/bases/apisix.apache.org_apisixroutes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: |-
Expand Down Expand Up @@ -361,7 +361,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
Expand Down
4 changes: 2 additions & 2 deletions docs/en/latest/reference/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -560,7 +560,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 -->

Expand Down Expand Up @@ -1187,7 +1187,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.



Expand Down