fix: fix docs

Author: Tsukilc

content/cn/docs/clients/restful-api/_index.md

@@ -9,6 +9,7 @@ weight: 1
 > - HugeGraph 1.7.0+ 引入了图空间功能，API 路径格式为：`/graphspaces/{graphspace}/graphs/{graph}`
 > - HugeGraph 1.5.x 及之前版本使用旧路径：`/graphs/{graph}`, 以及创建/克隆图的 api 使用 text/plain 作为 Content-Type, 1.7.0 及之后使用 json
 > - 默认图空间名称为 `DEFAULT`,可直接使用
+> - 旧版本 doc 参考：[HugeGraph 1.5.x RESTful API](https://github.com/apache/incubator-hugegraph-doc/tree/release-1.5.0)
 
 除了下方的文档，你还可以通过 `localhost:8080/swagger-ui/index.html` 访问 `swagger-ui` 以查看 `RESTful API`。[示例可以参考此处](/cn/docs/quickstart/hugegraph/hugegraph-server#swaggerui-example)
 

content/cn/docs/clients/restful-api/auth.md

@@ -22,6 +22,7 @@ city: Beijing})
 
 ##### 接口说明：
 用户认证与权限控制接口包括 5 类：UserAPI、GroupAPI、TargetAPI、BelongAPI、AccessAPI。
