Improve the API generated docs for managedBy

api/jobset/v1alpha2/jobset_types.go

@@ -94,7 +94,18 @@ type JobSetSpec struct {
 	// Suspend suspends all running child Jobs when set to true.
 	Suspend *bool `json:"suspend,omitempty"`
 
-	// ManagedBy is used to indicate the controller or entity that manages a JobSet
+	// ManagedBy is used to indicate the controller or entity that manages a JobSet.
+	// The built-in JobSet controller reconciles JobSets which don't have this
+	// field at all or the field value is the reserved string
+	// `jobset.sigs.k8s.io/jobset-controller`, but skips reconciling JobSets
+	// with a custom value for this field.
+	//
+	// The value must be a valid domain-prefixed path (e.g. acme.io/foo) -
+	// all characters before the first "/" must be a valid subdomain as defined
+	// by RFC 1123. All characters trailing the first "/" must be valid HTTP Path
+	// characters as defined by RFC 3986. The value cannot exceed 63 characters.
+	// The field is immutable.
+	// +optional
 	ManagedBy *string `json:"managedBy,omitempty"`
 
 	// TTLSecondsAfterFinished limits the lifetime of a JobSet that has finished

config/components/crd/bases/jobset.x-k8s.io_jobsets.yaml

@@ -73,8 +73,19 @@ spec:
                 - message: Value is immutable
                   rule: self == oldSelf
               managedBy:
-                description: ManagedBy is used to indicate the controller or entity
-                  that manages a JobSet
+                description: |-
+                  ManagedBy is used to indicate the controller or entity that manages a JobSet.
+                  The built-in JobSet controller reconciles JobSets which don't have this
+                  field at all or the field value is the reserved string
+                  `jobset.sigs.k8s.io/jobset-controller`, but skips reconciling JobSets
+                  with a custom value for this field.
+
+
+                  The value must be a valid domain-prefixed path (e.g. acme.io/foo) -
+                  all characters before the first "/" must be a valid subdomain as defined
+                  by RFC 1123. All characters trailing the first "/" must be valid HTTP Path
+                  characters as defined by RFC 3986. The value cannot exceed 63 characters.
+                  The field is immutable.
                 type: string
               network:
                 description: Network defines the networking options for the jobset.

hack/python-sdk/swagger.json

@@ -80,7 +80,7 @@
           "$ref": "#/definitions/jobset.v1alpha2.FailurePolicy"
         },
         "managedBy": {
-          "description": "ManagedBy is used to indicate the controller or entity that manages a JobSet",
+          "description": "ManagedBy is used to indicate the controller or entity that manages a JobSet. The built-in JobSet controller reconciles JobSets which don't have this field at all or the field value is the reserved string `jobset.sigs.k8s.io/jobset-controller`, but skips reconciling JobSets with a custom value for this field.\n\nThe value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first \"/\" must be a valid subdomain as defined by RFC 1123. All characters trailing the first \"/\" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. The field is immutable.",
           "type": "string"
         },
         "network": {

sdk/python/docs/JobsetV1alpha2JobSetSpec.md

@@ -5,7 +5,7 @@ JobSetSpec defines the desired state of JobSet
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **failure_policy** | [**JobsetV1alpha2FailurePolicy**](JobsetV1alpha2FailurePolicy.md) |  | [optional] 
-**managed_by** | **str** | ManagedBy is used to indicate the controller or entity that manages a JobSet | [optional] 
+**managed_by** | **str** | ManagedBy is used to indicate the controller or entity that manages a JobSet. The built-in JobSet controller reconciles JobSets which don't have this field at all or the field value is the reserved string `jobset.sigs.k8s.io/jobset-controller`, but skips reconciling JobSets with a custom value for this field.  The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first \"/\" must be a valid subdomain as defined by RFC 1123. All characters trailing the first \"/\" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. The field is immutable. | [optional] 
 **network** | [**JobsetV1alpha2Network**](JobsetV1alpha2Network.md) |  | [optional] 
 **replicated_jobs** | [**list[JobsetV1alpha2ReplicatedJob]**](JobsetV1alpha2ReplicatedJob.md) | ReplicatedJobs is the group of jobs that will form the set. | [optional] 
 **startup_policy** | [**JobsetV1alpha2StartupPolicy**](JobsetV1alpha2StartupPolicy.md) |  | [optional] 

sdk/python/jobset/models/jobset_v1alpha2_job_set_spec.py

@@ -112,7 +112,7 @@ def failure_policy(self, failure_policy):
     def managed_by(self):
         """Gets the managed_by of this JobsetV1alpha2JobSetSpec.  # noqa: E501
 
-        ManagedBy is used to indicate the controller or entity that manages a JobSet  # noqa: E501
+        ManagedBy is used to indicate the controller or entity that manages a JobSet. The built-in JobSet controller reconciles JobSets which don't have this field at all or the field value is the reserved string `jobset.sigs.k8s.io/jobset-controller`, but skips reconciling JobSets with a custom value for this field.  The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first \"/\" must be a valid subdomain as defined by RFC 1123. All characters trailing the first \"/\" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. The field is immutable.  # noqa: E501
 
         :return: The managed_by of this JobsetV1alpha2JobSetSpec.  # noqa: E501
         :rtype: str
@@ -123,7 +123,7 @@ def managed_by(self):
     def managed_by(self, managed_by):
         """Sets the managed_by of this JobsetV1alpha2JobSetSpec.
 
-        ManagedBy is used to indicate the controller or entity that manages a JobSet  # noqa: E501
+        ManagedBy is used to indicate the controller or entity that manages a JobSet. The built-in JobSet controller reconciles JobSets which don't have this field at all or the field value is the reserved string `jobset.sigs.k8s.io/jobset-controller`, but skips reconciling JobSets with a custom value for this field.  The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first \"/\" must be a valid subdomain as defined by RFC 1123. All characters trailing the first \"/\" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. The field is immutable.  # noqa: E501
 
         :param managed_by: The managed_by of this JobsetV1alpha2JobSetSpec.  # noqa: E501
         :type: str