[incubator-hugegraph-doc] branch master updated: doc: update gremlin config in graphs.md (#282)

Mon, 18 Sep 2023 02:51:19 -0700 

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 3baae60d doc: update gremlin config in graphs.md (#282)
3baae60d is described below

commit 3baae60dffe15f6e70b1e1bd26c8ad11530208cc
Author: badagou333 <[email protected]>
AuthorDate: Mon Sep 18 17:50:28 2023 +0800

    doc: update gremlin config in graphs.md (#282)
    
    line126:
    gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
    
    * enhance a string of style problem & fix package name
    
    ---------
    
    Co-authored-by: imbajin <[email protected]>
---
 content/cn/docs/clients/restful-api/graphs.md |  85 +++++++-------
 content/en/docs/clients/restful-api/graphs.md | 153 +++++++++++++-------------
 2 files changed, 120 insertions(+), 118 deletions(-)

diff --git a/content/cn/docs/clients/restful-api/graphs.md 
b/content/cn/docs/clients/restful-api/graphs.md
index e1d5a0ff..176c37ee 100644
--- a/content/cn/docs/clients/restful-api/graphs.md
+++ b/content/cn/docs/clients/restful-api/graphs.md
@@ -16,13 +16,13 @@ GET http://localhost:8080/graphs
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
     "graphs": [
         "hugegraph",
@@ -41,24 +41,24 @@ GET http://localhost:8080/graphs/hugegraph
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
     "name": "hugegraph",
     "backend": "cassandra"
 }
 ```
 
-#### 6.1.3 清空某个图的全部数据，包括schema、vertex、edge和index等，**该操作需要管理员权限**
+#### 6.1.3 清空某个图的全部数据，包括 schema、vertex、edge 和 index 等，**该操作需要管理员权限**
 
 ##### Params
 
-由于清空图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：
+由于清空图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：
 
 - confirm_message: 默认为`I'm sure to delete all data`
 
@@ -70,7 +70,7 @@ DELETE 
http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+t
 
 ##### Response Status
 
-```json
+```javascript
 204
 ```
 
@@ -86,10 +86,10 @@ DELETE 
http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+t
 POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph
 ```
 
-##### Request Body 【可选】
+##### Request Body【可选】
 
 ```
-gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph_clone
@@ -99,13 +99,13 @@ rocksdb.wal_path=./hg2
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
     "name": "hugegraph_clone",
     "backend": "rocksdb"
@@ -123,7 +123,7 @@ POST http://localhost:8080/graphs/hugegraph2
 ##### Request Body
 
 ```
-gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph2
@@ -133,13 +133,13 @@ rocksdb.wal_path=./hg2
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
     "name": "hugegraph2",
     "backend": "rocksdb"
@@ -150,7 +150,7 @@ rocksdb.wal_path=./hg2
 
 ##### Params
 
-由于删除图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：
+由于删除图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：
 
 - confirm_message: 默认为`I'm sure to drop the graph`
 
@@ -162,7 +162,7 @@ DELETE 
http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure
 
 ##### Response Status
 
-```json
+```javascript
 204
 ```
 
@@ -178,7 +178,7 @@ GET http://localhost:8080/graphs/hugegraph/conf
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
@@ -186,8 +186,7 @@ GET http://localhost:8080/graphs/hugegraph/conf
 
 ```properties
 # gremlin entrence to create graph
-gremlin.graph=com.baidu.hugegraph.HugeFactory
-
+gremlin.graph=org.apache.hugegraph.HugeFactory
 # cache config
 #schema.cache_capacity=1048576
 #graph.cache_capacity=10485760
@@ -202,20 +201,20 @@ backend=cassandra
 serializer=cassandra
 
 store=hugegraph
-...
+...=
 ```
 
 ### 6.3 Mode
 
 合法的图模式包括：NONE，RESTORING，MERGING，LOADING
-    
+
 - None 模式（默认），元数据和图数据的写入属于正常状态。特别的：
     - 元数据（schema）创建时不允许指定 ID
     - 图数据（vertex）在 id strategy 为 Automatic 时，不允许指定 ID
 - LOADING：批量导入数据时自动启用，特别的：
     - 添加顶点/边时，不会检查必填属性是否传入
 
-Restore 时存在两种不同的模式： Restoring 和 Merging
+Restore 时存在两种不同的模式：Restoring 和 Merging
 
 - Restoring 模式，恢复到一个新图中，特别的：
     - 元数据（schema）创建时允许指定 ID
@@ -224,10 +223,10 @@ Restore 时存在两种不同的模式： Restoring 和 Merging
     - 元数据（schema）创建时不允许指定 ID
     - 图数据（vertex）在 id strategy 为 Automatic 时，允许指定 ID
 
-正常情况下，图模式为 None，当需要 Restore 图时，需要根据需要临时修改图模式为 Restoring 模式或者 Merging 模式，并在完成 
Restore 时，恢复图模式为 None。
+正常情况下，图模式为 None，当需要 Restore 图时，需要根据需要临时修改图模式为 Restoring 模式或者 Merging
+模式，并在完成 Restore 时，恢复图模式为 None。
 
-
-#### 6.3.1 查看某个图的模式.
+#### 6.3.1 查看某个图的模式。
 
 ##### Method & Url
 
@@ -237,13 +236,13 @@ GET http://localhost:8080/graphs/hugegraph/mode
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
     "mode": "NONE"
 }
@@ -251,7 +250,7 @@ GET http://localhost:8080/graphs/hugegraph/mode
 
 > 合法的图模式包括：NONE，RESTORING，MERGING
 
-#### 6.3.2 设置某个图的模式. **该操作需要管理员权限**
+#### 6.3.2 设置某个图的模式。**该操作需要管理员权限**
 
 ##### Method & Url
 
@@ -269,19 +268,19 @@ PUT http://localhost:8080/graphs/hugegraph/mode
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
     "mode": "RESTORING"
 }
 ```
 
-#### 6.3.3 查看某个图的读模式.
+#### 6.3.3 查看某个图的读模式。
 
 ##### Params
 
@@ -295,19 +294,19 @@ GET http://localhost:8080/graphs/hugegraph/graph_read_mode
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
     "graph_read_mode": "ALL"
 }
 ```
 
-#### 6.3.4 设置某个图的读模式. **该操作需要管理员权限**
+#### 6.3.4 设置某个图的读模式。**该操作需要管理员权限**
 
 ##### Params
 
@@ -329,13 +328,13 @@ PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
     "graph_read_mode": "OLTP_ONLY"
 }
@@ -357,13 +356,13 @@ PUT http://localhost:8080/graphs/hugegraph/snapshot_create
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
     "hugegraph": "snapshot_created"
 }
@@ -383,13 +382,13 @@ PUT http://localhost:8080/graphs/hugegraph/snapshot_resume
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
     "hugegraph": "snapshot_resumed"
 }
@@ -411,13 +410,13 @@ PUT http://localhost:8080/graphs/hugegraph/compact
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
     "nodes": 1,
     "cluster_id": "local",
@@ -425,4 +424,4 @@ PUT http://localhost:8080/graphs/hugegraph/compact
         "local": "OK"
     }
 }
-```
\ No newline at end of file
+```
diff --git a/content/en/docs/clients/restful-api/graphs.md 
b/content/en/docs/clients/restful-api/graphs.md
index 82ca91d8..913a1d49 100644
--- a/content/en/docs/clients/restful-api/graphs.md
+++ b/content/en/docs/clients/restful-api/graphs.md
@@ -16,18 +16,18 @@ GET http://localhost:8080/graphs
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
-    "graphs": [
-        "hugegraph",
-        "hugegraph1"
-    ]
+  "graphs": [
+    "hugegraph",
+    "hugegraph1"
+  ]
 }
 ```
 
@@ -41,25 +41,28 @@ GET http://localhost:8080/graphs/hugegraph
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
-    "name": "hugegraph",
-    "backend": "cassandra"
+  "name": "hugegraph",
+  "backend": "cassandra"
 }
 ```
 
-#### 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 
.etc.,**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：
+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`
 
@@ -71,17 +74,17 @@ DELETE 
http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+t
 
 ##### Response Status
 
-```json
+```javascript
 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 exist 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
+- 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
 
@@ -92,7 +95,7 @@ POST 
http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph
 ##### Request Body [Optional]
 
 ```
-gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph_clone
@@ -102,20 +105,20 @@ rocksdb.wal_path=./hg2
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
-    "name": "hugegraph_clone",
-    "backend": "rocksdb"
+  "name": "hugegraph_clone",
+  "backend": "rocksdb"
 }
 ```
 
-#### 6.1.5 Create graph，**This operation requires administrator privileges**
+#### 6.1.5 Create graph,**This operation requires administrator privileges**
 
 ##### Method & Url
 
@@ -126,7 +129,7 @@ POST http://localhost:8080/graphs/hugegraph2
 ##### Request Body
 
 ```
-gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph2
@@ -136,16 +139,16 @@ rocksdb.wal_path=./hg2
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
-    "name": "hugegraph2",
-    "backend": "rocksdb"
+  "name": "hugegraph2",
+  "backend": "rocksdb"
 }
 ```
 
@@ -153,8 +156,9 @@ rocksdb.wal_path=./hg2
 
 ##### Params
 
-Since deleting a graph is a dangerous operation, we have added parameters for 
confirmation to the API to 
-avoid false calls by users：
+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`
 
@@ -166,13 +170,13 @@ DELETE 
http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure
 
 ##### Response Status
 
-```json
+```javascript
 204
 ```
 
 ### 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**
 
 ##### Method & Url
 
@@ -182,7 +186,7 @@ GET http://localhost:8080/graphs/hugegraph/conf
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
@@ -190,8 +194,7 @@ GET http://localhost:8080/graphs/hugegraph/conf
 
 ```properties
 # gremlin entrence to create graph
-gremlin.graph=com.baidu.hugegraph.HugeFactory
-
+gremlin.graph=org.apache.hugegraph.HugeFactory
 # cache config
 #schema.cache_capacity=1048576
 #graph.cache_capacity=10485760
@@ -206,30 +209,30 @@ backend=cassandra
 serializer=cassandra
 
 store=hugegraph
-...
+...=
 ```
 
 ### 6.3 Mode
 
-Allowed graph mode values are：NONE，RESTORING，MERGING，LOADING
-    
+Allowed graph mode values are: NONE, RESTORING, MERGING, LOADING
+
 - None mode is regular mode
-    - Not allowed create schema with specified id
-    - Not support create vertex with id for AUTOMATIC id strategy
+    - Not allowed to create schema with specified id
+    - Not support creating vertex with id for AUTOMATIC id strategy
 - LOADING mode used to load data via hugegraph-loader.
     - When adding vertices / edges, it is not checked whether the required 
attributes are passed in
 
-Restore has two different modes： Restoring and Merging
+Restore has two different modes: Restoring and Merging
 
-- Restoring mode is used to restore schema and graph data to an new graph.
+- Restoring mode is used to restore schema and graph data to a new graph.
     - Support create schema with specified id
     - Support create vertex with id for AUTOMATIC id strategy
 - Merging mode is used to merge schema and graph data to an existing graph.
-    - Not allowed create schema with specified id
+    - Not allowed to create schema with specified id
     - Support create vertex with id for AUTOMATIC id strategy
 
-Under normal circumstances, the graph mode is None. When you need to restore 
the graph, 
-you need to temporarily modify the graph mode to Restoring or Merging as 
needed. 
+Under normal circumstances, the graph mode is None. When you need to restore 
the graph,
+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.
@@ -242,19 +245,19 @@ GET http://localhost:8080/graphs/hugegraph/mode
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
-    "mode": "NONE"
+  "mode": "NONE"
 }
 ```
 
-> Allowed graph mode values are：NONE，RESTORING，MERGING
+> Allowed graph mode values are: NONE, RESTORING, MERGING
 
 #### 6.3.2 Modify graph mode. **This operation requires administrator 
privileges**
 
@@ -270,19 +273,19 @@ PUT http://localhost:8080/graphs/hugegraph/mode
 "RESTORING"
 ```
 
