Files
grafana/pkg/services/ngalert/api/tooling/definitions/provisioning_templates.go
T
Alexander Weaver 17e76b06ff Alerting: Fix rendering issues in OpenAPI docs (#50630)
* Clean up status codes

* Missing consumes tag

* Regenerate

* Fix incorrect documented responses and missing UI elements

* Fix response docs

* Fix wrong response copy paste

* Regenerate

* Temporarily revert
2022-06-13 12:51:07 -05:00

75 lines
1.7 KiB
Go

package definitions
import (
"github.com/grafana/grafana/pkg/services/ngalert/models"
)
// swagger:route GET /api/v1/provisioning/templates provisioning stable RouteGetTemplates
//
// Get all message templates.
//
// Responses:
// 200: MessageTemplates
// 404: description: Not found.
// swagger:route GET /api/v1/provisioning/templates/{name} provisioning stable RouteGetTemplate
//
// Get a message template.
//
// Responses:
// 200: MessageTemplate
// 404: description: Not found.
// swagger:route PUT /api/v1/provisioning/templates/{name} provisioning stable RoutePutTemplate
//
// Updates an existing template.
//
// Consumes:
// - application/json
//
// Responses:
// 202: MessageTemplate
// 400: ValidationError
// swagger:route DELETE /api/v1/provisioning/templates/{name} provisioning stable RouteDeleteTemplate
//
// Delete a template.
//
// Responses:
// 204: description: The template was deleted successfully.
// swagger:parameters RouteGetTemplate RoutePutTemplate RouteDeleteTemplate
type RouteGetTemplateParam struct {
// Template Name
// in:path
Name string `json:"name"`
}
// swagger:model
type MessageTemplate struct {
Name string `json:"name"`
Template string `json:"template"`
Provenance models.Provenance `json:"provenance,omitempty"`
}
// swagger:model
type MessageTemplates []MessageTemplate
type MessageTemplateContent struct {
Template string `json:"template"`
}
// swagger:parameters RoutePutTemplate
type MessageTemplatePayload struct {
// in:body
Body MessageTemplateContent
}
func (t *MessageTemplate) ResourceType() string {
return "template"
}
func (t *MessageTemplate) ResourceID() string {
return t.Name
}