proto: Add missing docs for SearchFilesByName RPC

3 files changed, 18 insertions, 13 deletions

diff --git a/proto/go/gitalypb/repository.pb.go b/proto/go/gitalypb/repository.pb.go
index 7eb4bb7d2..c989feaeb 100644
--- a/proto/go/gitalypb/repository.pb.go
+++ b/proto/go/gitalypb/repository.pb.go
@@ -3659,17 +3659,18 @@ func (x *GetRawChangesResponse) GetRawChanges() []*GetRawChangesResponse_RawChan
 	return nil
 }
 
-// SearchFilesByNameRequest ...
+// SearchFilesByNameRequest is a request for the SearchFilesByName RPC.
 type SearchFilesByNameRequest struct {
 	state         protoimpl.MessageState
 	sizeCache     protoimpl.SizeCache
 	unknownFields protoimpl.UnknownFields
 
-	// repository ...
+	// repository is the repo to execute the search in. The storage_name and
+	// relative_path attributes must be provided.
 	Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`
-	// query ...
+	// query is the search query.
 	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
-	// ref ...
+	// ref is the Git reference whose tree should be searched.
 	Ref []byte `protobuf:"bytes,3,opt,name=ref,proto3" json:"ref,omitempty"`
 	// filter is a regular expression used to filter the result set before it is
 	// transmitted. It is parsed using Go's `regexp` package, which is closely related
@@ -3758,7 +3759,7 @@ func (x *SearchFilesByNameRequest) GetOffset() uint32 {
 	return 0
 }
 
-// SearchFilesByNameResponse ...
+// SearchFilesByNameResponse is a response for the SearchFilesByName RPC.
 type SearchFilesByNameResponse 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 efcf2860c..99346c5f3 100644
--- a/proto/go/gitalypb/repository_grpc.pb.go
+++ b/proto/go/gitalypb/repository_grpc.pb.go
@@ -126,7 +126,8 @@ type RepositoryServiceClient interface {
 	// SearchFilesByContent searches files in the repository using the provided grep pattern.
 	// For each result, the matched line is returned along with the two previous and next lines.
 	SearchFilesByContent(ctx context.Context, in *SearchFilesByContentRequest, opts ...grpc.CallOption) (RepositoryService_SearchFilesByContentClient, error)
-	// SearchFilesByName ...
+	// SearchFilesByName searches files in the repository based on its name and an
+	// optional filter.
 	SearchFilesByName(ctx context.Context, in *SearchFilesByNameRequest, opts ...grpc.CallOption) (RepositoryService_SearchFilesByNameClient, error)
 	// Deprecated: Do not use.
 	// RestoreCustomHooks sets the git hooks for a repository. The hooks are sent
@@ -1099,7 +1100,8 @@ type RepositoryServiceServer interface {
 	// SearchFilesByContent searches files in the repository using the provided grep pattern.
 	// For each result, the matched line is returned along with the two previous and next lines.
 	SearchFilesByContent(*SearchFilesByContentRequest, RepositoryService_SearchFilesByContentServer) error
-	// SearchFilesByName ...
+	// SearchFilesByName searches files in the repository based on its name and an
+	// optional filter.
 	SearchFilesByName(*SearchFilesByNameRequest, RepositoryService_SearchFilesByNameServer) error
 	// Deprecated: Do not use.
 	// RestoreCustomHooks sets the git hooks for a repository. The hooks are sent
diff --git a/proto/repository.proto b/proto/repository.proto
index efca0ec09..005df5869 100644
--- a/proto/repository.proto
+++ b/proto/repository.proto
@@ -254,7 +254,8 @@ service RepositoryService {
     };
   }
 
-  // SearchFilesByName ...
+  // SearchFilesByName searches files in the repository based on its name and an
+  // optional filter.
   rpc SearchFilesByName(SearchFilesByNameRequest) returns (stream SearchFilesByNameResponse) {
     option (op_type) = {
       op: ACCESSOR
@@ -1071,13 +1072,14 @@ message GetRawChangesResponse {
   repeated RawChange raw_changes = 1;
 }
 
-// SearchFilesByNameRequest ...
+// SearchFilesByNameRequest is a request for the SearchFilesByName RPC.
 message SearchFilesByNameRequest {
-  // repository ...
+  // repository is the repo to execute the search in. The storage_name and
+  // relative_path attributes must be provided.
   Repository repository = 1 [(target_repository)=true];
-  // query ...
+  // query is the search query.
   string query = 2;
-  // ref ...
+  // ref is the Git reference whose tree should be searched.
   bytes ref = 3;
   // filter is a regular expression used to filter the result set before it is
   // transmitted. It is parsed using Go's `regexp` package, which is closely related
@@ -1092,7 +1094,7 @@ message SearchFilesByNameRequest {
   uint32 offset = 6;
 }
 
-// SearchFilesByNameResponse ...
+// SearchFilesByNameResponse is a response for the SearchFilesByName RPC.
 message SearchFilesByNameResponse {
   // files contains the paths of files that have been found to match the query.
   repeated bytes files = 1;