Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitaly.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Liu <jliu@gitlab.com>2023-10-09 05:23:53 +0300
committerJames Liu <jliu@gitlab.com>2023-10-12 08:17:04 +0300
commit993b53834714a20aa751b42c3e38938ea2141e4d (patch)
treeff953c398cce8c0ed7bb2c2b0d89b0f6d0c5f8a9
parent399fa0266ce9d03a8c72267555482587ff2fc6eb (diff)
proto: Add missing docs for UserRevert*
-rw-r--r--proto/go/gitalypb/operations.pb.go6
-rw-r--r--proto/operations.proto6
2 files changed, 6 insertions, 6 deletions
diff --git a/proto/go/gitalypb/operations.pb.go b/proto/go/gitalypb/operations.pb.go
index 381d3b313..7e9fc50a0 100644
--- a/proto/go/gitalypb/operations.pb.go
+++ b/proto/go/gitalypb/operations.pb.go
@@ -2304,7 +2304,7 @@ func (*UserCherryPickError_ChangesAlreadyApplied) isUserCherryPickError_Error()
func (*UserCherryPickError_AccessCheck) isUserCherryPickError_Error() {}
-// UserRevertRequest ...
+// UserRevertRequest is a request for the UserRevert RPC.
type UserRevertRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
@@ -2315,7 +2315,7 @@ type UserRevertRequest struct {
// user is the user to perform the revert as. This is used both for
// authorization and as author/committer for the revert commit.
User *User `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`
- // commit iis the commit to revert.
+ // commit is the commit to revert. Only the `id` field is required.
Commit *GitCommit `protobuf:"bytes,3,opt,name=commit,proto3" json:"commit,omitempty"`
// branch_name is the name of the branch onto which the reverted commit shall
// be committed.
@@ -2448,7 +2448,7 @@ func (x *UserRevertRequest) GetExpectedOldOid() string {
return ""
}
-// UserRevertResponse ...
+// UserRevertResponse is a response for the UserRevert RPC.
type UserRevertResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
diff --git a/proto/operations.proto b/proto/operations.proto
index 65db318e7..4143054ee 100644
--- a/proto/operations.proto
+++ b/proto/operations.proto
@@ -675,14 +675,14 @@ message UserCherryPickError {
}
}
-// UserRevertRequest ...
+// UserRevertRequest is a request for the UserRevert RPC.
message UserRevertRequest {
// repository is the repository in which the revert shall be applied.
Repository repository = 1 [(target_repository)=true];
// user is the user to perform the revert as. This is used both for
// authorization and as author/committer for the revert commit.
User user = 2;
- // commit iis the commit to revert.
+ // commit is the commit to revert. Only the `id` field is required.
GitCommit commit = 3;
// branch_name is the name of the branch onto which the reverted commit shall
// be committed.
@@ -713,7 +713,7 @@ message UserRevertRequest {
string expected_old_oid = 10;
}
-// UserRevertResponse ...
+// UserRevertResponse is a response for the UserRevert RPC.
message UserRevertResponse {
// CreateTreeError represents an error which happened when computing the
// revert.