[GitHub] [pulsar] RobertIndie commented on a diff in pull request #15497: [Doc] Add doc for `CommandAckResponse`

[GitBox <gi...@apache.org>]

RobertIndie commented on code in PR #15497:
URL: https://github.com/apache/pulsar/pull/15497#discussion_r867641494


##########
site2/docs/developing-binary-protocol.md:
##########
@@ -418,7 +418,24 @@ Parameters:
  * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
    `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
  * `request_id` -> *(optional)* ID for handling response and timeout.
-   
+
+##### Command CommandAckResponse
+
+This is the broker's response to ack request by the client. It contains the `consumer_id` sent in the request. 
+If transaction is used, it will also contain the transactionId and requestID sent in the request.
+The client will process the specific request according to the request ID.
+If the `error` field is set, it indicates that the request has failed.
+
+Example of ack response with redirection:
+
+```protobuf
+message CommandAckResponse {
+    "consumer_id" : 1,
+    "txnid_least_bits" = 0,
+    "txnid_most_bits" = 1,
+    request_id = 5

Review Comment:
   ```suggestion
       “request_id” = 5
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org