* API: Using go-swagger for extracting OpenAPI specification from source code
* Merge Grafana Alerting spec
* Include enterprise endpoints (if enabled)
* Serve SwaggerUI under feature flag
* Fix building dev docker images
* Configure swaggerUI
* Add missing json tags
Co-authored-by: Ying WANG <ying.wang@grafana.com>
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
(cherry picked from commit 35fe58de37)
This commit is contained in:
committed by
GitHub
parent
c6a58003d1
commit
08ad99c36e
@@ -0,0 +1,67 @@
|
||||
package definitions
|
||||
|
||||
import (
|
||||
"github.com/grafana/grafana/pkg/api/dtos"
|
||||
)
|
||||
|
||||
// swagger:route GET /admin/settings admin getSettings
|
||||
//
|
||||
// Fetch settings.
|
||||
//
|
||||
// If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `settings:read` and scopes: `settings:*`, `settings:auth.saml:` and `settings:auth.saml:enabled` (property level).
|
||||
//
|
||||
// Security:
|
||||
// - basic:
|
||||
//
|
||||
// Responses:
|
||||
// 200: getSettingsResponse
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
|
||||
// swagger:route GET /admin/stats admin getStats
|
||||
//
|
||||
// Fetch Grafana Stats.
|
||||
//
|
||||
// Only works with Basic Authentication (username and password). See introduction for an explanation.
|
||||
// If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `server:stats:read`.
|
||||
//
|
||||
// Responses:
|
||||
// 200: getStatsResponse
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:route POST /admin/pause-all-alerts admin pauseAllAlerts
|
||||
//
|
||||
// Pause/unpause all (legacy) alerts.
|
||||
//
|
||||
// Security:
|
||||
// - basic:
|
||||
//
|
||||
// Responses:
|
||||
// 200: pauseAlertsResponse
|
||||
// 401: unauthorisedError
|
||||
// 403: forbiddenError
|
||||
// 500: internalServerError
|
||||
|
||||
// swagger:parameters pauseAllAlerts
|
||||
type PauseAllAlertsParam struct {
|
||||
// in:body
|
||||
// required:true
|
||||
Body dtos.PauseAllAlertsCommand `json:"body"`
|
||||
}
|
||||
|
||||
// swagger:response pauseAlertsResponse
|
||||
type PauseAllAlertsResponse struct {
|
||||
// in:body
|
||||
Body struct {
|
||||
// AlertsAffected is the number of the affected alerts.
|
||||
// required: true
|
||||
AlertsAffected int64 `json:"alertsAffected"`
|
||||
// required: true
|
||||
Message string `json:"message"`
|
||||
// Alert result state
|
||||
// required true
|
||||
State string `json:"state"`
|
||||
} `json:"body"`
|
||||
}
|
||||
Reference in New Issue
Block a user