Add description placeholders to service translation strings #154984

jbouwh · 2025-10-22T10:02:45Z

Proposed change

To avoid URLs in service description strings, we want to be able to move those out of strings.json. This PR makes it possible to add description placeholders via the service registration.

Needs: home-assistant/frontend#27636

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue: Move translatable URLs out of strings.json #154226
Link to documentation pull request:
Link to developer documentation pull request: Introducing description placeholders for service action translations developers.home-assistant#2844
Link to frontend pull request: Add support for service action description placeholders frontend#27636
Link to JS websocket API PR: Add support for description placeholders for service actions home-assistant-js-websocket#661

Checklist

I understand the code I am submitting and can explain how it works.
The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.
Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

home-assistant · 2025-10-22T10:02:54Z

Hey there @Julius2342, @farmio, @marvin-w, mind taking a look at this pull request as it has been labeled with an integration (knx) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of knx can trigger bot actions by commenting:

@home-assistant close Closes the pull request.
@home-assistant rename Awesome new title Renames the pull request.
@home-assistant reopen Reopen the pull request.
@home-assistant unassign knx Removes the current integration label and assignees on the pull request, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

farmio · 2025-10-22T20:09:39Z

Hi 👋!
This yields

ERROR (MainThread) [frontend.js.modern.202510014] Failed to format translation for key 'component.knx.services.send.fields.type.description' in language 'en'. Error: The intl string context variable "sensor_value_types_url" was not provided to the string "If set, the payload will not be sent as raw bytes, but encoded as given DPT. KNX sensor types are valid values (see {sensor_value_types_url})."

when loading the frontend.

jbouwh · 2025-10-22T20:16:08Z

Oops, I'll do some more investigation.

jbouwh · 2025-10-22T21:24:58Z

It seems the API returns the correct translation strings, so I'm not sure what happens here yet.

jbouwh · 2025-10-22T21:28:49Z

Hi 👋! This yields

ERROR (MainThread) [frontend.js.modern.202510014] Failed to format translation for key 'component.knx.services.send.fields.type.description' in language 'en'. Error: The intl string context variable "sensor_value_types_url" was not provided to the string "If set, the payload will not be sent as raw bytes, but encoded as given DPT. KNX sensor types are valid values (see {sensor_value_types_url})."

when loading the frontend.

Try to clear you frontend cash. It should work after all (CTRL+F5) and restart your browser.

emontnemery · 2025-10-23T11:13:19Z

I'm not sure the API changes are needed, this PR removes translations from the old service API #147120

I think that PR should be decided on first, because if it's accepted this PR is much simpler

homeassistant/helpers/service.py

emontnemery · 2025-10-24T07:26:38Z

The translation placeholders don't seem to be returned in the response to the WS command get_services

emontnemery · 2025-10-24T07:32:33Z

Frontend also needs to be updated:

home-assistant-js-websocket needs to be updated around here https://github.com/home-assistant/home-assistant-js-websocket/blob/ffd635dbae8d904fa2094c6b56dd6a2fb286b353/lib/types.ts#L100-L121
frontend needs a bump of home-assistant-js-websocket which makes use of the new feature

homeassistant/helpers/service.py

emontnemery

LGTM, thanks @jbouwh 👍

Can be merged when the frontend PR is approved.

hembhagat99 · 2025-11-04T17:32:31Z

@jbouwh, @emontnemery, I started looking into moving URLs out of strings.json and started with ntfy integration. I noticed that it registers its service using platform.async_register_entity_service, which is defined in entity_platform.py. Shouldn't we also update the contract in that file as well to accept the description_placeholders parameter?

Link to ntfy service registration code

…ink example

Co-authored-by: Erik Montnemery <[email protected]>

…vice and to async_register_platform_entity_service

jbouwh · 2025-11-04T19:51:54Z

@jbouwh, @emontnemery, I started looking into moving URLs out of strings.json and started with ntfy integration. I noticed that it registers its service using platform.async_register_entity_service, which is defined in entity_platform.py. Shouldn't we also update the contract in that file as well to accept the description_placeholders parameter?

Link to ntfy service registration code

You are right, that part was missed. Added the support and a test.

joostlek · 2025-11-05T06:05:17Z

I think a good next step would be to make sure we have tooling like we have with issues and entity placeholders to check that we have the right placeholders filled

jbouwh · 2025-12-08T11:02:02Z

I think a good next step would be to make sure we have tooling like we have with issues and entity placeholders to check that we have the right placeholders filled

#158225

jbouwh requested review from a team, farmio and marvin-w as code owners October 22, 2025 10:02

