mirror of
https://github.com/grafana/grafana.git
synced 2025-07-29 12:52:08 +08:00
d99d095ac6
* Replace sequential IDs with UID for dashboard permossion * Add back endpoint with id * Rename parameter from dashboarUid->uid and add swagger definitions for endpoints * Generate swagger json * Add deprecated to swagger and docs * Add deprecated comment in the api.go * Add model for POST body * Fix model post body for endpoint * Generate spec with enterprise
78 lines
2.2 KiB
Go
78 lines
2.2 KiB
Go
package definitions
|
||
|
||
import (
|
||
"github.com/grafana/grafana/pkg/api/dtos"
|
||
"github.com/grafana/grafana/pkg/models"
|
||
)
|
||
|
||
// swagger:route GET /dashboards/id/{DashboardID}/permissions dashboard_permissions getDashboardPermissions
|
||
//
|
||
// Gets all existing permissions for the given dashboard.
|
||
//
|
||
// Please refer to [updated API](#/dashboard_permissions/getDashboardPermissionsWithUid) instead
|
||
//
|
||
// Deprecated: true
|
||
//
|
||
// Responses:
|
||
// 200: getDashboardPermissionsResponse
|
||
// 401: unauthorisedError
|
||
// 403: forbiddenError
|
||
// 404: notFoundError
|
||
// 500: internalServerError
|
||
|
||
// swagger:route POST /dashboards/id/{DashboardID}/permissions dashboard_permissions postDashboardPermissions
|
||
//
|
||
// Updates permissions for a dashboard.
|
||
//
|
||
// Please refer to [updated API](#/dashboard_permissions/postDashboardPermissionsWithUid) instead
|
||
//
|
||
// This operation will remove existing permissions if they’re not included in the request.
|
||
//
|
||
// Deprecated: true
|
||
//
|
||
// Responses:
|
||
// 200: okResponse
|
||
// 400: badRequestError
|
||
// 401: unauthorisedError
|
||
// 403: forbiddenError
|
||
// 404: notFoundError
|
||
// 500: internalServerError
|
||
|
||
// swagger:route GET /dashboards/uid/{uid}/permissions dashboard_permissions getDashboardPermissionsWithUid
|
||
//
|
||
// Gets all existing permissions for the given dashboard.
|
||
//
|
||
// Responses:
|
||
// 200: getDashboardPermissionsResponse
|
||
// 401: unauthorisedError
|
||
// 403: forbiddenError
|
||
// 404: notFoundError
|
||
// 500: internalServerError
|
||
|
||
// swagger:route POST /dashboards/uid/{uid}/permissions dashboard_permissions postDashboardPermissionsWithUid
|
||
//
|
||
// Updates permissions for a dashboard.
|
||
//
|
||
// This operation will remove existing permissions if they’re not included in the request.
|
||
//
|
||
// Responses:
|
||
// 200: okResponse
|
||
// 400: badRequestError
|
||
// 401: unauthorisedError
|
||
// 403: forbiddenError
|
||
// 404: notFoundError
|
||
// 500: internalServerError
|
||
|
||
// swagger:parameters postDashboardPermissions updateFolderPermissions postDashboardPermissionsWithUid
|
||
type PostDashboardPermissionsParam struct {
|
||
// in:body
|
||
// required:true
|
||
Body dtos.UpdateDashboardAclCommand
|
||
}
|
||
|
||
// swagger:response getDashboardPermissionsResponse
|
||
type GetDashboardPermissionsResponse struct {
|
||
// in: body
|
||
Body []*models.DashboardAclInfoDTO `json:"body"`
|
||
}
|