public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

PublicDashboards: Add swagger documentation (#75318)

Browse Source
This commit is contained in:
Ezequiel Victorero
2023-10-30 10:32:07 -03:00
committed by GitHub
parent e1293af775
commit 16034ef062
6 changed files with 2076 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/services/publicdashboards/api/query.go
+76 -8
View File
@@ -4,6 +4,8 @@ import (
"net/http"
"strconv"
"github.com/grafana/grafana-plugin-sdk-go/backend"
"github.com/grafana/grafana/pkg/api/dtos"
"github.com/grafana/grafana/pkg/api/response"
contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model"
. "github.com/grafana/grafana/pkg/services/publicdashboards/models"
@@ -11,8 +13,17 @@ import (
"github.com/grafana/grafana/pkg/web"
)
// ViewPublicDashboard Gets public dashboard
// GET /api/public/dashboards/:accessToken
// swagger:route GET /public/dashboards/{accessToken} dashboard_public viewPublicDashboard
//
// Get public dashboard for view
//
// Responses:
// 200: viewPublicDashboardResponse
// 400: badRequestPublicError
// 401: unauthorisedPublicError
// 403: forbiddenPublicError
// 404: notFoundPublicError
// 500: internalServerPublicError
func (api *Api) ViewPublicDashboard(c *contextmodel.ReqContext) response.Response {
accessToken := web.Params(c.Req)[":accessToken"]
if !validation.IsValidAccessToken(accessToken) {
@@ -27,8 +38,18 @@ func (api *Api) ViewPublicDashboard(c *contextmodel.ReqContext) response.Respons
return response.JSON(http.StatusOK, dto)
}
// QueryPublicDashboard returns all results for a given panel on a public dashboard
// POST /api/public/dashboard/:accessToken/panels/:panelId/query
// swagger:route POST /public/dashboards/{accessToken}/panels/{panelId}/query dashboard_public queryPublicDashboard
//
// Get results for a given panel on a public dashboard
//
// Responses:
// 200: queryPublicDashboardResponse
// 400: badRequestPublicError
// 401: unauthorisedPublicError
// 404: panelNotFoundPublicError
// 404: notFoundPublicError
// 403: forbiddenPublicError
// 500: internalServerPublicError
func (api *Api) QueryPublicDashboard(c *contextmodel.ReqContext) response.Response {
accessToken := web.Params(c.Req)[":accessToken"]
if !validation.IsValidAccessToken(accessToken) {
@@ -53,12 +74,21 @@ func (api *Api) QueryPublicDashboard(c *contextmodel.ReqContext) response.Respon
return toJsonStreamingResponse(api.Features, resp)
}
// GetAnnotations returns annotations for a public dashboard
// GET /api/public/dashboards/:accessToken/annotations
func (api *Api) GetAnnotations(c *contextmodel.ReqContext) response.Response {
// swagger:route GET /public/dashboards/{accessToken}/annotations dashboard_public getPublicAnnotations
//
// Get annotations for a public dashboard
//
// Responses:
// 200: getPublicAnnotationsResponse
// 400: badRequestPublicError
// 404: notFoundPublicError
// 401: unauthorisedPublicError
// 403: forbiddenPublicError
// 500: internalServerPublicError
func (api *Api) GetPublicAnnotations(c *contextmodel.ReqContext) response.Response {
accessToken := web.Params(c.Req)[":accessToken"]
if !validation.IsValidAccessToken(accessToken) {
return response.Err(ErrInvalidAccessToken.Errorf("GetAnnotations: invalid access token"))
return response.Err(ErrInvalidAccessToken.Errorf("GetPublicAnnotations: invalid access token"))
}
reqDTO := AnnotationsQueryDTO{
@@ -73,3 +103,41 @@ func (api *Api) GetAnnotations(c *contextmodel.ReqContext) response.Response {
return response.JSON(http.StatusOK, annotations)
}
// swagger:response viewPublicDashboardResponse
type ViewPublicDashboardResponse struct {
// in: body
Body dtos.DashboardFullWithMeta `json:"body"`
}
// swagger:parameters viewPublicDashboard
type ViewPublicDashboardParams struct {
// in: path
AccessToken string `json:"accessToken"`
}
// swagger:response queryPublicDashboardResponse
type QueryPublicDashboardResponse struct {
// in: body
Body backend.QueryDataResponse `json:"body"`
}
// swagger:parameters queryPublicDashboard
type QueryPublicDashboardParams struct {
// in: path
AccessToken string `json:"accessToken"`
// in: path
PanelId int64 `json:"panelId"`
}
// swagger:response getPublicAnnotationsResponse
type GetPublicAnnotationsResponse struct {
// in: body
Body []AnnotationEvent `json:"body"`
}
// swagger:parameters getPublicAnnotations
type GetPublicAnnotationsParams struct {
// in: path
AccessToken string `json:"accessToken"`
}