From 106630ed8ba681fcd4f8a3ecabdd98dcac418b4b Mon Sep 17 00:00:00 2001
From: alex-smile <443677891@qq.com>
Date: Fri, 1 Dec 2023 14:17:52 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20change.log?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 sdks/apigw-manager/CHANGE.md | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/sdks/apigw-manager/CHANGE.md b/sdks/apigw-manager/CHANGE.md
index ec181706..67853e68 100644
--- a/sdks/apigw-manager/CHANGE.md
+++ b/sdks/apigw-manager/CHANGE.md
@@ -4,15 +4,17 @@
 - 添加指令 add_related_apps，支持为网关添加关联应用
 - definition.yaml 添加 spec_version 字段，指定配置文件版本号
 - Django Command 中，通过参数 --gateway-name 指定网关
+- 基础镜像 apigw-manager 中，sync-apigateway.sh 中去除指令 apply_apigw_permissions
+- 优化请求 bk-apigateway 接口失败时，打印的错误消息
+- 优化 README.md，提供 examples
+
+Breaking changes:
 - 基础镜像 apigw-manager 中，调整指令名称
   - sync-apigateway 改为 sync-apigateway.sh
   - apigw-manager 改为 apigw-manager.sh
   - call_command 改为 call_command_or_warning
   - call_definition_command 改为 call_definition_command_or_warning
   - must_call_definition_command 改为 call_definition_command_or_exit
-- 基础镜像 apigw-manager 中，sync-apigateway.sh 中去除指令 apply_apigw_permissions
-- 优化请求 bk-apigateway 接口失败时，打印的错误消息
-- 优化 README.md，提供 examples
 - 以下函数中的参数名 api_name 改为 gateway_name
   - ApiGatewayJWTUserMiddleware.get_user
   - UserModelBackend.authenticate
@@ -27,6 +29,10 @@
   - PublicKeyProvider.__init__
   - SettingsPublicKeyProvider.__init__
 
+如果项目添加了自定义镜像，或自定义 Django 中间件，需要按照新的规则进行调整，或者锁定版本号
+- 自定义镜像锁定基础镜像 apigw-manager 版本，版本号 < 3.0.0
+- SDK 锁定版本号 < 3.0.0，如 poetry 可设置 `apigw-manager = "<3.0.0"`
+
 ### 2.0.1
 - 修复镜像 sync-apigateway 中，同步任务失败时，脚本退出码为 0 的问题