IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-10 07:35:45 -06:00
Code Issues Packages Projects Releases Wiki Activity

Chore: Deprecate FolderId in ImportDashboardRequest and ImportDashboardResponse (#77627)

Browse Source 
* Chore: Deprecate FolderId in ImportDashboardRequest

* chore: deprecate FodlerId from ImportDashboardResponse

* chore: add missing nolint comment

* chore: regen specs
This commit is contained in:
Kat Yang 2023-11-06 11:32:34 -05:00 committed by GitHub
parent 6ed09de47d
commit 1959f3434b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 29 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
pkg/services/dashboardimport/dashboardimport.go
View File

@ -22,22 +22,24 @@ type ImportDashboardRequest struct {
Overwrite bool `json:"overwrite"`
Dashboard *simplejson.Json `json:"dashboard"`
Inputs []ImportDashboardInput `json:"inputs"`
FolderId int64 `json:"folderId"`
FolderUid string `json:"folderUid"`
// Deprecated: use FolderUID instead
FolderId int64 `json:"folderId"`
FolderUid string `json:"folderUid"`
User identity.Requester `json:"-"`
}
// ImportDashboardResponse response object returned when importing a dashboard.
type ImportDashboardResponse struct {
UID string `json:"uid"`
PluginId string `json:"pluginId"`
Title string `json:"title"`
Imported bool `json:"imported"`
ImportedUri string `json:"importedUri"`
ImportedUrl string `json:"importedUrl"`
Slug string `json:"slug"`
DashboardId int64 `json:"dashboardId"`
UID string `json:"uid"`
PluginId string `json:"pluginId"`
Title string `json:"title"`
Imported bool `json:"imported"`
ImportedUri string `json:"importedUri"`
ImportedUrl string `json:"importedUrl"`
Slug string `json:"slug"`
DashboardId int64 `json:"dashboardId"`
// Deprecated: use FolderUID instead
FolderId int64 `json:"folderId"`
FolderUID string `json:"folderUid"`
ImportedRevision int64 `json:"importedRevision,omitempty"` // Only used for plugin imports

10
pkg/services/dashboardimport/service/service.go
View File

@ -93,10 +93,11 @@ func (s *ImportDashboardService) ImportDashboard(ctx context.Context, req *dashb
if err != nil {
return nil, err
}
// nolint:staticcheck
req.FolderId = folder.ID
} else {
folder, err := s.folderService.Get(ctx, &folder.GetFolderQuery{
ID: &req.FolderId,
ID: &req.FolderId, // nolint:staticcheck
OrgID: req.User.GetOrgID(),
SignedInUser: req.User,
})
@ -120,7 +121,7 @@ func (s *ImportDashboardService) ImportDashboard(ctx context.Context, req *dashb
UserID: userID,
Overwrite: req.Overwrite,
PluginID: req.PluginId,
FolderID: req.FolderId,
FolderID: req.FolderId, // nolint:staticcheck
FolderUID: req.FolderUid,
}
@ -136,6 +137,7 @@ func (s *ImportDashboardService) ImportDashboard(ctx context.Context, req *dashb
return nil, err
}
// nolint:staticcheck
err = s.libraryPanelService.ImportLibraryPanelsForDashboard(ctx, req.User, libraryElements, generatedDash.Get("panels").MustArray(), req.FolderId)
if err != nil {
return nil, err
@ -152,8 +154,8 @@ func (s *ImportDashboardService) ImportDashboard(ctx context.Context, req *dashb
PluginId: req.PluginId,
Title: savedDashboard.Title,
Path: req.Path,
Revision: revision, // only used for plugin version tracking
FolderId: savedDashboard.FolderID,
Revision: revision, // only used for plugin version tracking
FolderId: savedDashboard.FolderID, // nolint:staticcheck
FolderUID: req.FolderUid,
ImportedUri: "db/" + savedDashboard.Slug,
ImportedUrl: savedDashboard.GetURL(),

4
pkg/services/dashboardimport/service/service_test.go
View File

@ -77,7 +77,7 @@ func TestImportDashboardService(t *testing.T) {
{Name: "*", Type: "datasource", Value: "prom"},
},
User: &user.SignedInUser{UserID: 2, OrgRole: org.RoleAdmin, OrgID: 3},
FolderId: 5,
FolderId: 5, // nolint:staticcheck
}
resp, err := s.ImportDashboard(context.Background(), req)
require.NoError(t, err)
@ -144,7 +144,7 @@ func TestImportDashboardService(t *testing.T) {
{Name: "*", Type: "datasource", Value: "prom"},
},
User: &user.SignedInUser{UserID: 2, OrgRole: org.RoleAdmin, OrgID: 3},
FolderId: 5,
FolderId: 5, // nolint:staticcheck
}
resp, err := s.ImportDashboard(context.Background(), req)
require.NoError(t, err)

2
pkg/services/plugindashboards/service/dashboard_updater.go
View File

@ -177,7 +177,7 @@ func (du *DashboardUpdater) autoUpdateAppDashboard(ctx context.Context, pluginDa
{Action: dashboards.ActionDashboardsWrite, Scope: dashboards.ScopeFoldersAll},
}),
Path: pluginDashInfo.Reference,
FolderId: 0,
FolderId: 0, // nolint:staticcheck
Dashboard: resp.Dashboard.Data,
Overwrite: true,
Inputs: nil,

4
pkg/services/plugindashboards/service/dashboard_updater_test.go
View File

@ -195,6 +195,7 @@ func TestDashboardUpdater(t *testing.T) {
require.Equal(t, "updated.json", ctx.importDashboardArgs[0].Path)
require.Equal(t, int64(2), ctx.importDashboardArgs[0].User.GetOrgID())
require.Equal(t, org.RoleAdmin, ctx.importDashboardArgs[0].User.GetOrgRole())
// nolint:staticcheck
require.Equal(t, int64(0), ctx.importDashboardArgs[0].FolderId)
require.True(t, ctx.importDashboardArgs[0].Overwrite)
})
@ -322,6 +323,7 @@ func TestDashboardUpdater(t *testing.T) {
require.Equal(t, "dashboard1.json", ctx.importDashboardArgs[0].Path)
require.Equal(t, int64(2), ctx.importDashboardArgs[0].User.GetOrgID())
require.Equal(t, org.RoleAdmin, ctx.importDashboardArgs[0].User.GetOrgRole())
// nolint:staticcheck
require.Equal(t, int64(0), ctx.importDashboardArgs[0].FolderId)
require.True(t, ctx.importDashboardArgs[0].Overwrite)
@ -329,6 +331,7 @@ func TestDashboardUpdater(t *testing.T) {
require.Equal(t, "dashboard2.json", ctx.importDashboardArgs[1].Path)
require.Equal(t, int64(2), ctx.importDashboardArgs[1].User.GetOrgID())
require.Equal(t, org.RoleAdmin, ctx.importDashboardArgs[1].User.GetOrgRole())
// nolint:staticcheck
require.Equal(t, int64(0), ctx.importDashboardArgs[1].FolderId)
require.True(t, ctx.importDashboardArgs[1].Overwrite)
@ -336,6 +339,7 @@ func TestDashboardUpdater(t *testing.T) {
require.Equal(t, "dashboard3.json", ctx.importDashboardArgs[2].Path)
require.Equal(t, int64(2), ctx.importDashboardArgs[2].User.GetOrgID())
require.Equal(t, org.RoleAdmin, ctx.importDashboardArgs[2].User.GetOrgRole())
// nolint:staticcheck
require.Equal(t, int64(0), ctx.importDashboardArgs[2].FolderId)
require.True(t, ctx.importDashboardArgs[2].Overwrite)
})

2
public/api-merged.json
View File

@ -15398,6 +15398,7 @@
"$ref": "#/definitions/Json"
},
"folderId": {
"description": "Deprecated: use FolderUID instead",
"type": "integer",
"format": "int64"
},
@ -15433,6 +15434,7 @@
"type": "string"
},
"folderId": {
"description": "Deprecated: use FolderUID instead",
"type": "integer",
"format": "int64"
},

2
public/openapi3.json
View File

@ -6310,6 +6310,7 @@
"$ref": "#/components/schemas/Json"
},
"folderId": {
"description": "Deprecated: use FolderUID instead",
"format": "int64",
"type": "integer"
},
@ -6345,6 +6346,7 @@
"type": "string"
},
"folderId": {
"description": "Deprecated: use FolderUID instead",
"format": "int64",
"type": "integer"
},