home-assistant bot added cla-signed core Hacktoberfest integration: knx new-feature labels Oct 22, 2025

home-assistant bot assigned farmio and marvin-w Oct 22, 2025

home-assistant bot added the Quality Scale: silver label Oct 22, 2025

jbouwh added the docs-missing label Oct 22, 2025

This was referenced Oct 22, 2025

Move translatable URLs out of strings.json #154226

Open

Introducing description placeholders for service action translations home-assistant/developers.home-assistant#2844

Merged

jbouwh removed the docs-missing label Oct 22, 2025

jbouwh marked this pull request as draft October 22, 2025 20:16

jbouwh force-pushed the services-translation-placeholders branch from 69b409f to b0d611a Compare October 23, 2025 15:45

emontnemery requested changes Oct 24, 2025

View reviewed changes

homeassistant/helpers/service.py Outdated Show resolved Hide resolved

homeassistant/helpers/service.py Outdated Show resolved Hide resolved

emontnemery added the awaiting-frontend label Oct 24, 2025

This was referenced Oct 25, 2025

Add support for description placeholders for service actions home-assistant/home-assistant-js-websocket#661

Merged

Add support for service action description placeholders home-assistant/frontend#27636

Merged

jbouwh changed the title ~~Add description placeholders to service translation strings and implement this for the KNX integration~~ Add description placeholders to service translation strings Oct 27, 2025

jbouwh mentioned this pull request Oct 27, 2025

Move translatable URL out of strings.json for knx integration #155244

Merged

22 tasks

emontnemery requested changes Oct 27, 2025

View reviewed changes

homeassistant/helpers/service.py Show resolved Hide resolved

homeassistant/helpers/service.py Show resolved Hide resolved

homeassistant/helpers/service.py Show resolved Hide resolved

jbouwh marked this pull request as ready for review October 27, 2025 12:21

emontnemery approved these changes Oct 27, 2025

View reviewed changes

This was referenced Oct 28, 2025

Move url out of zwave strings.json #155312

Closed

Move translatable URLs out of rainmachine #155308

Closed

jbouwh and others added 8 commits November 4, 2025 19:20

Add description placeholders to service translation strings

0b1817a

Add placeholders to service actions descriptions and add to kitchen s…

854780f

…ink example

Update homeassistant/helpers/service.py

c54905a

Co-authored-by: Erik Montnemery <[email protected]>

Ruff

f2e7e65

Update test

10b387e

Revert KNX changes

d78dffd

Also add description_placeholders option to async_register_entity_ser…

229587d

…vice and to async_register_platform_entity_service

Add tests

8d28424

jbouwh force-pushed the services-translation-placeholders branch from 6b9af13 to 8d28424 Compare November 4, 2025 19:26

Add missed entity platform service

e50dbbf

Linter

d5baad9

joostlek approved these changes Nov 5, 2025

View reviewed changes

hembhagat99 mentioned this pull request Nov 5, 2025

Move translatable URL out of strings.json for ntfy integration #155859

Merged

21 tasks

jbouwh and others added 3 commits November 25, 2025 21:15

Merge branch 'dev' into services-translation-placeholders

0de4793

Fix tests

4ad5471

Revert caching test change

7506ea5

jbouwh removed the awaiting-frontend label Nov 25, 2025

bramkragten merged commit 10299b2 into dev Nov 26, 2025
62 checks passed

bramkragten deleted the services-translation-placeholders branch November 26, 2025 08:54

github-actions bot locked and limited conversation to collaborators Nov 27, 2025

Uh oh!

Add description placeholders to service translation strings #154984

Add description placeholders to service translation strings #154984

Uh oh!

Conversation

jbouwh commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

home-assistant bot commented Oct 22, 2025

Uh oh!

farmio commented Oct 22, 2025

Uh oh!

jbouwh commented Oct 22, 2025

Uh oh!

jbouwh commented Oct 22, 2025

Uh oh!

jbouwh commented Oct 22, 2025

Uh oh!

emontnemery commented Oct 23, 2025

Uh oh!

Uh oh!

Uh oh!

emontnemery commented Oct 24, 2025

Uh oh!

emontnemery commented Oct 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

emontnemery left a comment

Choose a reason for hiding this comment

Uh oh!

hembhagat99 commented Nov 4, 2025

Uh oh!

jbouwh commented Nov 4, 2025

Uh oh!

joostlek commented Nov 5, 2025

Uh oh!

Uh oh!

jbouwh commented Dec 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

jbouwh commented Oct 22, 2025 •

edited

Loading