proto: Add missing docs for FetchRemote RPC

3 files changed, 20 insertions, 13 deletions

diff --git a/proto/go/gitalypb/repository.pb.go b/proto/go/gitalypb/repository.pb.go
index a22992e3f..11b17c84e 100644
--- a/proto/go/gitalypb/repository.pb.go
+++ b/proto/go/gitalypb/repository.pb.go
@@ -935,13 +935,14 @@ func (*FetchBundleResponse) Descriptor() ([]byte, []int) {
 	return file_repository_proto_rawDescGZIP(), []int{13}
 }
 
-// FetchRemoteRequest ...
+// FetchRemoteRequest is a request for the FetchRemote RPC.
 type FetchRemoteRequest struct {
 	state         protoimpl.MessageState
 	sizeCache     protoimpl.SizeCache
 	unknownFields protoimpl.UnknownFields
 
-	// repository ...
+	// repository is the repository to fetch the remote into. The storage_name
+	// and relative_path attributes must be provided.
 	Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`
 	// force determines if references should be force-updated in case they have
 	// diverged.
@@ -950,9 +951,10 @@ type FetchRemoteRequest struct {
 	NoTags bool `protobuf:"varint,4,opt,name=no_tags,json=noTags,proto3" json:"no_tags,omitempty"`
 	// timeout specifies a timeout for the fetch.
 	Timeout int32 `protobuf:"varint,5,opt,name=timeout,proto3" json:"timeout,omitempty"`
-	// ssh_key ...
+	// ssh_key is an optional SSH key to use for fetching the remote.
 	SshKey string `protobuf:"bytes,6,opt,name=ssh_key,json=sshKey,proto3" json:"ssh_key,omitempty"`
-	// known_hosts ...
+	// known_hosts is the optional content of an SSH known-hosts file to use
+	// for the SSH session.
 	KnownHosts string `protobuf:"bytes,7,opt,name=known_hosts,json=knownHosts,proto3" json:"known_hosts,omitempty"`
 	// no_prune will the fetch to not prune remote references which do not exist
 	// in the remote repository anymore.
@@ -1060,7 +1062,7 @@ func (x *FetchRemoteRequest) GetCheckTagsChanged() bool {
 	return false
 }
 
-// FetchRemoteResponse ...
+// FetchRemoteResponse is a response for the FetchRemote RPC.
 type FetchRemoteResponse struct {
 	state         protoimpl.MessageState
 	sizeCache     protoimpl.SizeCache
diff --git a/proto/go/gitalypb/repository_grpc.pb.go b/proto/go/gitalypb/repository_grpc.pb.go
index 99346c5f3..aed25749e 100644
--- a/proto/go/gitalypb/repository_grpc.pb.go
+++ b/proto/go/gitalypb/repository_grpc.pb.go
@@ -60,7 +60,8 @@ type RepositoryServiceClient interface {
 	// This RPC will be removed in 17.0.
 	ApplyGitattributes(ctx context.Context, in *ApplyGitattributesRequest, opts ...grpc.CallOption) (*ApplyGitattributesResponse, error)
 	// FetchRemote fetches references from a remote repository into the local
-	// repository.
+	// repository. The remote can be fetched via HTTP or SSH depending on the
+	// request options provided.
 	FetchRemote(ctx context.Context, in *FetchRemoteRequest, opts ...grpc.CallOption) (*FetchRemoteResponse, error)
 	// CreateRepository creates a new empty repository.
 	CreateRepository(ctx context.Context, in *CreateRepositoryRequest, opts ...grpc.CallOption) (*CreateRepositoryResponse, error)
@@ -1034,7 +1035,8 @@ type RepositoryServiceServer interface {
 	// This RPC will be removed in 17.0.
 	ApplyGitattributes(context.Context, *ApplyGitattributesRequest) (*ApplyGitattributesResponse, error)
 	// FetchRemote fetches references from a remote repository into the local
-	// repository.
+	// repository. The remote can be fetched via HTTP or SSH depending on the
+	// request options provided.
 	FetchRemote(context.Context, *FetchRemoteRequest) (*FetchRemoteResponse, error)
 	// CreateRepository creates a new empty repository.
 	CreateRepository(context.Context, *CreateRepositoryRequest) (*CreateRepositoryResponse, error)
diff --git a/proto/repository.proto b/proto/repository.proto
index 5d4fce5ea..541c2baed 100644
--- a/proto/repository.proto
+++ b/proto/repository.proto
@@ -78,7 +78,8 @@ service RepositoryService {
   }
 
   // FetchRemote fetches references from a remote repository into the local
-  // repository.
+  // repository. The remote can be fetched via HTTP or SSH depending on the
+  // request options provided.
   rpc FetchRemote(FetchRemoteRequest) returns (FetchRemoteResponse) {
     option (op_type) = {
       op: MUTATOR
@@ -564,9 +565,10 @@ message FetchBundleRequest {
 message FetchBundleResponse {
 }
 
-// FetchRemoteRequest ...
+// FetchRemoteRequest is a request for the FetchRemote RPC.
 message FetchRemoteRequest {
-  // repository ...
+  // repository is the repository to fetch the remote into. The storage_name
+  // and relative_path attributes must be provided.
   Repository repository = 1 [(target_repository)=true];
   // force determines if references should be force-updated in case they have
   // diverged.
@@ -575,9 +577,10 @@ message FetchRemoteRequest {
   bool no_tags = 4;
   // timeout specifies a timeout for the fetch.
   int32 timeout = 5;
-  // ssh_key ...
+  // ssh_key is an optional SSH key to use for fetching the remote.
   string ssh_key = 6;
-  // known_hosts ...
+  // known_hosts is the optional content of an SSH known-hosts file to use
+  // for the SSH session.
   string known_hosts = 7;
   reserved 8;
   // no_prune will the fetch to not prune remote references which do not exist
@@ -594,7 +597,7 @@ message FetchRemoteRequest {
   reserved "remote";
 }
 
-// FetchRemoteResponse ...
+// FetchRemoteResponse is a response for the FetchRemote RPC.
 message FetchRemoteResponse {
   // tags_changed is set based to true if tags were changed or cannot be determined
   // and false when no tags were change. It is only calculated when check_tags_changed