diff options
author | James Liu <jliu@gitlab.com> | 2023-10-09 06:09:25 +0300 |
---|---|---|
committer | James Liu <jliu@gitlab.com> | 2023-10-12 08:17:04 +0300 |
commit | 654cb89472e87e423cfacd5d96b6095f34de8919 (patch) | |
tree | 0ff8a2701b6963faaee4945fde7c945136ac0f5a | |
parent | ac61012c72ac8abdf16288cc1849fb749501d07b (diff) |
proto: Add missing docs for UserUpdateSubmodule
-rw-r--r-- | internal/gitaly/service/operations/submodules.go | 2 | ||||
-rw-r--r-- | proto/go/gitalypb/operations.pb.go | 4 | ||||
-rw-r--r-- | proto/operations.proto | 4 |
3 files changed, 5 insertions, 5 deletions
diff --git a/internal/gitaly/service/operations/submodules.go b/internal/gitaly/service/operations/submodules.go index 144ef5cac..bef9e5d62 100644 --- a/internal/gitaly/service/operations/submodules.go +++ b/internal/gitaly/service/operations/submodules.go @@ -19,7 +19,7 @@ const ( legacyErrPrefixInvalidSubmodulePath = "Invalid submodule path" ) -//nolint:revive // This is unintentionally missing documentation. +// UserUpdateSubmodule updates a submodule to point to a new commit. func (s *Server) UserUpdateSubmodule(ctx context.Context, req *gitalypb.UserUpdateSubmoduleRequest) (*gitalypb.UserUpdateSubmoduleResponse, error) { if err := s.locator.ValidateRepository(req.GetRepository()); err != nil { return nil, structerr.NewInvalidArgument("%w", err) diff --git a/proto/go/gitalypb/operations.pb.go b/proto/go/gitalypb/operations.pb.go index 06dd30f8a..160065c21 100644 --- a/proto/go/gitalypb/operations.pb.go +++ b/proto/go/gitalypb/operations.pb.go @@ -3789,7 +3789,7 @@ func (x *UserApplyPatchResponse) GetBranchUpdate() *OperationBranchUpdate { return nil } -// UserUpdateSubmoduleRequest ... +// UserUpdateSubmoduleRequest is a request for the UserUpdateSubmodule RPC. type UserUpdateSubmoduleRequest struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache @@ -3912,7 +3912,7 @@ func (x *UserUpdateSubmoduleRequest) GetExpectedOldOid() string { return "" } -// UserUpdateSubmoduleResponse ... +// UserUpdateSubmoduleResponse is a response for the UserUpdateSubmodule RPC. type UserUpdateSubmoduleResponse struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache diff --git a/proto/operations.proto b/proto/operations.proto index 2a52f74ea..c096ed524 100644 --- a/proto/operations.proto +++ b/proto/operations.proto @@ -1048,7 +1048,7 @@ message UserApplyPatchResponse { OperationBranchUpdate branch_update = 1; } -// UserUpdateSubmoduleRequest ... +// UserUpdateSubmoduleRequest is a request for the UserUpdateSubmodule RPC. message UserUpdateSubmoduleRequest { // repository is the repository in which the submodule shall be updated. Repository repository = 1 [(target_repository)=true]; @@ -1079,7 +1079,7 @@ message UserUpdateSubmoduleRequest { string expected_old_oid = 8; } -// UserUpdateSubmoduleResponse ... +// UserUpdateSubmoduleResponse is a response for the UserUpdateSubmodule RPC. message UserUpdateSubmoduleResponse { // branch_update contains information about the updated branch. OperationBranchUpdate branch_update = 1; |