-> Allowed graph mode values are：NONE，RESTORING，MERGING
+> Allowed graph mode values are: NONE, RESTORING, MERGING
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
-    "mode": "RESTORING"
+  "mode": "RESTORING"
 }
 ```
 
@@ -300,15 +303,15 @@ GET http://localhost:8080/graphs/hugegraph/graph_read_mode
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
-    "graph_read_mode": "ALL"
+  "graph_read_mode": "ALL"
 }
 ```
 
@@ -330,19 +333,19 @@ PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
 "OLTP_ONLY"
 ```
 
-> Allowed read mode values are：ALL，OLTP_ONLY，OLAP_ONLY
+> Allowed read mode values are: ALL, OLTP_ONLY, OLAP_ONLY
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
-    "graph_read_mode": "OLTP_ONLY"
+  "graph_read_mode": "OLTP_ONLY"
 }
 ```
 
@@ -362,15 +365,15 @@ PUT http://localhost:8080/graphs/hugegraph/snapshot_create
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
-    "hugegraph": "snapshot_created"
+  "hugegraph": "snapshot_created"
 }
 ```
 
@@ -388,21 +391,21 @@ PUT http://localhost:8080/graphs/hugegraph/snapshot_resume
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
-    "hugegraph": "snapshot_resumed"
+  "hugegraph": "snapshot_resumed"
 }
 ```
 
 ### 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
 
@@ -416,18 +419,18 @@ PUT http://localhost:8080/graphs/hugegraph/compact
 
 ##### Response Status
 
-```json
+```javascript
 200
 ```
 
 ##### Response Body
 
-```json
+```javascript
 {
-    "nodes": 1,
-    "cluster_id": "local",
-    "servers": {
-        "local": "OK"
-    }
+  "nodes": 1,
+  "cluster_id": "local",
+  "servers": {
+    "local": "OK"
+  }
 }
 ```
\ No newline at end of file

Reply via email to