mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 11:32:36 +08:00
API: Make Swagger specification more consistent (#50576)
* Fix swagger generation targer using mac Validate using the swagger binarry instead of the docker container * API: Make swagger specification more consistent Fix operation parameter ordering
This commit is contained in:

committed by
GitHub

parent
f87927c82e
commit
7418a80264
@ -148,7 +148,7 @@ import "github.com/grafana/grafana/pkg/models"
|
||||
// 403: forbiddenError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route POST /user/revoke-auth-token signed_in_user revokeSignedINAuthTokenCmd
|
||||
// swagger:route POST /user/revoke-auth-token signed_in_user revokeSignedInAuthToken
|
||||
//
|
||||
// Revoke an auth token of the actual User.
|
||||
//
|
||||
@ -161,28 +161,57 @@ import "github.com/grafana/grafana/pkg/models"
|
||||
// 403: forbiddenError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:parameters starDashboard unstarDashboard
|
||||
type DashboardIDParam struct {
|
||||
// swagger:parameters updateSignedInUser
|
||||
type UpdateSignedInUserParams struct {
|
||||
// To change the email, name, login, theme, provide another one.
|
||||
// in:body
|
||||
// required:true
|
||||
Body models.UpdateUserCommand `json:"body"`
|
||||
}
|
||||
|
||||
// swagger:parameters userSetUsingOrg
|
||||
type UserSetUsingOrgParams struct {
|
||||
// in:path
|
||||
// required:true
|
||||
OrgID int64 `json:"org_id"`
|
||||
}
|
||||
|
||||
// swagger:parameters starDashboard
|
||||
type StarDashboardParams struct {
|
||||
// in:path
|
||||
// required:true
|
||||
DashboardID string `json:"dashboard_id"`
|
||||
}
|
||||
|
||||
// swagger:parameters unstarDashboard
|
||||
type UnstarDashboardParams struct {
|
||||
// in:path
|
||||
// required:true
|
||||
DashboardID string `json:"dashboard_id"`
|
||||
}
|
||||
|
||||
// swagger:parameters setHelpFlag
|
||||
type FlagIDParam struct {
|
||||
type SetHelpFlagParams struct {
|
||||
// in:path
|
||||
// required:true
|
||||
FlagID string `json:"flag_id"`
|
||||
}
|
||||
|
||||
// swagger:parameters updateUser changeUserPassword
|
||||
type ChangeUserPasswordParam struct {
|
||||
// swagger:parameters changeUserPassword
|
||||
type ChangeUserPasswordParams struct {
|
||||
// To change the email, name, login, theme, provide another one.
|
||||
// in:body
|
||||
// required:true
|
||||
Body models.ChangeUserPasswordCommand `json:"body"`
|
||||
}
|
||||
|
||||
// swagger:parameters revokeSignedInAuthToken
|
||||
type RevokeSignedINAuthTokenCmdParams struct {
|
||||
// in:body
|
||||
// required:true
|
||||
Body models.RevokeAuthTokenCmd `json:"body"`
|
||||
}
|
||||
|
||||
// swagger:response helpFlagResponse
|
||||
type HelpFlagResponse struct {
|
||||
// The response message
|
||||
|
Reference in New Issue
Block a user