Add targets and selectors for services (P-R) (#50628)

homeassistant/components/persistent_notification/services.yaml

@@ -1,26 +1,47 @@
 create:
+  name: Create
   description: Show a notification in the frontend.
   fields:
     message:
+      name: Message
       description: Message body of the notification. [Templates accepted]
+      required: true
       example: Please check your configuration.yaml.
+      selector:
+        text:
     title:
-      description: Optional title for your notification. [Optional, Templates accepted]
+      name: Title
+      description: Optional title for your notification. [Templates accepted]
       example: Test notification
+      selector:
+        text:
     notification_id:
-      description: Target ID of the notification, will replace a notification with the same ID. [Optional]
+      name: Notification ID
+      description: Target ID of the notification, will replace a notification with the same ID.
       example: 1234
+      selector:
+        text:
 
 dismiss:
+  name: Dismiss
   description: Remove a notification from the frontend.
   fields:
     notification_id:
-      description: Target ID of the notification, which should be removed. [Required]
+      name: Notification ID
+      description: Target ID of the notification, which should be removed.
+      required: true
       example: 1234
+      selector:
+        text:
 
 mark_read:
+  name: Mark read
   description: Mark a notification read.
   fields:
     notification_id:
-      description: Target ID of the notification, which should be mark read. [Required]
+      name: Notification ID
+      description: Target ID of the notification, which should be mark read.
+      required: true
       example: 1234
+      selector:
+        text:

homeassistant/components/person/services.yaml

@@ -1,2 +1,3 @@
 reload:
+  name: Reload
   description: Reload the person configuration.

homeassistant/components/pilight/services.yaml

@@ -1,6 +1,11 @@
 send:
+  name: Send
   description: Send RF code to Pilight device
   fields:
     protocol:
+      name: Protocol
       description: "Protocol that Pilight recognizes. See https://manual.pilight.org/protocols/index.html for supported protocols and additional parameters that each protocol supports"
+      required: true
       example: "lirc"
+      selector:
+        object:

homeassistant/components/ping/services.yaml

@@ -1,2 +1,3 @@
 reload:
+  name: Reload
   description: Reload all ping entities.

homeassistant/components/qvr_pro/services.yaml

@@ -1,13 +1,23 @@
 start_record:
+  name: Start record
   description: Start QVR Pro recording on specified channel.
   fields:
     guid:
+      name: GUID
       description: GUID of the channel to start recording.
+      required: true
       example: "245EBE933C0A597EBE865C0A245E0002"
+      selector:
+        text:
 
 stop_record:
+  name: Stop record
   description: Stop QVR Pro recording on specified channel.
   fields:
     guid:
+      name: GUID
       description: GUID of the channel to stop recording.
+      required: true
       example: "245EBE933C0A597EBE865C0A245E0002"
+      selector:
+        text:

homeassistant/components/rachio/services.yaml

@@ -1,5 +1,5 @@
 set_zone_moisture_percent:
-  name: Set Zone Moisture Percent
+  name: Set zone moisture percent
   description: Set the moisture percentage of a zone or list of zones.
   target:
     entity:
@@ -8,7 +8,7 @@ set_zone_moisture_percent:
   fields:
     percent:
       name: Percent
-      description: Set the desired zone moisture percentage from 0 to 100.
+      description: Set the desired zone moisture percentage.
       required: true
       example: 50
       selector:
@@ -17,9 +17,8 @@ set_zone_moisture_percent:
           max: 100
           mode: slider
           unit_of_measurement: "%"
-          step: 1
 start_multiple_zone_schedule:
-  name: Start Multiple Zones
+  name: Start multiple zones
   description: Create a custom schedule of zones and runtimes. Note that all zones should be on the same controller to avoid issues.
   target:
     entity:
@@ -34,7 +33,7 @@ start_multiple_zone_schedule:
       selector:
         object:
 pause_watering:
-  name: Pause Watering
+  name: Pause watering
   description: Pause any currently running zones or schedules.
   fields:
     devices:
@@ -45,8 +44,8 @@ pause_watering:
         text:
     duration:
       name: Duration
-      description: The number of minutes to pause running schedules. Accepts 1-60. Default is 60 minutes if not provided.
+      description: The time to pause running schedules.
-      example: 60
+      example: 30
       default: 60
       selector:
         number:
@@ -54,9 +53,8 @@ pause_watering:
           max: 60
           mode: slider
           unit_of_measurement: "minutes"
-          step: 1
 resume_watering:
-  name: Resume Watering
+  name: Resume watering
   description: Resume any paused zone runs or schedules.
   fields:
     devices:

homeassistant/components/rainbird/services.yaml

@@ -1,9 +1,18 @@
 start_irrigation:
+  name: Start irrigation
   description: Start the irrigation
   fields:
     entity_id:
+      name: Entity
       description: Name of a single irrigation to turn on
+      required: true
       example: "switch.sprinkler_1"
+      selector:
+        entity:
+          integration: rainbird
+          domain: switch
     duration:
+      name: Duration
       description: Duration for this sprinkler to be turned on
+      required: true
       example: 1

homeassistant/components/rainmachine/services.yaml

@@ -1,97 +1,174 @@
 # Describes the format for available RainMachine services
 disable_program:
+  name: Disable program
   description: Disable a program.
+  target:
+    entity:
+      integration: rainmachine
+      domain: switch
   fields:
-    entity_id:
-      description: An entity from the desired RainMachine controller
-      example: switch.zone_1
     program_id:
+      name: Program ID
       description: The program to disable.
+      required: true
       example: 3
+      selector:
+        number:
+          min: 1
+          max: 255
 disable_zone:
+  name: Disable zone
   description: Disable a zone.
+  target:
+    entity:
+      integration: rainmachine
+      domain: switch
   fields:
-    entity_id:
-      description: An entity from the desired RainMachine controller
-      example: switch.zone_1
     zone_id:
+      name: Zone ID
       description: The zone to disable.
+      required: true
       example: 3
+      selector:
+        number:
+          min: 1
+          max: 255
 enable_program:
+  name: Enable program
   description: Enable a program.
+  target:
+    entity:
+      integration: rainmachine
+      domain: switch
   fields:
-    entity_id:
-      description: An entity from the desired RainMachine controller
-      example: switch.zone_1
     program_id:
+      name: Program ID
       description: The program to enable.
+      required: true
       example: 3
+      selector:
+        number:
+          min: 1
+          max: 255
 enable_zone:
+  name: Enable zone
   description: Enable a zone.
+  target:
+    entity:
+      integration: rainmachine
+      domain: switch
   fields:
-    entity_id:
-      description: An entity from the desired RainMachine controller
-      example: switch.zone_1
     zone_id:
+      name: Zone ID
       description: The zone to enable.
+      required: true
       example: 3
+      selector:
+        number:
+          min: 1
+          max: 255
 pause_watering:
+  name: Pause watering
   description: Pause all watering for a number of seconds.
+  target:
+    entity:
+      integration: rainmachine
+      domain: switch
   fields:
-    entity_id:
-      description: An entity from the desired RainMachine controller
-      example: switch.zone_1
     seconds:
-      description: The number of seconds to pause.
+      name: Seconds
+      description: The time to pause.
+      required: true
       example: 30
+      selector:
+        number:
+          min: 1
+          max: 86400
+          unit_of_measurement: seconds
 start_program:
+  name: Start program
   description: Start a program.
+  target:
+    entity:
+      integration: rainmachine
+      domain: switch
   fields:
-    entity_id:
-      description: An entity from the desired RainMachine controller
-      example: switch.zone_1
     program_id:
+      name: Program ID
       description: The program to start.
+      required: true
       example: 3
+      selector:
+        number:
+          min: 1
+          max: 255
 start_zone:
+  name: Start zone
   description: Start a zone for a set number of seconds.
+  target:
+    entity:
+      integration: rainmachine
+      domain: switch
   fields:
-    entity_id:
-      description: An entity from the desired RainMachine controller
-      example: switch.zone_1
     zone_id:
+      name: Zone ID
       description: The zone to start.
+      required: true
       example: 3
+      selector:
+        number:
+          min: 1
+          max: 255
     zone_run_time:
+      name: Zone run time
       description: The number of seconds to run the zone.
       example: 120
+      default: 600
 stop_all:
+  name: Stop all
   description: Stop all watering activities.
-  fields:
+  target:
-    entity_id:
+    entity:
-      description: An entity from the desired RainMachine controller
+      integration: rainmachine
-      example: switch.zone_1
+      domain: switch
 stop_program:
+  name: Stop program
   description: Stop a program.
+  target:
+    entity:
+      integration: rainmachine
+      domain: switch
   fields:
-    entity_id:
-      description: An entity from the desired RainMachine controller
-      example: switch.zone_1
     program_id:
+      name: Program ID
       description: The program to stop.
+      required: true
       example: 3
+      selector:
+        number:
+          min: 1
+          max: 255
 stop_zone:
+  name: Stop zone
   description: Stop a zone.
+  target:
+    entity:
+      integration: rainmachine
+      domain: switch
   fields:
-    entity_id:
-      description: An entity from the desired RainMachine controller
-      example: switch.zone_1
     zone_id:
+      name: Zone ID
       description: The zone to stop.
+      required: true
       example: 3
+      selector:
+        number:
+          min: 1
+          max: 255
 unpause_watering:
+  name: Unpause watering
   description: Unpause all watering.
-  fields:
+  target:
-    entity_id:
+    entity:
-      description: An entity from the desired RainMachine controller
+      integration: rainmachine
-      example: switch.zone_1
+      domain: switch

homeassistant/components/recorder/services.yaml

@@ -34,7 +34,9 @@ purge:
         boolean:
 
 disable:
+  name: Disable
   description: Stop the recording of events and state changes
 
-enabled:
+enable:
+  name: Enable
   description: Start the recording of events and state changes

homeassistant/components/remember_the_milk/services.yaml

@@ -1,21 +1,34 @@
 # Describes the format for available Remember The Milk services
 
 create_task:
+  name: Create task
   description: >-
     Create (or update) a new task in your Remember The Milk account. If you want to update a task
     later on, you have to set an "id" when creating the task.
     Note: Updating a tasks does not support the smart syntax.
   fields:
     name:
+      name: Name
       description: name of the new task, you can use the smart syntax here
+      required: true
       example: "do this ^today #from_hass"
+      selector:
+        text:
     id:
-      description: (optional) identifier for the task you're creating, can be used to update or complete the task later on
+      name: ID
+      description: Identifier for the task you're creating, can be used to update or complete the task later on
       example: myid
+      selector:
+        text:
 
 complete_task:
+  name: Complete task
   description: Complete a tasks that was privously created.
   fields:
     id:
+      name: ID
       description: identifier that was defined when creating the task
+      required: true
       example: myid
+      selector:
+        text:

homeassistant/components/rest/services.yaml

@@ -1,2 +1,3 @@
 reload:
+  name: Reload
   description: Reload all rest entities and notify services

homeassistant/components/rflink/services.yaml

@@ -1,9 +1,18 @@
 send_command:
+  name: Send command
   description: Send device command through RFLink.
   fields:
     command:
+      name: Command
       description: The command to be sent.
+      required: true
       example: "on"
+      selector:
+        text:
     device_id:
+      name: Device ID
       description: RFLink device ID.
+      required: true
       example: newkaku_0000c6c2_1
+      selector:
+        text:

homeassistant/components/rfxtrx/services.yaml

@@ -1,6 +1,11 @@
 send:
+  name: Send
   description: Sends a raw event on radio.
   fields:
     event:
+      name: Event
       description: A hexadecimal string to send.
+      required: true
       example: "0b11009e00e6116202020070"
+      selector:
+        text:

homeassistant/components/ring/services.yaml

@@ -1,2 +1,3 @@
 update:
+  name: Update
   description: Updates the data we have for all your ring devices

homeassistant/components/risco/services.yaml

@@ -1,15 +1,17 @@
 # Describes the format for available Risco services
 
 bypass_zone:
+  name: Bypass zone
   description: Bypass a Risco Zone
-  fields:
+  target:
-    entity_id:
+    entity:
-      description: Entity ID of the zone to bypass
+      integration: risco
-      example: "binary_sensor.living_room_motion"
+      domain: binary_sensor
 
 unbypass_zone:
+  name: Unbypass zone
   description: Unbypass a Risco Zone
-  fields:
+  target:
-    entity_id:
+    entity:
-      description: Entity ID of the zone to unbypass
+      integration: risco
-      example: "binary_sensor.living_room_motion"
+      domain: binary_sensor

homeassistant/components/roku/services.yaml

@@ -1,9 +1,15 @@
 search:
+  name: Search
   description: Emulates opening the search screen and entering the search keyword.
+  target:
+    entity:
+      integration: roku
+      domain: media_player
   fields:
-    entity_id:
-      description: The entities to search on.
-      example: "media_player.roku"
     keyword:
+      name: Keyword
       description: The keyword to search for.
+      required: true
       example: "Space Jam"
+      selector:
+        text:

homeassistant/components/roon/services.yaml

@@ -1,9 +1,15 @@
 transfer:
+  name: Transfer
   description: Transfer playback from one player to another.
+  target:
+    entity:
+      integration: roon
+      domain: media_player
   fields:
-    entity_id:
-      description: id of the source player.
-      example: "media_player.bedroom"
     transfer_id:
+      name: Transfer ID
       description: id of the destination player.
+      required: true
       example: "media_player.study"
+      selector:
+        text:

homeassistant/components/route53/services.yaml

@@ -1,2 +1,3 @@
 update_records:
+  name: Update records
   description: Trigger update of records.

homeassistant/components/rpi_gpio/services.yaml

@@ -1,2 +1,3 @@
 reload:
+  name: Reload
   description: Reload all rpi_gpio entities.