You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by sp...@apache.org on 2022/06/29 01:59:42 UTC

[apisix] branch master updated: docs: fix typo and syntax (#7347)

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

spacewander pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git


The following commit(s) were added to refs/heads/master by this push:
     new 03ae27d64 docs: fix typo and syntax (#7347)
03ae27d64 is described below

commit 03ae27d640d9d35092e57f4ad288094de2f99344
Author: okaybase <75...@users.noreply.github.com>
AuthorDate: Wed Jun 29 09:59:36 2022 +0800

    docs: fix typo and syntax (#7347)
---
 docs/en/latest/admin-api.md          | 8 ++++----
 docs/zh/latest/admin-api.md          | 6 +++---
 docs/zh/latest/plugins/basic-auth.md | 2 +-
 3 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/docs/en/latest/admin-api.md b/docs/en/latest/admin-api.md
index d78eb0d6e..0dc4ee318 100644
--- a/docs/en/latest/admin-api.md
+++ b/docs/en/latest/admin-api.md
@@ -103,7 +103,7 @@ Example configuration:
         "send": 3,
         "read": 3
     },
-    "filter_func": "",                    # User-defined filtering function
+    "filter_func": ""                     # User-defined filtering function
 }
 ```
 
@@ -458,7 +458,7 @@ Example Configuration:
 {
     "plugins": {},          # Bound plugin
     "username": "name",     # Consumer name
-    "desc": "hello world",  # Consumer desc
+    "desc": "hello world"   # Consumer desc
 }
 ```
 
@@ -584,7 +584,7 @@ Example Configuration:
     "timeout": {                # Set the timeout for connecting, sending and receiving messages, each is 15 seconds.
         "connect":15,
         "send":15,
-        "read":15,
+        "read":15
     },
     "nodes": {"host:80": 100},  # Upstream machine address list, the format is `Address + Port`
                                 # is the same as "nodes": [ {"host": "host", "port": 80, "weight": 100} ],
@@ -594,7 +594,7 @@ Example Configuration:
     "key": "",
     "name": "upstream-for-test",
     "desc": "hello world",
-    "scheme": "http",           # The scheme used when communicating with upstream, the default is `http`
+    "scheme": "http"            # The scheme used when communicating with upstream, the default is `http`
 }
 ```
 
diff --git a/docs/zh/latest/admin-api.md b/docs/zh/latest/admin-api.md
index 367c318ac..2ae3290de 100644
--- a/docs/zh/latest/admin-api.md
+++ b/docs/zh/latest/admin-api.md
@@ -110,7 +110,7 @@ route 对象 json 配置内容:
         "send": 3,
         "read": 3
     },
-    "filter_func": "",                    # 用户自定义的过滤函数,非必填
+    "filter_func": ""                     # 用户自定义的过滤函数,非必填
 }
 ```
 
@@ -467,7 +467,7 @@ consumer 对象 json 配置内容:
 {
     "plugins": {},          # 指定 consumer 绑定的插件
     "username": "name",     # 必填
-    "desc": "hello world",  # consumer 描述
+    "desc": "hello world"   # consumer 描述
 }
 ```
 
@@ -594,7 +594,7 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
     "timeout": {                # 设置连接、发送消息、接收消息的超时时间,每项都为 15 秒
         "connect":15,
         "send":15,
-        "read":15,
+        "read":15
     },
     "nodes": {"host:80": 100},  # 上游机器地址列表,格式为`地址 + 端口`
                                 # 等价于 "nodes": [ {"host":"host", "port":80, "weight": 100} ],
diff --git a/docs/zh/latest/plugins/basic-auth.md b/docs/zh/latest/plugins/basic-auth.md
index 69ee41526..39ca5ff2f 100644
--- a/docs/zh/latest/plugins/basic-auth.md
+++ b/docs/zh/latest/plugins/basic-auth.md
@@ -99,7 +99,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 \
 通过上述命令启用插件后,可以通过以下方法测试插件。
 
 ```shell
-curl -i -ubar:bar http://127.0.0.1:9080/hello
+curl -i -ufoo:bar http://127.0.0.1:9080/hello
 ```
 
 如果配置成功则返回如下结果: