proto: Add missing docs for CreateRepositoryFromSnapshot RPC

3 files changed, 19 insertions, 14 deletions

diff --git a/proto/go/gitalypb/repository.pb.go b/proto/go/gitalypb/repository.pb.go
index 20d814125..44a0a0555 100644
--- a/proto/go/gitalypb/repository.pb.go
+++ b/proto/go/gitalypb/repository.pb.go
@@ -3420,17 +3420,18 @@ func (x *GetSnapshotResponse) GetData() []byte {
 	return nil
 }
 
-// CreateRepositoryFromSnapshotRequest ...
+// CreateRepositoryFromSnapshotRequest is a request for the CreateRepositoryFromSnapshot RPC.
 type CreateRepositoryFromSnapshotRequest struct {
 	state         protoimpl.MessageState
 	sizeCache     protoimpl.SizeCache
 	unknownFields protoimpl.UnknownFields
 
-	// repository ...
+	// repository indicates where the new repo should be created. The storage_name and
+	// relative_path attributes must be provided.
 	Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`
-	// http_url ...
+	// http_url is the full URL of the location of the snapshot TAR.
 	HttpUrl string `protobuf:"bytes,2,opt,name=http_url,json=httpUrl,proto3" json:"http_url,omitempty"`
-	// http_auth ...
+	// http_auth is the value of the Authorization header to send to http_url.
 	HttpAuth string `protobuf:"bytes,3,opt,name=http_auth,json=httpAuth,proto3" json:"http_auth,omitempty"`
 	// resolved_address holds the resolved IP address of the remote_url. This is
 	// used to avoid DNS rebinding by mapping the url to the resolved address.
@@ -3501,7 +3502,7 @@ func (x *CreateRepositoryFromSnapshotRequest) GetResolvedAddress() string {
 	return ""
 }
 
-// CreateRepositoryFromSnapshotResponse ...
+// CreateRepositoryFromSnapshotResponse is a response for the CreateRepositoryFromSnapshot RPC.
 type CreateRepositoryFromSnapshotResponse 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 6dc602468..1884c232a 100644
--- a/proto/go/gitalypb/repository_grpc.pb.go
+++ b/proto/go/gitalypb/repository_grpc.pb.go
@@ -118,7 +118,8 @@ type RepositoryServiceClient interface {
 	// 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 creates a new repository based on a snapshot created with
+	// the GetSnapshot RPC. The snapshot is fetched via HTTP.
 	CreateRepositoryFromSnapshot(ctx context.Context, in *CreateRepositoryFromSnapshotRequest, opts ...grpc.CallOption) (*CreateRepositoryFromSnapshotResponse, error)
 	// GetRawChanges ...
 	GetRawChanges(ctx context.Context, in *GetRawChangesRequest, opts ...grpc.CallOption) (RepositoryService_GetRawChangesClient, error)
@@ -1089,7 +1090,8 @@ type RepositoryServiceServer interface {
 	// 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 creates a new repository based on a snapshot created with
+	// the GetSnapshot RPC. The snapshot is fetched via HTTP.
 	CreateRepositoryFromSnapshot(context.Context, *CreateRepositoryFromSnapshotRequest) (*CreateRepositoryFromSnapshotResponse, error)
 	// GetRawChanges ...
 	GetRawChanges(*GetRawChangesRequest, RepositoryService_GetRawChangesServer) error
diff --git a/proto/repository.proto b/proto/repository.proto
index 83bfbcc00..1576a0c67 100644
--- a/proto/repository.proto
+++ b/proto/repository.proto
@@ -231,7 +231,8 @@ service RepositoryService {
     };
   }
 
-  // CreateRepositoryFromSnapshot ...
+  // CreateRepositoryFromSnapshot creates a new repository based on a snapshot created with
+  // the GetSnapshot RPC. The snapshot is fetched via HTTP.
   rpc CreateRepositoryFromSnapshot(CreateRepositoryFromSnapshotRequest) returns (CreateRepositoryFromSnapshotResponse) {
     option (op_type) = {
       op: MUTATOR
@@ -976,13 +977,14 @@ message GetSnapshotResponse {
   bytes data = 1;
 }
 
-// CreateRepositoryFromSnapshotRequest ...
+// CreateRepositoryFromSnapshotRequest is a request for the CreateRepositoryFromSnapshot RPC.
 message CreateRepositoryFromSnapshotRequest {
-  // repository ...
+  // repository indicates where the new repo should be created. The storage_name and
+  // relative_path attributes must be provided.
   Repository repository = 1 [(target_repository)=true];
-  // http_url ...
+  // http_url is the full URL of the location of the snapshot TAR.
   string http_url = 2;
-  // http_auth ...
+  // http_auth is the value of the Authorization header to send to http_url.
   string http_auth = 3;
   // resolved_address holds the resolved IP address of the remote_url. This is
   // used to avoid DNS rebinding by mapping the url to the resolved address.
@@ -992,12 +994,12 @@ message CreateRepositoryFromSnapshotRequest {
   // Optional.
   string resolved_address = 5;
 
-  // HttpHost has been removed in favor of ResolvedAddress.
+  // http_host has been removed in favor of ResolvedAddress.
   reserved 4;
   reserved "http_host";
 }
 
-// CreateRepositoryFromSnapshotResponse ...
+// CreateRepositoryFromSnapshotResponse is a response for the CreateRepositoryFromSnapshot RPC.
 message CreateRepositoryFromSnapshotResponse {
 }