Allow for translating service examples (home-assistant#97141)

kevdotpub · Jul 24, 2023 · b655b9d · b655b9d
1 parent 0c4e341
commit b655b9d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/homeassistant/helpers/service.py b/homeassistant/helpers/service.py
@@ -666,6 +666,10 @@ async def async_get_all_descriptions(
                     f"component.{domain}.services.{service_name}.fields.{field_name}.description"
                 ):
                     field_schema["description"] = desc
+                if example := translations.get(
+                    f"component.{domain}.services.{service_name}.fields.{field_name}.example"
+                ):
+                    field_schema["example"] = example
 
             if "target" in yaml_description:
                 description["target"] = yaml_description["target"]

diff --git a/script/hassfest/translations.py b/script/hassfest/translations.py
@@ -334,6 +334,7 @@ def gen_strings_schema(config: Config, integration: Integration) -> vol.Schema:
                         {
                             vol.Required("name"): str,
                             vol.Required("description"): translation_value_validator,
+                            vol.Optional("example"): translation_value_validator,
                         },
                         slug_validator=translation_key_validator,
                     ),

diff --git a/tests/helpers/test_service.py b/tests/helpers/test_service.py
@@ -573,6 +573,7 @@ async def async_get_translations(
             f"{translation_key_prefix}.description": "Translated description",
             f"{translation_key_prefix}.fields.level.name": "Field name",
             f"{translation_key_prefix}.fields.level.description": "Field description",
+            f"{translation_key_prefix}.fields.level.example": "Field example",
         }
 
     with patch(
@@ -599,6 +600,10 @@ async def async_get_translations(
         ]
         == "Field description"
     )
+    assert (
+        descriptions[logger.DOMAIN]["set_default_level"]["fields"]["level"]["example"]
+        == "Field example"
+    )
 
     hass.services.async_register(logger.DOMAIN, "new_service", lambda x: None, None)
     service.async_set_service_schema(