Added ProviderReference description

crossplane-contrib · Mar 18, 2024 · bc16e85 · bc16e85
1 parent a8af5e0
commit bc16e85
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/apis/civo/cluster/v1alpha1/types.go b/apis/civo/cluster/v1alpha1/types.go
@@ -61,6 +61,7 @@ type CivoKubernetesSpec struct {
 	// Changing the version to a higher version will upgrade the cluster. Note that this may cause breaking changes to the Kubernetes API so please check kubernetes deprecations/mitigations before upgrading.
 	Version *string `json:"version,omitempty"`
 
+	// ProviderReference holds configs (region, API key etc) for the crossplane provider that is being used.
 	ProviderReference *xpv1.Reference `json:"providerReference"`
 	// TODO: Update the examples as well
 }

diff --git a/apis/civo/instance/v1alpha1/types.go b/apis/civo/instance/v1alpha1/types.go
@@ -58,7 +58,9 @@ type SecretReference struct {
 type CivoInstanceSpec struct {
 	xpv1.ResourceSpec `json:",inline"`
 	InstanceConfig    CivoInstanceConfig `json:"instanceConfig"`
-	ProviderReference *xpv1.Reference    `json:"providerReference"`
+
+	// ProviderReference holds configs (region, API key etc) for the crossplane provider that is being used.
+	ProviderReference *xpv1.Reference `json:"providerReference"`
 }
 
 // CivoInstanceObservation observation fields

diff --git a/package/crds/cluster.civo.crossplane.io_civokubernetes.yaml b/package/crds/cluster.civo.crossplane.io_civokubernetes.yaml
@@ -176,7 +176,8 @@ spec:
                 - name
                 type: object
               providerReference:
-                description: A Reference to a named object.
+                description: ProviderReference holds configs (region, API key etc)
+                  for the crossplane provider that is being used.
                 properties:
                   name:
                     description: Name of the referenced object.

diff --git a/package/crds/instance.civo.crossplane.io_civoinstances.yaml b/package/crds/instance.civo.crossplane.io_civoinstances.yaml
@@ -174,7 +174,8 @@ spec:
                 - name
                 type: object
               providerReference:
-                description: A Reference to a named object.
+                description: ProviderReference holds configs (region, API key etc)
+                  for the crossplane provider that is being used.
                 properties:
                   name:
                     description: Name of the referenced object.