FEATURE BRANCH: Add `v2beta1` 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

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

ivanortegaalba

Double checked, it looks great! I'd love the eyes of @stephaniehingtgen from the backend point of view, but looks great so far 💯

…everts # Conflicts: # go.work.sum

Copilot

Pull Request Overview

This PR consolidates schema breaking changes by introducing a new v2beta1 API version to replace the experimental v2alpha1 version. The changes include updating imports, API version references, and data structure modifications throughout the codebase.

Key changes:

Migration from v2alpha1 to v2beta1 API version across the entire codebase
Updates to data query structure to use a more standardized format with DataQuery kind and separate group field
Refactoring of datasource references in queries, variables, and annotations

Reviewed Changes

Copilot reviewed 144 out of 148 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
Frontend imports	Updated all schema imports from `v2alpha1` to `v2` simplified path
API version constants	Changed API version from `v2alpha1` to `v2beta1`
Data structures	Modified query structures to use new `DataQuery` format with separate `group` and `datasource` fields
Test files	Updated test data and assertions to match new schema
Backend Go files	Updated imports and API version references from `v2alpha2` to `v2beta1`

Comments suppressed due to low confidence (1)

Copilot · 2025-07-28T15:23:52Z

public/app/features/manage-dashboards/state/actions.ts

@@ -332,43 +333,43 @@ export function getFolderByUid(uid: string): Promise<{ uid: string; title: strin
 }

 export async function processV2DatasourceInput(
-  obj: PanelQueryKind['spec'] | QueryVariableKind['spec'] | AnnotationQueryKind['spec'],
+  spec: PanelQueryKind['spec'] | QueryVariableKind['spec'] | AnnotationQueryKind['spec'],
  inputs: Record<string, DataSourceInput> = {}
 ) {


Potential null reference error: spec.query could be undefined, which would cause a runtime error when accessing spec.query.datasource. Consider adding a null check before accessing nested properties.

Suggested change

) {

) {

if (!spec.query) {

return inputs; // If spec.query is undefined, return inputs as-is

}

Copilot · 2025-07-28T15:23:52Z

public/app/features/manage-dashboards/state/actions.ts

+  const datasourceRef = spec.query.datasource;
+  let dataSourceInput: DataSourceInput | undefined;
+  const dsType = spec.query.group;


Potential null reference error: spec.query could be undefined, which would cause a runtime error when accessing spec.query.group. This should be protected with the same null check as the datasourceRef.

Suggested change

const datasourceRef = spec.query.datasource;

let dataSourceInput: DataSourceInput | undefined;

const dsType = spec.query.group;

const datasourceRef = spec.query?.datasource;

let dataSourceInput: DataSourceInput | undefined;

const dsType = spec.query?.group;

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

ivanortegaalba · 2025-07-28T15:30:13Z

@harisrozajac feel free to merge if everything is ok!

harisrozajac · 2025-07-28T15:53:21Z

@ivanortegaalba should we wait for app platform's input?

stephaniehingtgen

LGTM overall - one small change & one question

stephaniehingtgen · 2025-07-28T17:12:57Z

apps/dashboard/pkg/apis/dashboard/v2beta1/doc.go

@@ -7,4 +7,4 @@
 // because grafana-app-sdk already provides deepcopy functions.
 // Kinds which are not generated by the SDK are explicitly opted in to deepcopy generation.

-package v2alpha2 // import "github.com/grafana/grafana/apps/dashboard/pkg/apis/dashboard/v2alpha1"
+package v2beta1 // import "github.com/grafana/grafana/apps/dashboard/pkg/apis/dashboard/v2alpha1"


Suggested change

package v2beta1 // import "github.com/grafana/grafana/apps/dashboard/pkg/apis/dashboard/v2alpha1"

package v2beta1 // import "github.com/grafana/grafana/apps/dashboard/pkg/apis/dashboard/v2beta1"

stephaniehingtgen · 2025-07-28T17:28:50Z

apps/dashboard/pkg/migration/conversion/v2alpha1_to_v2beta1.go

+	// For brevity, assume the structure is identical and just return nil
+	// In a real implementation, this would need proper conversion


looks like this needs to be implemented?

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 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

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

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

This comment was marked as outdated.

Sign in to view

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

dprokop requested review from ivanortegaalba and harisrozajac July 28, 2025 07:25

ivanortegaalba approved these changes Jul 28, 2025

View reviewed changes

ivanortegaalba added 3 commits July 28, 2025 17:01

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

04dd7f9

…everts # Conflicts: # go.work.sum

Update API discovery registry

eff4a96

Rename to v2beta1

d7ef9f0

ivanortegaalba requested a review from a team as a code owner July 28, 2025 15:15

ivanortegaalba requested review from alexanderzobnin, mihai-turdean and Copilot and removed request for a team July 28, 2025 15:15

This comment was marked as outdated.

Sign in to view

Rename migrations

778122d

ivanortegaalba requested a review from Copilot July 28, 2025 15:23

Copilot AI reviewed Jul 28, 2025

View reviewed changes

stephaniehingtgen changed the title ~~FEATURE BRANCH: Add v2alpha2 api version: Consolidate schema breaking changes~~ FEATURE BRANCH: Add v2beta1 api version: Consolidate schema breaking changes Jul 28, 2025

stephaniehingtgen approved these changes Jul 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

dprokop commented Jul 16, 2025 •

edited by harisrozajac

Loading

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

ivanortegaalba left a comment

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 28, 2025

Uh oh!

Copilot AI Jul 28, 2025

Uh oh!

Uh oh!

ivanortegaalba commented Jul 28, 2025

Uh oh!

harisrozajac commented Jul 28, 2025

Uh oh!

stephaniehingtgen left a comment •

edited

Loading

Uh oh!

stephaniehingtgen Jul 28, 2025

Uh oh!

stephaniehingtgen Jul 28, 2025

Uh oh!

Uh oh!

-) {
+) {
+  if (!spec.query) {
+    return inputs; // If spec.query is undefined, return inputs as-is
+  }

	package v2beta1 // import "github.com/grafana/grafana/apps/dashboard/pkg/apis/dashboard/v2alpha1"
	package v2beta1 // import "github.com/grafana/grafana/apps/dashboard/pkg/apis/dashboard/v2beta1"

		// For brevity, assume the structure is identical and just return nil
		// In a real implementation, this would need proper conversion

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

Are you sure you want to change the base?

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

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!

This comment was marked as outdated.

Uh oh!

ivanortegaalba left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ivanortegaalba commented Jul 28, 2025

Uh oh!

harisrozajac commented Jul 28, 2025

Uh oh!

stephaniehingtgen left a comment • 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!

stephaniehingtgen Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

stephaniehingtgen Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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

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

dprokop commented Jul 16, 2025 •

edited by harisrozajac

Loading

stephaniehingtgen left a comment •

edited

Loading