Improve ClusterServiceVersion schema

Fixes #167 Add descriptions for kind, name, and version properties of APIResourceReference schema.
operator-framework · Nov 2, 2021 · 8818a44 · 8818a44
1 parent 37561c9
commit 8818a44
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/crds/operators.coreos.com_clusterserviceversions.yaml b/crds/operators.coreos.com_clusterserviceversions.yaml
@@ -127,10 +127,13 @@ spec:
                                 - version
                               properties:
                                 kind:
+                                  description: Kind of the referent
                                   type: string
                                 name:
+                                  description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
                                   type: string
                                 version:
+                                  description: The API version of the referent
                                   type: string
                           specDescriptors:
                             type: array
@@ -237,10 +240,13 @@ spec:
                                 - version
                               properties:
                                 kind:
+                                  description: Kind of the referent
                                   type: string
                                 name:
+                                  description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
                                   type: string
                                 version:
+                                  description: The API version of the referent
                                   type: string
                           specDescriptors:
                             type: array
@@ -349,12 +355,16 @@ spec:
                                 - kind
                                 - name
                                 - version
+                              properties:
                               properties:
                                 kind:
+                                  description: Kind of the referent
                                   type: string
                                 name:
+                                  description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
                                   type: string
                                 version:
+                                  description: API version of the referent
                                   type: string
                           specDescriptors:
                             type: array
@@ -453,10 +463,13 @@ spec:
                                 - version
                               properties:
                                 kind:
+                                  description: Kind of the referent
                                   type: string
                                 name:
+                                  description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
                                   type: string
                                 version:
+                                  description: The API version of the referent
                                   type: string
                           specDescriptors:
                             type: array