Chore: Deprecate FolderId in DashboardMeta (#77626)

* Chore: Deprecate FolderId in DashboardMeta

* chore: regen specs
This commit is contained in:
Kat Yang 2023-11-06 11:31:44 -05:00 committed by GitHub
parent 911ffed45b
commit 6ed09de47d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 26 additions and 22 deletions

View File

@ -164,7 +164,7 @@ func (hs *HTTPServer) GetDashboard(c *contextmodel.ReqContext) response.Response
Version: dash.Version,
HasACL: dash.HasACL,
IsFolder: dash.IsFolder,
FolderId: dash.FolderID,
FolderId: dash.FolderID, // nolint:staticcheck
Url: dash.GetURL(),
FolderTitle: "General",
AnnotationsPermissions: annotationPermissions,

View File

@ -7,24 +7,25 @@ import (
)
type DashboardMeta struct {
IsStarred bool `json:"isStarred,omitempty"`
IsSnapshot bool `json:"isSnapshot,omitempty"`
Type string `json:"type,omitempty"`
CanSave bool `json:"canSave"`
CanEdit bool `json:"canEdit"`
CanAdmin bool `json:"canAdmin"`
CanStar bool `json:"canStar"`
CanDelete bool `json:"canDelete"`
Slug string `json:"slug"`
Url string `json:"url"`
Expires time.Time `json:"expires"`
Created time.Time `json:"created"`
Updated time.Time `json:"updated"`
UpdatedBy string `json:"updatedBy"`
CreatedBy string `json:"createdBy"`
Version int `json:"version"`
HasACL bool `json:"hasAcl" xorm:"has_acl"`
IsFolder bool `json:"isFolder"`
IsStarred bool `json:"isStarred,omitempty"`
IsSnapshot bool `json:"isSnapshot,omitempty"`
Type string `json:"type,omitempty"`
CanSave bool `json:"canSave"`
CanEdit bool `json:"canEdit"`
CanAdmin bool `json:"canAdmin"`
CanStar bool `json:"canStar"`
CanDelete bool `json:"canDelete"`
Slug string `json:"slug"`
Url string `json:"url"`
Expires time.Time `json:"expires"`
Created time.Time `json:"created"`
Updated time.Time `json:"updated"`
UpdatedBy string `json:"updatedBy"`
CreatedBy string `json:"createdBy"`
Version int `json:"version"`
HasACL bool `json:"hasAcl" xorm:"has_acl"`
IsFolder bool `json:"isFolder"`
// Deprecated: use FolderUID instead
FolderId int64 `json:"folderId"`
FolderUid string `json:"folderUid"`
FolderTitle string `json:"folderTitle"`

View File

@ -83,7 +83,7 @@ func (pd *PublicDashboardServiceImpl) GetPublicDashboardForView(ctx context.Cont
Updated: dash.Updated,
Version: dash.Version,
IsFolder: false,
FolderId: dash.FolderID,
FolderId: dash.FolderID, // nolint:staticcheck
PublicDashboardEnabled: pubdash.IsEnabled,
}
dash.Data.Get("timepicker").Set("hidden", !pubdash.TimeSelectionEnabled)

View File

@ -344,7 +344,7 @@ func TestGetPublicDashboardForView(t *testing.T) {
Updated: d.Updated,
Version: d.Version,
IsFolder: false,
FolderId: d.FolderID,
FolderId: d.FolderID, // nolint:staticcheck
PublicDashboardEnabled: true,
},
},
@ -372,7 +372,7 @@ func TestGetPublicDashboardForView(t *testing.T) {
Updated: d.Updated,
Version: d.Version,
IsFolder: false,
FolderId: d.FolderID,
FolderId: d.FolderID, // nolint:staticcheck
PublicDashboardEnabled: true,
},
},
@ -411,6 +411,7 @@ func TestGetPublicDashboardForView(t *testing.T) {
assert.Equal(t, test.DashResp.Meta.Updated, dashboardFullWithMeta.Meta.Updated)
assert.Equal(t, test.DashResp.Meta.Version, dashboardFullWithMeta.Meta.Version)
assert.Equal(t, false, dashboardFullWithMeta.Meta.IsFolder)
// nolint:staticcheck
assert.Equal(t, test.DashResp.Meta.FolderId, dashboardFullWithMeta.Meta.FolderId)
assert.Equal(t, test.DashResp.Meta.PublicDashboardEnabled, dashboardFullWithMeta.Meta.PublicDashboardEnabled)

View File

@ -13530,6 +13530,7 @@
"format": "date-time"
},
"folderId": {
"description": "Deprecated: use FolderUID instead",
"type": "integer",
"format": "int64"
},

View File

@ -4443,6 +4443,7 @@
"type": "string"
},
"folderId": {
"description": "Deprecated: use FolderUID instead",
"format": "int64",
"type": "integer"
},