diff options
author | Patrick Steinhardt <psteinhardt@gitlab.com> | 2021-04-26 15:00:37 +0300 |
---|---|---|
committer | Patrick Steinhardt <psteinhardt@gitlab.com> | 2021-04-28 08:44:27 +0300 |
commit | fef9c6b53d2162b35abc372a24023955349f2406 (patch) | |
tree | 0fc734b7ec83bf4a242fb556e420fce32933c283 /proto/go/gitalypb/remote.pb.go | |
parent | edd1a967791bd019102aca99f6826ecc7fcee11f (diff) |
proto: Document FindRemoteRootRef RPC
The FindRemoteRootRef RPC doesn't have any documentation in the protobuf
sources. Add some.
Diffstat (limited to 'proto/go/gitalypb/remote.pb.go')
-rw-r--r-- | proto/go/gitalypb/remote.pb.go | 29 |
1 files changed, 24 insertions, 5 deletions
diff --git a/proto/go/gitalypb/remote.pb.go b/proto/go/gitalypb/remote.pb.go index fc5e43ff9..6311ca685 100644 --- a/proto/go/gitalypb/remote.pb.go +++ b/proto/go/gitalypb/remote.pb.go @@ -514,12 +514,18 @@ func (m *FindRemoteRepositoryResponse) GetExists() bool { return false } +// FindRemoteRootRefRequest represents a request for the FindRemoteRootRef RPC. type FindRemoteRootRefRequest struct { - Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"` - Remote string `protobuf:"bytes,2,opt,name=remote,proto3" json:"remote,omitempty"` - XXX_NoUnkeyedLiteral struct{} `json:"-"` - XXX_unrecognized []byte `json:"-"` - XXX_sizecache int32 `json:"-"` + // Repository is the repository in which the request shall be executed in. If + // a remote name is given, then this is the repository in which the remote + // will be looked up. + Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"` + // Remote is the name of the remote of which the root reference shall be + // looked up. The remote must have been created before this call. + Remote string `protobuf:"bytes,2,opt,name=remote,proto3" json:"remote,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` } func (m *FindRemoteRootRefRequest) Reset() { *m = FindRemoteRootRefRequest{} } @@ -561,7 +567,10 @@ func (m *FindRemoteRootRefRequest) GetRemote() string { return "" } +// FindRemoteRootRefResponse represents the response for the FindRemoteRootRef +// request. type FindRemoteRootRefResponse struct { + // Ref is the name of the remote root reference. Ref string `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -828,6 +837,11 @@ type RemoteServiceClient interface { // the patterns specified in the requests. UpdateRemoteMirror(ctx context.Context, opts ...grpc.CallOption) (RemoteService_UpdateRemoteMirrorClient, error) FindRemoteRepository(ctx context.Context, in *FindRemoteRepositoryRequest, opts ...grpc.CallOption) (*FindRemoteRepositoryResponse, error) + // FindRemoteRootRef tries to find the root reference of a remote + // repository. The root reference is the default branch as pointed to by + // the remotes HEAD reference. Returns an InvalidArgument error if the + // specified remote does not exist and a NotFound error in case no HEAD + // branch was found. FindRemoteRootRef(ctx context.Context, in *FindRemoteRootRefRequest, opts ...grpc.CallOption) (*FindRemoteRootRefResponse, error) } @@ -930,6 +944,11 @@ type RemoteServiceServer interface { // the patterns specified in the requests. UpdateRemoteMirror(RemoteService_UpdateRemoteMirrorServer) error FindRemoteRepository(context.Context, *FindRemoteRepositoryRequest) (*FindRemoteRepositoryResponse, error) + // FindRemoteRootRef tries to find the root reference of a remote + // repository. The root reference is the default branch as pointed to by + // the remotes HEAD reference. Returns an InvalidArgument error if the + // specified remote does not exist and a NotFound error in case no HEAD + // branch was found. FindRemoteRootRef(context.Context, *FindRemoteRootRefRequest) (*FindRemoteRootRefResponse, error) } |