Skip to content

Commit 5a8cd5b

Browse files
authored
Merge pull request #21 from unfoldedcircle/v0.6.1-release
docs: switch to Keep a Changelog format
2 parents d3dcfbb + 9e2e210 commit 5a8cd5b

File tree

1 file changed

+38
-32
lines changed

1 file changed

+38
-32
lines changed

CHANGELOG.md

Lines changed: 38 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,64 @@
1-
# Core API Changelog
1+
# Core-API Changelog
2+
All notable changes to this project will be documented in this file.
23

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).
46

5-
**2022-05-01** First public release.
7+
## Unreleased
68

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.
814

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.
1217

13-
### Documentation
18+
### Fixed
19+
- Integration API: entity discriminator property is `entity_type`
20+
- Fix entity command examples for climate and cover.
1421

15-
- Refactor and enhance documentation.
16-
- Prepared AsyncAPI html generation with GitHub action.
22+
## 0.6.0-alpha - 2022-05-01
1723

18-
## 0.5.0-alpha
24+
First public release.
1925

20-
**2022-03-23**
26+
### Added
27+
- Refactor and enhance documentation.
28+
- Prepare AsyncAPI html generation with GitHub action.
2129

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.
2334

35+
## 0.5.0-alpha - 2022-03-23
36+
### Added
2437
- Add authentication messages: `auth_required`, `auth`, `authentication`.
25-
- Refactor `driver_version`.
2638
- Add `device_id` property in `device_state` event.
27-
28-
### Documentation
29-
30-
- Refactor documentation structure.
3139
- Add WebSockets specific information.
3240

33-
## 0.4.0-alpha
34-
35-
**2022-02-27**
36-
37-
### AsyncAPI
41+
### Changed
42+
- Refactor `driver_version`.
43+
- Refactor documentation structure.
3844

45+
## 0.4.0-alpha - 2022-02-27
46+
### Added
3947
- Add `entity_type` property to messages: `entity_command`, `entity_change`, `entity_state`, `entity_removed`.
48+
49+
### Changed
4050
- Rename `entity_change` property `driver_id` to `device_id`.
4151
- Change `device_state` response message to an event message.
4252
- Change `entity` message:
4353
- Property `features` is now optional.
4454
- 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.
4656
- 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
5058

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.
5561

56-
**2021 - 2022-02-18**
62+
## 0.0.1 - 0.3.0-alpha - 2022-02-18
5763

5864
Internal releases.

0 commit comments

Comments
 (0)