From 60bad056c3289d487f95b2f3378a671fd8c800a2 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 Date: Thu, 7 Dec 2023 09:22:00 +0100 Subject: [PATCH] Deprecate service list_events in favor of get_events - The service `calendar.list_events` is deprecated in favor or `calendar.get_events` - in 2023.12. Scheduled to be removed in 2024.6 - This PR adds a note that this service is deprecated - The docs for `get_events` are a topic for a separate PR - Unlike list_events, get_events supports multiple responses - related parent PR in core: https://github.com/home-assistant/core/pull/102481 --- source/_docs/scripts/service-calls.markdown | 5 ++--- source/_integrations/calendar.markdown | 4 ++++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown index d153233b4ca3..0a5b949700e2 100644 --- a/source/_docs/scripts/service-calls.markdown +++ b/source/_docs/scripts/service-calls.markdown @@ -133,13 +133,12 @@ Examples of service response data are upcoming calendar events for the next week Templates can also be used for handling response data. The service call can specify a `response_variable`. This is the [variable](/docs/scripts/#variables) -that contains the response data. You can define any name for your `response_variable`. This example calls a service and stores the response in -the variable called `agenda`. +that contains the response data. You can define any name for your `response_variable`. This example calls a service and stores the response in the variable called `agenda`. {% raw %} ```yaml -service: calendar.list_events +service: calendar.get_events target: entity_id: calendar.school data: diff --git a/source/_integrations/calendar.markdown b/source/_integrations/calendar.markdown index de20cd1328d2..ac39d36a98e0 100644 --- a/source/_integrations/calendar.markdown +++ b/source/_integrations/calendar.markdown @@ -194,6 +194,8 @@ data: ### Service `calendar.list_events` +This service has been **deprecated** in Home Assistant version 2023.12. It will be removed in June 2024. Please use `calendar.get_events` instead. + This service populates [Response Data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with calendar events within a date range. @@ -249,3 +251,5 @@ data:

``` {% endraw %} + +