docs: fix cr

TencentBlueKing · Jan 19, 2024 · 6dcc959 · 6dcc959
1 parent f6227e3
commit 6dcc959
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/sdks/apigw-manager/docs/sync-apigateway-with-django.md b/sdks/apigw-manager/docs/sync-apigateway-with-django.md
@@ -30,7 +30,10 @@ python manage.py sync_apigw_config --gateway-name=${gateway_name} --file="${defi
 # 同步网关环境信息
 python manage.py sync_apigw_stage --gateway-name=${gateway_name} --file="${definition_file}"
 
-# 同步网关资源；--delete 将删除网关中未在 resources.yaml 存在的资源
+# 同步网关资源
+# 
+# --delete: 当资源在服务端存在，却未出现在资源定义文件中时，默认将被忽略
+#   指定本参数会强制删除这类资源，以保证服务端资源和文件内容完全一致。
 python manage.py sync_apigw_resources --delete --gateway-name=${gateway_name} --file="${resources_file}"
 
 # 可选，同步资源文档