v1.0.0-rc3

Frequenz Dispatch API Release Notes

Summary

• Use frequenz.api.common.v1alpha8.streaming.Event message instead of the local Event message.
• Updated all frequenz.api.common imports from v1 to v1alpha8.
• Removed the TimeIntervalFilter message, replacing its usage with the new frequenz.api.common.v1alpha8.types.Interval type.
• In the DispatchFilter message, the start_time_interval, end_time_interval, and update_time_interval fields were updated to use the new Interval type.
• In the TargetComponents message:
  • The CategorySet message's categories field was updated to use the new ElectricalComponentCategory enum.
  • The CategoryAndType message's category field was also updated to use the new ElectricalComponentCategory enum, and the nested battery, inverter, and ev_charger fields were updated to use their corresponding new types.
• The ListMicrogridDispatchesRequest message's pagination_params field was updated to use the new PaginationParams type.
• The ListMicrogridDispatchesResponse message's pagination_info field was updated to use the new PaginationInfo type.

Upgrading

• The CategorySet message and component_categories field in TargetComponents are now properly marked as deprecated in the protobuf schema using the deprecated option. Code generators will now emit deprecation warnings when these deprecated elements are used. Use CategoryTypeSet and component_categories_types instead.

New Features

• In the DispatchFilter message, new fields dispatch_ids, and queries were added to allow filtering dispatches by ID and a free-text search query across the id and type fields.

Bug Fixes

What's Changed

• Bump the patch group with 6 updates by @dependabot[bot] in #249
• Bump mypy from 1.15.0 to 1.16.0 in the minor group by @dependabot[bot] in #250
• Bump setuptools from 78.1.0 to 80.9.0 by @dependabot[bot] in #251
• dependabot: Group grpc/protobuf updates together by @llucax in #257
• Bump the patch group with 6 updates by @dependabot[bot] in #254
• Bump the minor group across 1 directory with 2 updates by @dependabot[bot] in #258
• Bump the compatible group with 2 updates by @dependabot[bot] in #267
• Bump mkdocs-material from 9.6.15 to 9.6.16 in the patch group by @dependabot[bot] in #261
• Bump mkdocstrings[python] from 0.29.1 to 0.30.0 in the mkdocstrings group by @dependabot[bot] in #263
• Update to common-proto api v0.8.0 by @Marenz in #259
• Use types from common repo alpha8 by @Marenz in #260
• Add id and q filter options by @Marenz in #268
• Bump types-markdown from 3.8.0.20250415 to 3.8.0.20250708 by @dependabot[bot] in #265
• Bump mypy from 1.16.1 to 1.17.1 in the minor group by @dependabot[bot] in #262
• docs: Clarify indefinite and recurring dispatches by @Marenz in #273
• Mark deprecated fields with deprecated option in protobuf by @Copilot in #269
• Use Event message from common api by @Marenz in #270
• Update dispatch.proto to clarify payload usage by @Marenz in #274

New Contributors

• @Copilot made their first contribution in #269

Full Changelog: v1.0.0-rc2...v1.0.0-rc3