Dashboard Controls: Fix schema transformation for link placement (#114630)

* fix: add missing transformation for scenes -> save model v2 * fix: link placement transformation on the backend between schemas * fix: update the openapi spec in the tests * tes: add tests for `transformSceneToSaveModelSchemaV2` * tests: extend conversion_test.go to cover link placements
2025-12-02 13:12:01 +00:00
parent 09883ab4ee
commit 0e6166a753
17 changed files with 120 additions and 2 deletions
@@ -113,8 +113,14 @@ DashboardLink: {
 	includeVars: bool | *false
 	// If true, includes current time range in the link as query params
 	keepTime: bool | *false
+	// Placement can be used to display the link somewhere else on the dashboard other than above the visualisations.
+	placement?: DashboardLinkPlacement
 }

+// Dashboard Link placement. Defines where the link should be displayed. 
+// - "inControlsMenu" renders the link in bottom part of the dashboard controls dropdown menu
+DashboardLinkPlacement: "inControlsMenu"
+
 DataSourceRef: {
 	// The plugin type-id
 	type?: string
@@ -1216,6 +1216,8 @@ type DashboardDashboardLink struct {
 	IncludeVars bool `json:"includeVars"`
 	// If true, includes current time range in the link as query params
 	KeepTime bool `json:"keepTime"`
+	// Placement can be used to display the link somewhere else on the dashboard other than above the visualisations.
+	Placement *string `json:"placement,omitempty"`
 }

 // NewDashboardDashboardLink creates a new DashboardDashboardLink object.
@@ -1226,6 +1228,7 @@ func NewDashboardDashboardLink() *DashboardDashboardLink {
 		TargetBlank: false,
 		IncludeVars: false,
 		KeepTime:    false,
+		Placement:   (func(input string) *string { return &input })(DashboardDashboardLinkPlacement),
 	}
 }

@@ -1238,6 +1241,11 @@ const (
 	DashboardDashboardLinkTypeDashboards DashboardDashboardLinkType = "dashboards"
 )

+// Dashboard Link placement. Defines where the link should be displayed.
+// - "inControlsMenu" renders the link in bottom part of the dashboard controls dropdown menu
+// +k8s:openapi-gen=true
+const DashboardDashboardLinkPlacement = "inControlsMenu"
+
 // Time configuration
 // It defines the default time config for the time picker, the refresh picker for the specific dashboard.
 // +k8s:openapi-gen=true
@@ -1600,6 +1600,13 @@ func schema_pkg_apis_dashboard_v2alpha1_DashboardDashboardLink(ref common.Refere
 							Format:      "",
 						},
 					},
+					"placement": {
+						SchemaProps: spec.SchemaProps{
+							Description: "Placement can be used to display the link somewhere else on the dashboard other than above the visualisations.",
+							Type:        []string{"string"},
+							Format:      "",
+						},
+					},
 				},
 				Required: []string{"title", "type", "icon", "tooltip", "tags", "asDropdown", "targetBlank", "includeVars", "keepTime"},
 			},
@@ -70,6 +70,7 @@
        "title": "Documentation",
        "tooltip": "View documentation",
        "type": "link",
+        "placement": "inControlsMenu",
        "url": "https://docs.example.com/dashboard-guide"
      },
      {
@@ -69,6 +69,7 @@
        "title": "Documentation",
        "tooltip": "View documentation",
        "type": "link",
+        "placement": "inControlsMenu",
        "url": "https://docs.example.com/dashboard-guide"
      },
      {
@@ -132,7 +132,8 @@
        "asDropdown": false,
        "targetBlank": true,
        "includeVars": false,
-        "keepTime": false
+        "keepTime": false,
+        "placement": "inControlsMenu"
      },
      {
        "title": "Tag-based Link",
@@ -137,7 +137,8 @@
        "asDropdown": false,
        "targetBlank": true,
        "includeVars": false,
-        "keepTime": false
+        "keepTime": false,
+        "placement": "inControlsMenu"
      },
      {
        "title": "Tag-based Link",
@@ -376,6 +376,13 @@ func transformLinks(dashboard map[string]interface{}) []dashv2alpha1.DashboardDa
 					}
 				}

+				// Optional placement field - only set if present
+				if placement, exists := linkMap["placement"]; exists {
+					if placementStr, ok := placement.(string); ok {
+						dashLink.Placement = &placementStr
+					}
+				}
+
 				result = append(result, dashLink)
 			}
 		}
@@ -548,6 +548,7 @@ func convertDashboardLink_V2alpha1_to_V2beta1(in *dashv2alpha1.DashboardDashboar
 	out.TargetBlank = in.TargetBlank
 	out.IncludeVars = in.IncludeVars
 	out.KeepTime = in.KeepTime
+	out.Placement = in.Placement
 }

 func convertDataLink_V2alpha1_to_V2beta1(in *dashv2alpha1.DashboardDataLink, out *dashv2beta1.DashboardDataLink) {
@@ -565,6 +565,7 @@ func convertDashboardLink_V2beta1_to_V2alpha1(in *dashv2beta1.DashboardDashboard
 	out.TargetBlank = in.TargetBlank
 	out.IncludeVars = in.IncludeVars
 	out.KeepTime = in.KeepTime
+	out.Placement = in.Placement
 }

 func convertDataLink_V2beta1_to_V2alpha1(in *dashv2beta1.DashboardDataLink, out *dashv2alpha1.DashboardDataLink) {