generate api-docs

grafana · May 31, 2022 · ee164e8 · ee164e8
1 parent 7750acf
commit ee164e8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/deploy/manifests/latest/crds.yaml b/deploy/manifests/latest/crds.yaml
@@ -54,7 +54,10 @@ spec:
               contentCacheDuration:
                 description: ContentCacheDuration sets how often the operator should
                   resync with the external source when using the `grafanaCom.id` or
-                  `url` field to specify the source of the dashboard.
+                  `url` field to specify the source of the dashboard. The default
+                  value is decided by the `dashboardContentCacheDuration` field in
+                  the `Grafana` resource. The default is 0 which is interpreted as
+                  never refetching.
                 type: string
               customFolderName:
                 type: string
@@ -2456,6 +2459,7 @@ spec:
               dashboardContentCacheDuration:
                 description: DashboardContentCacheDuration sets a default for when
                   a `GrafanaDashboard` resource doesn't specify a `contentCacheDuration`.
+                  If left unset or 0 the default behaviour is to cache indefinitely.
                 type: string
               dashboardLabelSelector:
                 items:

diff --git a/documentation/api.md b/documentation/api.md
@@ -100,7 +100,7 @@ GrafanaDashboardSpec defines the desired state of GrafanaDashboard
         <td><b>contentCacheDuration</b></td>
         <td>string</td>
         <td>
-          ContentCacheDuration sets how often the operator should resync with the external source when using the `grafanaCom.id` or `url` field to specify the source of the dashboard.<br/>
+          ContentCacheDuration sets how often the operator should resync with the external source when using the `grafanaCom.id` or `url` field to specify the source of the dashboard. The default value is decided by the `dashboardContentCacheDuration` field in the `Grafana` resource. The default is 0 which is interpreted as never refetching.<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -1963,7 +1963,7 @@ Grafana is the Schema for the grafanas API
         <td><b>dashboardContentCacheDuration</b></td>
         <td>string</td>
         <td>
-          DashboardContentCacheDuration sets a default for when a `GrafanaDashboard` resource doesn't specify a `contentCacheDuration`.<br/>
+          DashboardContentCacheDuration sets a default for when a `GrafanaDashboard` resource doesn't specify a `contentCacheDuration`. If left unset or 0 the default behaviour is to cache indefinitely.<br/>
         </td>
         <td>false</td>
       </tr><tr>