Skip to content

Commit

Permalink
doc: fix typos. (#1916)
Browse files Browse the repository at this point in the history
url -> URL .
  • Loading branch information
membphis committed Jul 29, 2020
1 parent fbc3c68 commit 4c61baa
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 17 deletions.
2 changes: 1 addition & 1 deletion FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ If using a proxy doesn't solve this problem, you can add `--verbose` option duri

## How to support gray release via APISIX?

An example, `foo.com/product/index.html?id=204&page=2`, gray release based on `id` in the query string in uri as a condition:
An example, `foo.com/product/index.html?id=204&page=2`, gray release based on `id` in the query string in URL as a condition:

1. Group A:id <= 1000
2. Group B:id > 1000
Expand Down
2 changes: 1 addition & 1 deletion FAQ_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ luarocks 服务。 运行 `luarocks config rocks_servers` 命令(这个命令

## 如何通过 APISIX 支持灰度发布?

比如,`foo.com/product/index.html?id=204&page=2`, 根据 uri 中 query string 中的 `id` 作为条件来灰度发布:
比如,`foo.com/product/index.html?id=204&page=2`, 根据 URL 中 query string 中的 `id` 作为条件来灰度发布:

1. A组:id <= 1000
2. B组:id > 1000
Expand Down
2 changes: 1 addition & 1 deletion doc/admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Config Example:
{
"id": "1", # id, unnecessary.
"uri": "/release/a", # uri
"uris": ["/a","/b"], # A set of uri, uri and uris need only have a non-empty one.
"uris": ["/a","/b"], # A set of uri, URL and uris need only have a non-empty one.
"methods": ["GET","POST"], # Can fill multiple methods
"host": "aa.com", # host
"hosts": ["a.com","b.com"], # A set of host. Host and hosts only need to be non-empty one.
Expand Down
6 changes: 3 additions & 3 deletions doc/architecture-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ We configure all the parameters directly in the Route, it's easy to set up, and

The shortcomings mentioned above are independently abstracted in APISIX by the two concepts [Service](#service) and [Upstream](#upstream).

The route example created below is to proxy the request with uri `/index.html` to the Upstream service with the address `39.97.63.215:80`:
The route example created below is to proxy the request with URL `/index.html` to the Upstream service with the address `39.97.63.215:80`:

```shell
$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
Expand Down Expand Up @@ -453,8 +453,8 @@ Set the route that best suits your business needs in the local configuration `co
* `Absolute match `: Complete match for the given `uri` , such as `/foo/bar`,`/foo/glo`.
* `Prefix match`: Use `*` at the end to represent the given `uri` as a prefix match. For example, `/foo*` allows matching `/foo/`, `/foo/a` and `/foo/b`.
* `match priority`: first try absolute match, if you can't hit absolute match, try prefix match.
* `Any filter attribute`: Allows you to specify any Ningx built-in variable as a filter, such as uri request parameters, request headers, cookies, and so on.
* `radixtree_host_uri`: Use `host + uri` as the primary index (based on the `radixtree` engine), matching both host and uri for the current request.
* `Any filter attribute`: Allows you to specify any Ningx built-in variable as a filter, such as URL request parameters, request headers, cookies, and so on.
* `radixtree_host_uri`: Use `host + uri` as the primary index (based on the `radixtree` engine), matching both host and URL for the current request.

* `apisix.router.ssl`: SSL loads the matching route.
* `radixtree_sni`: (Default) Use `SNI` (Server Name Indication) as the primary index (based on the radixtree engine).
Expand Down
2 changes: 1 addition & 1 deletion doc/discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ eureka:

## Upstream setting

Here is an example of routing a request with a uri of "/user/*" to a service which named "user-service" in the registry :
Here is an example of routing a request with a URL of "/user/*" to a service which named "user-service" in the registry :

```shell
$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
Expand Down
2 changes: 1 addition & 1 deletion doc/plugins/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ We fetch the metric data from the specified url `/apisix/prometheus/metrics`.
curl -i http://127.0.0.1:9080/apisix/prometheus/metrics
```

Puts this uri address into prometheus, and it will automatically fetch
Puts this URL address into prometheus, and it will automatically fetch
these metric data.

For example like this:
Expand Down
2 changes: 1 addition & 1 deletion doc/plugins/proxy-rewrite.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ upstream proxy info rewrite plugin.
|------- |-----|------|
|scheme |optional| Upstream new `schema` forwarding protocol,options can be `http` or `https`,default `http`.|
|uri |optional| Upstream new `uri` forwarding address.|
|regex_uri |optional| Upstream new `uri` forwarding address. Use regular expression to match uri from client, when the match is successful, the uri template will be forwarded upstream. If the match is not successful, the uri 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 regular expression and the second element represents the uri template that is forwarded to the upstream.|
|regex_uri |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 regular expression and the second element represents the URL template that is forwarded to the upstream.|
|host |optional| Upstream new `host` forwarding address, example `iresty.com`. |
|headers |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.|

Expand Down
2 changes: 1 addition & 1 deletion doc/plugins/redirect.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ URI redirect.

|Name |Requirement|Description|
|------- |-----|------|
|uri |required, need pick one from `uri` and `http_to_https`| New uri which can contain Nginx variable, eg: `/test/index.html`, `$uri/index.html`. You can refer to variables in a way similar to `${xxx}` to avoid ambiguity, eg: `${uri}foo/index.html`. If you just need the original `$` character, add `\` in front of it, like this one: `/\$foo/index.html`. If you refer to a variable name that does not exist, this will not produce an error, and it will be used as an empty string.|
|uri |required, need pick one from `uri` and `http_to_https`| New URL which can contain Nginx variable, eg: `/test/index.html`, `$uri/index.html`. You can refer to variables in a way similar to `${xxx}` to avoid ambiguity, eg: `${uri}foo/index.html`. If you just need the original `$` character, add `\` in front of it, like this one: `/\$foo/index.html`. If you refer to a variable name that does not exist, this will not produce an error, and it will be used as an empty string.|
|ret_code|optional, only works with `uri`|Response code, the default value is `302`.|
|http_to_https|required, need pick one from `uri` and `http_to_https`|Boolean value. The default value is `false`. When it is set to `ture` and the request is HTTP, will be automatically redirected to HTTPS with 301 response code, and the URI will keep the same as client request.|

Expand Down
6 changes: 3 additions & 3 deletions doc/zh-cn/admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
|DELETE |/apisix/admin/routes/{id}||删除资源|
|PATCH |/apisix/admin/routes/{id}|{...}|修改已有 Route 的部分内容,其他不涉及部分会原样保留;如果你要删除某个属性,将该属性的值设置为null 即可删除|

> uri 请求参数:
> URL 请求参数:
|名字 |可选项 |类型 |说明 |示例|
|---------|---------|----|-----------|----|
Expand Down Expand Up @@ -80,8 +80,8 @@ route 对象 json 配置内容:
```shell
{
"id": "1", # id,非必填
"uri": "/release/a", # uri 路径
"uris": ["/a","/b"], # 一组 uri 路径, uri 与 uris 只需要有一个非空即可
"uri": "/release/a", # URL 路径
"uris": ["/a","/b"], # 一组 URL 路径, URL 与 uris 只需要有一个非空即可
"methods": ["GET","POST"], # 可以填多个方法
"host": "aa.com", # host 域名
"hosts": ["a.com","b.com"], # 一组 host 域名, host 与 hosts 只需要有一个非空即可
Expand Down
4 changes: 2 additions & 2 deletions doc/zh-cn/architecture-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Route 中主要包含三部分内容:匹配规则(比如 uri、host、remote_a

上面提及重复的缺点在 APISIX 中独立抽象了 [Service](#service) 和 [Upstream](#upstream) 两个概念来解决。

下面创建的 Route 示例,是把 uri 为 "/index.html" 的请求代理到地址为 "39.97.63.215:80" 的 Upstream 服务:
下面创建的 Route 示例,是把 URL 为 "/index.html" 的请求代理到地址为 "39.97.63.215:80" 的 Upstream 服务:

```shell
$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
Expand Down Expand Up @@ -464,7 +464,7 @@ APISIX 区别于其他 API 网关的一大特点是允许用户选择不同 Rout
* `绝对匹配`:完整匹配给定的 `uri` ,比如 `/foo/bar``/foo/glo`
* `前缀匹配`:末尾使用 `*` 代表给定的 `uri` 是前缀匹配。比如 `/foo*`,则允许匹配 `/foo/``/foo/a``/foo/b`等。
* `匹配优先级`:优先尝试绝对匹配,若无法命中绝对匹配,再尝试前缀匹配。
* `任意过滤属性`:允许指定任何 Ningx 内置变量作为过滤条件,比如 uri 请求参数、请求头、cookie 等。
* `任意过滤属性`:允许指定任何 Ningx 内置变量作为过滤条件,比如 URL 请求参数、请求头、cookie 等。
* `radixtree_host_uri`: 使用 `host + uri` 作为主索引(基于 `radixtree` 引擎),对当前请求会同时匹配 host 和 uri,支持的匹配条件与 `radixtree_uri` 基本一致。

* `apisix.router.ssl`: SSL 加载匹配路由。
Expand Down
2 changes: 1 addition & 1 deletion doc/zh-cn/discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ eureka:

## upstream 配置

APISIX是通过 `upstream.service_name` 与注册中心的服务名进行关联。下面是将 uri 为 "/user/*" 的请求路由到注册中心名为 "USER-SERVICE" 的服务上例子:
APISIX是通过 `upstream.service_name` 与注册中心的服务名进行关联。下面是将 URL 为 "/user/*" 的请求路由到注册中心名为 "USER-SERVICE" 的服务上例子:

```shell
$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
Expand Down
3 changes: 2 additions & 1 deletion doc/zh-cn/plugins/http-logger.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
-->

# 目录

- [**定义**](#name)
- [**属性列表**](#attributes)
- [**如何开启**](#how-to-enable)
Expand Down Expand Up @@ -68,7 +69,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f13

## 测试插件

* 成功:
> 成功:
```shell
$ curl -i http://127.0.0.1:9080/hello
Expand Down

0 comments on commit 4c61baa

Please sign in to comment.