Merge pull request #5611 from RainbowMango/pr_update_work_api_comments

Correct SuspendDispatching comments and add notes.
This commit is contained in:
karmada-bot 2024-09-26 21:20:10 +08:00 committed by GitHub
commit 8906ec0097
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 6 additions and 4 deletions

View File

@ -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": {

View File

@ -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

View File

@ -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"`

View File

@ -6530,7 +6530,7 @@ func schema_pkg_apis_work_v1alpha1_WorkSpec(ref common.ReferenceCallback) common
},
"suspendDispatching": {
SchemaProps: spec.SchemaProps{
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: []string{"boolean"},
Format: "",
},