You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by yu...@apache.org on 2022/07/13 08:49:41 UTC

[rocketmq-apis] branch main updated: Update README.md

This is an automated email from the ASF dual-hosted git repository.

yukon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/rocketmq-apis.git


The following commit(s) were added to refs/heads/main by this push:
     new 52ce6b9  Update README.md
52ce6b9 is described below

commit 52ce6b96ec626e6657d57ea82f7aae4945011fc1
Author: yukon <yu...@apache.org>
AuthorDate: Wed Jul 13 16:49:36 2022 +0800

    Update README.md
---
 README.md | 18 ++++--------------
 1 file changed, 4 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 57b0efb..b148045 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,7 @@
 ## Overview
+RocketMQ APIs use Protocol Buffers version 3 (proto3) as their Interface Definition Language (IDL) to define the API interface and the structure of the payload messages. Reading these definitions can understand RocketMQ 5.0 models and API behaviors easily.
 
-## Extension Spec
+Currently, Apache RocketMQ only supports these APIs over gRPC, a high-performance binary RPC protocol over HTTP/2. The implementation consists of two parts:
 
-## Message Model
-
-## Producer Flow
-
-## Consumer Flow
-
-## Error handling
-This API spec adopts a rich error model developed by Google as described [here](https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto). This model enables servers to return and clients to consume additional [error details](https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto) expressed as one or more protobuf messages. It further specifies a standard set of error message types to cover the most common needs (such as invalid parameters [...]
-
-The whole set of response codes are listed [here](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto), except the offical gRPC error model, please refer to `service.proto` for more details about the error responses of each RPC service.
-
-## Reserved Fields
-Messages and enumerations of the API spec reserve the first 64 fields for the evolution of RocketMQ exclusively. Vendor-specific extensions to the protocol are supposed to use fields beyond 64.
\ No newline at end of file
+  * [rocketmq](https://github.com/apache/rocketmq): The main repo of Apache RocketMQ contains a `proxy` module that implements this specification in the server-side.
+  * [rocketmq-clients](https://github.com/apache/rocketmq-clients): A mono repo consists of polyglot clients that implement this specification in the client-side.