update docs

kayx23 · kayx23 · commit a0696fbbcc27 · 2025-05-20T15:35:14.000+08:00
diff --git a/api/v1alpha1/backendtrafficpolicy_types.go b/api/v1alpha1/backendtrafficpolicy_types.go
@@ -28,6 +28,7 @@ type BackendTrafficPolicySpec struct {
 	// The default strategy is round robin.
 	LoadBalancer *LoadBalancer `json:"loadbalancer,omitempty" yaml:"loadbalancer,omitempty"`
 	// Scheme is the protocol used to communicate with the upstream.
+	// Default is `http`.
 	// Can be one of `http`, `https`, `grpc`, or `grpcs`.
 	// +kubebuilder:validation:Enum=http;https;grpc;grpcs;
 	// +kubebuilder:default=http
@@ -43,6 +44,7 @@ type BackendTrafficPolicySpec struct {
 
 	// PassHost configures how the host header should be determined when a
 	// request is forwarded to the upstream.
+	// Default is `pass`.
 	// Can be one of `pass`, `node` or `rewrite`.
 	//
 	// +kubebuilder:validation:Enum=pass;node;rewrite;
@@ -58,12 +60,14 @@ type BackendTrafficPolicySpec struct {
 // +kubebuilder:validation:XValidation:rule="!(has(self.key) && self.type != 'chash')"
 type LoadBalancer struct {
 	// Type specifies the load balancing algorithms.
+	// Default is `roundrobin`.
 	// Can be one of `roundrobin`, `chash`, `ewma`, or `least_conn`.
 	// +kubebuilder:validation:Enum=roundrobin;chash;ewma;least_conn;
 	// +kubebuilder:default=roundrobin
 	// +kubebuilder:validation:Required
 	Type string `json:"type" yaml:"type"`
 	// HashOn specified the type of field used for hashing, required when Type is `chash`.
+	// Default is `vars`.
 	// Can be one of `vars`, `header`, `cookie`, `consumer`, or `vars_combinations`.
 	// +kubebuilder:validation:Enum=vars;header;cookie;consumer;vars_combinations;
 	// +kubebuilder:default=vars
diff --git a/api/v1alpha1/consumer_types.go b/api/v1alpha1/consumer_types.go
@@ -31,10 +31,10 @@ type GatewayRef struct {
 	// +kubebuilder:validation:Required
 	// +kubebuilder:validation:MinLength=1
 	Name string `json:"name"`
-	// Kind is the type of Kubernetes object. Default to `Gateway`.
+	// Kind is the type of Kubernetes object. Default is `Gateway`.
 	// +kubebuilder:default=Gateway
 	Kind *string `json:"kind,omitempty"`
-	// Group is the API group the resource belongs to. Default to `gateway.networking.k8s.io`.
+	// Group is the API group the resource belongs to. Default is `gateway.networking.k8s.io`.
 	// +kubebuilder:default=gateway.networking.k8s.io
 	Group     *string `json:"group,omitempty"`
 	// Namespace is namespace of the resource.
diff --git a/api/v1alpha1/gatewayproxy_types.go b/api/v1alpha1/gatewayproxy_types.go
@@ -55,7 +55,7 @@ const (
 // GatewayProxyProvider defines the provider configuration for GatewayProxy.
 // +kubebuilder:validation:XValidation:rule="self.type == 'ControlPlane' ? has(self.controlPlane) : true",message="controlPlane must be specified when type is ControlPlane"
 type GatewayProxyProvider struct {
-	// Type specifies the type of provider.
+	// Type specifies the type of provider. Can only be `ControlPlane`.
 	// +kubebuilder:validation:Required
 	Type ProviderType `json:"type"`
 
@@ -105,6 +105,7 @@ type AdminKeyValueFrom struct {
 // ControlPlaneAuth defines the authentication configuration for control plane.
 type ControlPlaneAuth struct {
 	// Type specifies the type of authentication.
+	// Can only be `AdminKey`.
 	// +kubebuilder:validation:Required
 	Type AuthType `json:"type"`
 
diff --git a/api/v1alpha1/httproutepolicy_types.go b/api/v1alpha1/httproutepolicy_types.go
@@ -42,6 +42,8 @@ type HTTPRoutePolicy struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
+	// HTTPRoutePolicySpec defines the defines the desired state and configuration of a HTTPRoutePolicy,
+	// including route priority and request matching conditions.
 	Spec   HTTPRoutePolicySpec `json:"spec,omitempty"`
 	Status PolicyStatus        `json:"status,omitempty"`
 }
diff --git a/api/v1alpha1/pluginconfig_types.go b/api/v1alpha1/pluginconfig_types.go
@@ -15,6 +15,8 @@ type PluginConfig struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
+	// PluginConfigSpec defines the desired state of a PluginConfig,
+	// in which plugins and their configurations are specified.
 	Spec PluginConfigSpec `json:"spec,omitempty"`
 }
 
diff --git a/config/crd/bases/apisix.apache.org_backendtrafficpolicies.yaml b/config/crd/bases/apisix.apache.org_backendtrafficpolicies.yaml
@@ -49,6 +49,7 @@ spec:
                     default: vars
                     description: |-
                       HashOn specified the type of field used for hashing, required when Type is `chash`.
+                      Default is `vars`.
                       Can be one of `vars`, `header`, `cookie`, `consumer`, or `vars_combinations`.
                     enum:
                     - vars
@@ -69,6 +70,7 @@ spec:
                     default: roundrobin
                     description: |-
                       Type specifies the load balancing algorithms.
+                      Default is `roundrobin`.
                       Can be one of `roundrobin`, `chash`, `ewma`, or `least_conn`.
                     enum:
                     - roundrobin
@@ -86,6 +88,7 @@ spec:
                 description: |-
                   PassHost configures how the host header should be determined when a
                   request is forwarded to the upstream.
+                  Default is `pass`.
                   Can be one of `pass`, `node` or `rewrite`.
                 enum:
                 - pass
@@ -101,6 +104,7 @@ spec:
                 default: http
                 description: |-
                   Scheme is the protocol used to communicate with the upstream.
+                  Default is `http`.
                   Can be one of `http`, `https`, `grpc`, or `grpcs`.
                 enum:
                 - http
diff --git a/config/crd/bases/apisix.apache.org_consumers.yaml b/config/crd/bases/apisix.apache.org_consumers.yaml
@@ -83,11 +83,11 @@ spec:
                   group:
                     default: gateway.networking.k8s.io
                     description: Group is the API group the resource belongs to. Default
-                      to `gateway.networking.k8s.io`.
+                      is `gateway.networking.k8s.io`.
                     type: string
                   kind:
                     default: Gateway
-                    description: Kind is the type of Kubernetes object. Default to
+                    description: Kind is the type of Kubernetes object. Default is
                       `Gateway`.
                     type: string
                   name:
diff --git a/config/crd/bases/apisix.apache.org_gatewayproxies.yaml b/config/crd/bases/apisix.apache.org_gatewayproxies.yaml
@@ -103,7 +103,9 @@ spec:
                                 type: object
                             type: object
                           type:
-                            description: Type specifies the type of authentication.
+                            description: |-
+                              Type specifies the type of authentication.
+                              Can only be `AdminKey`.
                             enum:
                             - AdminKey
                             type: string
@@ -126,7 +128,8 @@ spec:
                     - endpoints
                     type: object
                   type:
-                    description: Type specifies the type of provider.
+                    description: Type specifies the type of provider. Can only be
+                      `ControlPlane`.
                     enum:
                     - ControlPlane
                     type: string
diff --git a/config/crd/bases/apisix.apache.org_httproutepolicies.yaml b/config/crd/bases/apisix.apache.org_httproutepolicies.yaml
@@ -37,7 +37,9 @@ spec:
           metadata:
             type: object
           spec:
-            description: HTTPRoutePolicySpec defines the desired state of HTTPRoutePolicy.
+            description: |-
+              HTTPRoutePolicySpec defines the defines the desired state and configuration of a HTTPRoutePolicy,
+              including route priority and request matching conditions.
             properties:
               priority:
                 description: Priority sets the priority for route. A higher value
diff --git a/config/crd/bases/apisix.apache.org_pluginconfigs.yaml b/config/crd/bases/apisix.apache.org_pluginconfigs.yaml
@@ -37,7 +37,9 @@ spec:
           metadata:
             type: object
           spec:
-            description: PluginConfigSpec defines the desired state of PluginConfig.
+            description: |-
+              PluginConfigSpec defines the desired state of a PluginConfig,
+              in which plugins and their configurations are specified.
             properties:
               plugins:
                 description: Plugins are an array of plugins and their configurations
diff --git a/docs/crd/api.md b/docs/crd/api.md
@@ -79,7 +79,7 @@ HTTPRoutePolicy is the Schema for the httproutepolicies API.
 | `apiVersion` _string_ | `apisix.apache.org/v1alpha1`
 | `kind` _string_ | `HTTPRoutePolicy`
 | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#objectmeta-v1-meta)_ | Please refer to the Kubernetes API documentation for details on the `metadata` field. |
-| `spec` _[HTTPRoutePolicySpec](#httproutepolicyspec)_ |  |
+| `spec` _[HTTPRoutePolicySpec](#httproutepolicyspec)_ | HTTPRoutePolicySpec defines the defines the desired state and configuration of a HTTPRoutePolicy, including route priority and request matching conditions. |
 
 
 
@@ -95,7 +95,7 @@ PluginConfig is the Schema for the PluginConfigs API.
 | `apiVersion` _string_ | `apisix.apache.org/v1alpha1`
 | `kind` _string_ | `PluginConfig`
 | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#objectmeta-v1-meta)_ | Please refer to the Kubernetes API documentation for details on the `metadata` field. |
-| `spec` _[PluginConfigSpec](#pluginconfigspec)_ |  |
+| `spec` _[PluginConfigSpec](#pluginconfigspec)_ | PluginConfigSpec defines the desired state of a PluginConfig, in which plugins and their configurations are specified. |
 
 
 
@@ -174,10 +174,10 @@ _Appears in:_
 | --- | --- |
 | `targetRefs` _[BackendPolicyTargetReferenceWithSectionName](#backendpolicytargetreferencewithsectionname) array_ | TargetRef identifies an API object to apply policy to. Currently, Backends (i.e. Service, ServiceImport, or any implementation-specific backendRef) are the only valid API target references. |
 | `loadbalancer` _[LoadBalancer](#loadbalancer)_ | LoadBalancer represents the load balancer configuration for Kubernetes Service. The default strategy is round robin. |
-| `scheme` _string_ | Scheme is the protocol used to communicate with the upstream. Can be one of `http`, `https`, `grpc`, or `grpcs`. |
+| `scheme` _string_ | Scheme is the protocol used to communicate with the upstream. Default is `http`. Can be one of `http`, `https`, `grpc`, or `grpcs`. |
 | `retries` _integer_ | Retries specify the number of times the gateway should retry sending requests when errors such as timeouts or 502 errors occur. |
 | `timeout` _[Timeout](#timeout)_ | Timeout sets the read, send, and connect timeouts to the upstream. |
-| `passHost` _string_ | PassHost configures how the host header should be determined when a request is forwarded to the upstream. Can be one of `pass`, `node` or `rewrite`. |
+| `passHost` _string_ | PassHost configures how the host header should be determined when a request is forwarded to the upstream. Default is `pass`. Can be one of `pass`, `node` or `rewrite`. |
 | `upstreamHost` _[Hostname](#hostname)_ | UpstreamHost specifies the host of the Upstream request. Used only if passHost is set to `rewrite`. |
 
 
@@ -210,7 +210,7 @@ ControlPlaneAuth defines the authentication configuration for control plane.
 
 | Field | Description |
 | --- | --- |
-| `type` _[AuthType](#authtype)_ | Type specifies the type of authentication. |
+| `type` _[AuthType](#authtype)_ | Type specifies the type of authentication. Can only be `AdminKey`. |
 | `adminKey` _[AdminKeyAuth](#adminkeyauth)_ | AdminKey specifies the admin key authentication configuration. |
 
 
@@ -278,7 +278,7 @@ GatewayProxyProvider defines the provider configuration for GatewayProxy.
 
 | Field | Description |
 | --- | --- |
-| `type` _[ProviderType](#providertype)_ | Type specifies the type of provider. |
+| `type` _[ProviderType](#providertype)_ | Type specifies the type of provider. Can only be `ControlPlane`. |
 | `controlPlane` _[ControlPlaneProvider](#controlplaneprovider)_ | ControlPlane specifies the configuration for control plane provider. |
 
 
@@ -314,8 +314,8 @@ _Appears in:_
 | Field | Description |
 | --- | --- |
 | `name` _string_ | Name is the name of the gateway. |
-| `kind` _string_ | Kind is the type of Kubernetes object. Default to `Gateway`. |
-| `group` _string_ | Group is the API group the resource belongs to. Default to `gateway.networking.k8s.io`. |
+| `kind` _string_ | Kind is the type of Kubernetes object. Default is `Gateway`. |
+| `group` _string_ | Group is the API group the resource belongs to. Default is `gateway.networking.k8s.io`. |
 | `namespace` _string_ | Namespace is namespace of the resource. |
 
 
@@ -360,8 +360,8 @@ LoadBalancer describes the load balancing parameters.
 
 | Field | Description |
 | --- | --- |
-| `type` _string_ | Type specifies the load balancing algorithms. Can be one of `roundrobin`, `chash`, `ewma`, or `least_conn`. |
-| `hashOn` _string_ | HashOn specified the type of field used for hashing, required when Type is `chash`. Can be one of `vars`, `header`, `cookie`, `consumer`, or `vars_combinations`. |
+| `type` _string_ | Type specifies the load balancing algorithms. Default is `roundrobin`. Can be one of `roundrobin`, `chash`, `ewma`, or `least_conn`. |
+| `hashOn` _string_ | HashOn specified the type of field used for hashing, required when Type is `chash`. Default is `vars`. Can be one of `vars`, `header`, `cookie`, `consumer`, or `vars_combinations`. |
 | `key` _string_ | Key is used with HashOn, generally required when Type is `chash`. When HashOn is `header` or `cookie`, specifies the name of the header or cookie. When HashOn is `consumer`, key is not required, as the consumer name is used automatically. When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of [built-in variables](/enterprise/reference/built-in-variables). |
 
 

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,8 @@ type HTTPRoutePolicy struct {`
`42`	`42`	metav1.TypeMeta `json:",inline"`
`43`	`43`	metav1.ObjectMeta `json:"metadata,omitempty"`
`44`	`44`
	`45`	`+ // HTTPRoutePolicySpec defines the defines the desired state and configuration of a HTTPRoutePolicy,`
	`46`	`+ // including route priority and request matching conditions.`
`45`	`47`	Spec HTTPRoutePolicySpec `json:"spec,omitempty"`
`46`	`48`	Status PolicyStatus `json:"status,omitempty"`
`47`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@ type PluginConfig struct {`
`15`	`15`	metav1.TypeMeta `json:",inline"`
`16`	`16`	metav1.ObjectMeta `json:"metadata,omitempty"`
`17`	`17`
	`18`	`+ // PluginConfigSpec defines the desired state of a PluginConfig,`
	`19`	`+ // in which plugins and their configurations are specified.`
`18`	`20`	Spec PluginConfigSpec `json:"spec,omitempty"`
`19`	`21`	`}`
`20`	`22`