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 7c5df5d docs: lint Markdown (#3178)
7c5df5d is described below
commit 7c5df5d343ef79f9a292a8eb621fec72280d13ea
Author: John Bampton <[email protected]>
AuthorDate: Wed Jan 6 13:06:43 2021 +1000
docs: lint Markdown (#3178)
---
.markdownlint.yml | 1 -
CHANGELOG.md | 1 +
CHANGELOG_CN.md | 2 ++
FAQ.md | 1 +
doc/plugins/batch-requests.md | 4 ++++
doc/plugins/openid-connect.md | 1 +
doc/powered-by.md | 7 +++++++
doc/router-radixtree.md | 1 +
doc/zh-cn/plugins/batch-requests.md | 4 ++++
doc/zh-cn/plugins/consumer-restriction.md | 1 +
doc/zh-cn/plugins/sls-logger.md | 1 +
kubernetes/README.md | 2 ++
12 files changed, 25 insertions(+), 1 deletion(-)
diff --git a/.markdownlint.yml b/.markdownlint.yml
index aacb8dd..7dc768e 100644
--- a/.markdownlint.yml
+++ b/.markdownlint.yml
@@ -25,7 +25,6 @@ MD007: false
MD010: false
MD013: false
MD014: false
-MD022: false
MD024: false
MD026: false
MD029: false
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5d1dc6b..16c332f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -59,6 +59,7 @@
- fix: check decrypt key to prevent lua thread aborted
[#2815](https://github.com/apache/apisix/pull/2815)
## Not downward compatible features in future versions
+
-In the 2.3 release, the consumer will only support user names and discard the
id. The consumer needs to manually clean up the id field in etcd, otherwise the
schema verification will report an error during use
-In the 2.3 release, opening websocket on upstream will no longer be supported
-In version 3.0, the data plane and control plane will be separated into two
independent ports, that is, the current port 9080 will only process data plane
requests, and no longer process admin API requests
diff --git a/CHANGELOG_CN.md b/CHANGELOG_CN.md
index c27e10c..ad4435f 100644
--- a/CHANGELOG_CN.md
+++ b/CHANGELOG_CN.md
@@ -193,6 +193,7 @@
- 实现完成 `sys logger` 插件.
[#1414](https://github.com/apache/incubator-apisix/pull/1414)
## 1.2.0
+
1.2 版本在内核以及插件上带来了非常多的更新。
### Core
@@ -341,6 +342,7 @@
- 使用 `lua-resty-jsonschema` 全局替换 `lua-rapidjson` 扩展，`lua-resty-jsonschema`
解析速度更快，更容易编译。
## 0.8.0
+
> Released on 2019/09/30
这个版本带来很多新的特性，比如四层协议的代理, 支持 MQTT 协议代理，以及对 ARM 平台的支持, 和代理改写插件等。
diff --git a/FAQ.md b/FAQ.md
index 873e0b6..9cd3810 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -197,6 +197,7 @@ Server: APISIX web server
```
## How to fix OpenResty Installation Failure on MacOS 10.15
+
When you install the OpenResty on MacOs 10.15, you may face this error
```shell
diff --git a/doc/plugins/batch-requests.md b/doc/plugins/batch-requests.md
index fbb9402..42f5379 100644
--- a/doc/plugins/batch-requests.md
+++ b/doc/plugins/batch-requests.md
@@ -70,6 +70,7 @@ curl
http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API
| max_body_size | integer | required | 1048576 | > 0 | the
maximum of request body size in bytes |
## Batch API Request/Response
+
The plugin will create a API in `apisix` to handle your batch request.
### Batch API Request:
@@ -82,6 +83,7 @@ The plugin will create a API in `apisix` to handle your batch
request.
| pipeline | [HttpRequest](#HttpRequest) | required | | |
Request's detail |
#### HttpRequest
+
| Name | Type | Requirement | Default | Valid
| Description
|
| ---------- | ------- | ----------- | ------- |
--------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------------------------------
|
| version | string | optional | 1.1 | [1.0, 1.1]
| http version
|
@@ -93,9 +95,11 @@ The plugin will create a API in `apisix` to handle your
batch request.
| ssl_verify | boolean | optional | false |
| verify if SSL cert matches
hostname. |
### Batch API Response：
+
Response is `Array` of [HttpResponse](#HttpResponse).
#### HttpResponse
+
| Name | Type | Description |
| ------- | ------- | --------------------- |
| status | integer | http status code |
diff --git a/doc/plugins/openid-connect.md b/doc/plugins/openid-connect.md
index d3490c9..796388a 100644
--- a/doc/plugins/openid-connect.md
+++ b/doc/plugins/openid-connect.md
@@ -53,6 +53,7 @@ The OAuth 2 / Open ID Connect(OIDC) plugin provides
authentication and introspec
| set_userinfo_header | boolean | optional | true
| | Whether to ensure the UserInfo object, if available, is set
in the `X-Userinfo` request header. |
### Modes of operation
+
The plugin supports different modes of operation.
1) It can be configured to just validate an access token that is expected to
be present in a request header.
diff --git a/doc/powered-by.md b/doc/powered-by.md
index a400415..87c3759 100644
--- a/doc/powered-by.md
+++ b/doc/powered-by.md
@@ -57,20 +57,27 @@ Users are encouraged to add themselves to this page,
[issue](https://github.com/
<img
src="https://raw.githubusercontent.com/iresty/iresty.com/master/user-wall.jpg";
width="900" height="500">
# User Cases
+
## NASA JPL
+
Using Apache APISIX as a API gateway to deal with north-south and east-west
traffic between microservices.
## ke.com
+
Using Apache APISIX as traffic entry gateway
## meizu
+
Using Apache APISIX as api gateway (limit, grpc transcode, abtest, dynamic
configures ...)
## zuzuche.com
+
Using Apache APISIX as a gateway, it uses the functions of current limiting,
speed limiting, black-and-white list and so on. In the later stage, it also
wants to add gRPC protocol, Serverless, custom plug-in, and other functions to
meet business needs.
## souche.com
+
Using Apache APISIX as a Web ACL gateway to deal with backend OA systems
traffic.
## HelloTalk, Inc.
+
Using Apache APISIX as an API gateway to manage all API and SSL certificates
in test\dev\CMS environment.
diff --git a/doc/router-radixtree.md b/doc/router-radixtree.md
index 85d66e9..92ca128 100644
--- a/doc/router-radixtree.md
+++ b/doc/router-radixtree.md
@@ -20,6 +20,7 @@
# libradixtree
### what's libradixtree?
+
[libradixtree](https://github.com/iresty/lua-resty-radixtree), adaptive radix
trees implemented in Lua for OpenResty.
APISIX using libradixtree as route dispatching library.
diff --git a/doc/zh-cn/plugins/batch-requests.md
b/doc/zh-cn/plugins/batch-requests.md
index 814b3fe..6ed660b 100644
--- a/doc/zh-cn/plugins/batch-requests.md
+++ b/doc/zh-cn/plugins/batch-requests.md
@@ -69,6 +69,7 @@ curl
http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API
| max_body_size | integer | 必选 | 1048576 | > 0 |
请求体的最大大小，单位为字节。|
## 批量接口请求/响应
+
插件会为 `apisix` 创建一个 `/apisix/batch-requests` 的接口来处理你的批量请求。
### 接口请求参数:
@@ -81,6 +82,7 @@ curl
http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API
| pipeline | [HttpRequest](#HttpRequest) | 必须 | | | Http
请求的详细信息 |
#### HttpRequest
+
| 参数名 | 类型 | 可选 | 默认值 | 有效值
| 描述
|
| ---------- | ------- | ---- | ------ |
--------------------------------------------------------------------------------
| ------------------------------------------------------------------------- |
| version | string | 可选 | 1.1 | [1.0, 1.1]
| 请求用的 `http` 协议版本
|
@@ -92,9 +94,11 @@ curl
http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API
| ssl_verify | boolean | 可选 | false |
| 验证 SSL 证书与主机名是否匹配
|
### 接口响应参数：
+
返回值为一个 [HttpResponse](#HttpResponse) 的 `数组`。
#### HttpResponse
+
| 参数名 | 类型 | 描述 |
| ------- | ------- | ------------------- |
| status | integer | Http 请求的状态码 |
diff --git a/doc/zh-cn/plugins/consumer-restriction.md
b/doc/zh-cn/plugins/consumer-restriction.md
index 804a29c..1dd8388 100644
--- a/doc/zh-cn/plugins/consumer-restriction.md
+++ b/doc/zh-cn/plugins/consumer-restriction.md
@@ -115,6 +115,7 @@ HTTP/1.1 403 Forbidden
```
### 如何限制 `service_id`
+
`service_id`方式需要与授权插件一起配合使用，这里以key-auth授权插件为例。
1、创建两个 service
diff --git a/doc/zh-cn/plugins/sls-logger.md b/doc/zh-cn/plugins/sls-logger.md
index d8c9b1c..772f79d 100644
--- a/doc/zh-cn/plugins/sls-logger.md
+++ b/doc/zh-cn/plugins/sls-logger.md
@@ -54,6 +54,7 @@
|buffer_duration|可选的 |必须先处理批次中最旧条目的最大期限（以秒为单位）。|
|max_retry_count|可选的 |从处理管道中移除之前的最大重试次数。|
|retry_delay |可选的 |如果执行失败，应该延迟进程执行的秒数。|
+
## 如何开启
1. 下面例子展示了如何为指定路由开启 `sls-logger` 插件的。
diff --git a/kubernetes/README.md b/kubernetes/README.md
index 9c9b5b0..dbbc26c 100644
--- a/kubernetes/README.md
+++ b/kubernetes/README.md
@@ -16,6 +16,7 @@
# limitations under the License.
#
-->
+
### kubernetes
There are some yaml files for deploying apisix in Kubernetes.
@@ -35,6 +36,7 @@ $ kubectl create configmap apisix-gw-config.yaml
--from-file=../conf/config.yaml
```
#### when using etcd-operator
+
when using etcd-operator, you need to change `apisix-gw-config-cm.yaml`:
* add CoreDNS IP into dns_resolver
![https://raw.githubusercontent.com/iresty/iresty.com/master/user-wall.jpg"](https://raw.githubusercontent.com/iresty/iresty.com/master/user-wall.jpg"){kind=link}