Update api docs

red-hat-data-services · Sep 16, 2024 · 76c835e · 76c835e
1 parent 78e140c
commit 76c835e
Show file tree

Hide file tree

Showing 11 changed files with 700 additions and 1,242 deletions.
diff --git a/config/crd/bases/datasciencecluster.opendatahub.io_datascienceclusters.yaml b/config/crd/bases/datasciencecluster.opendatahub.io_datascienceclusters.yaml
diff --git a/config/crd/bases/dscinitialization.opendatahub.io_dscinitializations.yaml b/config/crd/bases/dscinitialization.opendatahub.io_dscinitializations.yaml
diff --git a/config/crd/bases/features.opendatahub.io_featuretrackers.yaml b/config/crd/bases/features.opendatahub.io_featuretrackers.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.9.2
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.16.1
   name: featuretrackers.features.opendatahub.io
 spec:
   group: features.opendatahub.io
@@ -18,24 +17,29 @@ spec:
   - name: v1
     schema:
       openAPIV3Schema:
-        description: FeatureTracker represents a cluster-scoped resource in the Data
-          Science Cluster, specifically designed for monitoring and managing objects
-          created via the internal Features API. This resource serves a crucial role
-          in cross-namespace resource management, acting as an owner reference for
-          various resources. The primary purpose of the FeatureTracker is to enable
-          efficient garbage collection by Kubernetes. This is essential for ensuring
-          that resources are automatically cleaned up and reclaimed when they are
+        description: |-
+          FeatureTracker represents a cluster-scoped resource in the Data Science Cluster,
+          specifically designed for monitoring and managing objects created via the internal Features API.
+          This resource serves a crucial role in cross-namespace resource management, acting as
+          an owner reference for various resources. The primary purpose of the FeatureTracker
+          is to enable efficient garbage collection by Kubernetes. This is essential for
+          ensuring that resources are automatically cleaned up and reclaimed when they are
           no longer required.
         properties:
           apiVersion:
-            description: 'APIVersion defines the versioned schema of this representation
-              of an object. Servers should convert recognized schemas to the latest
-              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
             type: string
           kind:
-            description: 'Kind is a string value representing the REST resource this
-              object represents. Servers may infer this from the endpoint the client
-              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
             type: string
           metadata:
             type: object
@@ -59,8 +63,9 @@ spec:
             properties:
               conditions:
                 items:
-                  description: Condition represents the state of the operator's reconciliation
-                    functionality.
+                  description: |-
+                    Condition represents the state of the operator's
+                    reconciliation functionality.
                   properties:
                     lastHeartbeatTime:
                       format: date-time
@@ -84,9 +89,9 @@ spec:
                   type: object
                 type: array
               phase:
-                description: Phase describes the Phase of FeatureTracker reconciliation
-                  state. This is used by OLM UI to provide status information to the
-                  user.
+                description: |-
+                  Phase describes the Phase of FeatureTracker reconciliation state.
+                  This is used by OLM UI to provide status information to the user.
                 type: string
             type: object
         type: object

diff --git a/config/crd/external/route.openshift.io_routes.yaml b/config/crd/external/route.openshift.io_routes.yaml
diff --git a/config/crd/external/user.openshift.io_groups.yaml b/config/crd/external/user.openshift.io_groups.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.9.2
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.16.1
   name: groups.user.openshift.io
 spec:
   group: user.openshift.io
@@ -18,19 +17,25 @@ spec:
   - name: v1
     schema:
       openAPIV3Schema:
-        description: "Group represents a referenceable set of Users \n Compatibility
-          level 1: Stable within a major release for a minimum of 12 months or 3 minor
-          releases (whichever is longer)."
+        description: |-
+          Group represents a referenceable set of Users
+
+          Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
         properties:
           apiVersion:
-            description: 'APIVersion defines the versioned schema of this representation
-              of an object. Servers should convert recognized schemas to the latest
-              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
             type: string
           kind:
-            description: 'Kind is a string value representing the REST resource this
-              object represents. Servers may infer this from the endpoint the client
-              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
             type: string
           metadata:
             type: object

diff --git a/config/crd/external/user.openshift.io_identities.yaml b/config/crd/external/user.openshift.io_identities.yaml
@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.9.2
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: v0.16.1
   name: identities.user.openshift.io
 spec:
   group: user.openshift.io
@@ -18,29 +17,34 @@ spec:
   - name: v1
     schema:
       openAPIV3Schema:
-        description: "Identity records a successful authentication of a user with
-          an identity provider. The information about the source of authentication
-          is stored on the identity, and the identity is then associated with a single
-          user object. Multiple identities can reference a single user. Information
-          retrieved from the authentication provider is stored in the extra field
-          using a schema determined by the provider. \n Compatibility level 1: Stable
-          within a major release for a minimum of 12 months or 3 minor releases (whichever
-          is longer)."
+        description: |-
+          Identity records a successful authentication of a user with an identity provider. The
+          information about the source of authentication is stored on the identity, and the identity
+          is then associated with a single user object. Multiple identities can reference a single
+          user. Information retrieved from the authentication provider is stored in the extra field
+          using a schema determined by the provider.
+
+          Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
         properties:
           apiVersion:
-            description: 'APIVersion defines the versioned schema of this representation
-              of an object. Servers should convert recognized schemas to the latest
-              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
             type: string
           extra:
             additionalProperties:
               type: string
             description: Extra holds extra information about this identity
             type: object
           kind:
-            description: 'Kind is a string value representing the REST resource this
-              object represents. Servers may infer this from the endpoint the client
-              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
             type: string
           metadata:
             type: object
@@ -52,39 +56,47 @@ spec:
               scope of the provider
             type: string
           user:
-            description: User is a reference to the user this identity is associated
-              with Both Name and UID must be set
+            description: |-
+              User is a reference to the user this identity is associated with
+              Both Name and UID must be set
             properties:
               apiVersion:
                 description: API version of the referent.
                 type: string
               fieldPath:
-                description: 'If referring to a piece of an object instead of an entire
-                  object, this string should contain a valid JSON/Go field access
-                  statement, such as desiredState.manifest.containers[2]. For example,
-                  if the object reference is to a container within a pod, this would
-                  take on a value like: "spec.containers{name}" (where "name" refers
-                  to the name of the container that triggered the event) or if no
-                  container name is specified "spec.containers[2]" (container with
-                  index 2 in this pod). This syntax is chosen only to have some well-defined
-                  way of referencing a part of an object. TODO: this design is not
-                  final and this field is subject to change in the future.'
+                description: |-
+                  If referring to a piece of an object instead of an entire object, this string
+                  should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
+                  For example, if the object reference is to a container within a pod, this would take on a value like:
+                  "spec.containers{name}" (where "name" refers to the name of the container that triggered
+                  the event) or if no container name is specified "spec.containers[2]" (container with
+                  index 2 in this pod). This syntax is chosen only to have some well-defined way of
+                  referencing a part of an object.
                 type: string
               kind:
-                description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+                description: |-
+                  Kind of the referent.
+                  More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
                 type: string
               name:
-                description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+                description: |-
+                  Name of the referent.
+                  More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                 type: string
               namespace:
-                description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
+                description: |-
+                  Namespace of the referent.
+                  More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
                 type: string
               resourceVersion:
-                description: 'Specific resourceVersion to which this reference is
-                  made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
+                description: |-
+                  Specific resourceVersion to which this reference is made, if any.
+                  More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
                 type: string
               uid:
-                description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
+                description: |-
+                  UID of the referent.
+                  More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
                 type: string
             type: object
             x-kubernetes-map-type: atomic