v1.0.0-rc1

Frequenz Dispatch API Release Notes

New Features

• Added start_immediately to the create RPC.

What's Changed

• Extend documentation of duration by @Marenz in #200
• Bump the required group across 1 directory with 13 updates by @dependabot in #201
• Bump the required group with 2 updates by @dependabot in #203
• Rename selector to target by @Marenz in #204
• Changed time interval to be inclusive on both sides by @Marenz in #207
• Reset release notes by @Marenz in #209
• Improve documentation by @Marenz in #208
• Add start_immediately to create RPC by @Marenz in #206
• Bump the required group with 7 updates by @dependabot in #211

Full Changelog: v0.15.1...v1.0.0-rc1

v0.15.1

Frequenz Dispatch API Release Notes

Summary

This update focuses on pagination.

Upgrading

• Updated to the latest common-api which provides slighlty modified pagination messages.

New Features

• Added more detailed documentation on how to use pagination.

Bug Fixes

• Fixed pagination fields in the response (pagination_params -> pagination_info)

What's Changed

• Fix pagination response and add docu by @Marenz in #196
• Bump the required group with 8 updates by @dependabot in #197
• Update release notes for v0.16 by @Marenz in #198

Full Changelog: v0.15.0...v0.15.1

v0.15.0

Frequenz Dispatch API Release Notes

Summary

This is just a minor update that changes the Dispatch message structure a bit.

Upgrading

• DispatchDetail is now Dispatch
• Dispatch became DispatchData
• Member part of Dispatch is now the new message DispatchMedatata

What's Changed

• Reset release notes by @Marenz in #192
• Split & Rename the Dispatch object by @Marenz in #194
• Update release notes for release by @Marenz in #195

Full Changelog: v0.14.0...v0.15.0

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

v0.13.0

Frequenz Dispatch API Release Notes

Upgrading

• Queries that compare against a time interval filter should check for the end time inside the recurrence rule.
• end_time has been renamed until and is mutually exclusive with count.
• Update request handlers should check the field mask for which attributes to update.
• The common api dependency has been udpated so that the v1 paths for ComponentCategory is used.

What's Changed

• Bump mkdocs-section-index from 0.3.5 to 0.3.8 by @dependabot in #83
• Bump mkdocs-material from 9.3.2 to 9.4.3 by @dependabot in #93
• Bump repo-config to v0.6.2 by @TalweSingh in #95
• Bump mike from 1.1.2 to 2.0.0 by @dependabot in #109
• Add support for mike 2.0.0 by @tiyash-basu-frequenz in #113
• Update CODEOWNERS by @llucax in #118
• Bump actions/setup-python from 4 to 5 by @dependabot in #120
• Bump actions/download-artifact from 3 to 4 by @dependabot in #123
• Bump actions/upload-artifact from 3 to 4 by @dependabot in #124
• Improve and fix documentation by @llucax in #68
• Update frequenz-api-common to 0.5 by @Marenz in #132
• Bump grpc-stubs from 1.53.0.2 to 1.53.0.5 by @dependabot in #135
• Bump actions/labeler from 4.3.0 to 5.0.0 by @dependabot in #121
• Update repo-config 0.8.0 by @Marenz in #137
• Bump actions/cache from 3 to 4 by @dependabot in #140
• Bump actions/setup-python from 4 to 5 by @dependabot in #142
• Bump actions/{download,upload}-artifact from 3 to 4 by @dependabot in #141
• Bump the optional group with 9 updates by @dependabot in #143
• Update code and api-common submodule to use v1 paths by @Marenz in #138
• Bump black from 23.9.1 to 24.2.0 by @dependabot in #147
• Bump flake8 from 6.1.0 to 7.0.0 by @dependabot in #146
• Bump the optional group with 6 updates by @dependabot in #145
• Add link to high-level overview by @Marenz in #150
• Bump pytest from 7.4.2 to 8.0.2 by @dependabot in #148
• Bump nox from 2023.4.22 to 2024.3.2 by @dependabot in #154
• Bump the optional group with 7 updates by @dependabot in #153
• Bump the optional group with 2 updates by @dependabot in #156
• Fix wrong reference to field in filter comment by @Marenz in #152
• Prepare release notes for release by @Marenz in #159

New Contributors

• @TalweSingh made their first contribution in #95
• @tiyash-basu-frequenz made their first contribution in #113
• @Marenz made their first contribution in #132

