proto: Add missing docs for SetCustomHooks RPC

3 files changed, 16 insertions, 14 deletions

diff --git a/proto/go/gitalypb/repository.pb.go b/proto/go/gitalypb/repository.pb.go
index b2291ca88..91c8ab114 100644
--- a/proto/go/gitalypb/repository.pb.go
+++ b/proto/go/gitalypb/repository.pb.go
@@ -2557,15 +2557,16 @@ func (x *RestoreCustomHooksRequest) GetData() []byte {
 	return nil
 }
 
-// SetCustomHooksRequest ...
+// SetCustomHooksRequest is a request for the SetCustomHooks RPC.
 type SetCustomHooksRequest struct {
 	state         protoimpl.MessageState
 	sizeCache     protoimpl.SizeCache
 	unknownFields protoimpl.UnknownFields
 
-	// repository ...
+	// repository is the repo to set the custom hooks in. The storage_name and relative_path
+	// attributes must be provided. The repository can be omitted in subsequent requests.
 	Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`
-	// data ...
+	// data is a tarball containing a `custom_hooks` directory.
 	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
 }
 
@@ -2654,7 +2655,7 @@ func (*RestoreCustomHooksResponse) Descriptor() ([]byte, []int) {
 	return file_repository_proto_rawDescGZIP(), []int{42}
 }
 
-// SetCustomHooksResponse ...
+// SetCustomHooksResponse is a response for the SetCustomHooks RPC.
 type SetCustomHooksResponse 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 aed25749e..d5af55b94 100644
--- a/proto/go/gitalypb/repository_grpc.pb.go
+++ b/proto/go/gitalypb/repository_grpc.pb.go
@@ -136,8 +136,8 @@ type RepositoryServiceClient interface {
 	// ultimately extracted to the repository.
 	RestoreCustomHooks(ctx context.Context, opts ...grpc.CallOption) (RepositoryService_RestoreCustomHooksClient, error)
 	// SetCustomHooks sets the git hooks for a repository. The hooks are sent in a
-	// tar archive containing a `custom_hooks` directory. This directory is
-	// ultimately extracted to the repository.
+	// tar archive containing a `custom_hooks` directory (i.e. the response from the
+	// GetCustomHooksResponse RPC. This directory will be extracted into the repository.
 	SetCustomHooks(ctx context.Context, opts ...grpc.CallOption) (RepositoryService_SetCustomHooksClient, error)
 	// Deprecated: Do not use.
 	// BackupCustomHooks fetches the git hooks for a repository. The hooks are
@@ -1111,8 +1111,8 @@ type RepositoryServiceServer interface {
 	// ultimately extracted to the repository.
 	RestoreCustomHooks(RepositoryService_RestoreCustomHooksServer) error
 	// SetCustomHooks sets the git hooks for a repository. The hooks are sent in a
-	// tar archive containing a `custom_hooks` directory. This directory is
-	// ultimately extracted to the repository.
+	// tar archive containing a `custom_hooks` directory (i.e. the response from the
+	// GetCustomHooksResponse RPC. This directory will be extracted into the repository.
 	SetCustomHooks(RepositoryService_SetCustomHooksServer) error
 	// Deprecated: Do not use.
 	// BackupCustomHooks fetches the git hooks for a repository. The hooks are
diff --git a/proto/repository.proto b/proto/repository.proto
index 7ad1132e0..40f6aa3cb 100644
--- a/proto/repository.proto
+++ b/proto/repository.proto
@@ -274,8 +274,8 @@ service RepositoryService {
   }
 
   // SetCustomHooks sets the git hooks for a repository. The hooks are sent in a
-  // tar archive containing a `custom_hooks` directory. This directory is
-  // ultimately extracted to the repository.
+  // tar archive containing a `custom_hooks` directory (i.e. the response from the
+  // GetCustomHooksResponse RPC. This directory will be extracted into the repository.
   rpc SetCustomHooks(stream SetCustomHooksRequest) returns (SetCustomHooksResponse) {
     option (op_type) = {
       op: MUTATOR
@@ -865,11 +865,12 @@ message RestoreCustomHooksRequest {
   bytes data = 2;
 }
 
-// SetCustomHooksRequest ...
+// SetCustomHooksRequest is a request for the SetCustomHooks RPC.
 message SetCustomHooksRequest {
-  // repository ...
+  // repository is the repo to set the custom hooks in. The storage_name and relative_path
+  // attributes must be provided. The repository can be omitted in subsequent requests.
   Repository repository = 1 [(target_repository)=true];
-  // data ...
+  // data is a tarball containing a `custom_hooks` directory.
   bytes data = 2;
 }
 
@@ -877,7 +878,7 @@ message SetCustomHooksRequest {
 message RestoreCustomHooksResponse {
 }
 
-// SetCustomHooksResponse ...
+// SetCustomHooksResponse is a response for the SetCustomHooks RPC.
 message SetCustomHooksResponse {
 }