You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/08/08 00:57:30 UTC

[GitHub] [apisix] tokers commented on a diff in pull request #7609: docs: add plugin filter usage example

tokers commented on code in PR #7609:
URL: https://github.com/apache/apisix/pull/7609#discussion_r939750782


##########
docs/en/latest/terminology/plugin.md:
##########
@@ -76,7 +76,19 @@ ip-restriction exits with http status code 403
 
 ## Plugin common configuration
 
-Some common configurations can be applied to the plugin configuration. For example,
+Some common configurations can be applied to plugins through the `_meta` configuration items, the specific configuration items are as follows:
+
+| Name         | Type | Description |
+|--------------|------|-------------|
+| error_response | string/object  | Custom error response |
+| priority       | integer        | Custom plugin priority |
+| filter  | array | Depending on the requested parameters, it is decided at runtime whether the plugin should be executed. Something like this: {{var, operator, val}, {var, operator, val}, ...}}. For example: `{"arg_version", "==", "v2"}`, indicating that the current request parameter `version` is `v2`. The variables here are consistent with NGINX internal variables. For details on supported operators, please see [lua-resty-expr](https://github.com/api7/lua-resty-expr#operator-list). |

Review Comment:
   ```suggestion
   | filter  | array | Depending on the requested parameters, it is decided at runtime whether the plugin should be executed. Something like this: `{{var, operator, val}, {var, operator, val}, ...}}`. For example: `{"arg_version", "==", "v2"}`, indicating that the current request parameter `version` is `v2`. The variables here are consistent with NGINX internal variables. For details on supported operators, please see [lua-resty-expr](https://github.com/api7/lua-resty-expr#operator-list). |
   ```



-- 
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.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org