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

Fix capitalising Folder structs (#79207)

Browse Source 
* Fix capitalising Folder structs

* Add swagger and fix api dashboard test

* Add swagger files with bingo installed
This commit is contained in:
idafurjes 2023-12-07 13:15:58 +01:00 committed by GitHub
parent 9e71dc801d
commit 550746be71
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
pkg/api/dtos/folder.go
View File

@ -7,11 +7,11 @@ import (
) )
type Folder struct { type Folder struct {
// Deprecated: use Uid instead // Deprecated: use UID instead
Id int64 `json:"id"` ID int64 `json:"id" xorm:"pk autoincr 'id'"`
Uid string `json:"uid"` UID string `json:"uid" xorm:"uid"`
Title string `json:"title"` Title string `json:"title"`
Url string `json:"url"` URL string `json:"url" xoem:"url"`
HasACL bool `json:"hasAcl" xorm:"has_acl"` HasACL bool `json:"hasAcl" xorm:"has_acl"`
CanSave bool `json:"canSave"` CanSave bool `json:"canSave"`
CanEdit bool `json:"canEdit"` CanEdit bool `json:"canEdit"`
@ -30,8 +30,8 @@ type Folder struct {
} }
type FolderSearchHit struct { type FolderSearchHit struct {
Id int64 `json:"id"` ID int64 `json:"id" xorm:"pk autoincr 'id'"`
Uid string `json:"uid"` UID string `json:"uid" xorm:"uid"`
Title string `json:"title"` Title string `json:"title"`
ParentUID string `json:"parentUid,omitempty"` ParentUID string `json:"parentUid,omitempty"`
} }

12
pkg/api/folder.go
View File

@ -63,8 +63,8 @@ func (hs *HTTPServer) GetFolders(c *contextmodel.ReqContext) response.Response {
result := make([]dtos.FolderSearchHit, 0) result := make([]dtos.FolderSearchHit, 0)
for _, f := range folders { for _, f := range folders {
result = append(result, dtos.FolderSearchHit{ result = append(result, dtos.FolderSearchHit{
Id: f.ID, // nolint:staticcheck ID: f.ID, // nolint:staticcheck
Uid: f.UID, UID: f.UID,
Title: f.Title, Title: f.Title,
ParentUID: f.ParentUID, ParentUID: f.ParentUID,
}) })
@ -360,17 +360,17 @@ func (hs *HTTPServer) newToFolderDto(c *contextmodel.ReqContext, f *folder.Folde
canView, _ := g.CanView() canView, _ := g.CanView()
if !canView { if !canView {
return dtos.Folder{ return dtos.Folder{
Uid: REDACTED, UID: REDACTED,
Title: REDACTED, Title: REDACTED,
}, nil }, nil
} }
} }
return dtos.Folder{ return dtos.Folder{
Id: f.ID, // nolint:staticcheck ID: f.ID, // nolint:staticcheck
Uid: f.UID, UID: f.UID,
Title: f.Title, Title: f.Title,
Url: f.URL, URL: f.URL,
HasACL: f.HasACL, HasACL: f.HasACL,
CanSave: canSave, CanSave: canSave,
CanEdit: canEdit, CanEdit: canEdit,

10
pkg/api/folder_test.go
View File

@ -146,8 +146,8 @@ func TestFoldersCreateAPIEndpoint(t *testing.T) {
if tc.expectedCode == http.StatusOK { if tc.expectedCode == http.StatusOK {
// nolint:staticcheck // nolint:staticcheck
assert.Equal(t, int64(1), folder.Id) assert.Equal(t, int64(1), folder.ID)
assert.Equal(t, "uid", folder.Uid) assert.Equal(t, "uid", folder.UID)
assert.Equal(t, "Folder", folder.Title) assert.Equal(t, "Folder", folder.Title)
} }
}) })
@ -251,8 +251,8 @@ func TestFoldersUpdateAPIEndpoint(t *testing.T) {
if tc.expectedCode == http.StatusOK { if tc.expectedCode == http.StatusOK {
// nolint:staticcheck // nolint:staticcheck
assert.Equal(t, int64(1), folder.Id) assert.Equal(t, int64(1), folder.ID)
assert.Equal(t, "uid", folder.Uid) assert.Equal(t, "uid", folder.UID)
assert.Equal(t, "Folder upd", folder.Title) assert.Equal(t, "Folder upd", folder.Title)
} }
}) })
@ -515,7 +515,7 @@ func TestFolderGetAPIEndpoint(t *testing.T) {
require.Equal(t, len(folder.Parents), len(tc.expectedParentTitles)) require.Equal(t, len(folder.Parents), len(tc.expectedParentTitles))
for i := 0; i < len(tc.expectedParentUIDs); i++ { for i := 0; i < len(tc.expectedParentUIDs); i++ {
assert.Equal(t, tc.expectedParentUIDs[i], folder.Parents[i].Uid) assert.Equal(t, tc.expectedParentUIDs[i], folder.Parents[i].UID)
assert.Equal(t, tc.expectedParentTitles[i], folder.Parents[i].Title) assert.Equal(t, tc.expectedParentTitles[i], folder.Parents[i].Title)
} }
require.NoError(t, resp.Body.Close()) require.NoError(t, resp.Body.Close())

8
pkg/tests/api/dashboards/api_dashboards_test.go
View File

@ -328,7 +328,7 @@ func TestIntegrationCreate(t *testing.T) {
buf1 := &bytes.Buffer{} buf1 := &bytes.Buffer{}
err = json.NewEncoder(buf1).Encode(dashboards.SaveDashboardCommand{ err = json.NewEncoder(buf1).Encode(dashboards.SaveDashboardCommand{
Dashboard: dashboardDataOne, Dashboard: dashboardDataOne,
FolderUID: folder.Uid, FolderUID: folder.UID,
}) })
require.NoError(t, err) require.NoError(t, err)
u := fmt.Sprintf("http://admin:admin@%s/api/dashboards/db", grafanaListedAddr) u := fmt.Sprintf("http://admin:admin@%s/api/dashboards/db", grafanaListedAddr)
@ -347,7 +347,7 @@ func TestIntegrationCreate(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
assert.NotEmpty(t, m["id"]) assert.NotEmpty(t, m["id"])
assert.NotEmpty(t, m["uid"]) assert.NotEmpty(t, m["uid"])
assert.Equal(t, folder.Uid, m["folderUid"]) assert.Equal(t, folder.UID, m["folderUid"])
}) })
t.Run("create dashboard under folder (using deprecated folder sequential ID) should succeed", func(t *testing.T) { t.Run("create dashboard under folder (using deprecated folder sequential ID) should succeed", func(t *testing.T) {
@ -358,7 +358,7 @@ func TestIntegrationCreate(t *testing.T) {
buf1 := &bytes.Buffer{} buf1 := &bytes.Buffer{}
err = json.NewEncoder(buf1).Encode(dashboards.SaveDashboardCommand{ err = json.NewEncoder(buf1).Encode(dashboards.SaveDashboardCommand{
Dashboard: dashboardDataOne, Dashboard: dashboardDataOne,
FolderID: folder.Id, // nolint:staticcheck FolderID: folder.ID, // nolint:staticcheck
}) })
require.NoError(t, err) require.NoError(t, err)
u := fmt.Sprintf("http://admin:admin@%s/api/dashboards/db", grafanaListedAddr) u := fmt.Sprintf("http://admin:admin@%s/api/dashboards/db", grafanaListedAddr)
@ -377,7 +377,7 @@ func TestIntegrationCreate(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
assert.NotEmpty(t, m["id"]) assert.NotEmpty(t, m["id"])
assert.NotEmpty(t, m["uid"]) assert.NotEmpty(t, m["uid"])
assert.Equal(t, folder.Uid, m["folderUid"]) assert.Equal(t, folder.UID, m["folderUid"])
}) })
t.Run("create dashboard under unknow folder should fail", func(t *testing.T) { t.Run("create dashboard under unknow folder should fail", func(t *testing.T) {

2
public/api-merged.json
View File

@ -14139,7 +14139,7 @@
"type": "boolean" "type": "boolean"
}, },
"id": { "id": {
"description": "Deprecated: use Uid instead", "description": "Deprecated: use UID instead",
"type": "integer", "type": "integer",
"format": "int64" "format": "int64"
}, },

2
public/openapi3.json
View File

@ -5156,7 +5156,7 @@
"type": "boolean" "type": "boolean"
}, },
"id": { "id": {
"description": "Deprecated: use Uid instead", "description": "Deprecated: use UID instead",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },