aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2023-12-19 02:01:18 +0800
committerGitHub <noreply@github.com>2023-12-19 02:01:18 +0800
commit40d78c8e03b8988ec9ebab509b2d542f0d35795a (patch)
tree3aeb1c424af077f445405907e2bc9ca99eeca151 /README.md
parentdece9f540f94fd4d4c3d327ab822b609087068f8 (diff)
downloadecho-40d78c8e03b8988ec9ebab509b2d542f0d35795a.tar.gz
echo-40d78c8e03b8988ec9ebab509b2d542f0d35795a.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 5 insertions, 43 deletions
diff --git a/README.md b/README.md
index 9238721..02c3e50 100644
--- a/README.md
+++ b/README.md
@@ -20,49 +20,11 @@ Echo 标准包括以下几个方面:
示例:
-```json
-{
- "event": {
- "type": "join",
- "source": "user1",
- "target": "all",
- "data": {
- "name": "Alice",
- "role": "PC"
- }
- },
- "api": {
- "path": "/event",
- "method": "POST",
- "parameters": {
- "event": {
- "type": "object",
- "required": true
- }
- },
- "responses": {
- "200": {
- "status": "success",
- "code": 0,
- "message": "OK",
- "data": null
- },
- "400": {
- "status": "error",
- "code": 1001,
- "message": "Bad Request",
- "tip": "请输入正确的事件类型"
- }
- }
- },
- "error": {
- "type": "400",
- "code": 1001,
- "message": "Bad Request",
- "tip": "请输入正确的事件类型"
- }
-}
-```
+| Workflow | Event |
+| :------: | :---: |
+| event_name | str |
+| event_paras | dict |
+
### 特性