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-07-13 20:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update calendar event rest AP with description and location (#1332)

Browse Source 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Matej Drobnič 2022-05-15 20:33:38 +02:00 committed by GitHub
parent 967b7b04af
commit 8e7cd6d474
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/api/rest.md
View File

@ -486,10 +486,9 @@ curl -X GET -H "Authorization: Bearer ABCDEFGH" \
<ApiEndpoint path="/api/calendars/<calendar entity_id>" method="get">
Returns the list of calendar events for the specified calendar entity_id between the `start` and `end` times (exclusive).
Returns the list of [calendar events](/docs/core/entity/calendar/#calendarevent) for the specified calendar entity_id between the `start` and `end` times (exclusive).
The events in the response have a `start` and `end` that contain either `dateTime` or `date` for an all day event.
```json
[
{
@ -508,7 +507,9 @@ The events in the response have a `start` and `end` that contain either `dateTim
},
"end": {
"dateTime": "2022-05-06T23:00:00-07:00"
}
},
"description": "Don't forget to bring balloons",
"location": "Brian's House"
}
]
```