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 012484f chore: enable Markdownlint rule MD038 (#3246)
012484f is described below
commit 012484f558e26c2461d9739efece1ac56718d0d0
Author: John Bampton <[email protected]>
AuthorDate: Tue Jan 12 11:07:57 2021 +1000
chore: enable Markdownlint rule MD038 (#3246)
MD038/no-space-in-code Spaces inside code span elements
---
.markdownlint.yml | 1 -
doc/admin-api.md | 2 +-
doc/discovery.md | 2 +-
doc/plugins/proxy-rewrite.md | 2 +-
doc/plugins/wolf-rbac.md | 2 +-
5 files changed, 4 insertions(+), 5 deletions(-)
diff --git a/.markdownlint.yml b/.markdownlint.yml
index 4f363d6..e9be7e3 100644
--- a/.markdownlint.yml
+++ b/.markdownlint.yml
@@ -30,7 +30,6 @@ MD029: false
MD033: false
MD034: false
MD036: false
-MD038: false
MD040: false
MD041: false
MD045: false
diff --git a/doc/admin-api.md b/doc/admin-api.md
index 306c257..b4b3544 100644
--- a/doc/admin-api.md
+++ b/doc/admin-api.md
@@ -64,7 +64,7 @@
|remote_addr|False, can't be used with `remote_addrs` |Match Rules|The client
requests an IP address: `192.168.1.101`, `192.168.1.102`, and CIDR format
support `192.168.1.0/24`. In particular, APISIX also fully supports IPv6
address matching: `::1`, `fe80::1`, `fe80::1/64`, etc.|"192.168.1.0/24"|
|remote_addrs|False, can't be used with `remote_addr` |Match Rules|The
`remote_addr` in the form of a non-empty list indicates that multiple different
IP addresses are allowed, and match any one of them.|{"127.0.0.1",
"192.0.0.0/8", "::1"}|
|methods |False |Match Rules|If empty or without this option, there are no
`method` restrictions, and it can be a combination of one or more:
`GET`,`POST`,`PUT`,`DELETE`,`PATCH`,
`HEAD`,`OPTIONS`,`CONNECT`,`TRACE`.|{"GET", "POST"}|
-|priority |False |Match Rules|If different routes contain the same `uri`,
determine which route is matched first based on the attribute` priority`.
Larger value means higher priority. The default value is 0.|priority = 10|
+|priority |False |Match Rules|If different routes contain the same `uri`,
determine which route is matched first based on the attribute `priority`.
Larger value means higher priority. The default value is 0.|priority = 10|
|vars |False |Match Rules |A list of one or more `{var, operator, val}`
elements, like this: `{{var, operator, val}, {var, operator, val}, ...}}`. For
example: `{"arg_name", "==", "json"}` means that the current request parameter
`name` is `json`. The `var` here is consistent with the internal variable name
of Nginx, so you can also use `request_uri`, `host`, etc. For more details, see
[lua-resty-expr](https://github.com/api7/lua-resty-expr) |{{"arg_name", "==",
"json"}, {"arg_age [...]
|filter_func|False|Match Rules|User-defined filtering function. You can use it
to achieve matching requirements for special scenarios. This function accepts
an input parameter named `vars` by default, which you can use to get Nginx
variables.|function(vars) return vars["arg_name"] == "json" end|
|plugins |False |Plugin|See [Plugin](architecture-design.md#plugin) for more
||
diff --git a/doc/discovery.md b/doc/discovery.md
index 91218c4..67c7e13 100644
--- a/doc/discovery.md
+++ b/doc/discovery.md
@@ -61,7 +61,7 @@ It is very easy for APISIX to extend the discovery client,
the basic steps are a
First, add [`eureka.lua`](../apisix/discovery/eureka.lua) in the
`apisix/discovery/` directory;
-Then implement the `_M.init_worker()` function for initialization and the
`_M.nodes(service_name)` function for obtaining the list of service instance
nodes in ` eureka.lua`:
+Then implement the `_M.init_worker()` function for initialization and the
`_M.nodes(service_name)` function for obtaining the list of service instance
nodes in `eureka.lua`:
```lua
local _M = {
diff --git a/doc/plugins/proxy-rewrite.md b/doc/plugins/proxy-rewrite.md
index 8dcf2a3..05a8c13 100644
--- a/doc/plugins/proxy-rewrite.md
+++ b/doc/plugins/proxy-rewrite.md
@@ -37,7 +37,7 @@ The `proxy-rewrite` is an upstream proxy information
rewriting plugin, which sup
| --------- | ------------- | ----------- | ------- | ----------------- |
------------------------------------------------------------ |
| scheme | string | optional | "http" | ["http", "https"] |
Upstream new `schema` forwarding protocol. |
| uri | string | optional | | |
Upstream new `uri` forwarding address. Supports the use of [Nginx
variables](https://nginx.org/en/docs/http/ngx_http_core_module.html). Variables
must start with `$`, such as `$arg_name`. |
-| regex_uri | array[string] | optional | | |
Upstream new `uri` forwarding address. Use regular expression to match URL from
client, when the match is successful, the URL template will be forwarded
upstream. If the match is not successful, the URL from the client will be
forwarded to the upstream. When `uri` and` regex_uri` are both exist, `uri` is
used first. For example: [" ^/iresty/(.*)/(.*)/(.*)", "/$1-$2-$3"], the first
element represents the matching re [...]
+| regex_uri | array[string] | optional | | |
Upstream new `uri` forwarding address. Use regular expression to match URL from
client, when the match is successful, the URL template will be forwarded
upstream. If the match is not successful, the URL from the client will be
forwarded to the upstream. When `uri` and `regex_uri` are both exist, `uri` is
used first. For example: [" ^/iresty/(.*)/(.*)/(.*)", "/$1-$2-$3"], the first
element represents the matching re [...]
| host | string | optional | | |
Upstream new `host` forwarding address, example `iresty.com`. |
| headers | object | optional | | |
Forward to the new `headers` of the upstream, can set up multiple. If it
exists, will rewrite the header, otherwise will add the header. You can set the
corresponding value to an empty string to remove a header. Support the use of
Nginx variables. Need to start with `$`, such as `client_addr: $remote_addr`:
it means that the request header `client_addr` is the client IP. |
diff --git a/doc/plugins/wolf-rbac.md b/doc/plugins/wolf-rbac.md
index 78935c9..6472d12 100644
--- a/doc/plugins/wolf-rbac.md
+++ b/doc/plugins/wolf-rbac.md
@@ -37,7 +37,7 @@ The rbac feature is provided by
[wolf](https://github.com/iGeeky/wolf). For more
| Name | Type | Requirement | Default | Valid |
Description |
| ------------- | ------ | ----------- | ------------------------ | ----- |
--------------------------------------------------------- |
-| server | string | optional | "http://127.0.0.1:10080"; | |
Set the service address of` wolf-server`. |
+| server | string | optional | "http://127.0.0.1:10080"; | |
Set the service address of `wolf-server`. |
| appid | string | optional | "unset" | |
Set the app id. The app id must be added in wolf-console. |
| header_prefix | string | optional | "X-" | |
prefix of custom HTTP header. After authentication is successful, three headers
will be added to the request header (for backend) and response header (for
frontend): `X-UserId`, `X-Username`, `X-Nickname`. |
