Extract comments

K-Phoen · Feb 8, 2024 · 5bac2ee · 5bac2ee
1 parent b7d18c0
commit 5bac2ee
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/cmd/generate-jsonschema/main.go b/cmd/generate-jsonschema/main.go
@@ -35,6 +35,11 @@ func main() {
 				return key
 			},
 		}
+
+		if err := reflector.AddGoComments("github.com/K-Phoen/grabana", "./decoder"); err != nil {
+			panic(fmt.Errorf("could not add Go comments to reflector: %w", err))
+		}
+
 		schema := reflector.Reflect(t.input)
 		schema.ID = jsonschema.ID(fmt.Sprintf("https://raw.githubusercontent.com/K-Phoen/grabana/master/schemas/%s.json", t.name))
 

diff --git a/schemas/dashboard.json b/schemas/dashboard.json
@@ -66,7 +66,8 @@
           "type": "string"
         },
         "avg": {
-          "type": "string"
+          "type": "string",
+          "description": "Query reducers, only one should be used"
         },
         "sum": {
           "type": "string"
@@ -437,7 +438,8 @@
         }
       },
       "additionalProperties": false,
-      "type": "object"
+      "type": "object",
+      "description": "DashboardHeatmap represents a heatmap panel."
     },
     "DashboardInternalLink": {
       "properties": {
@@ -655,7 +657,8 @@
         }
       },
       "additionalProperties": false,
-      "type": "object"
+      "type": "object",
+      "description": "DashboardRow represents a dashboard row."
     },
     "DashboardSingleStat": {
       "properties": {
@@ -863,7 +866,8 @@
         }
       },
       "additionalProperties": false,
-      "type": "object"
+      "type": "object",
+      "description": "DashboardTable represents a table panel."
     },
     "DashboardText": {
       "properties": {