opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-28 10:52:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Rename Message templates to Notification templates (#59477)

Browse Source 
This commit renames "Message templates" to "Notification templates"
in the user interface as it suggests that these templates cannot
be used to template anything other than the message. However, message
templates are much more general and can be used to template other fields
too such as the subject of an email, or the title of a Slack message.
This commit is contained in:
George Robinson
2023-01-18 17:26:34 +00:00
committed by GitHub
parent c54aa18cd8
commit d4256b352d
30 changed files with 513 additions and 268 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/sources/developers/http_api/alerting_provisioning.md
View File

@ -70,12 +70,12 @@ title: 'Alerting Provisioning HTTP API '
### Templates
| Method | URI | Name | Summary |
| ------ | ------------------------------------- | ----------------------------------------------- | ------------------------------ |
| GET | /api/v1/provisioning/templates | [route get templates](#route-get-templates) | Get all message templates. |
| GET | /api/v1/provisioning/templates/{name} | [route get template](#route-get-template) | Get a message template. |
| PUT | /api/v1/provisioning/templates/{name} | [route put template](#route-put-template) | Creates or updates a template. |
| DELETE | /api/v1/provisioning/templates/{name} | [route delete template](#route-delete-template) | Delete a template. |
| Method | URI | Name | Summary |
| ------ | ------------------------------------- | ----------------------------------------------- | ------------------------------- |
| GET | /api/v1/provisioning/templates | [route get templates](#route-get-templates) | Get all notification templates. |
| GET | /api/v1/provisioning/templates/{name} | [route get template](#route-get-template) | Get a notification template. |
| PUT | /api/v1/provisioning/templates/{name} | [route put template](#route-put-template) | Creates or updates a template. |
| DELETE | /api/v1/provisioning/templates/{name} | [route delete template](#route-delete-template) | Delete a template. |
## Paths
@ -378,7 +378,7 @@ Status: Bad Request
[ValidationError](#validation-error)
### <span id="route-get-template"></span> Get a message template. (_RouteGetTemplate_)
### <span id="route-get-template"></span> Get a notification template. (_RouteGetTemplate_)
```
GET /api/v1/provisioning/templates/{name}
@ -392,20 +392,20 @@ GET /api/v1/provisioning/templates/{name}
#### All responses
| Code | Status | Description | Has headers | Schema |
| ------------------------------ | --------- | --------------- | :---------: | ---------------------------------------- |
| [200](#route-get-template-200) | OK | MessageTemplate | | [schema](#route-get-template-200-schema) |
| [404](#route-get-template-404) | Not Found | NotFound | | [schema](#route-get-template-404-schema) |
| Code | Status | Description | Has headers | Schema |
| ------------------------------ | --------- | -------------------- | :---------: | ---------------------------------------- |
| [200](#route-get-template-200) | OK | NotificationTemplate | | [schema](#route-get-template-200-schema) |
| [404](#route-get-template-404) | Not Found | NotFound | | [schema](#route-get-template-404-schema) |
#### Responses
##### <span id="route-get-template-200"></span> 200 - MessageTemplate
##### <span id="route-get-template-200"></span> 200 - NotificationTemplate
Status: OK
###### <span id="route-get-template-200-schema"></span> Schema
[MessageTemplate](#message-template)
[NotificationTemplate](#message-template)
##### <span id="route-get-template-404"></span> 404 - NotFound
@ -415,7 +415,7 @@ Status: Not Found
[NotFound](#not-found)
### <span id="route-get-templates"></span> Get all message templates. (_RouteGetTemplates_)
### <span id="route-get-templates"></span> Get all notification templates. (_RouteGetTemplates_)
```
GET /api/v1/provisioning/templates
@ -423,20 +423,20 @@ GET /api/v1/provisioning/templates
#### All responses
| Code | Status | Description | Has headers | Schema |
| ------------------------------- | ----------- | --------------- | :---------: | ----------------------------------------- |
| [200](#route-get-templates-200) | OK | MessageTemplate | | [schema](#route-get-templates-200-schema) |
| [400](#route-get-templates-400) | Bad Request | ValidationError | | [schema](#route-get-templates-400-schema) |
| Code | Status | Description | Has headers | Schema |
| ------------------------------- | ----------- | -------------------- | :---------: | ----------------------------------------- |
| [200](#route-get-templates-200) | OK | NotificationTemplate | | [schema](#route-get-templates-200-schema) |
| [400](#route-get-templates-400) | Bad Request | ValidationError | | [schema](#route-get-templates-400-schema) |
#### Responses
##### <span id="route-get-templates-200"></span> 200 - MessageTemplate
##### <span id="route-get-templates-200"></span> 200 - NotificationTemplate
Status: OK
###### <span id="route-get-templates-200-schema"></span> Schema
[MessageTemplate](#message-template)
[NotificationTemplate](#message-template)
##### <span id="route-get-templates-400"></span> 400 - ValidationError
@ -787,10 +787,10 @@ PUT /api/v1/provisioning/templates/{name}
#### Parameters
| Name | Source | Type | Go type | Separator | Required | Default | Description |
| ---- | ------ | --------------------------------------------------- | ------------------------------- | --------- | :------: | ------- | ------------- |
| name | `path` | string | `string` | | ✓ | | Template Name |
| Body | `body` | [MessageTemplateContent](#message-template-content) | `models.MessageTemplateContent` | | | | |
| Name | Source | Type | Go type | Separator | Required | Default | Description |
| ---- | ------ | -------------------------------------------------------- | ------------------------------------ | --------- | :------: | ------- | ------------- |
| name | `path` | string | `string` | | ✓ | | Template Name |
| Body | `body` | [NotificationTemplateContent](#message-template-content) | `models.NotificationTemplateContent` | | | | |
#### All responses
@ -915,7 +915,7 @@ Status: Bad Request
[][matcher](#matcher)
### <span id="message-template"></span> MessageTemplate
### <span id="message-template"></span> NotificationTemplate
**Properties**
@ -925,7 +925,7 @@ Status: Bad Request
| Template | string | `string` | | | | |
| provenance | string | `Provenance` | | | | |
### <span id="message-template-content"></span> MessageTemplateContent
### <span id="message-template-content"></span> NotificationTemplateContent
**Properties**