Skip to content

Commit 0352ec5

Browse files
committed
Add documentation about authentication and encryption
fixes #14 Signed-off-by: Mathias L. Baumann <[email protected]>
1 parent 7cb40a3 commit 0352ec5

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@ import "frequenz/api/common/v1/microgrid/components/components.proto";
5353
// This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid
5454
// electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in
5555
// electrical engineering and systems.
56+
//
57+
// #### Security
58+
//
59+
// ALL requests to this service must be signed. The key and signature
60+
// should be added to the request metadata (HTTP headers). The signature
61+
// should be computed using the HMAC-SHA256 algorithm and the user's secret key.
62+
//
63+
// ALL requests to this service must be made over HTTPS.
5664
service MicrogridDispatchService {
5765
// Returns a list of all dispatches
5866
rpc ListMicrogridDispatches(ListMicrogridDispatchesRequest) returns (ListMicrogridDispatchesResponse);

0 commit comments

Comments
 (0)