Skip to content

Deprecate StreamMicrogridDispatches RPC #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Marenz wants to merge 1 commit into
base: v1.x.x
Choose a base branch
from
Open

Deprecate StreamMicrogridDispatches RPC #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,18 @@

## Summary

This is the v1.0.0 release. It is equivalent to v1.0.0-rc3 and introduces a period of API stabilization.
<!-- Here goes a general summary of what this release is about -->

## Upgrading

- The `StreamMicrogridDispatches` RPC and its request/response messages are now
deprecated. They are kept for compatibility, but this controller-facing part
of the API will move out as part of a future Dispatch API split.

## New Features

<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
20 changes: 19 additions & 1 deletion proto/frequenz/api/dispatch/v1/dispatch.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,13 @@ service MicrogridDispatchService {
rpc ListMicrogridDispatches(ListMicrogridDispatchesRequest) returns (ListMicrogridDispatchesResponse);

// Streaming RPC for receiving dispatch updates for a given microgrid
rpc StreamMicrogridDispatches(StreamMicrogridDispatchesRequest) returns (stream StreamMicrogridDispatchesResponse);
//
// Deprecated: This controller-facing operation will be moved out as part of a
// future Dispatch API split. It is kept here for now to avoid breaking
// existing clients.
rpc StreamMicrogridDispatches(StreamMicrogridDispatchesRequest) returns (stream StreamMicrogridDispatchesResponse) {
option deprecated = true;
}

// Create a new dispatch
rpc CreateMicrogridDispatch(CreateMicrogridDispatchRequest) returns (CreateMicrogridDispatchResponse);
Expand All @@ -87,14 +93,26 @@ service MicrogridDispatchService {
// Subscribe to a stream of microgrid dispatch requests.
// This method provides real-time updates on newly or updated dispatch requests for edge-based
// realtime decision making.
//
// Deprecated: This controller-facing message will be moved out as part of a
// future Dispatch API split. It is kept here for now to avoid breaking existing
// clients.
message StreamMicrogridDispatchesRequest {
option deprecated = true;

// ID of the microgrid to subscribe to
uint64 microgrid_id = 1;
}

// Response to a subscription request for a stream of microgrid dispatches.
// Real-time information on dispatches affecting a certain microgrid are pushed through this response.
//
// Deprecated: This controller-facing message will be moved out as part of a
// future Dispatch API split. It is kept here for now to avoid breaking existing
// clients.
message StreamMicrogridDispatchesResponse {
option deprecated = true;

// Dispatch record returned.
Dispatch dispatch = 1;

Expand Down
Loading