From 2d09bac2b87fe851e595690f9ee6d99cec5b42a0 Mon Sep 17 00:00:00 2001 From: Kat Yang <69819079+yangkb09@users.noreply.github.com> Date: Thu, 16 Nov 2023 09:57:04 -0500 Subject: [PATCH] Chore: Deprecate FolderIDs only used by Swagger (#78219) --- pkg/api/alerting.go | 2 ++ pkg/api/folder.go | 2 ++ pkg/api/search.go | 2 ++ .../plugindashboards/plugindashboards.go | 17 +++++++++-------- 4 files changed, 15 insertions(+), 8 deletions(-) diff --git a/pkg/api/alerting.go b/pkg/api/alerting.go index 61b84557b78..5cc31aebb68 100644 --- a/pkg/api/alerting.go +++ b/pkg/api/alerting.go @@ -921,6 +921,8 @@ type GetAlertsParams struct { // required:false // type array // collectionFormat: multi + // + // Deprecated: use FolderUID instead FolderID []string `json:"folderId"` // Limit response to alerts having a dashboard name like this value./ Limit response to alerts having a dashboard name like this value. // in:query diff --git a/pkg/api/folder.go b/pkg/api/folder.go index e972d6dee89..449fbffdac6 100644 --- a/pkg/api/folder.go +++ b/pkg/api/folder.go @@ -514,6 +514,8 @@ type UpdateFolderParams struct { type GetFolderByIDParams struct { // in:path // required:true + // + // Deprecated: use FolderUID instead FolderID int64 `json:"folder_id"` } diff --git a/pkg/api/search.go b/pkg/api/search.go index 257119ed415..da9a27a8ab0 100644 --- a/pkg/api/search.go +++ b/pkg/api/search.go @@ -157,6 +157,8 @@ type SearchParams struct { // in:query // required: false // deprecated: true + // + // Deprecated: use FolderUIDs instead FolderIds []int64 `json:"folderIds"` // List of folder UID’s to search in for dashboards // If it's an empty string then it will query for the top level folders diff --git a/pkg/services/plugindashboards/plugindashboards.go b/pkg/services/plugindashboards/plugindashboards.go index 04373f9ad81..153a9e306dc 100644 --- a/pkg/services/plugindashboards/plugindashboards.go +++ b/pkg/services/plugindashboards/plugindashboards.go @@ -8,14 +8,15 @@ import ( // PluginDashboard plugin dashboard model.. type PluginDashboard 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"` ImportedRevision int64 `json:"importedRevision"` Revision int64 `json:"revision"`