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 3dc5cd8 docs: format CHANGELOG (#3226)
3dc5cd8 is described below
commit 3dc5cd801e5e9138179e699123ed80752e7386b3
Author: 罗泽轩 <[email protected]>
AuthorDate: Sat Jan 9 03:08:30 2021 -0600
docs: format CHANGELOG (#3226)
---
CHANGELOG.md | 24 +++++++++++++-----------
CHANGELOG_CN.md | 24 +++++++++++++-----------
2 files changed, 26 insertions(+), 22 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 79f3e91..c033c2e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -36,14 +36,14 @@
## 2.2.0
-## Change
+### Change
+
- disable node-status plugin by default
[#2968](https://github.com/apache/apisix/pull/2968)
- k8s_deployment_info is no longer allowed in upstream
[#3098](https://github.com/apache/apisix/pull/3098)
- don't treat route segment with ':' as parameter by default
[#3154](https://github.com/apache/apisix/pull/3154)
-## Deprecated
-
### Core
+
- :sunrise: allow create consumers with multiple auth plugins
[#2898](https://github.com/apache/apisix/pull/2898)
- :sunrise: increase the delay before resync etcd
[#2977](https://github.com/apache/apisix/pull/2977)
- :sunrise: support enable/disable route
[#2943](https://github.com/apache/apisix/pull/2943)
@@ -51,7 +51,8 @@
- :sunrise: share etcd auth token
[#2932](https://github.com/apache/apisix/pull/2932)
- :sunrise: add control API [#3048](https://github.com/apache/apisix/pull/3048)
-## Plugin
+### Plugin
+
- :sunrise: feat(limt-count): use 'remote_addr' as default key
[#2927](https://github.com/apache/apisix/pull/2927)
- :sunrise: feat(fault-injection): support Nginx variable in abort.body
[#2986](https://github.com/apache/apisix/pull/2986)
- :sunrise: feat: implement new plugin `server-info`
[#2926](https://github.com/apache/apisix/pull/2926)
@@ -61,7 +62,8 @@
- :sunrise: feat: Make headers to add to request in openid-connect plugin
configurable [#2903](https://github.com/apache/apisix/pull/2903)
- :sunrise: feat: support var in upstream_uri on proxy-rewrite plugin
[#3139](https://github.com/apache/apisix/pull/3139)
-## Bugfix
+### Bugfix
+
- basic-auth plugin should run in rewrite phases.
[#2905](https://github.com/apache/apisix/pull/2905)
- fixed the non effective config update in http/udp-logger
[#2901](https://github.com/apache/apisix/pull/2901)
- always necessary to save the data of the limit concurrency, and release the
statistical status in the log phase
[#2465](https://github.com/apache/apisix/pull/2465)
@@ -83,20 +85,20 @@ For more changes, please refer to
[Milestone](https://github.com/apache/apisix/m
- Added `X-APISIX-Upstream-Status` header to distinguish 5xx errors from
upstream or APISIX itself. [#2817](https://github.com/apache/apisix/pull/2817)
- support Nginx configuration snippet.
[#2803](https://github.com/apache/apisix/pull/2803)
-## Plugin
+### Plugin
- :sunrise: **Upgrade protocol to support Apache Skywalking
8.0**[#2389](https://github.com/apache/apisix/pull/2389). So this version only
supports skywalking 8.0 protocol. This plugin is disabled by default, you need
to modify config.yaml to enable, which is not backward compatible.
- :sunrise: add aliyun sls logging
plugin.[#2169](https://github.com/apache/apisix/issues/2169)
- proxy-cache: the cache_zone field in the schema should be
optional.[#2776](https://github.com/apache/apisix/pull/2776)
- fix: validate plugin configuration in the DP
[#2856](https://github.com/apache/apisix/pull/2856)
-## Bugfix
+### Bugfix
- :bug: fix(etcd): handle etcd
compaction.[#2687](https://github.com/apache/apisix/pull/2687)
- fix: move `conf/cert` to `t/certs` and disable ssl by default, which is not
backward compatible. [#2112](https://github.com/apache/apisix/pull/2112)
- fix: check decrypt key to prevent lua thread aborted
[#2815](https://github.com/apache/apisix/pull/2815)
-## Not downward compatible features in future versions
+### 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
@@ -117,7 +119,7 @@ This is release candidate.
- support multiple ports for http and https
listen.[#2409](https://github.com/apache/apisix/pull/2409)
- implement `core.sleep`.[#2397](https://github.com/apache/apisix/pull/2397)
-## Plugin
+### Plugin
- :sunrise: **add AK/SK(HMAC) auth
plugin.**[#2192](https://github.com/apache/apisix/pull/2192)
- :sunrise: add referer-restriction
plugin.[#2352](https://github.com/apache/apisix/pull/2352)
@@ -125,7 +127,7 @@ This is release candidate.
- feat(proxy-cache): store the temporary file under cache directory.
[#2317](https://github.com/apache/apisix/pull/2317)
- feat(http-logger): support for specified the log formats via admin API
[#2309](https://github.com/apache/apisix/pull/2309)
-## Bugfix
+### Bugfix
- :bug: **`high priority`** When the data plane receives an instruction to
delete a resource(router or upstream etc.), it does not properly clean up the
cache, resulting in the existing resources cannot be found. This problem only
occurs in the case of long and frequent deletion
operations.[#2168](https://github.com/apache/apisix/pull/2168)
- fix routing priority does not take
effect.[#2447](https://github.com/apache/apisix/pull/2447)
@@ -135,7 +137,7 @@ This is release candidate.
For more changes, please refer to
[Milestone](https://github.com/apache/apisix/milestone/7)
-## CVE
+### CVE
- Fixed Admin API default access token vulnerability
diff --git a/CHANGELOG_CN.md b/CHANGELOG_CN.md
index 80c94f0..a14ebc7 100644
--- a/CHANGELOG_CN.md
+++ b/CHANGELOG_CN.md
@@ -36,14 +36,14 @@
## 2.2.0
-## Change
+### Change
+
- 默认不启用 node-status 插件 [#2968](https://github.com/apache/apisix/pull/2968)
- upstreeam 配置中不再允许使用 k8s_deployment_info
[#3098](https://github.com/apache/apisix/pull/3098)
- 默认不再匹配路由中以 ':' 开头的参数变量 [#3154](https://github.com/apache/apisix/pull/3154)
-## Deprecated
-
### Core
+
- :sunrise: 允许一个 consumer 关联多个认证插件
[#2898](https://github.com/apache/apisix/pull/2898)
- :sunrise: 增加 etcd 重试间隔，并允许配置
[#2977](https://github.com/apache/apisix/pull/2977)
- :sunrise: 允许启用或禁用 route [#2943](https://github.com/apache/apisix/pull/2943)
@@ -51,7 +51,8 @@
- :sunrise: 共享 etcd 鉴权 token
[#2932](https://github.com/apache/apisix/pull/2932)
- :sunrise: 新增 control API [#3048](https://github.com/apache/apisix/pull/3048)
-## Plugin
+### Plugin
+
- :sunrise: limt-count 中使用 'remote_addr' 作为默认 key
[#2927](https://github.com/apache/apisix/pull/2927)
- :sunrise: 支持在 fault-injection 的 abort.body 中使用变量
[#2986](https://github.com/apache/apisix/pull/2986)
- :sunrise: 新增插件 `server-info`
[#2926](https://github.com/apache/apisix/pull/2926)
@@ -61,7 +62,8 @@
- :sunrise: openid-connect 插件增加更多配置项
[#2903](https://github.com/apache/apisix/pull/2903)
- :sunrise: proxy-rewrite 支持在 upstream_uri 中使用变量
[#3139](https://github.com/apache/apisix/pull/3139)
-## Bugfix
+### Bugfix
+
- basic-auth 应该在 rewrite phase 执行
[#2905](https://github.com/apache/apisix/pull/2905)
- http/udp-logger 中插件配置运行时变更没有生效
[#2901](https://github.com/apache/apisix/pull/2901)
- 修复 limit-conn 对象没有被正确释放的问题
[#2465](https://github.com/apache/apisix/pull/2465)
@@ -83,20 +85,20 @@
- 增加 `X-APISIX-Upstream-Status` 头来区分 5xx 错误来自上游还是 APISIX
自身。[#2817](https://github.com/apache/apisix/pull/2817)
- 支持 Nginx 配置片段。[#2803](https://github.com/apache/apisix/pull/2803)
-## Plugin
+### Plugin
- :sunrise: **升级协议来 Apache Skywalking
8.0**[#2389](https://github.com/apache/apisix/pull/2389). 这个版本只支持 skywalking
8.0 协议。此插件默认关闭，需要修改 config.yaml 来开启。这是不向下兼容的修改。
- :sunrise: 新增阿里云 sls
日志服务插件。[#2169](https://github.com/apache/apisix/issues/2169)
- proxy-cache: cache_zone
字段改为可选.[#2776](https://github.com/apache/apisix/pull/2776)
- 在数据平面校验插件的配置。[#2856](https://github.com/apache/apisix/pull/2856)
-## Bugfix
+### Bugfix
- :bug: fix(etcd): 处理 etcd
compaction.[#2687](https://github.com/apache/apisix/pull/2687)
- 将 `conf/cert` 中的测试证书移动到 `t/certs` 目录中，并且默认关闭 SSL。这是不向下兼容的修改。
[#2112](https://github.com/apache/apisix/pull/2112)
- 检查 decrypt key 来阻止 lua thread 中断。
[#2815](https://github.com/apache/apisix/pull/2815)
-## 不向下兼容特性预告
+### 不向下兼容特性预告
- 在 2.3 发布版本中，consumer 将只支持用户名，废弃 id，consumer需要在 etcd 中手工清理掉 id 字段，不然使用时
schema 校验会报错
- 在 2.3 发布版本中，将不再支持在 upstream 上开启 websocket
@@ -117,7 +119,7 @@
- 支持 http 和 https 监听多个端口。[#2409](https://github.com/apache/apisix/pull/2409)
- 实现 `core.sleep` 函数。[#2397](https://github.com/apache/apisix/pull/2397)
-## Plugin
+### Plugin
- :sunrise: **增加 AK/SK(HMAC)
认证插件。**[#2192](https://github.com/apache/apisix/pull/2192)
- :sunrise: 增加 referer-restriction
插件。[#2352](https://github.com/apache/apisix/pull/2352)
@@ -125,7 +127,7 @@
- proxy-cache 插件支持存储临时文件。[#2317](https://github.com/apache/apisix/pull/2317)
- http-logger 插件支持通过 admin API
来指定文件格式。[#2309](https://github.com/apache/apisix/pull/2309)
-## Bugfix
+### Bugfix
- :bug: **`高优先级`**
当数据平面接收到删除某一个资源(路由、上游等)的指令时，没有正确的清理缓存，导致存在的资源也会找不到。这个问题在长时间、频繁删除操作的情况下才会出现。[#2168](https://github.com/apache/apisix/pull/2168)
- 修复路由优先级不生效的问题。[#2447](https://github.com/apache/apisix/pull/2447)
@@ -135,7 +137,7 @@
更多的变动可以参考[里程碑](https://github.com/apache/apisix/milestone/7)
-## CVE
+### CVE
- 修复 Admin API 默认访问令牌漏洞
