Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitaly.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/proto
diff options
context:
space:
mode:
authorJames Liu <jliu@gitlab.com>2023-11-28 02:58:27 +0300
committerJames Liu <jliu@gitlab.com>2023-11-28 02:58:27 +0300
commit646e6c45dc21cf77d470879efca8fb82bf4a5095 (patch)
tree704bf96940d3b74f1ff4e6a21299a57c963721e7 /proto
parente987447d0ec3d93187f44bd4374bad4e5506a149 (diff)
proto: Add missing docs for CreateRepository RPC
Diffstat (limited to 'proto')
-rw-r--r--proto/go/gitalypb/repository.pb.go7
-rw-r--r--proto/go/gitalypb/repository_grpc.pb.go4
-rw-r--r--proto/repository.proto9
3 files changed, 11 insertions, 9 deletions
diff --git a/proto/go/gitalypb/repository.pb.go b/proto/go/gitalypb/repository.pb.go
index 5b85ae039..02a5bc593 100644
--- a/proto/go/gitalypb/repository.pb.go
+++ b/proto/go/gitalypb/repository.pb.go
@@ -1110,13 +1110,13 @@ func (x *FetchRemoteResponse) GetTagsChanged() bool {
return false
}
-// CreateRepositoryRequest ...
+// CreateRepositoryRequest is a request for the CreateRepository RPC.
type CreateRepositoryRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
- // repository ...
+ // repository represents the repo to create. The storage_name and relative_path attributes must be provided.
Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`
// default_branch is the branch name to set as the default branch of the newly created
// repository. Note, this will be treated as the branch name and not a
@@ -1181,7 +1181,8 @@ func (x *CreateRepositoryRequest) GetObjectFormat() ObjectFormat {
return ObjectFormat_OBJECT_FORMAT_UNSPECIFIED
}
-// CreateRepositoryResponse ...
+// CreateRepositoryResponse is a response for the CreateRepository RPC. An empty
+// response denotes a successful request.
type CreateRepositoryResponse 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 1ea0a3b6e..dd73c1090 100644
--- a/proto/go/gitalypb/repository_grpc.pb.go
+++ b/proto/go/gitalypb/repository_grpc.pb.go
@@ -62,7 +62,7 @@ type RepositoryServiceClient interface {
// FetchRemote fetches references from a remote repository into the local
// repository.
FetchRemote(ctx context.Context, in *FetchRemoteRequest, opts ...grpc.CallOption) (*FetchRemoteResponse, error)
- // CreateRepository ...
+ // CreateRepository creates a new empty repository.
CreateRepository(ctx context.Context, in *CreateRepositoryRequest, opts ...grpc.CallOption) (*CreateRepositoryResponse, error)
// GetArchive ...
GetArchive(ctx context.Context, in *GetArchiveRequest, opts ...grpc.CallOption) (RepositoryService_GetArchiveClient, error)
@@ -1029,7 +1029,7 @@ type RepositoryServiceServer interface {
// FetchRemote fetches references from a remote repository into the local
// repository.
FetchRemote(context.Context, *FetchRemoteRequest) (*FetchRemoteResponse, error)
- // CreateRepository ...
+ // CreateRepository creates a new empty repository.
CreateRepository(context.Context, *CreateRepositoryRequest) (*CreateRepositoryResponse, error)
// GetArchive ...
GetArchive(*GetArchiveRequest, RepositoryService_GetArchiveServer) error
diff --git a/proto/repository.proto b/proto/repository.proto
index a5381384a..9fc49809e 100644
--- a/proto/repository.proto
+++ b/proto/repository.proto
@@ -85,7 +85,7 @@ service RepositoryService {
};
}
- // CreateRepository ...
+ // CreateRepository creates a new empty repository.
rpc CreateRepository(CreateRepositoryRequest) returns (CreateRepositoryResponse) {
option (op_type) = {
op: MUTATOR
@@ -595,9 +595,9 @@ message FetchRemoteResponse {
bool tags_changed = 1;
}
-// CreateRepositoryRequest ...
+// CreateRepositoryRequest is a request for the CreateRepository RPC.
message CreateRepositoryRequest {
- // repository ...
+ // repository represents the repo to create. The storage_name and relative_path attributes must be provided.
Repository repository = 1 [(target_repository)=true];
// default_branch is the branch name to set as the default branch of the newly created
// repository. Note, this will be treated as the branch name and not a
@@ -609,7 +609,8 @@ message CreateRepositoryRequest {
ObjectFormat object_format = 3;
}
-// CreateRepositoryResponse ...
+// CreateRepositoryResponse is a response for the CreateRepository RPC. An empty
+// response denotes a successful request.
message CreateRepositoryResponse {
}