Merge pull request #5611 from RainbowMango/pr_update_work_api_comments

Correct SuspendDispatching comments and add notes.
karmada-io · Sep 26, 2024 · 8906ec0 · 8906ec0
2 parents 4f7dc2c + 6b3a781
commit 8906ec0
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 4 deletions.
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -19847,7 +19847,7 @@
           "type": "boolean"
         },
         "suspendDispatching": {
-          "description": "SuspendDispatching controls whether dispatching should be suspended, nil means not suspend. Note: true means stop propagating to all clusters.",
+          "description": "SuspendDispatching controls whether dispatching should be suspended, nil means not suspend. Note: true means stop propagating to the corresponding member cluster, and does not prevent status collection.",
           "type": "boolean"
         },
         "workload": {

diff --git a/charts/karmada/_crds/bases/work/work.karmada.io_works.yaml b/charts/karmada/_crds/bases/work/work.karmada.io_works.yaml
@@ -65,7 +65,8 @@ spec:
                 description: |-
                   SuspendDispatching controls whether dispatching should
                   be suspended, nil means not suspend.
-                  Note: true means stop propagating to all clusters.
+                  Note: true means stop propagating to the corresponding member cluster, and
+                  does not prevent status collection.
                 type: boolean
               workload:
                 description: Workload represents the manifest workload to be deployed

diff --git a/pkg/apis/work/v1alpha1/work_types.go b/pkg/apis/work/v1alpha1/work_types.go
@@ -60,7 +60,8 @@ type WorkSpec struct {
 
 	// SuspendDispatching controls whether dispatching should
 	// be suspended, nil means not suspend.
-	// Note: true means stop propagating to all clusters.
+	// Note: true means stop propagating to the corresponding member cluster, and
+	// does not prevent status collection.
 	// +optional
 	SuspendDispatching *bool `json:"suspendDispatching,omitempty"`
 

diff --git a/pkg/generated/openapi/zz_generated.openapi.go b/pkg/generated/openapi/zz_generated.openapi.go