From dc9e6b9f27c1d5a191c87a44620bb5ee74b15ee7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Cie=C5=9Blak?= Date: Fri, 2 Jun 2023 17:34:08 +0200 Subject: [PATCH] Document lack of stability of lib/teleterm gRPC API --- gen/proto/js/teleport/lib/teleterm/v1/service_grpc_pb.js | 7 ++++++- proto/teleport/lib/teleterm/v1/service.proto | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/gen/proto/js/teleport/lib/teleterm/v1/service_grpc_pb.js b/gen/proto/js/teleport/lib/teleterm/v1/service_grpc_pb.js index 4a53e9962de72..57877a288204c 100644 --- a/gen/proto/js/teleport/lib/teleterm/v1/service_grpc_pb.js +++ b/gen/proto/js/teleport/lib/teleterm/v1/service_grpc_pb.js @@ -534,7 +534,12 @@ function deserialize_teleport_lib_teleterm_v1_UpdateTshdEventsServerAddressRespo } -// TerminalService describes Teleterm service +// TerminalService is used by the Electron app to communicate with the tsh daemon. +// +// While we aim to preserve backwards compatibility in order to satisfy CI checks and follow the +// proto practices used within the company, this service is not guaranteed to be stable across +// versions. The packaging process of Teleport Connect ensures that the server and the client use +// the same version of the service. var TerminalServiceService = exports.TerminalServiceService = { // UpdateTshdEventsServerAddress lets the Electron app update the address the tsh daemon is // supposed to use when connecting to the tshd events gRPC service. This RPC needs to be made diff --git a/proto/teleport/lib/teleterm/v1/service.proto b/proto/teleport/lib/teleterm/v1/service.proto index 7d0715a102826..2ff6762b33419 100644 --- a/proto/teleport/lib/teleterm/v1/service.proto +++ b/proto/teleport/lib/teleterm/v1/service.proto @@ -27,7 +27,12 @@ import "teleport/lib/teleterm/v1/usage_events.proto"; option go_package = "github.com/gravitational/teleport/gen/proto/go/teleport/lib/teleterm/v1;teletermv1"; -// TerminalService describes Teleterm service +// TerminalService is used by the Electron app to communicate with the tsh daemon. +// +// While we aim to preserve backwards compatibility in order to satisfy CI checks and follow the +// proto practices used within the company, this service is not guaranteed to be stable across +// versions. The packaging process of Teleport Connect ensures that the server and the client use +// the same version of the service. service TerminalService { // UpdateTshdEventsServerAddress lets the Electron app update the address the tsh daemon is // supposed to use when connecting to the tshd events gRPC service. This RPC needs to be made