proto: Add missing docs for the GetSnapshot RPC

3 files changed, 16 insertions, 11 deletions

diff --git a/proto/go/gitalypb/repository.pb.go b/proto/go/gitalypb/repository.pb.go
index 536b241f2..20d814125 100644
--- a/proto/go/gitalypb/repository.pb.go
+++ b/proto/go/gitalypb/repository.pb.go
@@ -3321,13 +3321,14 @@ func (x *CalculateChecksumResponse) GetChecksum() string {
 	return ""
 }
 
-// GetSnapshotRequest ...
+// GetSnapshotRequest is a request for the GetSnapshot RPC.
 type GetSnapshotRequest struct {
 	state         protoimpl.MessageState
 	sizeCache     protoimpl.SizeCache
 	unknownFields protoimpl.UnknownFields
 
-	// repository ...
+	// repository is the repository to snapshot. The storage_name and relative_path
+	// attributes must be provided.
 	Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`
 }
 
@@ -3370,13 +3371,13 @@ func (x *GetSnapshotRequest) GetRepository() *Repository {
 	return nil
 }
 
-// GetSnapshotResponse ...
+// GetSnapshotResponse is a response for the GetSnapshot RPC.
 type GetSnapshotResponse struct {
 	state         protoimpl.MessageState
 	sizeCache     protoimpl.SizeCache
 	unknownFields protoimpl.UnknownFields
 
-	// data ...
+	// data is the snapshot of the repo compressed as a TAR archive.
 	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
 }
 
diff --git a/proto/go/gitalypb/repository_grpc.pb.go b/proto/go/gitalypb/repository_grpc.pb.go
index c31e2dacd..6dc602468 100644
--- a/proto/go/gitalypb/repository_grpc.pb.go
+++ b/proto/go/gitalypb/repository_grpc.pb.go
@@ -115,7 +115,8 @@ type RepositoryServiceClient interface {
 	// CalculateChecksum returns a checksum of the repository by hashing its references. Refs
 	// outside of well-known namespaces are not considered when computing the checksum.
 	CalculateChecksum(ctx context.Context, in *CalculateChecksumRequest, opts ...grpc.CallOption) (*CalculateChecksumResponse, error)
-	// GetSnapshot ...
+	// GetSnapshot returns a snapshot of the repository. A snapshot comprises all Git references
+	// and objects required to recreate the state of a repository at a point in time.
 	GetSnapshot(ctx context.Context, in *GetSnapshotRequest, opts ...grpc.CallOption) (RepositoryService_GetSnapshotClient, error)
 	// CreateRepositoryFromSnapshot ...
 	CreateRepositoryFromSnapshot(ctx context.Context, in *CreateRepositoryFromSnapshotRequest, opts ...grpc.CallOption) (*CreateRepositoryFromSnapshotResponse, error)
@@ -1085,7 +1086,8 @@ type RepositoryServiceServer interface {
 	// CalculateChecksum returns a checksum of the repository by hashing its references. Refs
 	// outside of well-known namespaces are not considered when computing the checksum.
 	CalculateChecksum(context.Context, *CalculateChecksumRequest) (*CalculateChecksumResponse, error)
-	// GetSnapshot ...
+	// GetSnapshot returns a snapshot of the repository. A snapshot comprises all Git references
+	// and objects required to recreate the state of a repository at a point in time.
 	GetSnapshot(*GetSnapshotRequest, RepositoryService_GetSnapshotServer) error
 	// CreateRepositoryFromSnapshot ...
 	CreateRepositoryFromSnapshot(context.Context, *CreateRepositoryFromSnapshotRequest) (*CreateRepositoryFromSnapshotResponse, error)
diff --git a/proto/repository.proto b/proto/repository.proto
index f7a78f75e..83bfbcc00 100644
--- a/proto/repository.proto
+++ b/proto/repository.proto
@@ -223,7 +223,8 @@ service RepositoryService {
     };
   }
 
-  // GetSnapshot ...
+  // GetSnapshot returns a snapshot of the repository. A snapshot comprises all Git references
+  // and objects required to recreate the state of a repository at a point in time.
   rpc GetSnapshot(GetSnapshotRequest) returns (stream GetSnapshotResponse) {
     option (op_type) = {
       op: ACCESSOR
@@ -962,15 +963,16 @@ message CalculateChecksumResponse {
   string checksum = 1;
 }
 
-// GetSnapshotRequest ...
+// GetSnapshotRequest is a request for the GetSnapshot RPC.
 message GetSnapshotRequest {
-  // repository ...
+  // repository is the repository to snapshot. The storage_name and relative_path
+  // attributes must be provided.
   Repository repository = 1 [(target_repository)=true];
 }
 
-// GetSnapshotResponse ...
+// GetSnapshotResponse is a response for the GetSnapshot RPC.
 message GetSnapshotResponse {
-  // data ...
+  // data is the snapshot of the repo compressed as a TAR archive.
   bytes data = 1;
 }