diff options
author | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-07-29 09:12:29 +0300 |
---|---|---|
committer | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-07-29 09:22:39 +0300 |
commit | a14e97112b0dc78266df414e98c7d307e9fdf859 (patch) | |
tree | a386e57ff1bfe0bf3a35ed159dbde725b8a80d84 /proto/go/gitalypb | |
parent | 0fa08d953e0d5497fe5366836d0ed54b9ff557d8 (diff) |
proto: Document FindTag RPC
The FindTag RPC does not have any documentation right now. Add some.
Diffstat (limited to 'proto/go/gitalypb')
-rw-r--r-- | proto/go/gitalypb/ref.pb.go | 12 | ||||
-rw-r--r-- | proto/go/gitalypb/ref_grpc.pb.go | 8 |
2 files changed, 13 insertions, 7 deletions
diff --git a/proto/go/gitalypb/ref.pb.go b/proto/go/gitalypb/ref.pb.go index e1af47561..6326f3485 100644 --- a/proto/go/gitalypb/ref.pb.go +++ b/proto/go/gitalypb/ref.pb.go @@ -937,15 +937,17 @@ func (x *FindAllBranchesResponse) GetBranches() []*FindAllBranchesResponse_Branc return nil } -// This comment is left unintentionally blank. +// FindTagRequest is a request for the FindTag RPC. type FindTagRequest struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - // This comment is left unintentionally blank. + // Repository is the repository to look up the tag in. Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"` - // This comment is left unintentionally blank. + // TagName is the name of the tag that should be looked up. The caller is supposed to pass in the + // tag name only, so if e.g. a tag `refs/tags/v1.0.0` exists, then the caller should pass `v1.0.0` + // as argument. TagName []byte `protobuf:"bytes,2,opt,name=tag_name,json=tagName,proto3" json:"tag_name,omitempty"` } @@ -995,13 +997,13 @@ func (x *FindTagRequest) GetTagName() []byte { return nil } -// This comment is left unintentionally blank. +// FindTagResponse is a response for the FindTag RPC. type FindTagResponse struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - // This comment is left unintentionally blank. + // Tag is the tag that was found. Tag *Tag `protobuf:"bytes,1,opt,name=tag,proto3" json:"tag,omitempty"` } diff --git a/proto/go/gitalypb/ref_grpc.pb.go b/proto/go/gitalypb/ref_grpc.pb.go index 0f0884a1c..d84760be1 100644 --- a/proto/go/gitalypb/ref_grpc.pb.go +++ b/proto/go/gitalypb/ref_grpc.pb.go @@ -34,7 +34,9 @@ type RefServiceClient interface { FindAllBranches(ctx context.Context, in *FindAllBranchesRequest, opts ...grpc.CallOption) (RefService_FindAllBranchesClient, error) // Returns a stream of tags repository has. FindAllTags(ctx context.Context, in *FindAllTagsRequest, opts ...grpc.CallOption) (RefService_FindAllTagsClient, error) - // This comment is left unintentionally blank. + // FindTag looks up a tag by its name and returns it to the caller if it exists. This RPC supports + // both lightweight and annotated tags. Note: this RPC returns an `Internal` error if the tag was + // not found. FindTag(ctx context.Context, in *FindTagRequest, opts ...grpc.CallOption) (*FindTagResponse, error) // This comment is left unintentionally blank. FindAllRemoteBranches(ctx context.Context, in *FindAllRemoteBranchesRequest, opts ...grpc.CallOption) (RefService_FindAllRemoteBranchesClient, error) @@ -509,7 +511,9 @@ type RefServiceServer interface { FindAllBranches(*FindAllBranchesRequest, RefService_FindAllBranchesServer) error // Returns a stream of tags repository has. FindAllTags(*FindAllTagsRequest, RefService_FindAllTagsServer) error - // This comment is left unintentionally blank. + // FindTag looks up a tag by its name and returns it to the caller if it exists. This RPC supports + // both lightweight and annotated tags. Note: this RPC returns an `Internal` error if the tag was + // not found. FindTag(context.Context, *FindTagRequest) (*FindTagResponse, error) // This comment is left unintentionally blank. FindAllRemoteBranches(*FindAllRemoteBranchesRequest, RefService_FindAllRemoteBranchesServer) error |