Update incorrect deprecation message

grafana · Nov 2, 2024 · b5f819d · b5f819d
1 parent e030cee
commit b5f819d
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git a/api/v1beta1/grafanadatasource_types.go b/api/v1beta1/grafanadatasource_types.go
@@ -42,7 +42,9 @@ type GrafanaDatasourceInternal struct {
 
 	// Deprecated field, it has no effect
 	OrgID *int64 `json:"orgId,omitempty"`
-	// Deprecated field, it has no effect
+
+	// Whether to enable/disable editing of the datasource in Grafana UI
+	// +optional
 	Editable *bool `json:"editable,omitempty"`
 
 	// +kubebuilder:validation:Schemaless

diff --git a/config/crd/bases/grafana.integreatly.org_grafanadatasources.yaml b/config/crd/bases/grafana.integreatly.org_grafanadatasources.yaml
@@ -67,7 +67,8 @@ spec:
                   database:
                     type: string
                   editable:
-                    description: Deprecated field, it has no effect
+                    description: Whether to enable/disable editing of the datasource
+                      in Grafana UI
                     type: boolean
                   isDefault:
                     type: boolean

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanadatasources.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanadatasources.yaml
@@ -67,7 +67,8 @@ spec:
                   database:
                     type: string
                   editable:
-                    description: Deprecated field, it has no effect
+                    description: Whether to enable/disable editing of the datasource
+                      in Grafana UI
                     type: boolean
                   isDefault:
                     type: boolean

diff --git a/deploy/kustomize/base/crds.yaml b/deploy/kustomize/base/crds.yaml
@@ -1141,7 +1141,8 @@ spec:
                   database:
                     type: string
                   editable:
-                    description: Deprecated field, it has no effect
+                    description: Whether to enable/disable editing of the datasource
+                      in Grafana UI
                     type: boolean
                   isDefault:
                     type: boolean

diff --git a/docs/docs/api.md b/docs/docs/api.md
@@ -2397,7 +2397,7 @@ GrafanaDatasourceSpec defines the desired state of GrafanaDatasource
         <td><b>editable</b></td>
         <td>boolean</td>
         <td>
-          Deprecated field, it has no effect<br/>
+          Whether to enable/disable editing of the datasource in Grafana UI<br/>
         </td>
         <td>false</td>
       </tr><tr>