Move url out of zwave strings.json #155312

mishmanners · 2025-10-28T03:17:17Z

Proposed change

Move URL out of strings.json to avoid making it translatable.

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:
Link to frontend pull request:

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.

Updated the description for the push_weather_data service to include a placeholder for the API URL.

Add description placeholders for API URL in user form.

Removed unnecessary description placeholders from the form display.

Updated the description for the 'push_weather_data' service to include a link to the RainMachine API documentation.

home-assistant · 2025-10-28T03:17:24Z

Hey there @home-assistant/z-wave, mind taking a look at this pull request as it has been labeled with an integration (zwave_js) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of zwave_js 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 zwave_js 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.

Copilot

Pull Request Overview

This PR moves Z-Wave API documentation URLs out of translatable strings in strings.json and into description placeholders in the config flow. This prevents the URLs from being unnecessarily translated while maintaining the same user-facing functionality.

Key changes:

Replaced hardcoded URLs in strings.json with placeholder variables {api_method} and {api_paramaters}
Added URL values to description placeholders in the config flow's async_step_manual method

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
homeassistant/components/zwave_js/strings.json	Replaced hardcoded documentation URLs with placeholder variables in method and parameter descriptions
homeassistant/components/zwave_js/config_flow.py	Added URL values for api_method and api_paramaters placeholders in description_placeholders dictionary

homeassistant/components/zwave_js/strings.json

homeassistant/components/zwave_js/config_flow.py

Co-authored-by: Copilot <[email protected]>

joostlek

Not quite, you're updating the config flow placeholders, but the strings are from the services, this integration requires #154984

home-assistant · 2025-10-28T06:31:15Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Add API documentation links as description placeholders.

mishmanners · 2025-10-28T07:18:58Z

I think I added in the correct services... please let me know.

TheJulianJES

Just to clarify: These are URLs used in Home Assistant action services. At the moment, there's no way to use description placeholders in them.

Other integrations mostly used URLs in config flows where it is already possible to use description placeholders to fix the issue with the URLs being in the tranlsations.

Like Joost mentioned, we'll need to wait for #154984 to be merged. Then, we can use a similar implementation to the kitchen_sink integration example used in that PR for Z-Wave.

homeassistant/components/zwave_js/config_flow.py

Added a list of ignored USB devices to prevent them from appearing in serial port selection.

Added API placeholders for documentation links.

Added description placeholders for API method and parameters in the configuration forms.

mishmanners · 2025-10-31T12:14:15Z

@zweckj any chance I can get some eyes on this. Looks like it failed when I merged the dev branch in...

zweckj · 2025-10-31T12:19:28Z

Please don't ping people, it's considered impolite. You'll need to set up a proper dev environment (e.g. devcontainer) and make sure the pre-commit hooks are passing. It's currently incorrectly formatted (it always was but nobody ran the pipeline I assume)

jbouwh · 2025-11-26T22:43:15Z

homeassistant/components/zwave_js/services.py

+API_PLACEHOLDERS = {
+    "api_method": "https://zwave-js.github.io/node-zwave-js/#/api/CCs/index",
+    "api_parameters": "https://zwave-js.github.io/node-zwave-js/#/api/CCs/index",
+    }


Suggested change

API_PLACEHOLDERS = {

"api_method": "https://zwave-js.github.io/node-zwave-js/#/api/CCs/index",

"api_parameters": "https://zwave-js.github.io/node-zwave-js/#/api/CCs/index",

}

Remove this lines, and only add one placeholder for api_url (URLs are the same), here:

core/homeassistant/components/zwave_js/services.py

Lines 433 to 455 in 9734058

self._hass.services.async_register(

const.DOMAIN,

const.SERVICE_INVOKE_CC_API,

self.async_invoke_cc_api,

schema=vol.Schema(

vol.All(

{

**TARGET_VALIDATORS,

vol.Required(const.ATTR_COMMAND_CLASS): vol.All(

vol.Coerce(int), vol.Coerce(CommandClass)

),

vol.Optional(const.ATTR_ENDPOINT): vol.Coerce(int),

vol.Required(const.ATTR_METHOD_NAME): cv.string,

vol.Required(const.ATTR_PARAMETERS): list,

},

cv.has_at_least_one_key(

ATTR_DEVICE_ID, ATTR_ENTITY_ID, ATTR_AREA_ID

),

get_nodes_from_service_data,

has_at_least_one_node,

),

),

)

