FEATURE BRANCH: Add `v2alpha2` api version: Consolidate schema breaking changes #108172

dprokop · 2025-07-16T11:18:40Z

Includes:

…ard Sche… (#107985)" This reverts commit 13a89d4.

…107984)" This reverts commit 2b8c5be.

…everts

* Use v2alpha2 by default * Apply only DS changes to alpha2 * Use v2alpha2 by default except to query * Create a v2 index in @grafana/schema * Update path and apply lint * Update tests

…everts

e2e/dashboards/TestV2Dashboard.json

…everts

… variable (#108237) * Schema v2: Introduce group/datasource convention to GroupBy and AdHoc variables * add conversion * App Installer: Authorizer support (#108419) * Chore: use `satisfies` and remove a load of `any`s (#108397) use satisfies and remove a load of anys * improve logging and fail unified-storage migration with more than 0 errors (#108471) improve logging and fail unified-storage migration with more than 0 errors * fix conversion test * Secrets: Create more granular fixed roles for SecureValues (#108382) * Provisioning: Fix bug in job progress recording (#108440) Fix bug in job progress recording * Provisioning: Fix ImportAllPanelsFromLocalRepository test (#108441) * Provisioning: Skip flaky test * Fix flaky provisioning test * Fix lint --------- Co-authored-by: Roberto Jimenez Sanchez <[email protected]> * BulkDeleteProvisionedResource: Move progress bar into a second step (#108417) * Move progress bar into a second step --------- Co-authored-by: Alex Khomenko <[email protected]> * [Dashboard Schema Codegen] Move dashboard CUE codegen block back up into kind body (#108476) [Dashboard Schema Codegen] Move dashboard CUE codegen block back up into kind body to make sure new versions have the same settings. --------- Co-authored-by: Haris Rozajac <[email protected]> Co-authored-by: Todd Treece <[email protected]> Co-authored-by: Ashley Harrison <[email protected]> Co-authored-by: Will Assis <[email protected]> Co-authored-by: Matheus Macabu <[email protected]> Co-authored-by: Roberto Jiménez Sánchez <[email protected]> Co-authored-by: Roberto Jimenez Sanchez <[email protected]> Co-authored-by: Yunwen Zheng <[email protected]> Co-authored-by: Alex Khomenko <[email protected]> Co-authored-by: Austin Pond <[email protected]> Co-authored-by: Ivan Ortega <[email protected]>

…onvention (#108148) * Dashboards API: Register v2alpha2 API * Prepare conversion functions * Fix test * Refactor VizConfigKind to follow DataQueryKind convention * fix tests * use new dataquerykind convention alpha 2 * add conversion * fix tests * fix tests * fix another test * Fix merge --------- Co-authored-by: Dominik Prokop <[email protected]>

apps/alerting/notifications/pkg/apis/alerting_manifest.go

apps/alerting/notifications/Makefile

apps/folder/pkg/apis/folder_manifest.go

apps/secret/pkg/apis/secret_manifest.go

go.work.sum

pkg/registry/apis/secret/accesscontrol.go

pkg/services/apiserver/appinstaller/installer.go

public/app/plugins/datasource/tempo/traceql/traceql.test.ts

public/app/features/provisioning/Shared/ProgressBar.tsx

public/locales/en-US/grafana.json

ivanortegaalba

Let's remove unnecessary changes from other apps/* and code-wise looks good to me!

apps/alerting/notifications/pkg/apis/alerting/v0alpha1/receiver_schema_gen.go

ivanortegaalba · 2025-07-25T11:12:22Z

apps/dashboard/pkg/migration/conversion/testdata/output/v2alpha1.ds-data-query.v2alpha2.json

+    "variables": [
+      null,
+      null,
+      null,
+      null
+    ]


There are no conversions for variables!

great catch!

@ivanortegaalba - just pushed these :)

2d941da
be8b999

Copilot

Pull Request Overview

This PR adds support for the v2alpha2 API version by consolidating schema breaking changes. The main purpose is to update all imports and references from v2alpha1 to v2alpha2 throughout the codebase, while also implementing structural changes to better organize data queries and visualization configurations.

Key changes include:

Migration from v2alpha1 to v2alpha2 API version across all files
Restructuring of data query schema to use a more consistent DataQuery pattern with group and datasource properties
Refactoring of visualization configuration to separate plugin metadata from configuration data

Reviewed Changes

Copilot reviewed 107 out of 107 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/grafana-schema/src/schema/dashboard/v2alpha2/types.spec.gen.ts	New schema definition for v2alpha2 with restructured data queries and viz config
packages/grafana-schema/src/schema/dashboard/v2.ts	Updated export path to point to v2alpha2
public/app/features/dashboard/api/v2.ts	Updated API version constant from v2alpha1 to v2alpha2
Multiple test files	Updated API version references and test data structures
Multiple transformation files	Updated to handle new data query structure with group/datasource pattern

Copilot · 2025-07-25T11:14:17Z

packages/grafana-schema/src/schema/dashboard/v2alpha2/types.spec.gen.ts

 	enable: boolean;
 	hide: boolean;
 	iconColor: string;
 	name: string;
 	builtIn?: boolean;
 	filter?: AnnotationPanelFilter;
-	// Catch-all field for datasource-specific properties
+	// Catch-all field for datasource-specific properties. Should not be available in as code tooling.


The comment states this field 'should not be available in as code tooling' but doesn't explain why or provide guidance on alternatives. Consider expanding this comment to explain the intended use case and provide clearer guidance.

Suggested change

// Catch-all field for datasource-specific properties. Should not be available in as code tooling.

// Catch-all field for datasource-specific properties. This field is intended for internal use by datasources

// to store configuration options that are not part of the standard schema. It should not be available in

// "as code" tooling because its structure is highly dynamic and specific to individual datasources, making

// it unsuitable for validation or code generation. Developers should avoid relying on this field in generic

// tooling and instead use well-defined schema fields whenever possible.

Copilot · 2025-07-25T11:14:18Z

public/app/features/dashboard-scene/serialization/transformSceneToSaveModelSchemaV2.ts

+      console.error(
+        'Misconfigured AnnotationsDataLayer: Data source is required for annotations. Resolving default data source',
+        layer,
+        layerDs


Using console.error directly in production code is not recommended. Consider using a proper logging framework or service that can be configured for different environments.

Suggested change

console.error(

'Misconfigured AnnotationsDataLayer: Data source is required for annotations. Resolving default data source',

layer,

layerDs

const logger = getLogger('transformSceneToSaveModelSchemaV2');

logger.error(

'Misconfigured AnnotationsDataLayer: Data source is required for annotations. Resolving default data source',

{ layer, layerDs }

Copilot · 2025-07-25T11:14:18Z

public/app/features/dashboard-scene/serialization/layoutSerializers/utils.ts

@@ -257,14 +266,22 @@ function getDataSourceForQuery(
    };
  }

-  // If we don't find a default datasource, return undefined
-  return undefined;
+  if (dsList && !dsList[defaultDatasource]) {


The condition checks if dsList exists but then accesses dsList[defaultDatasource] without verifying that defaultDatasource is defined. This could throw an error if defaultDatasource is undefined or null.

Copilot · 2025-07-25T11:14:18Z

public/app/features/dashboard-scene/serialization/transformSceneToSaveModelSchemaV2.ts

+      if (!dataQuery.datasource?.name) {
+        delete dataQuery.datasource;
+      }


The logic for handling missing datasource names appears in multiple places. Consider extracting this into a utility function to reduce code duplication and improve maintainability.

Suggested change

if (!dataQuery.datasource?.name) {

delete dataQuery.datasource;

}

const sanitizedDataQuery = sanitizeDatasource(dataQuery);

dprokop added 2 commits July 16, 2025 13:15

Revert "Revert: Future-proofing query and data source model in Dashbo…

131db99

…ard Sche… (#107985)" This reverts commit 13a89d4.

Revert "Revert "Schema V2: Simplify annotations v1<->v2 conversions" (#…

1f5c38d

…107984)" This reverts commit 2b8c5be.

github-actions bot added area/frontend area/backend labels Jul 16, 2025

dprokop and others added 2 commits July 16, 2025 13:20

make gen apps

66edc91

Merge remote-tracking branch 'origin/main' into schemav2-bring-back-r…

2911267

…everts

dprokop added no-backport Skip backport of PR no-changelog Skip including change in changelog/release notes labels Jul 17, 2025

dprokop added 2 commits July 17, 2025 10:37

Merge branch 'main' into schemav2-bring-back-reverts

ca75da2

e2e update

57a7cb0

dprokop changed the title ~~Schemav2 bring back reverts~~ Consolidate Breaking changes from DS refactor through app platform conversion Jul 17, 2025

ivanortegaalba changed the title ~~Consolidate Breaking changes from DS refactor through app platform conversion~~ Add v2alpha2 api version: Consolidate schema breaking changes Jul 17, 2025

ivanortegaalba and others added 4 commits July 17, 2025 12:17

Use v2alpha2 by default (#108177)

2f0ec81

* Use v2alpha2 by default * Apply only DS changes to alpha2 * Use v2alpha2 by default except to query * Create a v2 index in @grafana/schema * Update path and apply lint * Update tests

Update imports to v2 status

4d4b053

Fix failing openapi test

022d439

Merge remote-tracking branch 'origin/main' into schemav2-bring-back-r…

b38d62d

…everts

dprokop added no-changelog Skip including change in changelog/release notes and removed no-changelog Skip including change in changelog/release notes labels Jul 17, 2025

dprokop marked this pull request as ready for review July 17, 2025 14:17

dprokop requested review from a team as code owners July 17, 2025 14:17

dprokop requested review from axelavargas and juanicabanas and removed request for a team July 17, 2025 14:17

harisrozajac reviewed Jul 18, 2025

View reviewed changes

e2e/dashboards/TestV2Dashboard.json Outdated Show resolved Hide resolved

dprokop and others added 2 commits July 22, 2025 12:41

Merge remote-tracking branch 'origin/main' into schemav2-bring-back-r…

2e9641d

…everts

github-actions bot added the datasource/Tempo label Jul 22, 2025

harisrozajac and others added 2 commits July 22, 2025 17:48

fix k8s codegen

ab54567

ivanortegaalba reviewed Jul 22, 2025

View reviewed changes

ivanortegaalba added area/dashboard/schemas/v2 and removed datasource/Tempo labels Jul 22, 2025

github-actions bot added the datasource/Tempo label Jul 22, 2025

Merge branch 'main' into schemav2-bring-back-reverts

035cff6

harisrozajac marked this pull request as ready for review July 23, 2025 14:55

harisrozajac requested a review from a team as a code owner July 23, 2025 14:55

ivanortegaalba reviewed Jul 24, 2025

View reviewed changes

dprokop requested a review from stephaniehingtgen July 24, 2025 14:12

harisrozajac and others added 3 commits July 24, 2025 08:23

Update e2e-playwright/dashboards/TestV2Dashboard.json

a1c31c4

Update e2e/dashboards/TestV2Dashboard.json

1924c7f

revert app generation for non-related apps

3bcd7c8

harisrozajac reviewed Jul 24, 2025

View reviewed changes

apps/alerting/notifications/pkg/apis/alerting/v0alpha1/receiver_schema_gen.go Outdated Show resolved Hide resolved

harisrozajac added 4 commits July 24, 2025 08:45

try again

ac4d5da

another try

77a559c

also revert folder and secret app generation

d164b93

Merge branch 'main' into schemav2-bring-back-reverts

585363b

ivanortegaalba requested changes Jul 25, 2025

View reviewed changes

ivanortegaalba requested a review from Copilot July 25, 2025 11:13

Copilot AI reviewed Jul 25, 2025

View reviewed changes

dprokop and others added 4 commits July 25, 2025 13:59

v2alpha1 provisioned dashboard

90e72fa

Fix kind

2d941da

Fix conversion snapshots

be8b999

Merge branch 'main' into schemav2-bring-back-reverts

037e084

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

FEATURE BRANCH: Add `v2alpha2` api version: Consolidate schema breaking changes #108172

FEATURE BRANCH: Add `v2alpha2` api version: Consolidate schema breaking changes #108172

Uh oh!

dprokop commented Jul 16, 2025 •

edited by harisrozajac

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ivanortegaalba left a comment

Uh oh!

Uh oh!

ivanortegaalba Jul 25, 2025

Uh oh!

dprokop Jul 25, 2025

Uh oh!

dprokop Jul 25, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Copilot AI Jul 25, 2025

Uh oh!

Uh oh!

-	// Catch-all field for datasource-specific properties. Should not be available in as code tooling.
+	// Catch-all field for datasource-specific properties. This field is intended for internal use by datasources
+	// to store configuration options that are not part of the standard schema. It should not be available in
+	// "as code" tooling because its structure is highly dynamic and specific to individual datasources, making
+	// it unsuitable for validation or code generation. Developers should avoid relying on this field in generic
+	// tooling and instead use well-defined schema fields whenever possible.

FEATURE BRANCH: Add v2alpha2 api version: Consolidate schema breaking changes #108172

Are you sure you want to change the base?

FEATURE BRANCH: Add v2alpha2 api version: Consolidate schema breaking changes #108172

Uh oh!

Conversation

dprokop commented Jul 16, 2025 • edited by harisrozajac Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ivanortegaalba left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ivanortegaalba Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

dprokop Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

dprokop Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

FEATURE BRANCH: Add `v2alpha2` api version: Consolidate schema breaking changes #108172

FEATURE BRANCH: Add `v2alpha2` api version: Consolidate schema breaking changes #108172

dprokop commented Jul 16, 2025 •

edited by harisrozajac

Loading

dprokop Jul 25, 2025 •

edited

Loading