+**注意**: 1.5.0 及之前，group/target 等 id 的格式类似 -69:grant，1.7.0 及之后，id 和 name 一致，如 admin [HugeGraph 1.5.x RESTful API](https://github.com/apache/incubator-hugegraph-doc/tree/release-1.5.0)
 
 ### 10.2 用户（User）API
 用户接口包括：创建用户，删除用户，修改用户，和查询用户相关信息接口。

content/cn/docs/clients/restful-api/graphspace.md

@@ -2,6 +2,7 @@
 title: "Graphspace API"
 linkTitle: "Graphspace"
 weight: 1
+description: "Graphspace（图空间）REST 接口：多租户与资源隔离的创建、查看、更新与删除，以及使用前置条件与限制。"
 ---
 
 ### 2.0 Graphspace
@@ -73,8 +74,8 @@ POST http://localhost:8080/graphspaces
   "name": "gs1",
   "description": "1st graph space",
   "cpu_limit": 1000,
-  "memory_limit": 1024,
-  "storage_limit": 1000,
+  "memory_limit": 8192,
+  "storage_limit": 1000000,
   "compute_cpu_limit": 0,
   "compute_memory_limit": 0,
   "oltp_namespace": "hugegraph-server",
@@ -145,8 +146,8 @@ GET http://localhost:8080/graphspaces/gs1
   "name": "gs1",
   "description": "1st graph space",
   "cpu_limit": 1000,
-  "memory_limit": 1024,
-  "storage_limit": 1000,
+  "memory_limit": 8192,
+  "storage_limit": 1000000,
   "oltp_namespace": "hugegraph-server",
   "olap_namespace": "hugegraph-server",
   "storage_namespace": "hugegraph-server",
@@ -237,17 +238,17 @@ PUT http://localhost:8080/graphspaces/gs1
   "name": "gs1",
   "description": "1st graph space",
   "cpu_limit": 2000,
-  "memory_limit": 1024,
-  "storage_limit": 1000,
+  "memory_limit": 40960,
+  "storage_limit": 2048,
   "oltp_namespace": "hugegraph-server",
   "olap_namespace": "hugegraph-server",
   "storage_namespace": "hugegraph-server",
   "operator_image_path": "127.0.0.1/hugegraph-registry/hugegraph-computer-operator:3.1.1",
   "internal_algorithm_image_url": "127.0.0.1/hugegraph-registry/hugegraph-computer-algorithm:3.1.1",
   "compute_cpu_limit": 0,
   "compute_memory_limit": 0,
-  "max_graph_number": 100,
-  "max_role_number": 10,
+  "max_graph_number": 1000,
+  "max_role_number": 100,
   "cpu_used": 0,
   "memory_used": 0,
   "storage_used": 0,

content/en/docs/clients/restful-api/_index.md

@@ -9,6 +9,8 @@ weight: 1
 > - HugeGraph 1.7.0+ introduces graphspaces, and REST paths follow `/graphspaces/{graphspace}/graphs/{graph}`.
 > - HugeGraph 1.5.x and earlier still rely on the legacy `/graphs/{graph}` path, and the create/clone graph APIs require `Content-Type: text/plain`; 1.7.0+ expects JSON bodies.
 > - The default graphspace name is `DEFAULT`, which you can use directly if you do not need multi-tenant isolation.
+> - **Note**: Before version 1.5.0, the format of ids such as group/target was similar to -69:grant. After version 1.7.0, the id and name were consistent, such as admin [HugeGraph 1.5.x RESTful API](https://github.com/apache/incubator-hugegraph-doc/tree/release-1.5.0)
+
 
 Besides the documentation below, you can also open `swagger-ui` at `localhost:8080/swagger-ui/index.html` to explore the RESTful API. [Here is an example](/docs/quickstart/hugegraph/hugegraph-server#swaggerui-example)
 

content/en/docs/clients/restful-api/auth.md

@@ -17,6 +17,7 @@ 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.
+**Note** Before 1.5.0, the format of ids such as group/target was similar to -69:grant. After 1.7.0, the id and name were consistent. Such as admin [HugeGraph 1.5 x RESTful API](https://github.com/apache/incubator-hugegraph-doc/tree/release-1.5.0)
 
 ### 10.2 User (User) API
 The user interface includes APIs for creating users, deleting users, modifying users, and querying user-related information.

content/en/docs/clients/restful-api/cypher.md

@@ -11,18 +11,31 @@ weight: 15
 ##### Method & Url
 
 ```javascript
-GET /graphs/{graph}/cypher?cypher={cypher}
+GET / graphspaces / {graphspace}
+/graphs/
+{
+    graph
+}
+/cypher?cypher={cypher}
 ```
 
 ##### Params
+
+**Path parameters**
+
+- graphspace: Graphspace name
 - graph: Graph name
+
+**Query parameters**
+
 - 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
+GET
+http://localhost:8080/graphspaces/DEFAULT/graphs/hugecypher1/cypher?cypher=match(n:person) return n.name as name order by n.name limit 1
 ```
 
 ##### Response Status
@@ -61,10 +74,19 @@ GET http://localhost:8080/graphs/hugecypher1/cypher?cypher=match(n:person) retur
 ##### Method & Url
 
 ```javascript
-POST /graphs/{graph}/cypher
+POST / graphspaces / {graphspace}
+/graphs/
+{
+    graph
+}
+/cypher
 ```
 
 ##### Params
+
+**Path parameters**
+
+- graphspace: Graphspace name
 - graph: Graph name
 
 ##### Body
@@ -78,7 +100,8 @@ Note:
 ##### Example
 
 ```javascript
-POST http://localhost:8080/graphs/hugecypher1/cypher
+POST
+http://localhost:8080/graphspaces/DEFAULT/graphs/hugecypher1/cypher
 ```
 
 ###### Request Body

content/en/docs/clients/restful-api/graphs.md

@@ -8,12 +8,18 @@ weight: 12
 
 **Important Reminder**: Since HugeGraph 1.7.0, dynamic graph creation must enable authentication mode. For non-authentication mode, please refer to [Graph Configuration File](https://hugegraph.apache.org/docs/config/config-guide/#4-hugegraphproperties) to statically create graphs through configuration files.
 
-#### 6.1.1 List all graphs
+#### 6.1.1 List all graphs in the graphspace
+
+##### Params
+
+**Path parameters**
+
+- graphspace: Graphspace name
 
 ##### Method & Url
 
 ```
-GET http://localhost:8080/graphs
+GET http://localhost:8080/graphspaces/DEFAULT/graphs
 ```
 
 ##### Response Status
@@ -35,6 +41,13 @@ GET http://localhost:8080/graphs
 
 #### 6.1.2 Get details of the graph
 
+##### Params
+
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
+
 ##### Method & Url
 
 ```
@@ -56,15 +69,18 @@ GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph
 }
 ```
 
-#### 6.1.3 Clear all data of a graph, include: schema, vertex, edge and index .etc.,**This operation
-
-requires administrator privileges**
+#### 6.1.3 Clear all data of a graph, include: schema, vertex, edge and index, **This operation requires administrator privileges**
 
 ##### Params
 
-Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the
-API to
-avoid false calls by users:
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
+
+**Query parameters**
+
+Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the API to avoid false calls by users:
 
 - confirm_message: default by `I'm sure to delete all data`
 
@@ -80,13 +96,18 @@ DELETE http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/clear?confirm_
 204
 ```
 
-#### 6.1.4 Clone graph,**this operation requires administrator privileges**
+#### 6.1.4 Clone graph, **this operation requires administrator privileges**
 
 ##### Params
 
-- clone_graph_name: name of an existed graph.
-  To clone from an existing graph, the user can choose to transfer the configuration file,
-  which will replace the configuration in the existing graph
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Name of the new graph to create
+
+**Query parameters**
+
+- clone_graph_name: name of an existed graph. To clone from an existing graph, the user can choose to transfer the configuration file, which will replace the configuration in the existing graph
 
 ##### Method & Url
 
@@ -128,7 +149,14 @@ Clone a `non-auth` mode graph (set `Content-Type: application/json`)
 }
 ```
 
-#### 6.1.5 Create graph,**this operation requires administrator privileges**
+#### 6.1.5 Create graph, **this operation requires administrator privileges**
+
+##### Params
+
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
 
 ##### Method & Url
 
@@ -170,13 +198,18 @@ Create a non-auth graph (set `Content-Type: application/json`)
 }
 ```
 
-#### 6.1.6 Delete graph and it's data
+#### 6.1.6 Delete graph and its data
 
 ##### Params
 
-Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the
-API to
-avoid false calls by users:
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
+
+**Query parameters**
+
+Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the API to avoid false calls by users:
 
 - confirm_message: default by `I'm sure to drop the graph`
 
@@ -196,7 +229,14 @@ DELETE http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph_clone?confirm_
 
 ### 6.2 Conf
 
-#### 6.2.1 Get configuration for a graph,**This operation requires administrator privileges**
+#### 6.2.1 Get configuration for a graph, **This operation requires administrator privileges**
+
+##### Params
+
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
 
 ##### Method & Url
 
@@ -255,7 +295,14 @@ Under normal circumstances, the graph mode is None. When you need to restore the
 you need to temporarily modify the graph mode to Restoring or Merging as needed.
 When you complete the restore, change the graph mode to None.
 
-#### 6.3.1 Get graph mode.
+#### 6.3.1 Get graph mode
+
+##### Params
+
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
 
 ##### Method & Url
 
@@ -281,6 +328,13 @@ GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/mode
 
 #### 6.3.2 Modify graph mode. **This operation requires administrator privileges**
 
+##### Params
+
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
+
 ##### Method & Url
 
 ```
@@ -309,11 +363,14 @@ PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/mode
 }
 ```
 
-#### 6.3.3 Get graph's read mode.
+#### 6.3.3 Get graph's read mode
 
 ##### Params
 
-- name: name of a graph
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
 
 ##### Method & Url
 
@@ -339,7 +396,10 @@ GET http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/graph_read_mode
 
 ##### Params
 
-- name: name of a graph
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
 
 ##### Method & Url
 
@@ -375,7 +435,10 @@ PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/graph_read_mode
 
 ##### Params
 
-- name: name of a graph
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
 
 ##### Method & Url
 
@@ -401,7 +464,10 @@ PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/snapshot_create
 
 ##### Params
 
-- name: name of a graph
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
 
 ##### Method & Url
 
@@ -425,11 +491,14 @@ PUT http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/snapshot_resume
 
 ### 6.5 Compact
 
-#### 6.5.1 Manually compact graph,**This operation requires administrator privileges**
+#### 6.5.1 Manually compact graph, **This operation requires administrator privileges**
 
 ##### Params
 
-- name: name of a graph
+**Path parameters**
+
+- graphspace: Graphspace name
+- graph: Graph name
 
 ##### Method & Url