jbouwh · 2025-11-26T22:47:10Z

homeassistant/components/zwave_js/config_flow.py

+API_PLACEHOLDERS = {
+    "api_parameters": "https://zwave-js.github.io/node-zwave-js/#/api/CCs/index",
+    }


Suggested change

API_PLACEHOLDERS = {

"api_parameters": "https://zwave-js.github.io/node-zwave-js/#/api/CCs/index",

}

Not needed as this is not used in the config flow, only for a service action.

jbouwh · 2025-11-26T22:47:28Z

homeassistant/components/zwave_js/config_flow.py

        return self.async_show_form(
            step_id="rf_region",
            data_schema=schema,
+            description_placeholders=API_PLACEHOLDERS,


Suggested change

description_placeholders=API_PLACEHOLDERS,

jbouwh · 2025-11-26T22:48:30Z

homeassistant/components/zwave_js/config_flow.py

+            step_id="configure_security_keys",
+            data_schema=data_schema,
+            description_placeholders={
+                "api_method": "https://zwave-js.github.io/node-zwave-js/#/api/CCs/index",
+            },


Suggested change

step_id="configure_security_keys",

data_schema=data_schema,

description_placeholders={

"api_method": "https://zwave-js.github.io/node-zwave-js/#/api/CCs/index",

},

step_id="configure_security_keys", data_schema=data_schema

jbouwh · 2025-11-26T22:49:56Z

homeassistant/components/zwave_js/strings.json

        },
        "method_name": {
-          "description": "The name of the API method to call. Refer to the Z-Wave Command Class API documentation (https://zwave-js.github.io/node-zwave-js/#/api/CCs/index) for available methods.",
+          "description": "The name of the API method to call. Refer to the Z-Wave Command Class API documentation {api_method} for available methods.",


Suggested change

"description": "The name of the API method to call. Refer to the Z-Wave Command Class API documentation {api_method} for available methods.",

"description": "The name of the API method to call. Refer to the Z-Wave Command Class API documentation {api_url} for available methods.",

jbouwh · 2025-11-26T22:50:20Z

homeassistant/components/zwave_js/strings.json

        },
        "parameters": {
-          "description": "A list of parameters to pass to the API method. Refer to the Z-Wave Command Class API documentation (https://zwave-js.github.io/node-zwave-js/#/api/CCs/index) for parameters.",
+          "description": "A list of parameters to pass to the API method. Refer to the Z-Wave Command Class API documentation {api_parameters} for parameters.",


Suggested change

"description": "A list of parameters to pass to the API method. Refer to the Z-Wave Command Class API documentation {api_parameters} for parameters.",

"description": "A list of parameters to pass to the API method. Refer to the Z-Wave Command Class API documentation {api_url} for parameters.",

mishmanners added 5 commits October 28, 2025 12:12

Modify push_weather_data description in strings.json

fb15d93

Updated the description for the push_weather_data service to include a placeholder for the API URL.

Enhance user form with API URL description

eea145e

Add description placeholders for API URL in user form.

Move url out strings.json

d49cde8

Simplify user form in RainMachine config flow

a4960da

Removed unnecessary description placeholders from the form display.

Improve description for push_weather_data service

ad1f585

Updated the description for the 'push_weather_data' service to include a link to the RainMachine API documentation.

Copilot AI review requested due to automatic review settings October 28, 2025 03:17

mishmanners requested a review from a team as a code owner October 28, 2025 03:17

home-assistant bot added cla-signed code-quality Hacktoberfest integration: zwave_js small-pr PRs with less than 30 lines. Quality Scale: No score labels Oct 28, 2025

Copilot AI reviewed Oct 28, 2025

View reviewed changes

homeassistant/components/zwave_js/strings.json Outdated Show resolved Hide resolved

homeassistant/components/zwave_js/config_flow.py Outdated Show resolved Hide resolved

mishmanners and others added 2 commits October 28, 2025 13:21

Update homeassistant/components/zwave_js/strings.json

5a9ec5c

Co-authored-by: Copilot <[email protected]>

Update homeassistant/components/zwave_js/config_flow.py

b80b01a

Co-authored-by: Copilot <[email protected]>

joostlek requested changes Oct 28, 2025

View reviewed changes

home-assistant bot marked this pull request as draft October 28, 2025 06:31

Add description placeholders for API documentation

2f0d266

Add API documentation links as description placeholders.

mishmanners marked this pull request as ready for review October 28, 2025 07:19

home-assistant bot requested a review from joostlek October 28, 2025 07:19

TheJulianJES requested changes Oct 28, 2025

View reviewed changes

homeassistant/components/zwave_js/config_flow.py Outdated Show resolved Hide resolved

home-assistant bot marked this pull request as draft October 28, 2025 12:32

description placeholders added to service registration

ff5e499

mishmanners marked this pull request as ready for review October 29, 2025 03:07

home-assistant bot requested a review from TheJulianJES October 29, 2025 03:07

epenet marked this pull request as draft October 29, 2025 10:13

mishmanners added 6 commits October 31, 2025 22:51

Add ignored USB devices for serial port selection

a6a1315

Added a list of ignored USB devices to prevent them from appearing in serial port selection.

Add API placeholders to zwave_js services

e72e029

Added API placeholders for documentation links.

Merge branch 'dev' into zwave

226e4b4

Fix syntax error in API_PLACEHOLDERS dictionary

6e304e8

Enhance config flow with API documentation links

b7d23f7

Added description placeholders for API method and parameters in the configuration forms.

Refactor API placeholders in config flow

a754926

mishmanners and others added 2 commits October 31, 2025 23:20

Update API placeholders in config_flow.py

f62cb10

Merge branch 'dev' into zwave

61cd24e

jbouwh requested changes Nov 26, 2025

View reviewed changes

This was referenced Dec 4, 2025

Move out zwave_js api docs url from strings.json #157959

Merged

Move translatable URLs out of strings.json #154226

Open

zweckj closed this in #157959 Dec 4, 2025

home-assistant bot removed the Hacktoberfest label Dec 4, 2025

github-actions bot locked and limited conversation to collaborators Dec 5, 2025

	self._hass.services.async_register(
	const.DOMAIN,
	const.SERVICE_INVOKE_CC_API,
	self.async_invoke_cc_api,
	schema=vol.Schema(
	vol.All(
	{
	**TARGET_VALIDATORS,
	vol.Required(const.ATTR_COMMAND_CLASS): vol.All(
	vol.Coerce(int), vol.Coerce(CommandClass)
	),
	vol.Optional(const.ATTR_ENDPOINT): vol.Coerce(int),
	vol.Required(const.ATTR_METHOD_NAME): cv.string,
	vol.Required(const.ATTR_PARAMETERS): list,
	},
	cv.has_at_least_one_key(
	ATTR_DEVICE_ID, ATTR_ENTITY_ID, ATTR_AREA_ID
	),
	get_nodes_from_service_data,
	has_at_least_one_node,
	),
	),
	)

	API_PLACEHOLDERS = {
	"api_parameters": "https://zwave-js.github.io/node-zwave-js/#/api/CCs/index",
	}

	"description": "The name of the API method to call. Refer to the Z-Wave Command Class API documentation {api_method} for available methods.",
	"description": "The name of the API method to call. Refer to the Z-Wave Command Class API documentation {api_url} for available methods.",

	"description": "A list of parameters to pass to the API method. Refer to the Z-Wave Command Class API documentation {api_parameters} for parameters.",
	"description": "A list of parameters to pass to the API method. Refer to the Z-Wave Command Class API documentation {api_url} for parameters.",

Uh oh!

Move url out of zwave strings.json #155312

Move url out of zwave strings.json #155312

Conversation

mishmanners commented Oct 28, 2025

Proposed change

Type of change

Additional information

Checklist

Uh oh!

home-assistant bot commented Oct 28, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

joostlek left a comment

Choose a reason for hiding this comment

Uh oh!

home-assistant bot commented Oct 28, 2025

Uh oh!

mishmanners commented Oct 28, 2025

Uh oh!

TheJulianJES left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mishmanners commented Oct 31, 2025

Uh oh!

zweckj commented Oct 31, 2025

Uh oh!

jbouwh Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

jbouwh Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

jbouwh Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

jbouwh Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

jbouwh Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

jbouwh Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants