Improve the doc comment for the Job status.active field
This commit is contained in:
		
							
								
								
									
										2
									
								
								api/openapi-spec/swagger.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										2
									
								
								api/openapi-spec/swagger.json
									
									
									
										generated
									
									
									
								
							@@ -4343,7 +4343,7 @@
 | 
				
			|||||||
      "description": "JobStatus represents the current state of a Job.",
 | 
					      "description": "JobStatus represents the current state of a Job.",
 | 
				
			||||||
      "properties": {
 | 
					      "properties": {
 | 
				
			||||||
        "active": {
 | 
					        "active": {
 | 
				
			||||||
          "description": "The number of pending and running pods.",
 | 
					          "description": "The number of pending and running pods which are not terminating (without a deletionTimestamp).",
 | 
				
			||||||
          "format": "int32",
 | 
					          "format": "int32",
 | 
				
			||||||
          "type": "integer"
 | 
					          "type": "integer"
 | 
				
			||||||
        },
 | 
					        },
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -406,7 +406,7 @@
 | 
				
			|||||||
        "description": "JobStatus represents the current state of a Job.",
 | 
					        "description": "JobStatus represents the current state of a Job.",
 | 
				
			||||||
        "properties": {
 | 
					        "properties": {
 | 
				
			||||||
          "active": {
 | 
					          "active": {
 | 
				
			||||||
            "description": "The number of pending and running pods.",
 | 
					            "description": "The number of pending and running pods which are not terminating (without a deletionTimestamp).",
 | 
				
			||||||
            "format": "int32",
 | 
					            "format": "int32",
 | 
				
			||||||
            "type": "integer"
 | 
					            "type": "integer"
 | 
				
			||||||
          },
 | 
					          },
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -437,7 +437,8 @@ type JobStatus struct {
 | 
				
			|||||||
	// +optional
 | 
						// +optional
 | 
				
			||||||
	CompletionTime *metav1.Time
 | 
						CompletionTime *metav1.Time
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	// The number of pending and running pods.
 | 
						// The number of pending and running pods which are not terminating (without
 | 
				
			||||||
 | 
						// a deletionTimestamp).
 | 
				
			||||||
	// +optional
 | 
						// +optional
 | 
				
			||||||
	Active int32
 | 
						Active int32
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										2
									
								
								pkg/generated/openapi/zz_generated.openapi.go
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										2
									
								
								pkg/generated/openapi/zz_generated.openapi.go
									
									
									
										generated
									
									
									
								
							@@ -15913,7 +15913,7 @@ func schema_k8sio_api_batch_v1_JobStatus(ref common.ReferenceCallback) common.Op
 | 
				
			|||||||
					},
 | 
										},
 | 
				
			||||||
					"active": {
 | 
										"active": {
 | 
				
			||||||
						SchemaProps: spec.SchemaProps{
 | 
											SchemaProps: spec.SchemaProps{
 | 
				
			||||||
							Description: "The number of pending and running pods.",
 | 
												Description: "The number of pending and running pods which are not terminating (without a deletionTimestamp).",
 | 
				
			||||||
							Type:        []string{"integer"},
 | 
												Type:        []string{"integer"},
 | 
				
			||||||
							Format:      "int32",
 | 
												Format:      "int32",
 | 
				
			||||||
						},
 | 
											},
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -361,7 +361,8 @@ message JobStatus {
 | 
				
			|||||||
  // +optional
 | 
					  // +optional
 | 
				
			||||||
  optional k8s.io.apimachinery.pkg.apis.meta.v1.Time completionTime = 3;
 | 
					  optional k8s.io.apimachinery.pkg.apis.meta.v1.Time completionTime = 3;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  // The number of pending and running pods.
 | 
					  // The number of pending and running pods which are not terminating (without
 | 
				
			||||||
 | 
					  // a deletionTimestamp).
 | 
				
			||||||
  // +optional
 | 
					  // +optional
 | 
				
			||||||
  optional int32 active = 4;
 | 
					  optional int32 active = 4;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -441,7 +441,8 @@ type JobStatus struct {
 | 
				
			|||||||
	// +optional
 | 
						// +optional
 | 
				
			||||||
	CompletionTime *metav1.Time `json:"completionTime,omitempty" protobuf:"bytes,3,opt,name=completionTime"`
 | 
						CompletionTime *metav1.Time `json:"completionTime,omitempty" protobuf:"bytes,3,opt,name=completionTime"`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	// The number of pending and running pods.
 | 
						// The number of pending and running pods which are not terminating (without
 | 
				
			||||||
 | 
						// a deletionTimestamp).
 | 
				
			||||||
	// +optional
 | 
						// +optional
 | 
				
			||||||
	Active int32 `json:"active,omitempty" protobuf:"varint,4,opt,name=active"`
 | 
						Active int32 `json:"active,omitempty" protobuf:"varint,4,opt,name=active"`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -137,7 +137,7 @@ var map_JobStatus = map[string]string{
 | 
				
			|||||||
	"conditions":              "The latest available observations of an object's current state. When a Job fails, one of the conditions will have type \"Failed\" and status true. When a Job is suspended, one of the conditions will have type \"Suspended\" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type \"Complete\" and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/",
 | 
						"conditions":              "The latest available observations of an object's current state. When a Job fails, one of the conditions will have type \"Failed\" and status true. When a Job is suspended, one of the conditions will have type \"Suspended\" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type \"Complete\" and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/",
 | 
				
			||||||
	"startTime":               "Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.",
 | 
						"startTime":               "Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.",
 | 
				
			||||||
	"completionTime":          "Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully.",
 | 
						"completionTime":          "Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully.",
 | 
				
			||||||
	"active":                  "The number of pending and running pods.",
 | 
						"active":                  "The number of pending and running pods which are not terminating (without a deletionTimestamp).",
 | 
				
			||||||
	"succeeded":               "The number of pods which reached phase Succeeded.",
 | 
						"succeeded":               "The number of pods which reached phase Succeeded.",
 | 
				
			||||||
	"failed":                  "The number of pods which reached phase Failed.",
 | 
						"failed":                  "The number of pods which reached phase Failed.",
 | 
				
			||||||
	"terminating":             "The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp).\n\nThis field is beta-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (enabled by default).",
 | 
						"terminating":             "The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp).\n\nThis field is beta-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (enabled by default).",
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user