[GitHub] [apisix] juzhiyuan commented on a change in pull request #4155: docs: improve plugins' documentation (Chinese)
juzhiyuan commented on a change in pull request #4155: URL: https://github.com/apache/apisix/pull/4155#discussion_r625475491 ## File path: docs/zh/latest/plugins/api-breaker.md ## @@ -21,98 +21,69 @@ title: api-breaker # --> -## 目录 +## 简介 -- [**定义**](#定义) -- [**属性列表**](#属性列表) -- [**启用方式**](#启用方式) -- [**测试插件**](#测试插件) -- [**禁用插件**](#禁用插件) +启用该插件后，网关将根据配置判断上游是否异常，若异常，则直接返回预设的错误码，且在一定时间内不再访问上游。 -## 定义 +## 参数 -该插件实现 API 熔断功能，帮助我们保护上游业务服务。 +|参数名称 |类型| 必选 | 默认值 | 使用范围 | 描述| +| :-: | :: | :---: | :: | :---: | :: | +| break_response_code | 整数型 | 是 || 200 ~ 599 | 上游不健康时，将返回该状态码。 | Review comment: done -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a change in pull request #4155: docs: improve plugins' documentation (Chinese)
juzhiyuan commented on a change in pull request #4155: URL: https://github.com/apache/apisix/pull/4155#discussion_r625469631 ## File path: docs/zh/latest/plugins/api-breaker.md ## @@ -21,98 +21,69 @@ title: api-breaker # --> -## 目录 +## 简介 -- [**定义**](#定义) -- [**属性列表**](#属性列表) -- [**启用方式**](#启用方式) -- [**测试插件**](#测试插件) -- [**禁用插件**](#禁用插件) +启用该插件后，网关将根据配置判断上游是否异常，若异常，则直接返回预设的错误码，且在一定时间内不再访问上游。 -## 定义 +## 参数 -该插件实现 API 熔断功能，帮助我们保护上游业务服务。 +|参数名称 |类型| 必选 | 默认值 | 使用范围 | 描述| +| :-: | :: | :---: | :: | :---: | :: | +| break_response_code | 整数型 | 是 || 200 ~ 599 | 上游不健康时，将返回该状态码。 | Review comment: 樂 ok -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a change in pull request #4155: docs: improve plugins' documentation (Chinese)
juzhiyuan commented on a change in pull request #4155: URL: https://github.com/apache/apisix/pull/4155#discussion_r625469378 ## File path: docs/zh/latest/plugins/basic-auth.md ## @@ -21,128 +21,154 @@ title: basic-auth # --> -## 目录 +## 简介 -- [**名字**](#名字) -- [**属性**](#属性) -- [**如何启用**](#如何启用) -- [**测试插件**](#测试插件) -- [**禁用插件**](#禁用插件) +启用该插件后，客户端访问路由、服务时需提供正确的用户名与密码，插件将从 HTTP 请求头 Authorization 中获取凭证信息。 -## 名字 +:::caution 注意 Review comment: Those contents are used in the docs site, this syntax will be rendered as `Admonitions Box`.  -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
