Merge branch 'pks-user-delete-branch-structured-errors' into 'master'

operations: Use structured errors in UserDeleteBranch

See merge request gitlab-org/gitaly!4605

1 files changed, 8 insertions, 3 deletions

diff --git a/ruby/proto/gitaly/operations_services_pb.rb b/ruby/proto/gitaly/operations_services_pb.rb
index b71684ee1..c7e22ac03 100644
--- a/ruby/proto/gitaly/operations_services_pb.rb
+++ b/ruby/proto/gitaly/operations_services_pb.rb
@@ -28,9 +28,14 @@ module Gitaly
       #
       # - Returns `InvalidArgument` in case either the branch name or user are not set.
       # - Returns `FailedPrecondition` in case the branch does not exist.
-      # - Returns `OK` with a `PreReceiveError` in case custom hooks refused the update.
-      # - Returns `FailedPrecondition` in case updating the reference fails because of a concurrent
-      #   write to the same reference.
+      # - Returns `OK` with a `PreReceiveError` in case custom hooks refused the update. If the
+      #   `gitaly_user_delete_branch_structured_errors` feature flag is enabled this error case will
+      #   instead return `PermissionDenied` with either a `CustomHook` or AccessCheck` structured
+      #   error.
+      # - Returns `FailedPrecondition` in case updating the reference fails because
+      #   of a concurrent write to the same reference. If the
+      #   `gitaly_user_delete_branch_structured_errors` feature flag is set this error case will
+      #   instead return `FailedPrecondition` with a `ReferenceUpdate` structured error.
       rpc :UserDeleteBranch, ::Gitaly::UserDeleteBranchRequest, ::Gitaly::UserDeleteBranchResponse
       # UserCreateTag creates a new tag.
       rpc :UserCreateTag, ::Gitaly::UserCreateTagRequest, ::Gitaly::UserCreateTagResponse