Skip to content

Commit e9ade7e

Browse files
cmaglieper1234
andauthored
[skip-changelog] Added deprecation warning for gRPC MonitorService (#1648)
* Added deprecation warning for gRPC MonitorService * Apply suggestions from code review Co-authored-by: per1234 <[email protected]> * Added deprecation option Co-authored-by: per1234 <[email protected]>
1 parent 18cb00c commit e9ade7e

File tree

3 files changed

+84
-41
lines changed

3 files changed

+84
-41
lines changed

rpc/cc/arduino/cli/monitor/v1/monitor.pb.go

+56-40
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rpc/cc/arduino/cli/monitor/v1/monitor.proto

+22-1
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,18 @@ syntax = "proto3";
1717

1818
package cc.arduino.cli.monitor.v1;
1919

20+
option deprecated = true;
2021
option go_package = "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/monitor/v1;monitor";
2122

2223
import "google/protobuf/struct.proto";
2324

24-
// MonitorService provides services for boards monitor
25+
// MonitorService provides services for boards monitor.
26+
// DEPRECATION WARNING: MonitorService is deprecated and will be removed in a
27+
// future release. Use ArduinoCoreService.Monitor and
28+
// ArduinoCoreService.EnumerateMonitorPortSettings instead.
2529
service MonitorService {
30+
option deprecated = true;
31+
2632
// Open a bidirectional monitor stream. This can be used to implement
2733
// something similar to the Arduino IDE's Serial Monitor.
2834
rpc StreamingOpen(stream StreamingOpenRequest)
@@ -34,7 +40,12 @@ service MonitorService {
3440
// must contain a `monitor_config` message to initialize the monitor target.
3541
// All subsequent messages must contain bytes to be sent to the target
3642
// and must not contain a `monitor_config` message.
43+
// DEPRECATION WARNING: StreamingOpenRequest is deprecated and will be removed
44+
// in a future release. Use ArduinoCoreService.Monitor and
45+
// ArduinoCoreService.EnumerateMonitorPortSettings instead.
3746
message StreamingOpenRequest {
47+
option deprecated = true;
48+
3849
// Content must be either a monitor config or data to be sent.
3950
oneof content {
4051
// Provides information to the monitor that specifies which is the target.
@@ -53,7 +64,12 @@ message StreamingOpenRequest {
5364

5465
// Tells the monitor which target to open and provides additional parameters
5566
// that might be needed to configure the target or the monitor itself.
67+
// DEPRECATION WARNING: MonitorConfig is deprecated and will be removed
68+
// in a future release. Use ArduinoCoreService.Monitor and
69+
// ArduinoCoreService.EnumerateMonitorPortSettings instead.
5670
message MonitorConfig {
71+
option deprecated = true;
72+
5773
enum TargetType {
5874
TARGET_TYPE_SERIAL = 0;
5975
TARGET_TYPE_NULL = 99;
@@ -73,7 +89,12 @@ message MonitorConfig {
7389
int32 recv_rate_limit_buffer = 4;
7490
}
7591

92+
// DEPRECATION WARNING: StreamingOpenResponse is deprecated and will be removed
93+
// in a future release. Use ArduinoCoreService.Monitor and
94+
// ArduinoCoreService.EnumerateMonitorPortSettings instead.
7695
message StreamingOpenResponse {
96+
option deprecated = true;
97+
7798
// The data received from the target.
7899
bytes data = 1;
79100

rpc/cc/arduino/cli/monitor/v1/monitor_grpc.pb.go

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)