v0.14.0

Frequenz Dispatch API Release Notes

Summary

In this release, we have made some changes to the API to improve the user experience and to fix some bugs.
This might be the last breaking release, at least I tried hard to make it so.
Fingers crossed.

Note: The API supporting a feature does not mean that the service or client supports it as well, just yet.

Upgrading

• The dispatch message was split into into metadata and data.
• microgrid_id is required for all requests.
• id was renamed to dispatch_id in all requests.
• Naming conventions were updated to match API projects.
• The possibility to update the dry_run and type fields was removed.
• The ComponentSelector now can contain multiple component categories.
• Improve description of the EndCriteria.until field.

New Features

• Create and Update request now returns the new dispatch object.
• Documentation about authentication and encryption was added.
• Enhanced payload documentation.
• Add RPC streaming methods.
• Add YEARLY frequency to the recurrence definition.
• Add parameters for pagination and sorting.
• Documentation of valid values for count and interval fields was added.
• Extended DispatchFilter to support filtering by recurrence and end_time.
• Add new field end_time to the DispatchDetail.

Bug Fixes

• The field bymonthdays the recurrence definition also supports negative values and was updated accordingly.

What's Changed

• Bump yoheimuta/action-protolint from 1.0.0 to 1.3.0 by @dependabot in #149
• Reset release notes by @Marenz in #160
• Bump the required group with 6 updates by @dependabot in #168
• Bump the required group with 7 updates by @dependabot in #169
• Clarify component IDs of different categories are not supported by @llucax in #171
• Update bymonthdays to support negative values by @Marenz in #170
• API Update PR! by @Marenz in #172
• Add documentation for payload field by @Marenz in #173
• Add Yearly to frequency by @Marenz in #174
• Update bymonthdays in update request by @Marenz in #175
• Bump the required group with 7 updates by @dependabot in #178
• Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by @dependabot in #176
• Bump docker/build-push-action from 5 to 6 by @dependabot in #177
• Add pagination and sort parameters by @Marenz in #181
• Document valid values for count and interval by @Marenz in #179
• Add RPC streaming methods by @Marenz in #180
• Update dispatch filter for recurrence and end time [No Enum Alternative] by @Marenz in #184
• Add end_time field by @ela-kotulska-frequenz in #186
• Allow specifying multiple component categories by @Marenz in #187
• Use oneof in recurrence filter by @Marenz in #188
• Rename & Restructure ComponentSelector by @Marenz in #189
• Change description of the EndCriteria.until field. by @ela-kotulska-frequenz in #190
• Prepare release notes for release by @Marenz in #191

New Contributors

• @ela-kotulska-frequenz made their first contribution in #186

Full Changelog: v0.13.0...v0.14.0