Search: Fixes search limits and adds a page parameter (#16458)

* Search: Fixes search limits and adds a page parameter

This adds a page parameter to search api without adding
any major breaking change.

It does at an api validation error when trying to use
a limit beyond 5000. This is a breaking change. We could
remove this and have it only in the docs and describe that this
is a limit that grafana will apply silently.

Fixes #16049

* Fix: Corrected wrong array slice change

* Docs: minor docs fix

* Search: fixed folder tests

* Fixed: Moved limit to correct inner query

* Search: moving limit check and page check

* Search: limit in handler is no longer needed
This commit is contained in:
Torkel Ödegaard
2019-04-17 13:07:50 +02:00
committed by GitHub
parent 9cc67e49b4
commit 8b0dd4244b
12 changed files with 73 additions and 42 deletions
+1 -1
View File
@@ -325,7 +325,7 @@ func (hs *HTTPServer) registerRoutes() {
})
// Search
apiRoute.Get("/search/", Search)
apiRoute.Get("/search/", Wrap(Search))
// metrics
apiRoute.Post("/tsdb/query", bind(dtos.MetricRequest{}), Wrap(hs.QueryMetrics))
+1 -1
View File
@@ -12,7 +12,7 @@ import (
func GetFolders(c *m.ReqContext) Response {
s := dashboards.NewFolderService(c.OrgId, c.SignedInUser)
folders, err := s.GetFolders(c.QueryInt("limit"))
folders, err := s.GetFolders(c.QueryInt64("limit"))
if err != nil {
return toFolderError(err)
+1 -1
View File
@@ -213,7 +213,7 @@ type fakeFolderService struct {
DeletedFolderUids []string
}
func (s *fakeFolderService) GetFolders(limit int) ([]*m.Folder, error) {
func (s *fakeFolderService) GetFolders(limit int64) ([]*m.Folder, error) {
return s.GetFoldersResult, s.GetFoldersError
}
+8 -7
View File
@@ -9,16 +9,17 @@ import (
"github.com/grafana/grafana/pkg/services/search"
)
func Search(c *m.ReqContext) {
func Search(c *m.ReqContext) Response {
query := c.Query("query")
tags := c.QueryStrings("tag")
starred := c.Query("starred")
limit := c.QueryInt("limit")
limit := c.QueryInt64("limit")
page := c.QueryInt64("page")
dashboardType := c.Query("type")
permission := m.PERMISSION_VIEW
if limit == 0 {
limit = 1000
if limit > 5000 {
return Error(422, "Limit is above maximum allowed (5000), use page parameter to access hits beyond limit", nil)
}
if c.Query("permission") == "Edit" {
@@ -46,6 +47,7 @@ func Search(c *m.ReqContext) {
Tags: tags,
SignedInUser: c.SignedInUser,
Limit: limit,
Page: page,
IsStarred: starred == "true",
OrgId: c.OrgId,
DashboardIds: dbIDs,
@@ -56,10 +58,9 @@ func Search(c *m.ReqContext) {
err := bus.Dispatch(&searchQuery)
if err != nil {
c.JsonApiErr(500, "Search failed", err)
return
return Error(500, "Search failed", err)
}
c.TimeRequest(metrics.M_Api_Dashboard_Search)
c.JSON(200, searchQuery.Result)
return JSON(200, searchQuery.Result)
}