|
1 | | -# Core API Changelog |
| 1 | +# Core-API Changelog |
| 2 | +All notable changes to this project will be documented in this file. |
2 | 3 |
|
3 | | -## 0.6.0-alpha |
| 4 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 5 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
4 | 6 |
|
5 | | -**2022-05-01** First public release. |
| 7 | +## Unreleased |
6 | 8 |
|
7 | | -### AsyncAPI |
| 9 | +## 0.6.1-alpha - 2022-06-12 |
| 10 | +### Added |
| 11 | +- Media player entity has a new state `PAUSED`, new attributes `repeat` & `shuffle` and initial `media_type` definitions. |
| 12 | +- Link published [API models in Rust](https://github.com/unfoldedcircle/api-model-rs). |
| 13 | +- Clarify sensor state, unit and label. |
8 | 14 |
|
9 | | -- Rename `friendly_name` properties to `name`. |
10 | | -- Refactor entity command message: simple object, instead array of objects. |
11 | | -- Clean up, updated message state emojis to reflect current remote-core status. |
| 15 | +### Changed |
| 16 | +- Switching to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format for this changelog. |
12 | 17 |
|
13 | | -### Documentation |
| 18 | +### Fixed |
| 19 | +- Integration API: entity discriminator property is `entity_type` |
| 20 | +- Fix entity command examples for climate and cover. |
14 | 21 |
|
15 | | -- Refactor and enhance documentation. |
16 | | -- Prepared AsyncAPI html generation with GitHub action. |
| 22 | +## 0.6.0-alpha - 2022-05-01 |
17 | 23 |
|
18 | | -## 0.5.0-alpha |
| 24 | +First public release. |
19 | 25 |
|
20 | | -**2022-03-23** |
| 26 | +### Added |
| 27 | +- Refactor and enhance documentation. |
| 28 | +- Prepare AsyncAPI html generation with GitHub action. |
21 | 29 |
|
22 | | -### AsyncAPI |
| 30 | +### Changed |
| 31 | +- Rename `friendly_name` properties to `name`. |
| 32 | +- Refactor entity command message: simple object, instead array of objects. |
| 33 | +- Clean up, updated message state emojis to reflect current remote-core status. |
23 | 34 |
|
| 35 | +## 0.5.0-alpha - 2022-03-23 |
| 36 | +### Added |
24 | 37 | - Add authentication messages: `auth_required`, `auth`, `authentication`. |
25 | | -- Refactor `driver_version`. |
26 | 38 | - Add `device_id` property in `device_state` event. |
27 | | - |
28 | | -### Documentation |
29 | | - |
30 | | -- Refactor documentation structure. |
31 | 39 | - Add WebSockets specific information. |
32 | 40 |
|
33 | | -## 0.4.0-alpha |
34 | | - |
35 | | -**2022-02-27** |
36 | | - |
37 | | -### AsyncAPI |
| 41 | +### Changed |
| 42 | +- Refactor `driver_version`. |
| 43 | +- Refactor documentation structure. |
38 | 44 |
|
| 45 | +## 0.4.0-alpha - 2022-02-27 |
| 46 | +### Added |
39 | 47 | - Add `entity_type` property to messages: `entity_command`, `entity_change`, `entity_state`, `entity_removed`. |
| 48 | + |
| 49 | +### Changed |
40 | 50 | - Rename `entity_change` property `driver_id` to `device_id`. |
41 | 51 | - Change `device_state` response message to an event message. |
42 | 52 | - Change `entity` message: |
43 | 53 | - Property `features` is now optional. |
44 | 54 | - Cover entity: split `open_close` feature into `open` and `close` features for covers which can only be opened |
45 | | - programmatically but must be closed manually. |
| 55 | + programmatically but must be closed manually. |
46 | 56 | - Change `discovered_device` message property `friendly_name` to multi-language text object. |
47 | | -- Fix request message example in description. |
48 | | - |
49 | | -### Documentation |
| 57 | +- Improve entity change message descriptions and reflect changes in AsyncAPI |
50 | 58 |
|
51 | | -- Reflect changes in AsyncAPI. |
52 | | -- Improve entity change message descriptions. |
53 | | - |
54 | | -## 0.0.1 - 0.3.0-alpha |
| 59 | +### Fixed |
| 60 | +- Fix request message example in description. |
55 | 61 |
|
56 | | -**2021 - 2022-02-18** |
| 62 | +## 0.0.1 - 0.3.0-alpha - 2022-02-18 |
57 | 63 |
|
58 | 64 | Internal releases. |
0 commit comments