Migrate notify services to support translations (#96413)

* Migrate notify services to support translations

* Apply suggestions from code review

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Franck Nijhof 2023-07-12 20:37:45 +02:00 committed by GitHub
parent 273e80cc45
commit a96ee22afa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 45 additions and 25 deletions

View file

@ -1,61 +1,37 @@
# Describes the format for available notification services
notify:
name: Send a notification
description: Sends a notification message to selected notify platforms.
fields:
message:
name: Message
description: Message body of the notification.
required: true
example: The garage door has been open for 10 minutes.
selector:
text:
title:
name: Title
description: Title for your notification.
example: "Your Garage Door Friend"
selector:
text:
target:
name: Target
description:
An array of targets to send the notification to. Optional depending on
the platform.
example: platform specific
selector:
object:
data:
name: Data
description:
Extended information for notification. Optional depending on the
platform.
example: platform specific
selector:
object:
persistent_notification:
name: Send a persistent notification
description: Sends a notification that is visible in the front-end.
fields:
message:
name: Message
description: Message body of the notification.
required: true
example: The garage door has been open for 10 minutes.
selector:
text:
title:
name: Title
description: Title for your notification.
example: "Your Garage Door Friend"
selector:
text:
data:
name: Data
description:
Extended information for notification. Optional depending on the
platform.
example: platform specific
selector:
object:

View file

@ -1 +1,45 @@
{ "title": "Notifications" }
{
"title": "Notifications",
"services": {
"notify": {
"name": "Send a notification",
"description": "Sends a notification message to selected targets.",
"fields": {
"message": {
"name": "Message",
"description": "Message body of the notification."
},
"title": {
"name": "Title",
"description": "Title for your notification."
},
"target": {
"name": "Target",
"description": "Some integrations allow you to specify the targets that receive the notification. For more information, refer to the integration documentation."
},
"data": {
"name": "Data",
"description": "Some integrations provide extended functionality. For information on how to use _data_, refer to the integration documentation."
}
}
},
"persistent_notification": {
"name": "Send a persistent notification",
"description": "Sends a notification that is visible in the **Notifications** panel.",
"fields": {
"message": {
"name": "Message",
"description": "Message body of the notification."
},
"title": {
"name": "Title",
"description": "Title of the notification."
},
"data": {
"name": "Data",
"description": "Some integrations provide extended functionality. For information on how to use _data_, refer to the integration documentation.."
}
}
}
}
}