You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by sp...@apache.org on 2021/06/21 07:18:44 UTC

[apisix] branch master updated: docs: add GraphQL support to readme (#4450)

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 5162d73  docs: add GraphQL support to readme (#4450)
5162d73 is described below

commit 5162d7385e559de035c624b068065784844bf71a
Author: liuxiran <li...@apache.org>
AuthorDate: Mon Jun 21 15:18:09 2021 +0800

    docs: add GraphQL support to readme (#4450)
    
    Co-authored-by: 琚致远 <ju...@apache.org>
    Co-authored-by: 罗泽轩 <sp...@gmail.com>
---
 README.md                          |  1 +
 docs/en/latest/router-radixtree.md | 10 +++++-----
 docs/zh/latest/README.md           |  1 +
 3 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 2e4c4af..2725710 100644
--- a/README.md
+++ b/README.md
@@ -98,6 +98,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
   - Support [TTL](docs/en/latest/admin-api.md#route)
   - [Support priority](docs/en/latest/router-radixtree.md#3-match-priority)
   - [Support Batch Http Requests](docs/en/latest/plugins/batch-requests.md)
+  - [Support filtering route by GraphQL attributes](docs/en/latest/router-radixtree.md#how-to-filter-route-by-graphql-attributes)
 
 - **Security**
 
diff --git a/docs/en/latest/router-radixtree.md b/docs/en/latest/router-radixtree.md
index 9ddfcd7..d94d8a7 100644
--- a/docs/en/latest/router-radixtree.md
+++ b/docs/en/latest/router-radixtree.md
@@ -218,15 +218,15 @@ $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f
 
 This route will require the request header `host` equal `iresty.com`, request cookie key `_device_id` equal `a66f0cdc4ba2df8c096f74c9110163a9` etc.
 
-### How to filter route by graphql attributes
+### How to filter route by GraphQL attributes
 
-APISIX supports filtering route by some attributes of graphql. Currently we support:
+APISIX supports filtering route by some attributes of GraphQL. Currently we support:
 
 * graphql_operation
 * graphql_name
 * graphql_root_fields
 
-For instance, with graphql like this:
+For instance, with GraphQL like this:
 
 ```graphql
 query getRepo {
@@ -264,7 +264,7 @@ $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f
 }'
 ```
 
-To prevent spending too much time reading invalid graphql request body, we only read the first 1 MiB
+To prevent spending too much time reading invalid GraphQL request body, we only read the first 1 MiB
 data from the request body. This limitation is configured via:
 
 ```yaml
@@ -273,4 +273,4 @@ graphql:
 
 ```
 
-If you need to pass a graphql body which is larger than the limitation, you can increase the value in `conf/config.yaml`.
+If you need to pass a GraphQL body which is larger than the limitation, you can increase the value in `conf/config.yaml`.
diff --git a/docs/zh/latest/README.md b/docs/zh/latest/README.md
index e6d69ae..2d5def5 100644
--- a/docs/zh/latest/README.md
+++ b/docs/zh/latest/README.md
@@ -102,6 +102,7 @@ A/B 测试、金丝雀发布(灰度发布)、蓝绿部署、限流限速、抵
   - 支持路由的[自动过期(TTL)](admin-api.md#route)
   - [支持路由的优先级](../../en/latest/router-radixtree.md#3-match-priority)
   - [支持批量 Http 请求](plugins/batch-requests.md)
+  - [支持通过GraphQL属性过滤路由](../../en/latest/router-radixtree.md#how-to-filter-route-by-graphql-attributes)
 
 - **安全防护**