Skip to content

Commit 2c9decb

Browse files
Update release notes
This commit * refactors the existing release notes to fit into the standard structure, * fixes a few typos Signed-off-by: Tiyash Basu <[email protected]>
1 parent fcd7124 commit 2c9decb

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

RELEASE_NOTES.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
11
# Frequenz Common API Release Notes
22

33
## Summary
4-
This release:
5-
* Corrects `SensorData` and `ComponentData` doc examples
6-
to correctly reflect differences in respective values.
7-
* Adds `ComponentRatedBound` message to associate a charge & discharge range
8-
to a specific `Metric`.
9-
* Adds rated bounds field to `Component` for charge & discharge
10-
ranges for relevant metrics.
114

5+
This release adds new features, and fixes the documentation of a few messages.
126

137
## Upgrading
148

15-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
9+
- This release does not contain breaking changes in terms of protobuf definitions.
10+
However, when upgrading, applications may need to be adjusted to work with the new additions.
1611

1712
## New Features
1813

19-
Add protobufs definition necesary for Electricity Trading (and for Ancillary Services Market).
14+
- Adds ability to specify static bounds in the `Component` message.
15+
16+
- Adds protobuf definition necessary for Electricity Trading (and for Ancillary Services Market).
2017

2118
## Bug Fixes
2219

23-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
20+
- Fixes `SensorData` and `ComponentData` doc examples to correctly reflect differences in respective values.

0 commit comments

Comments
 (0)