diff options
author | James Liu <jliu@gitlab.com> | 2023-11-27 03:03:46 +0300 |
---|---|---|
committer | James Liu <jliu@gitlab.com> | 2023-11-27 03:03:46 +0300 |
commit | e987447d0ec3d93187f44bd4374bad4e5506a149 (patch) | |
tree | 6143912a584238a4905824581f10bb9e35f7fcb1 /proto | |
parent | 3cd2a30b770d3312a1634d8eec49e34a592ef5d7 (diff) |
proto: Add missing docs for RepositoryExists
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 01e2dfe9e..5b85ae039 100644 --- a/proto/go/gitalypb/repository.pb.go +++ b/proto/go/gitalypb/repository.pb.go @@ -203,13 +203,13 @@ func (OptimizeRepositoryRequest_Strategy) EnumDescriptor() ([]byte, []int) { return file_repository_proto_rawDescGZIP(), []int{73, 0} } -// RepositoryExistsRequest ... +// RepositoryExistsRequest is a request for the RepositoryExists RPC. type RepositoryExistsRequest 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"` } @@ -252,13 +252,13 @@ func (x *RepositoryExistsRequest) GetRepository() *Repository { return nil } -// RepositoryExistsResponse ... +// RepositoryExistsResponse is a response for the RepositoryExists RPC. type RepositoryExistsResponse struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - // exists ... + // exists indicates whether the repo exists. Exists bool `protobuf:"varint,1,opt,name=exists,proto3" json:"exists,omitempty"` } diff --git a/proto/go/gitalypb/repository_grpc.pb.go b/proto/go/gitalypb/repository_grpc.pb.go index b46e4ab3a..1ea0a3b6e 100644 --- a/proto/go/gitalypb/repository_grpc.pb.go +++ b/proto/go/gitalypb/repository_grpc.pb.go @@ -22,7 +22,7 @@ const _ = grpc.SupportPackageIsVersion7 // // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream. type RepositoryServiceClient interface { - // RepositoryExists ... + // RepositoryExists returns whether a given repository exists. RepositoryExists(ctx context.Context, in *RepositoryExistsRequest, opts ...grpc.CallOption) (*RepositoryExistsResponse, error) // RepositorySize returns information on the complete on-disk repository size. If you need more // detailed information about the size of various sub-structures you should instead use the @@ -989,7 +989,7 @@ func (c *repositoryServiceClient) GetFileAttributes(ctx context.Context, in *Get // All implementations must embed UnimplementedRepositoryServiceServer // for forward compatibility type RepositoryServiceServer interface { - // RepositoryExists ... + // RepositoryExists returns whether a given repository exists. RepositoryExists(context.Context, *RepositoryExistsRequest) (*RepositoryExistsResponse, error) // RepositorySize returns information on the complete on-disk repository size. If you need more // detailed information about the size of various sub-structures you should instead use the diff --git a/proto/repository.proto b/proto/repository.proto index 27c5ce666..a5381384a 100644 --- a/proto/repository.proto +++ b/proto/repository.proto @@ -10,7 +10,7 @@ option go_package = "gitlab.com/gitlab-org/gitaly/v16/proto/go/gitalypb"; // RepositoryService is a service providing RPCs accessing repositories as a whole. service RepositoryService { - // RepositoryExists ... + // RepositoryExists returns whether a given repository exists. rpc RepositoryExists(RepositoryExistsRequest) returns (RepositoryExistsResponse) { option (op_type) = { op: ACCESSOR @@ -406,15 +406,15 @@ service RepositoryService { } } -// RepositoryExistsRequest ... +// RepositoryExistsRequest is a request for the RepositoryExists RPC. message RepositoryExistsRequest { - // repository ... + // repository is the repo to check. The storage_name and relative_path attributes must be provided. Repository repository = 1 [(target_repository)=true]; } -// RepositoryExistsResponse ... +// RepositoryExistsResponse is a response for the RepositoryExists RPC. message RepositoryExistsResponse { - // exists ... + // exists indicates whether the repo exists. bool exists = 1; } |