Merge pull request #125189 from mimowo/improve-ready-comment

Improve the Job API comment for ready field
kubernetes · Jun 5, 2024 · 9e2075b · 9e2075b
2 parents d8b33e3 + 551464f
commit 9e2075b
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 9 deletions.
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
diff --git a/api/openapi-spec/v3/apis__batch__v1_openapi.json b/api/openapi-spec/v3/apis__batch__v1_openapi.json
@@ -459,7 +459,7 @@
             "type": "string"
           },
           "ready": {
-            "description": "The number of pods which have a Ready condition.",
+            "description": "The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).",
             "format": "int32",
             "type": "integer"
           },

diff --git a/pkg/apis/batch/types.go b/pkg/apis/batch/types.go
@@ -537,7 +537,8 @@ type JobStatus struct {
 	// +optional
 	Terminating *int32
 
-	// The number of active pods which have a Ready condition.
+	// The number of active pods which have a Ready condition and are not
+	// terminating (without a deletionTimestamp).
 	// +optional
 	Ready *int32
 

diff --git a/pkg/generated/openapi/zz_generated.openapi.go b/pkg/generated/openapi/zz_generated.openapi.go
diff --git a/staging/src/k8s.io/api/batch/v1/generated.proto b/staging/src/k8s.io/api/batch/v1/generated.proto
diff --git a/staging/src/k8s.io/api/batch/v1/types.go b/staging/src/k8s.io/api/batch/v1/types.go
@@ -597,8 +597,8 @@ type JobStatus struct {
 	// +optional
 	UncountedTerminatedPods *UncountedTerminatedPods `json:"uncountedTerminatedPods,omitempty" protobuf:"bytes,8,opt,name=uncountedTerminatedPods"`
 
-	// The number of pods which have a Ready condition.
-	// +optional
+	// The number of active pods which have a Ready condition and are not
+	// terminating (without a deletionTimestamp).
 	Ready *int32 `json:"ready,omitempty" protobuf:"varint,9,opt,name=ready"`
 }
 

diff --git a/staging/src/k8s.io/api/batch/v1/types_swagger_doc_generated.go b/staging/src/k8s.io/api/batch/v1/types_swagger_doc_generated.go