jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-04-19 10:57:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify blog post about entity service action schema changes (#2316)

Browse Source 
* Clarify blog post about entity service action schema changes

* Update blog/2024-08-27-entity-service-schema-validation.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Erik Montnemery 2024-09-12 12:21:35 +02:00 committed by GitHub
parent a9b5cfb9f1
commit f5f51fa125
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
blog/2024-08-27-entity-service-schema-validation.md
View File

@ -4,14 +4,18 @@ authorURL: https://github.com/emontnemery
title: "Validation of entity action schemas"
---
A warning will now be logged when registering an entity action with a custom schema which does not meet at least one of these criteria:
Registering entity service actions allows integration authors to pass in:
- No schema (`None`)
- A dictionary, which will be converted to a voluptuous schema by passing it to `cv.make_entity_service_schema`
- A custom voluptuous schema
For the third case, a warning will now be logged when registering an entity action with a custom schema which does not meet at least one of these criteria:
- A validator returned by `cv.make_entity_service_schema`
- A validator returned by `cv.make_entity_service_schema`, wrapped in a `vol.Schema`
- A validator returned by `cv.make_entity_service_schema`, wrapped in a `vol.All`
In Home Assistant Core 2025.10, it will no longer be possible to register an entity action with a custom schema not meeting this requirement.
It's still possible to register an entity action with no schema, or with a dict representing the additional action call parameters.
The reason for the change is that if `cv.make_entity_service_schema` is not used, the service will not automatically support all possible ways of targeting entities.
More details can be found in the [developer documentation](/docs/dev_101_services/#entity-service-actions) and in core PRs [#124102](https://github.com/home-assistant/core/pull/124102) and [#125057](https://github.com/home-assistant/core/pull/125057).