Full Changelog: v0.12.0...v0.13.0

v0.12.0

Frequenz Dispatch API Release Notes

Summary

• End time has been moved to the recurrence rule object, replaced by duration on the base dispatch object.
• Update requests now use a FieldMask to indicate which fields should be updated.

Upgrading

• Queries that compare against a time interval filter should check for the end time inside the recurrence rule.
• end_time has been renamed until and is mutually exclusive with count.
• Update request handlers should check the field mask for which attributes to update.

New Features

• Introduced a new field duration.
• Introduced FieldMask to the update request.

Bug Fixes

What's Changed

• Bring back the frequenz.api namespace by @llucax in #40
• Bump mkdocs-material from 9.2.3 to 9.3.1 by @dependabot in #69
• Bump mkdocs-material from 9.3.1 to 9.3.2 by @dependabot in #76
• Move end_time to RecurrenceRule and add duration field by @stefan-brus-frequenz in #78
• Bump pylint from 2.17.5 to 2.17.6 by @dependabot in #85
• Introduce FieldMask to update requests by @stefan-brus-frequenz in #87

Full Changelog: v0.11.0...v0.12.0

v0.11.0

Frequenz Dispatch API Release Notes

Summary

This release is mainly about updating the names of some objects, and improving documentation.

Upgrading

• Service and its methods have been renamed to MicrogridDispatchService
• DispatchComponentSelector has been renamed to ComponentSelector
• DispatchComponentIDs has been renamed to ComponentIDs

New Features

• DispatchFilter now supports filtering by is_active and is_dry_run

Bug Fixes

What's Changed

• Bump pytest from 7.4.0 to 7.4.2 by @dependabot in #63
• Bump mkdocs-literate-nav from 0.6.0 to 0.6.1 by @dependabot in #65
• Bump black from 23.7.0 to 23.9.1 by @dependabot in #66
• Name changes & documentation updates by @stefan-brus-frequenz in #64

Full Changelog: v0.10.0...v0.11.0

v0.10.0

Frequenz Dispatch API Release Notes

Summary

This release is mainly about creating a ruleset for recurring dispatches.

Upgrading

• As part of introducing versioning, the protobuf definitions and generated python code now has the path frequenz.dispatch.v1.

New Features

• Package-based versioning has been introduced.

• Rules for recurring dispatches have been added.
  Examples:
  Every 6 months:

  message RecurrenceRule {
    Frequency freq = FREQUENCY_MONTHLY;
    uint32 interval = 6;
  }
  

  Weekends only:

  message RecurrenceRule {
    Frequency freq = FREQUENCY_WEEKLY;
    repeated Weekday byweekdays = [WEEKDAY_SATURDAY, WEEKDAY_SUNDAY];
  }
  

  Every day at midnight:

  message RecurrenceRule {
    Frequency freq = FREQUENCY_DAILY;
    repeated uint32 byhours = [0];
  }
  

  Nightly, assuming "night" means from 8 PM to 6 AM:

  message RecurrenceRule {
    Frequency freq = FREQUENCY_DAILY;
    repeated uint32 byhours = [20, 21, 22, 23, 0, 1, 2, 3, 4, 5];
  }
  

Bug Fixes

What's Changed

• Add update_time field to Dispatch message by @stefan-brus-frequenz in #23
• Re-design dispatch filter message by @stefan-brus-frequenz in #28
• Remove ability to update existing microgrid ID by @stefan-brus-frequenz in #29
• Add rules for recurring dispatches by @stefan-brus-frequenz in #57

Full Changelog: v0.9.0...v0.10.0

v0.9.0

Release notes

• The FcrPrequalificationSettings message has been removed, and settings
  fields have been modified/reverted to use protobuf Structs, in order to
  represent arbitrary JSON objects.

What's Changed

• Add FCR prequalification cancellation event type by @christianparpart in #17
• Rename fcr_prequal_settings to fcr_prequalification by @christianparpart in #16
• Change settings to payload and use google protobuf Struct by @stefan-brus-frequenz in #19

Full Changelog: v0.8.2...v0.9.0

v0.8.2

Release notes

• Added python module & test case for submodule fcr.

What's Changed

• Fix Python module being broken by @christianparpart in #10

New Contributors

• @christianparpart made their first contribution in #10

Full Changelog: v0.8.1...v0.8.2