Merge pull request kubernetes#114063 from ruquanzhao/fixNetworkTypesDoc

fix doc of types.go of network v1, v1alpha1, v1beta1

Author: k8s-ci-robot

api/openapi-spec/swagger.json

@@ -109,7 +109,7 @@
               }
             ],
             "default": {},
-            "description": "Spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
+            "description": "spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
           }
         },
         "type": "object",
@@ -129,7 +129,7 @@
             "type": "string"
           },
           "items": {
-            "description": "Items is the list of ClusterCIDRs.",
+            "description": "items is the list of ClusterCIDRs.",
             "items": {
               "allOf": [
                 {
@@ -171,12 +171,12 @@
         "properties": {
           "ipv4": {
             "default": "",
-            "description": "IPv4 defines an IPv4 IP block in CIDR notation(e.g. \"10.0.0.0/8\"). At least one of IPv4 and IPv6 must be specified. This field is immutable.",
+            "description": "ipv4 defines an IPv4 IP block in CIDR notation(e.g. \"10.0.0.0/8\"). At least one of ipv4 and ipv6 must be specified. This field is immutable.",
             "type": "string"
           },
           "ipv6": {
             "default": "",
-            "description": "IPv6 defines an IPv6 IP block in CIDR notation(e.g. \"2001:db8::/64\"). At least one of IPv4 and IPv6 must be specified. This field is immutable.",
+            "description": "ipv6 defines an IPv6 IP block in CIDR notation(e.g. \"2001:db8::/64\"). At least one of ipv4 and ipv6 must be specified. This field is immutable.",
             "type": "string"
           },
           "nodeSelector": {
@@ -185,11 +185,11 @@
                 "$ref": "#/components/schemas/io.k8s.api.core.v1.NodeSelector"
               }
             ],
-            "description": "NodeSelector defines which nodes the config is applicable to. An empty or nil NodeSelector selects all nodes. This field is immutable."
+            "description": "nodeSelector defines which nodes the config is applicable to. An empty or nil nodeSelector selects all nodes. This field is immutable."
           },
           "perNodeHostBits": {
             "default": 0,
-            "description": "PerNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.",
+            "description": "perNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.",
             "format": "int32",
             "type": "integer"
           }

api/openapi-spec/v3/apis__networking.k8s.io__v1_openapi.json

@@ -37,26 +37,27 @@ import (
 // selector matches the Node may be used.
 type ClusterCIDR struct {
 	metav1.TypeMeta `json:",inline"`
+
 	// Standard object's metadata.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
 	// +optional
 	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
 
-	// Spec is the desired state of the ClusterCIDR.
+	// spec is the desired state of the ClusterCIDR.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
 	// +optional
 	Spec ClusterCIDRSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
 }
 
 // ClusterCIDRSpec defines the desired state of ClusterCIDR.
 type ClusterCIDRSpec struct {
-	// NodeSelector defines which nodes the config is applicable to.
-	// An empty or nil NodeSelector selects all nodes.
+	// nodeSelector defines which nodes the config is applicable to.
+	// An empty or nil nodeSelector selects all nodes.
 	// This field is immutable.
 	// +optional
 	NodeSelector *v1.NodeSelector `json:"nodeSelector,omitempty" protobuf:"bytes,1,opt,name=nodeSelector"`
 
-	// PerNodeHostBits defines the number of host bits to be configured per node.
+	// perNodeHostBits defines the number of host bits to be configured per node.
 	// A subnet mask determines how much of the address is used for network bits
 	// and host bits. For example an IPv4 address of 192.168.0.0/24, splits the
 	// address into 24 bits for the network portion and 8 bits for the host portion.
@@ -66,14 +67,14 @@ type ClusterCIDRSpec struct {
 	// +required
 	PerNodeHostBits int32 `json:"perNodeHostBits" protobuf:"varint,2,opt,name=perNodeHostBits"`
 
-	// IPv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8").
-	// At least one of IPv4 and IPv6 must be specified.
+	// ipv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8").
+	// At least one of ipv4 and ipv6 must be specified.
 	// This field is immutable.
 	// +optional
 	IPv4 string `json:"ipv4" protobuf:"bytes,3,opt,name=ipv4"`
 
-	// IPv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64").
-	// At least one of IPv4 and IPv6 must be specified.
+	// ipv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64").
+	// At least one of ipv4 and ipv6 must be specified.
 	// This field is immutable.
 	// +optional
 	IPv6 string `json:"ipv6" protobuf:"bytes,4,opt,name=ipv6"`
@@ -85,11 +86,12 @@ type ClusterCIDRSpec struct {
 // ClusterCIDRList contains a list of ClusterCIDR.
 type ClusterCIDRList struct {
 	metav1.TypeMeta `json:",inline"`
+
 	// Standard object's metadata.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
 	// +optional
 	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
 
-	// Items is the list of ClusterCIDRs.
+	// items is the list of ClusterCIDRs.
 	Items []ClusterCIDR `json:"items" protobuf:"bytes,2,rep,name=items"`
 }