remove comments about defaults

kubernetes-sigs · Jul 26, 2024 · 8a1b2ee · 8a1b2ee
1 parent 95fc11b
commit 8a1b2ee
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 16 deletions.
diff --git a/api/jobset/v1alpha2/jobset_types.go b/api/jobset/v1alpha2/jobset_types.go
@@ -344,11 +344,9 @@ type Coordinator struct {
 
 	// JobIndex is the index of Job which contains the coordinator pod
 	// (i.e., for a ReplicatedJob with N replicas, there are Job indexes 0 to N-1).
-	// Defaults to 0 if unset.
 	JobIndex int `json:"jobIndex,omitempty"`
 
 	// PodIndex is the Job completion index of the coordinator pod.
-	// Defaults to 0 if unset.
 	PodIndex int `json:"podIndex,omitempty"`
 }
 

diff --git a/api/jobset/v1alpha2/openapi_generated.go b/api/jobset/v1alpha2/openapi_generated.go
diff --git a/config/components/crd/bases/jobset.x-k8s.io_jobsets.yaml b/config/components/crd/bases/jobset.x-k8s.io_jobsets.yaml
@@ -71,12 +71,10 @@ spec:
                     description: |-
                       JobIndex is the index of Job which contains the coordinator pod
                       (i.e., for a ReplicatedJob with N replicas, there are Job indexes 0 to N-1).
-                      Defaults to 0 if unset.
                     type: integer
                   podIndex:
-                    description: |-
-                      PodIndex is the Job completion index of the coordinator pod.
-                      Defaults to 0 if unset.
+                    description: PodIndex is the Job completion index of the coordinator
+                      pod.
                     type: integer
                   replicatedJob:
                     description: |-

diff --git a/hack/python-sdk/swagger.json b/hack/python-sdk/swagger.json
@@ -15,12 +15,12 @@
       ],
       "properties": {
         "jobIndex": {
-          "description": "JobIndex is the index of Job which contains the coordinator pod (i.e., for a ReplicatedJob with N replicas, there are Job indexes 0 to N-1). Defaults to 0 if unset.",
+          "description": "JobIndex is the index of Job which contains the coordinator pod (i.e., for a ReplicatedJob with N replicas, there are Job indexes 0 to N-1).",
           "type": "integer",
           "format": "int32"
         },
         "podIndex": {
-          "description": "PodIndex is the Job completion index of the coordinator pod. Defaults to 0 if unset.",
+          "description": "PodIndex is the Job completion index of the coordinator pod.",
           "type": "integer",
           "format": "int32"
         },

diff --git a/sdk/python/docs/JobsetV1alpha2Coordinator.md b/sdk/python/docs/JobsetV1alpha2Coordinator.md
@@ -4,8 +4,8 @@ Coordinator defines which pod can be marked as the coordinator for the JobSet wo
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**job_index** | **int** | JobIndex is the index of Job which contains the coordinator pod (i.e., for a ReplicatedJob with N replicas, there are Job indexes 0 to N-1). Defaults to 0 if unset. | [optional] 
-**pod_index** | **int** | PodIndex is the Job completion index of the coordinator pod. Defaults to 0 if unset. | [optional] 
+**job_index** | **int** | JobIndex is the index of Job which contains the coordinator pod (i.e., for a ReplicatedJob with N replicas, there are Job indexes 0 to N-1). | [optional] 
+**pod_index** | **int** | PodIndex is the Job completion index of the coordinator pod. | [optional] 
 **replicated_job** | **str** | ReplicatedJob is the name of the ReplicatedJob which contains the coordinator pod. | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/sdk/python/jobset/models/jobset_v1alpha2_coordinator.py b/sdk/python/jobset/models/jobset_v1alpha2_coordinator.py
@@ -65,7 +65,7 @@ def __init__(self, job_index=None, pod_index=None, replicated_job='', local_vars
     def job_index(self):
         """Gets the job_index of this JobsetV1alpha2Coordinator.  # noqa: E501
 
-        JobIndex is the index of Job which contains the coordinator pod (i.e., for a ReplicatedJob with N replicas, there are Job indexes 0 to N-1). Defaults to 0 if unset.  # noqa: E501
+        JobIndex is the index of Job which contains the coordinator pod (i.e., for a ReplicatedJob with N replicas, there are Job indexes 0 to N-1).  # noqa: E501
 
         :return: The job_index of this JobsetV1alpha2Coordinator.  # noqa: E501
         :rtype: int
@@ -76,7 +76,7 @@ def job_index(self):
     def job_index(self, job_index):
         """Sets the job_index of this JobsetV1alpha2Coordinator.
 
-        JobIndex is the index of Job which contains the coordinator pod (i.e., for a ReplicatedJob with N replicas, there are Job indexes 0 to N-1). Defaults to 0 if unset.  # noqa: E501
+        JobIndex is the index of Job which contains the coordinator pod (i.e., for a ReplicatedJob with N replicas, there are Job indexes 0 to N-1).  # noqa: E501
 
         :param job_index: The job_index of this JobsetV1alpha2Coordinator.  # noqa: E501
         :type: int
@@ -88,7 +88,7 @@ def job_index(self, job_index):
     def pod_index(self):
         """Gets the pod_index of this JobsetV1alpha2Coordinator.  # noqa: E501
 
-        PodIndex is the Job completion index of the coordinator pod. Defaults to 0 if unset.  # noqa: E501
+        PodIndex is the Job completion index of the coordinator pod.  # noqa: E501
 
         :return: The pod_index of this JobsetV1alpha2Coordinator.  # noqa: E501
         :rtype: int
@@ -99,7 +99,7 @@ def pod_index(self):
     def pod_index(self, pod_index):
         """Sets the pod_index of this JobsetV1alpha2Coordinator.
 
-        PodIndex is the Job completion index of the coordinator pod. Defaults to 0 if unset.  # noqa: E501
+        PodIndex is the Job completion index of the coordinator pod.  # noqa: E501
 
         :param pod_index: The pod_index of this JobsetV1alpha2Coordinator.  # noqa: E501
         :type: int