diff options
author | James Liu <jliu@gitlab.com> | 2023-11-28 03:25:59 +0300 |
---|---|---|
committer | James Liu <jliu@gitlab.com> | 2023-11-29 09:33:35 +0300 |
commit | 9880e2a4d0c67bb18524e8d50146668b2a75b2ed (patch) | |
tree | da5cb53e60f76ce3b782685b213d3028f78624e7 /proto | |
parent | 0af8be2bf9178d1979c7eb50537d99530c3a60ac (diff) |
proto: Add missing docs for HasLocalBranches RPC
Diffstat (limited to 'proto')
-rw-r--r-- | proto/go/gitalypb/repository.pb.go | 8 | ||||
-rw-r--r-- | proto/go/gitalypb/repository_grpc.pb.go | 4 | ||||
-rw-r--r-- | proto/repository.proto | 10 |
3 files changed, 11 insertions, 11 deletions
diff --git a/proto/go/gitalypb/repository.pb.go b/proto/go/gitalypb/repository.pb.go index 11a207884..4453d5a0a 100644 --- a/proto/go/gitalypb/repository.pb.go +++ b/proto/go/gitalypb/repository.pb.go @@ -1388,13 +1388,13 @@ func (x *GetArchiveResponse) GetData() []byte { return nil } -// HasLocalBranchesRequest ... +// HasLocalBranchesRequest is a request for the HasLocalBranches RPC. type HasLocalBranchesRequest struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - // repository ... + // repository is the repo to check. The storage_name and relative_path attributes must be provided. Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"` } @@ -1437,13 +1437,13 @@ func (x *HasLocalBranchesRequest) GetRepository() *Repository { return nil } -// HasLocalBranchesResponse ... +// HasLocalBranchesResponse is a response for the HasLocalBranches RPC. type HasLocalBranchesResponse struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - // value ... + // value indicates whether branches exist in the repo. Value bool `protobuf:"varint,1,opt,name=value,proto3" json:"value,omitempty"` } diff --git a/proto/go/gitalypb/repository_grpc.pb.go b/proto/go/gitalypb/repository_grpc.pb.go index 77efc17c7..b61272442 100644 --- a/proto/go/gitalypb/repository_grpc.pb.go +++ b/proto/go/gitalypb/repository_grpc.pb.go @@ -66,7 +66,7 @@ type RepositoryServiceClient interface { CreateRepository(ctx context.Context, in *CreateRepositoryRequest, opts ...grpc.CallOption) (*CreateRepositoryResponse, error) // GetArchive produces and returns an archive of a repository. GetArchive(ctx context.Context, in *GetArchiveRequest, opts ...grpc.CallOption) (RepositoryService_GetArchiveClient, error) - // HasLocalBranches ... + // HasLocalBranches returns whether the given repo contains any branches. HasLocalBranches(ctx context.Context, in *HasLocalBranchesRequest, opts ...grpc.CallOption) (*HasLocalBranchesResponse, error) // FetchSourceBranch fetches a branch from a second (potentially remote) // repository into the given repository. @@ -1033,7 +1033,7 @@ type RepositoryServiceServer interface { CreateRepository(context.Context, *CreateRepositoryRequest) (*CreateRepositoryResponse, error) // GetArchive produces and returns an archive of a repository. GetArchive(*GetArchiveRequest, RepositoryService_GetArchiveServer) error - // HasLocalBranches ... + // HasLocalBranches returns whether the given repo contains any branches. HasLocalBranches(context.Context, *HasLocalBranchesRequest) (*HasLocalBranchesResponse, error) // FetchSourceBranch fetches a branch from a second (potentially remote) // repository into the given repository. diff --git a/proto/repository.proto b/proto/repository.proto index b78a563b0..f02890e67 100644 --- a/proto/repository.proto +++ b/proto/repository.proto @@ -99,7 +99,7 @@ service RepositoryService { }; } - // HasLocalBranches ... + // HasLocalBranches returns whether the given repo contains any branches. rpc HasLocalBranches(HasLocalBranchesRequest) returns (HasLocalBranchesResponse) { option (op_type) = { op: ACCESSOR @@ -658,15 +658,15 @@ message GetArchiveResponse { bytes data = 1; } -// HasLocalBranchesRequest ... +// HasLocalBranchesRequest is a request for the HasLocalBranches RPC. message HasLocalBranchesRequest { - // repository ... + // repository is the repo to check. The storage_name and relative_path attributes must be provided. Repository repository = 1 [(target_repository)=true]; } -// HasLocalBranchesResponse ... +// HasLocalBranchesResponse is a response for the HasLocalBranches RPC. message HasLocalBranchesResponse { - // value ... + // value indicates whether branches exist in the repo. bool value = 1; } |