Skip to content

Commit 8d408c6

Browse files
CopilotMarenz
andcommitted
Add deprecated option to CategorySet message and component_categories field
Co-authored-by: Marenz <[email protected]>
1 parent fb84b0b commit 8d408c6

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

RELEASE_NOTES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
## Upgrading
1616

17+
- 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.
18+
1719
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1820

1921
## New Features

proto/frequenz/api/dispatch/v1/dispatch.proto

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,7 @@ message TargetComponents {
344344

345345
// Deprecated: Use `CategoryTypeSet` instead
346346
message CategorySet {
347+
option deprecated = true;
347348
// Set of component categories
348349
repeated frequenz.api.common.v1alpha8.microgrid.electrical_components
349350
.ElectricalComponentCategory categories = 1;
@@ -390,7 +391,7 @@ message TargetComponents {
390391
// Deprecated: Component categories
391392
// Use `CategoryTypeSet` instead
392393
// In future versions, this field will be removed.
393-
CategorySet component_categories = 2;
394+
CategorySet component_categories = 2 [deprecated = true];
394395

395396
// Component categories with optional types
396397
CategoryTypeSet component_categories_types = 3;

0 commit comments

Comments
 (0)