github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-26 04:36:00 +00:00
Code Issues Projects Releases Wiki Activity

Add missing comments in k8s.io/api/core/v1

Browse Source 
Signed-off-by: Bo Wang <wangbob@uniontech.com>
This commit is contained in:
Bo Wang
2024-05-31 17:05:18 +08:00
committed by Tim Hockin
parent af41aa1d9f
commit 495af2a3d4
9 changed files with 180 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
api/openapi-spec/swagger.json generated
View File

@@ -7298,6 +7298,7 @@
"type": "object"
},
"io.k8s.api.core.v1.GRPCAction": {
"description": "GRPCAction specifies an action involving a GRPC service.",
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
@@ -7661,19 +7662,19 @@
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "Exec specifies the action to take."
"description": "Exec specifies a command to execute in the container."
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
"description": "HTTPGet specifies an HTTP GET request to perform."
},
"sleep": {
"$ref": "#/definitions/io.k8s.api.core.v1.SleepAction",
"description": "Sleep represents the duration that the container should sleep before being terminated."
"description": "Sleep represents a duration that the container should sleep."
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified."
"description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified."
}
},
"type": "object"
@@ -7980,12 +7981,15 @@
"description": "NamespaceCondition contains details about state of namespace.",
"properties": {
"lastTransitionTime": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time",
"description": "Last time the condition transitioned from one status to another."
},
"message": {
"description": "Human-readable message indicating details about last transition.",
"type": "string"
},
"reason": {
"description": "Unique, one-word, CamelCase reason for the condition's last transition.",
"type": "string"
},
"status": {
@@ -8698,9 +8702,11 @@
"type": "string"
},
"status": {
"description": "Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required",
"type": "string"
},
"type": {
"description": "Type is the type of the condition. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about",
"type": "string"
}
},
@@ -9292,10 +9298,11 @@
"description": "PodDNSConfigOption defines DNS resolver options of a pod.",
"properties": {
"name": {
"description": "Required.",
"description": "Name is this DNS resolver option's name. Required.",
"type": "string"
},
"value": {
"description": "Value is this DNS resolver option's value.",
"type": "string"
}
},
@@ -9955,6 +9962,7 @@
"type": "object"
},
"io.k8s.api.core.v1.PortStatus": {
"description": "PortStatus represents the error condition of a service port",
"properties": {
"error": {
"description": "Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.",
@@ -10021,7 +10029,7 @@
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "Exec specifies the action to take."
"description": "Exec specifies a command to execute in the container."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
@@ -10030,11 +10038,11 @@
},
"grpc": {
"$ref": "#/definitions/io.k8s.api.core.v1.GRPCAction",
"description": "GRPC specifies an action involving a GRPC port."
"description": "GRPC specifies a GRPC HealthCheckRequest."
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
"description": "HTTPGet specifies an HTTP GET request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
@@ -10053,7 +10061,7 @@
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port."
"description": "TCPSocket specifies a connection to a TCP port."
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
@@ -10587,6 +10595,7 @@
"type": "object"
},
"io.k8s.api.core.v1.ResourceStatus": {
"description": "ResourceStatus represents the status of a single resource allocated to a Pod.",
"properties": {
"name": {
"description": "Name of the resource. Must be unique within the pod and in case of non-DRA resource, match one of the resources from the pod spec. For DRA resources, the value must be \"claim:<claim_name>/<request>\". When this status is reported about a container, the \"claim_name\" and \"request\" must match one of the claims of this container.",
@@ -11662,6 +11671,7 @@
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.TypedObjectReference": {
"description": "TypedObjectReference contains enough information to let you locate the typed referenced object",
"properties": {
"apiGroup": {
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",

34
api/openapi-spec/v3/api__v1_openapi.json generated
View File

@@ -2651,6 +2651,7 @@
"type": "object"
},
"io.k8s.api.core.v1.GRPCAction": {
"description": "GRPCAction specifies an action involving a GRPC service.",
"properties": {
"port": {
"default": 0,
@@ -3068,7 +3069,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.ExecAction"
}
],
"description": "Exec specifies the action to take."
"description": "Exec specifies a command to execute in the container."
},
"httpGet": {
"allOf": [
@@ -3076,7 +3077,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.HTTPGetAction"
}
],
"description": "HTTPGet specifies the http request to perform."
"description": "HTTPGet specifies an HTTP GET request to perform."
},
"sleep": {
"allOf": [
@@ -3084,7 +3085,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.SleepAction"
}
],
"description": "Sleep represents the duration that the container should sleep before being terminated."
"description": "Sleep represents a duration that the container should sleep."
},
"tcpSocket": {
"allOf": [
@@ -3092,7 +3093,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.TCPSocketAction"
}
],
"description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified."
"description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified."
}
},
"type": "object"
@@ -3458,12 +3459,19 @@
"description": "NamespaceCondition contains details about state of namespace.",
"properties": {
"lastTransitionTime": {
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
}
],
"description": "Last time the condition transitioned from one status to another."
},
"message": {
"description": "Human-readable message indicating details about last transition.",
"type": "string"
},
"reason": {
"description": "Unique, one-word, CamelCase reason for the condition's last transition.",
"type": "string"
},
"status": {
@@ -4388,10 +4396,12 @@
},
"status": {
"default": "",
"description": "Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required",
"type": "string"
},
"type": {
"default": "",
"description": "Type is the type of the condition. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about",
"type": "string"
}
},
@@ -5210,10 +5220,11 @@
"description": "PodDNSConfigOption defines DNS resolver options of a pod.",
"properties": {
"name": {
"description": "Required.",
"description": "Name is this DNS resolver option's name. Required.",
"type": "string"
},
"value": {
"description": "Value is this DNS resolver option's value.",
"type": "string"
}
},
@@ -6052,6 +6063,7 @@
"type": "object"
},
"io.k8s.api.core.v1.PortStatus": {
"description": "PortStatus represents the error condition of a service port",
"properties": {
"error": {
"description": "Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.",
@@ -6131,7 +6143,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.ExecAction"
}
],
"description": "Exec specifies the action to take."
"description": "Exec specifies a command to execute in the container."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
@@ -6144,7 +6156,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.GRPCAction"
}
],
"description": "GRPC specifies an action involving a GRPC port."
"description": "GRPC specifies a GRPC HealthCheckRequest."
},
"httpGet": {
"allOf": [
@@ -6152,7 +6164,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.HTTPGetAction"
}
],
"description": "HTTPGet specifies the http request to perform."
"description": "HTTPGet specifies an HTTP GET request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
@@ -6175,7 +6187,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.TCPSocketAction"
}
],
"description": "TCPSocket specifies an action involving a TCP port."
"description": "TCPSocket specifies a connection to a TCP port."
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
@@ -6818,6 +6830,7 @@
"type": "object"
},
"io.k8s.api.core.v1.ResourceStatus": {
"description": "ResourceStatus represents the status of a single resource allocated to a Pod.",
"properties": {
"name": {
"default": "",
@@ -8053,6 +8066,7 @@
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.TypedObjectReference": {
"description": "TypedObjectReference contains enough information to let you locate the typed referenced object",
"properties": {
"apiGroup": {
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",

23
api/openapi-spec/v3/apis__apps__v1_openapi.json generated
View File

@@ -2570,6 +2570,7 @@
"type": "object"
},
"io.k8s.api.core.v1.GRPCAction": {
"description": "GRPCAction specifies an action involving a GRPC service.",
"properties": {
"port": {
"default": 0,
@@ -2876,7 +2877,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.ExecAction"
}
],
"description": "Exec specifies the action to take."
"description": "Exec specifies a command to execute in the container."
},
"httpGet": {
"allOf": [
@@ -2884,7 +2885,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.HTTPGetAction"
}
],
"description": "HTTPGet specifies the http request to perform."
"description": "HTTPGet specifies an HTTP GET request to perform."
},
"sleep": {
"allOf": [
@@ -2892,7 +2893,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.SleepAction"
}
],
"description": "Sleep represents the duration that the container should sleep before being terminated."
"description": "Sleep represents a duration that the container should sleep."
},
"tcpSocket": {
"allOf": [
@@ -2900,7 +2901,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.TCPSocketAction"
}
],
"description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified."
"description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified."
}
},
"type": "object"
@@ -3167,10 +3168,12 @@
},
"status": {
"default": "",
"description": "Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required",
"type": "string"
},
"type": {
"default": "",
"description": "Type is the type of the condition. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about",
"type": "string"
}
},
@@ -3541,10 +3544,11 @@
"description": "PodDNSConfigOption defines DNS resolver options of a pod.",
"properties": {
"name": {
"description": "Required.",
"description": "Name is this DNS resolver option's name. Required.",
"type": "string"
},
"value": {
"description": "Value is this DNS resolver option's value.",
"type": "string"
}
},
@@ -4123,7 +4127,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.ExecAction"
}
],
"description": "Exec specifies the action to take."
"description": "Exec specifies a command to execute in the container."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
@@ -4136,7 +4140,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.GRPCAction"
}
],
"description": "GRPC specifies an action involving a GRPC port."
"description": "GRPC specifies a GRPC HealthCheckRequest."
},
"httpGet": {
"allOf": [
@@ -4144,7 +4148,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.HTTPGetAction"
}
],
"description": "HTTPGet specifies the http request to perform."
"description": "HTTPGet specifies an HTTP GET request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
@@ -4167,7 +4171,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.TCPSocketAction"
}
],
"description": "TCPSocket specifies an action involving a TCP port."
"description": "TCPSocket specifies a connection to a TCP port."
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
@@ -4879,6 +4883,7 @@
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.TypedObjectReference": {
"description": "TypedObjectReference contains enough information to let you locate the typed referenced object",
"properties": {
"apiGroup": {
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",

21
api/openapi-spec/v3/apis__batch__v1_openapi.json generated
View File

@@ -1919,6 +1919,7 @@
"type": "object"
},
"io.k8s.api.core.v1.GRPCAction": {
"description": "GRPCAction specifies an action involving a GRPC service.",
"properties": {
"port": {
"default": 0,
@@ -2225,7 +2226,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.ExecAction"
}
],
"description": "Exec specifies the action to take."
"description": "Exec specifies a command to execute in the container."
},
"httpGet": {
"allOf": [
@@ -2233,7 +2234,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.HTTPGetAction"
}
],
"description": "HTTPGet specifies the http request to perform."
"description": "HTTPGet specifies an HTTP GET request to perform."
},
"sleep": {
"allOf": [
@@ -2241,7 +2242,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.SleepAction"
}
],
"description": "Sleep represents the duration that the container should sleep before being terminated."
"description": "Sleep represents a duration that the container should sleep."
},
"tcpSocket": {
"allOf": [
@@ -2249,7 +2250,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.TCPSocketAction"
}
],
"description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified."
"description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified."
}
},
"type": "object"
@@ -2745,10 +2746,11 @@
"description": "PodDNSConfigOption defines DNS resolver options of a pod.",
"properties": {
"name": {
"description": "Required.",
"description": "Name is this DNS resolver option's name. Required.",
"type": "string"
},
"value": {
"description": "Value is this DNS resolver option's value.",
"type": "string"
}
},
@@ -3327,7 +3329,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.ExecAction"
}
],
"description": "Exec specifies the action to take."
"description": "Exec specifies a command to execute in the container."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
@@ -3340,7 +3342,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.GRPCAction"
}
],
"description": "GRPC specifies an action involving a GRPC port."
"description": "GRPC specifies a GRPC HealthCheckRequest."
},
"httpGet": {
"allOf": [
@@ -3348,7 +3350,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.HTTPGetAction"
}
],
"description": "HTTPGet specifies the http request to perform."
"description": "HTTPGet specifies an HTTP GET request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
@@ -3371,7 +3373,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.TCPSocketAction"
}
],
"description": "TCPSocket specifies an action involving a TCP port."
"description": "TCPSocket specifies a connection to a TCP port."
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
@@ -4083,6 +4085,7 @@
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.TypedObjectReference": {
"description": "TypedObjectReference contains enough information to let you locate the typed referenced object",
"properties": {
"apiGroup": {
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",