This is an automated email from the ASF dual-hosted git repository.
jin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
The following commit(s) were added to refs/heads/master by this push:
new 18547af3 doc: added cypher api (#280)
18547af3 is described below
commit 18547af3fa0faa940b1929f92fdda8d99394a082
Author: Bond <[email protected]>
AuthorDate: Mon Jul 31 23:55:30 2023 +0800
doc: added cypher api (#280)
---------
Co-authored-by: imbajin <[email protected]>
---
content/cn/docs/SUMMARY.md | 1 +
content/cn/docs/clients/restful-api/_index.md | 2 +
content/cn/docs/clients/restful-api/auth.md | 66 +++++++--------
content/cn/docs/clients/restful-api/cypher.md | 115 +++++++++++++++++++++++++
content/cn/docs/clients/restful-api/other.md | 6 +-
content/en/docs/SUMMARY.md | 1 +
content/en/docs/clients/restful-api/_index.md | 2 +
content/en/docs/clients/restful-api/auth.md | 66 +++++++--------
content/en/docs/clients/restful-api/cypher.md | 117 ++++++++++++++++++++++++++
content/en/docs/clients/restful-api/other.md | 6 +-
10 files changed, 310 insertions(+), 72 deletions(-)
diff --git a/content/cn/docs/SUMMARY.md b/content/cn/docs/SUMMARY.md
index 050e1b82..558da672 100644
--- a/content/cn/docs/SUMMARY.md
+++ b/content/cn/docs/SUMMARY.md
@@ -34,6 +34,7 @@
* [Graphs](clients/restful-api/graphs.md)
* [Task](clients/restful-api/task.md)
* [Gremlin](clients/restful-api/gremlin.md)
+ * [Cypher](clients/restful-api/cypher.md)
* [Authentication](clients/restful-api/auth.md)
* [Other](clients/restful-api/other.md)
* [Java Client](clients/hugegraph-client.md)
diff --git a/content/cn/docs/clients/restful-api/_index.md
b/content/cn/docs/clients/restful-api/_index.md
index d2639585..85788b66 100644
--- a/content/cn/docs/clients/restful-api/_index.md
+++ b/content/cn/docs/clients/restful-api/_index.md
@@ -39,6 +39,8 @@ HugeGraph-Server通过HugeGraph-API基于HTTP协议为Client提供操作图的
[comment]: <> (- [Gremlin](restful-api/gremlin.md))
+[comment]: <> (- [Cypher](restful-api/cypher.md))
+
[comment]: <> (- [Authentication](restful-api/auth.md))
[comment]: <> (- [Other](restful-api/other.md))
diff --git a/content/cn/docs/clients/restful-api/auth.md
b/content/cn/docs/clients/restful-api/auth.md
index 45b55c23..2064a202 100644
--- a/content/cn/docs/clients/restful-api/auth.md
+++ b/content/cn/docs/clients/restful-api/auth.md
@@ -1,10 +1,10 @@
---
title: "Authentication API"
linkTitle: "Authentication"
-weight: 15
+weight: 16
---
-### 9.1 用户认证与权限控制
+### 10.1 用户认证与权限控制
> 开启权限及相关配置请先参考 [权限配置](/docs/config/config-authentication/) 文档
@@ -23,10 +23,10 @@ city: Beijing})
##### 接口说明：
用户认证与权限控制接口包括5类：UserAPI、GroupAPI、TargetAPI、BelongAPI、AccessAPI。
-### 9.2 用户（User）API
+### 10.2 用户（User）API
用户接口包括：创建用户，删除用户，修改用户，和查询用户相关信息接口。
-#### 9.2.1 创建用户
+#### 10.2.1 创建用户
##### Params
@@ -76,7 +76,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/users
}
```
-#### 9.2.2 删除用户
+#### 10.2.2 删除用户
##### Params
@@ -101,7 +101,7 @@ DELETE
http://localhost:8080/graphs/hugegraph/auth/users/-63:test
1
```
-#### 9.2.3 修改用户
+#### 10.2.3 修改用户
##### Params
@@ -143,7 +143,7 @@ PUT
http://localhost:8080/graphs/hugegraph/auth/users/-63:test
}
```
-#### 9.2.4 查询用户列表
+#### 10.2.4 查询用户列表
##### Params
@@ -179,7 +179,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/users
}
```
-#### 9.2.5 查询某个用户
+#### 10.2.5 查询某个用户
##### Params
@@ -214,7 +214,7 @@ GET
http://localhost:8080/graphs/hugegraph/auth/users/-63:admin
}
```
-#### 9.2.6 查询某个用户的角色
+#### 10.2.6 查询某个用户的角色
##### Method & Url
@@ -246,11 +246,11 @@ GET
http://localhost:8080/graphs/hugegraph/auth/users/-63:boss/role
}
```
-### 9.3 用户组（Group）API
+### 10.3 用户组（Group）API
用户组会赋予相应的资源权限，用户会被分配不同的用户组，即可拥有不同的资源权限。
用户组接口包括：创建用户组，删除用户组，修改用户组，和查询用户组相关信息接口。
-#### 9.3.1 创建用户组
+#### 10.3.1 创建用户组
##### Params
@@ -292,7 +292,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/groups
}
```
-#### 9.3.2 删除用户组
+#### 10.3.2 删除用户组
##### Params
@@ -317,7 +317,7 @@ DELETE
http://localhost:8080/graphs/hugegraph/auth/groups/-69:grant
1
```
-#### 9.3.3 修改用户组
+#### 10.3.3 修改用户组
##### Params
@@ -357,7 +357,7 @@ PUT
http://localhost:8080/graphs/hugegraph/auth/groups/-69:grant
}
```
-#### 9.3.4 查询用户组列表
+#### 10.3.4 查询用户组列表
##### Params
@@ -392,7 +392,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/groups
}
```
-#### 9.3.5 查询某个用户组
+#### 10.3.5 查询某个用户组
##### Params
@@ -423,12 +423,12 @@ GET
http://localhost:8080/graphs/hugegraph/auth/groups/-69:all
}
```
-### 9.4 资源（Target）API
+### 10.4 资源（Target）API
资源描述了图数据库中的数据，比如符合某一类条件的顶点，每一个资源包括type、label、properties三个要素，共有18种type、
任意label、任意properties的组合形成的资源，一个资源的内部条件是且关系，多个资源之间的条件是或关系。
资源接口包括：资源的创建、删除、修改和查询。
-#### 9.4.1 创建资源
+#### 10.4.1 创建资源
##### Params
- target_name: 资源名称
@@ -494,7 +494,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/targets
}
```
-#### 9.4.2 删除资源
+#### 10.4.2 删除资源
##### Params
@@ -519,7 +519,7 @@ DELETE
http://localhost:8080/graphs/hugegraph/auth/targets/-77:gremlin
1
```
-#### 9.4.3 修改资源
+#### 10.4.3 修改资源
##### Params
@@ -574,7 +574,7 @@ PUT
http://localhost:8080/graphs/hugegraph/auth/targets/-77:gremlin
}
```
-#### 9.4.4 查询资源列表
+#### 10.4.4 查询资源列表
##### Params
@@ -633,7 +633,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/targets
}
```
-#### 9.4.5 查询某个资源
+#### 10.4.5 查询某个资源
##### Params
@@ -672,11 +672,11 @@ GET
http://localhost:8080/graphs/hugegraph/auth/targets/-77:grant
}
```
-### 9.5 关联角色（Belong）API
+### 10.5 关联角色（Belong）API
关联用户和用户组的关系，一个用户可以关联一个或者多个用户组。用户组拥有相关资源的权限，不同用户组的资源权限可以理解为不同的角色。即给用户关联角色。
关联角色接口包括：用户关联角色的创建、删除、修改和查询。
-#### 9.5.1 创建用户的关联角色
+#### 10.5.1 创建用户的关联角色
##### Params
@@ -719,7 +719,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/belongs
}
```
-#### 9.5.2 删除关联角色
+#### 10.5.2 删除关联角色
##### Params
@@ -743,7 +743,7 @@ DELETE
http://localhost:8080/graphs/hugegraph/auth/belongs/S-63:boss>-82>>S-69:g
1
```
-#### 9.5.3 修改关联角色
+#### 10.5.3 修改关联角色
关联角色只能修改描述，不能修改 user 和 group 属性，如果需要修改关联角色，需要删除原来关联关系，新增关联角色。
##### Params
@@ -784,7 +784,7 @@ PUT
http://localhost:8080/graphs/hugegraph/auth/belongs/S-63:boss>-82>>S-69:gran
}
```
-#### 9.5.4 查询关联角色列表
+#### 10.5.4 查询关联角色列表
##### Params
@@ -820,7 +820,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/belongs
}
```
-#### 9.5.5 查看某个关联角色
+#### 10.5.5 查看某个关联角色
##### Params
@@ -851,11 +851,11 @@ GET
http://localhost:8080/graphs/hugegraph/auth/belongs/S-63:boss>-82>>S-69:all
}
```
-### 9.6 赋权（Access）API
+### 10.6 赋权（Access）API
给用户组赋予资源的权限，主要包含：读操作(READ)、写操作(WRITE)、删除操作(DELETE)、执行操作(EXECUTE)等。
赋权接口包括：赋权的创建、删除、修改和查询。
-#### 9.6.1 创建赋权(用户组赋予资源的权限)
+#### 10.6.1 创建赋权(用户组赋予资源的权限)
##### Params
@@ -906,7 +906,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/accesses
}
```
-#### 9.6.2 删除赋权
+#### 10.6.2 删除赋权
##### Params
@@ -931,7 +931,7 @@ DELETE
http://localhost:8080/graphs/hugegraph/auth/accesses/S-69:all>-88>12>S-77
1
```
-#### 9.6.3 修改赋权
+#### 10.6.3 修改赋权
赋权只能修改描述，不能修改用户组、资源和权限许可，如果需要修改赋权的关系，可以删除原来的赋权关系，新增赋权。
##### Params
@@ -973,7 +973,7 @@ PUT
http://localhost:8080/graphs/hugegraph/auth/accesses/S-69:all>-88>12>S-77:al
}
```
-#### 9.6.4 查询赋权列表
+#### 10.6.4 查询赋权列表
##### Params
@@ -1009,7 +1009,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/accesses
}
```
-#### 9.6.5 查询某个赋权
+#### 10.6.5 查询某个赋权
##### Params
diff --git a/content/cn/docs/clients/restful-api/cypher.md
b/content/cn/docs/clients/restful-api/cypher.md
new file mode 100644
index 00000000..b3efdf63
--- /dev/null
+++ b/content/cn/docs/clients/restful-api/cypher.md
@@ -0,0 +1,115 @@
+---
+title: "Cypher API"
+linkTitle: "Cypher"
+weight: 15
+---
+
+### 9.1 Cypher
+
+#### 9.1.1 向HugeGraphServer发送Cypher语句（GET），同步执行
+
+##### Method & Url
+
+```javascript
+GET /graphs/{graph}/cypher?cypher={cypher}
+```
+
+##### Params
+- graph: 图名称
+- cypher: cypher语句
+
+
+##### 使用示例
+
+```javascript
+GET http://localhost:8080/graphs/hugecypher1/cypher?cypher=match(n:person)
return n.name as name order by n.name limit 1
+```
+
+##### Response Status
+
+```javascript
+200
+```
+##### Response Body
+
+```javascript
+{
+ "requestId": "766b9f48-2f10-40d9-951a-3027d0748ab7",
+ "status": {
+ "message": "",
+ "code": 200,
+ "attributes": {
+ }
+ },
+ "result": {
+ "data": [
+ {
+ "name": "hello"
+ }
+ ],
+ "meta": {
+ }
+ }
+}
+```
+
+#### 9.1.2 向HugeGraphServer发送Cypher语句（POST），同步执行
+
+
+##### Method & Url
+
+```javascript
+POST /graphs/{graph}/cypher
+```
+
+##### Params
+- graph: 图名称
+
+##### Body
+{cypher}
+- cypher: cypher语句
+
+注意：
+
+> 不是JSON格式，是纯文本的Cypher语句
+
+##### 使用示例
+
+```javascript
+POST http://localhost:8080/graphs/hugecypher1/cypher
+```
+
+###### Request Body
+
+```cypher
+match(n:person) return n.name as name order by n.name limit 1
+```
+##### Response Status
+
+```javascript
+200
+```
+##### Response Body
+
+```javascript
+{
+ "requestId": "f096bee0-e249-498f-b5a3-ea684fc84f57",
+ "status": {
+ "message": "",
+ "code": 200,
+ "attributes": {
+ }
+ },
+ "result": {
+ "data": [
+ {
+ "name": "hello"
+ }
+ ],
+ "meta": {
+ }
+ }
+}
+
+
+```
diff --git a/content/cn/docs/clients/restful-api/other.md
b/content/cn/docs/clients/restful-api/other.md
index 0d4a4014..eb00992f 100644
--- a/content/cn/docs/clients/restful-api/other.md
+++ b/content/cn/docs/clients/restful-api/other.md
@@ -1,12 +1,12 @@
---
title: "Other API"
linkTitle: "Other"
-weight: 16
+weight: 17
---
-### 10.1 Other
+### 11.1 Other
-#### 10.1.1 查看HugeGraph的版本信息
+#### 11.1.1 查看HugeGraph的版本信息
##### Method & Url
diff --git a/content/en/docs/SUMMARY.md b/content/en/docs/SUMMARY.md
index 0dcba9f3..ecb669c0 100644
--- a/content/en/docs/SUMMARY.md
+++ b/content/en/docs/SUMMARY.md
@@ -35,6 +35,7 @@
* [Graphs](clients/restful-api/graphs.md)
* [Task](clients/restful-api/task.md)
* [Gremlin](clients/restful-api/gremlin.md)
+ * [Cypher](clients/restful-api/cypher.md)
* [Authentication](clients/restful-api/auth.md)
* [Other](clients/restful-api/other.md)
* [Java Client](clients/hugegraph-client.md)
diff --git a/content/en/docs/clients/restful-api/_index.md
b/content/en/docs/clients/restful-api/_index.md
index 8e1b90eb..9265a345 100644
--- a/content/en/docs/clients/restful-api/_index.md
+++ b/content/en/docs/clients/restful-api/_index.md
@@ -38,6 +38,8 @@ HugeGraph-Server provides interfaces for clients to operate
on graphs based on t
[comment]: <> (- [Gremlin](restful-api/gremlin.md))
+[comment]: <> (- [Cypher](restful-api/cypher.md))
+
[comment]: <> (- [Authentication](restful-api/auth.md))
[comment]: <> (- [Other](restful-api/other.md))
diff --git a/content/en/docs/clients/restful-api/auth.md
b/content/en/docs/clients/restful-api/auth.md
index d644d8a0..3fb187fd 100644
--- a/content/en/docs/clients/restful-api/auth.md
+++ b/content/en/docs/clients/restful-api/auth.md
@@ -1,10 +1,10 @@
---
title: "Authentication API"
linkTitle: "Authentication"
-weight: 15
+weight: 16
---
-### 9.1 User Authentication and Access Control
+### 10.1 User Authentication and Access Control
> To enable authentication and related configurations, please refer to the
> [Authentication Configuration](/docs/config/config-authentication/)
> documentation.
@@ -18,10 +18,10 @@ Description: User 'boss' has read permission for people in
the 'graph1' graph fr
##### Interface Description:
The user authentication and access control interface includes 5 categories:
UserAPI, GroupAPI, TargetAPI, BelongAPI, AccessAPI.
-### 9.2 User (User) API
+### 10.2 User (User) API
The user interface includes APIs for creating users, deleting users, modifying
users, and querying user-related information.
-#### 9.2.1 Create User
+#### 10.2.1 Create User
##### Params
@@ -71,7 +71,7 @@ In the response message, the password is encrypted as
ciphertext.
}
```
-#### 9.2.2 Delete User
+#### 10.2.2 Delete User
##### Params
@@ -96,7 +96,7 @@ DELETE
http://localhost:8080/graphs/hugegraph/auth/users/-63:test
1
```
-#### 9.2.3 Modify User
+#### 10.2.3 Modify User
##### Params
@@ -139,7 +139,7 @@ The returned result is the entire user object including the
modified content.
}
```
-#### 9.2.4 Query User List
+#### 10.2.4 Query User List
##### Params
@@ -175,7 +175,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/users
}
```
-#### 9.2.5 Query a User
+#### 10.2.5 Query a User
##### Params
@@ -210,7 +210,7 @@ GET
http://localhost:8080/graphs/hugegraph/auth/users/-63:admin
}
```
-#### 9.2.6 Query Roles of a User
+#### 10.2.6 Query Roles of a User
##### Method & Url
@@ -242,11 +242,11 @@ GET
http://localhost:8080/graphs/hugegraph/auth/users/-63:boss/role
}
```
-### 9.3 Group (Group) API
+### 10.3 Group (Group) API
Groups grant corresponding resource permissions, and users are assigned to
different groups, thereby having different resource permissions.
The group interface includes APIs for creating groups, deleting groups,
modifying groups, and querying group-related information.
-#### 9.3.1 Create Group
+#### 10.3.1 Create Group
##### Params
@@ -288,7 +288,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/groups
}
```
-#### 9.3.2 Delete Group
+#### 10.3.2 Delete Group
##### Params
@@ -313,7 +313,7 @@ DELETE
http://localhost:8080/graphs/hugegraph/auth/groups/-69:grant
1
```
-#### 9.3.3 Modify Group
+#### 10.3.3 Modify Group
##### Params
@@ -354,7 +354,7 @@ The returned result is the entire group object including
the modified content.
}
```
-#### 9.3.4 Query Group List
+#### 10.3.4 Query Group List
##### Params
@@ -389,7 +389,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/groups
}
```
-#### 9.3.5 Query a Specific Group
+#### 10.3.5 Query a Specific Group
##### Params
@@ -420,11 +420,11 @@ GET
http://localhost:8080/graphs/hugegraph/auth/groups/-69:all
}
```
-### 9.4 Resource (Target) API
+### 10.4 Resource (Target) API
Resources describe data in the graph database, such as vertices that meet
certain criteria. Each resource includes three elements: type, label, and
properties. There are 18 types in total, and the combination of any label and
any properties forms a resource. The internal conditions of a resource are
based on the AND relationship, while the conditions between multiple resources
are based on the OR relationship.
The resource API includes creating, deleting, modifying, and querying
resources.
-#### 9.4.1 Create Resource
+#### 10.4.1 Create Resource
##### Params
- target_name: Name of the resource
@@ -489,7 +489,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/targets
}
```
-#### 9.4.2 Delete Resource
+#### 10.4.2 Delete Resource
##### Params
@@ -513,7 +513,7 @@ DELETE
http://localhost:8080/graphs/hugegraph/auth/targets/-77:gremlin
1
```
-#### 9.4.3 Modify Resource
+#### 10.4.3 Modify Resource
##### Params
@@ -568,7 +568,7 @@ The response contains the entire target group object,
including the modified con
}
```
-#### 9.4.4 Query Resource List
+#### 10.4.4 Query Resource List
##### Params
@@ -627,7 +627,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/targets
}
```
-#### 9.4.5 Query a Specific Resource
+#### 10.4.5 Query a Specific Resource
##### Params
@@ -666,12 +666,12 @@ GET
http://localhost:8080/graphs/hugegraph/auth/targets/-77:grant
}
```
-### 9.5 Association of Roles (Belong) API
+### 10.5 Association of Roles (Belong) API
The association between users and user groups allows a user to be associated
with one or more user groups. User groups have permissions for related
resources, and the permissions for different user groups can be understood as
different roles. In other words, users are associated with roles.
The API for associating roles includes creating, deleting, modifying, and
querying the association of roles for users.
-#### 9.5.1 Create an Association of Roles for a User
+#### 10.5.1 Create an Association of Roles for a User
##### Params
@@ -714,7 +714,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/belongs
}
```
-#### 9.5.2 Delete an Association of Roles
+#### 10.5.2 Delete an Association of Roles
##### Params
@@ -738,7 +738,7 @@ DELETE
http://localhost:8080/graphs/hugegraph/auth/belongs/S-63:boss>-82>>S-69:g
1
```
-#### 9.5.3 Modify an Association of Roles
+#### 10.5.3 Modify an Association of Roles
An association of roles can only be modified for its description. The `user`
and `group` properties cannot be modified. If you need to modify an association
of roles, you need to delete the existing association and create a new one.
@@ -780,7 +780,7 @@ The response includes the modified content as well as the
entire association of
}
```
-#### 9.5.4 Query List of Associations of Roles
+#### 10.5.4 Query List of Associations of Roles
##### Params
@@ -816,7 +816,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/belongs
}
```
-#### 9.5.5 View a Specific Association of Roles
+#### 10.5.5 View a Specific Association of Roles
##### Params
@@ -847,11 +847,11 @@ GET
http://localhost:8080/graphs/hugegraph/auth/belongs/S-63:boss>-82>>S-69:all
}
```
-### 9.6 Authorization (Access) API
+### 10.6 Authorization (Access) API
Grant permissions to user groups for resources, including operations such as
READ, WRITE, DELETE, EXECUTE, etc.
The authorization API includes: creating, deleting, modifying, and querying
permissions.
-#### 9.6.1 Create Authorization (Granting permissions to user groups for
resources)
+#### 10.6.1 Create Authorization (Granting permissions to user groups for
resources)
##### Params
@@ -902,7 +902,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/accesses
}
```
-#### 9.6.2 Delete Authorization
+#### 10.6.2 Delete Authorization
##### Params
@@ -926,7 +926,7 @@ DELETE
http://localhost:8080/graphs/hugegraph/auth/accesses/S-69:all>-88>12>S-77
1
```
-#### 9.6.3 Modify Authorization
+#### 10.6.3 Modify Authorization
Authorization can only be modified for its description. User group, resource,
and permission cannot be modified. If you need to modify the relationship of
the authorization, you can delete the original authorization relationship and
create a new one.
##### Params
@@ -968,7 +968,7 @@ Modify access_description
}
```
-#### 9.6.4 Query Authorization List
+#### 10.6.4 Query Authorization List
##### Params
@@ -1004,7 +1004,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/accesses
}
```
-#### 9.6.5 Query a Specific Authorization
+#### 10.6.5 Query a Specific Authorization
##### Params
diff --git a/content/en/docs/clients/restful-api/cypher.md
b/content/en/docs/clients/restful-api/cypher.md
new file mode 100644
index 00000000..7ce3a972
--- /dev/null
+++ b/content/en/docs/clients/restful-api/cypher.md
@@ -0,0 +1,117 @@
+---
+title: "Cypher API"
+linkTitle: "Cypher"
+weight: 15
+---
+
+### 9.1 Cypher
+
+#### 9.1.1 Sending a cypher statement (GET) to HugeGraphServer for synchronous
execution
+
+##### Method & Url
+
+```javascript
+GET /graphs/{graph}/cypher?cypher={cypher}
+```
+
+##### Params
+- graph: Graph name
+- cypher: Cypher statement
+
+
+##### Example
+
+```javascript
+GET http://localhost:8080/graphs/hugecypher1/cypher?cypher=match(n:person)
return n.name as name order by n.name limit 1
+```
+
+##### Response Status
+
+```javascript
+200
+```
+##### Response Body
+
+```javascript
+{
+ "requestId": "766b9f48-2f10-40d9-951a-3027d0748ab7",
+ "status": {
+ "message": "",
+ "code": 200,
+ "attributes": {
+ }
+ },
+ "result": {
+ "data": [
+ {
+ "name": "hello"
+ }
+ ],
+ "meta": {
+ }
+ }
+}
+
+
+```
+
+#### 9.1.2 Sending a cypher statement (POST) to HugeGraphServer for
synchronous execution
+
+
+##### Method & Url
+
+```javascript
+POST /graphs/{graph}/cypher
+```
+
+##### Params
+- graph: Graph name
+
+##### Body
+{cypher}
+- cypher: Cypher statement
+
+Note:
+
+> It is not in JSON format, but a plain text Cypher statement.
+
+##### Example
+
+```javascript
+POST http://localhost:8080/graphs/hugecypher1/cypher
+```
+
+###### Request Body
+
+```cypher
+match(n:person) return n.name as name order by n.name limit 1
+```
+##### Response Status
+
+```javascript
+200
+```
+##### Response Body
+
+```javascript
+{
+ "requestId": "f096bee0-e249-498f-b5a3-ea684fc84f57",
+ "status": {
+ "message": "",
+ "code": 200,
+ "attributes": {
+ }
+ },
+ "result": {
+ "data": [
+ {
+ "name": "hello"
+ }
+ ],
+ "meta": {
+ }
+ }
+}
+
+
+```
diff --git a/content/en/docs/clients/restful-api/other.md
b/content/en/docs/clients/restful-api/other.md
index 8b100447..0dd61765 100644
--- a/content/en/docs/clients/restful-api/other.md
+++ b/content/en/docs/clients/restful-api/other.md
@@ -1,12 +1,12 @@
---
title: "Other API"
linkTitle: "Other"
-weight: 16
+weight: 17
---
-### 10.1 Other
+### 11.1 Other
-#### 10.1.1 View Version Information of HugeGraph
+#### 11.1.1 View Version Information of HugeGraph
##### Method & Url
