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

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
+59 -42
View File
@@ -7,6 +7,26 @@
"Ack": {
"type": "object"
},
"AddCommand": {
"properties": {
"name": {
"type": "string"
},
"role": {
"enum": [
"Viewer",
"Editor",
"Admin"
],
"type": "string"
},
"secondsToLive": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"Alert": {
"properties": {
"activeAt": {
@@ -1491,34 +1511,6 @@
},
"type": "array"
},
"MessageTemplate": {
"properties": {
"name": {
"type": "string"
},
"provenance": {
"$ref": "#/definitions/Provenance"
},
"template": {
"type": "string"
}
},
"type": "object"
},
"MessageTemplateContent": {
"properties": {
"template": {
"type": "string"
}
},
"type": "object"
},
"MessageTemplates": {
"items": {
"$ref": "#/definitions/MessageTemplate"
},
"type": "array"
},
"MultiStatus": {
"type": "object"
},
@@ -1580,6 +1572,34 @@
"title": "NoticeSeverity is a type for the Severity property of a Notice.",
"type": "integer"
},
"NotificationTemplate": {
"properties": {
"name": {
"type": "string"
},
"provenance": {
"$ref": "#/definitions/Provenance"
},
"template": {
"type": "string"
}
},
"type": "object"
},
"NotificationTemplateContent": {
"properties": {
"template": {
"type": "string"
}
},
"type": "object"
},
"NotificationTemplates": {
"items": {
"$ref": "#/definitions/NotificationTemplate"
},
"type": "array"
},
"NotifierConfig": {
"properties": {
"send_resolved": {
@@ -3352,7 +3372,6 @@
"type": "object"
},
"alertGroups": {
"description": "AlertGroups alert groups",
"items": {
"$ref": "#/definitions/alertGroup"
},
@@ -3513,14 +3532,12 @@
"type": "object"
},
"gettableAlerts": {
"description": "GettableAlerts gettable alerts",
"items": {
"$ref": "#/definitions/gettableAlert"
},
"type": "array"
},
"gettableSilence": {
"description": "GettableSilence gettable silence",
"properties": {
"comment": {
"description": "comment",
@@ -3569,7 +3586,6 @@
"type": "object"
},
"gettableSilences": {
"description": "GettableSilences gettable silences",
"items": {
"$ref": "#/definitions/gettableSilence"
},
@@ -3756,6 +3772,7 @@
"type": "object"
},
"receiver": {
"description": "Receiver receiver",
"properties": {
"active": {
"description": "active",
@@ -4442,16 +4459,16 @@
"operationId": "RouteGetTemplates",
"responses": {
"200": {
"description": "MessageTemplates",
"description": "NotificationTemplates",
"schema": {
"$ref": "#/definitions/MessageTemplates"
"$ref": "#/definitions/NotificationTemplates"
}
},
"404": {
"description": " Not found."
}
},
"summary": "Get all message templates.",
"summary": "Get all notification templates.",
"tags": [
"provisioning"
]
@@ -4492,16 +4509,16 @@
],
"responses": {
"200": {
"description": "MessageTemplate",
"description": "NotificationTemplate",
"schema": {
"$ref": "#/definitions/MessageTemplate"
"$ref": "#/definitions/NotificationTemplate"
}
},
"404": {
"description": " Not found."
}
},
"summary": "Get a message template.",
"summary": "Get a notification template.",
"tags": [
"provisioning"
]
@@ -4523,15 +4540,15 @@
"in": "body",
"name": "Body",
"schema": {
"$ref": "#/definitions/MessageTemplateContent"
"$ref": "#/definitions/NotificationTemplateContent"
}
}
],
"responses": {
"202": {
"description": "MessageTemplate",
"description": "NotificationTemplate",
"schema": {
"$ref": "#/definitions/MessageTemplate"
"$ref": "#/definitions/NotificationTemplate"
}
},
"400": {
@@ -4541,7 +4558,7 @@
}
}
},
"summary": "Updates an existing template.",
"summary": "Updates an existing notification template.",
"tags": [
"provisioning"
]