Skip to content
Permalink
Browse files
add schema api description (#85)
also adjust old docs

Change-Id: I595684d5ca20e8f34693b520836366df7c5535e5
  • Loading branch information
zhoney committed Sep 6, 2021
1 parent baa6503 commit 6af491813bda87baab4bed85f75ac7ded9d2257a
Showing 13 changed files with 403 additions and 85 deletions.
@@ -4,10 +4,12 @@ HugeGraph-Server通过HugeGraph-API基于HTTP协议为Client提供操作图的
图数据的增删改查,遍历算法,变量,图操作及其他操作。

- Graph Schema
- [Schema](restful-api/schema.md)
- [PropertyKey](restful-api/propertykey.md)
- [VertexLabel](restful-api/vertexlabel.md)
- [EdgeLabel](restful-api/edgelabel.md)
- [IndexLabel](restful-api/indexlabel.md)
- [Rebuild](restful-api/rebuild.md)
- Graph Vertex & Edge
- [Vertex](restful-api/vertex.md)
- [Edge](restful-api/edge.md)
@@ -1,4 +1,4 @@
### 8.1 用户认证与权限控制
### 9.1 用户认证与权限控制

> 开启权限及相关配置请先参考 [权限配置](../../config/config-authentication.md) 文档
@@ -17,10 +17,10 @@ city: Beijing})
##### 接口说明:
用户认证与权限控制接口包括5类:UserAPI、GroupAPI、TargetAPI、BelongAPI、AccessAPI。

### 8.2 用户(User)API
### 9.2 用户(User)API
用户接口包括:创建用户,删除用户,修改用户,和查询用户相关信息接口。

#### 8.2.1 创建用户
#### 9.2.1 创建用户

##### Params

@@ -70,7 +70,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/users
}
```

#### 8.2.2 删除用户
#### 9.2.2 删除用户

##### Params

@@ -95,7 +95,7 @@ DELETE http://localhost:8080/graphs/hugegraph/auth/users/-63:test
1
```

#### 8.2.3 修改用户
#### 9.2.3 修改用户

##### Params

@@ -137,7 +137,7 @@ PUT http://localhost:8080/graphs/hugegraph/auth/users/-63:test
}
```

#### 8.2.4 查询用户列表
#### 9.2.4 查询用户列表

##### Params

@@ -173,7 +173,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/users
}
```

#### 8.2.5 查询某个用户
#### 9.2.5 查询某个用户

##### Params

@@ -208,7 +208,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/users/-63:admin
}
```

#### 8.2.6 查询某个用户的角色
#### 9.2.6 查询某个用户的角色

##### Method & Url

@@ -240,11 +240,11 @@ GET http://localhost:8080/graphs/hugegraph/auth/users/-63:boss/role
}
```

### 8.3 用户组(Group)API
### 9.3 用户组(Group)API
用户组会赋予相应的资源权限,用户会被分配不同的用户组,即可拥有不同的资源权限。
用户组接口包括:创建用户组,删除用户组,修改用户组,和查询用户组相关信息接口。

#### 8.3.1 创建用户组
#### 9.3.1 创建用户组

##### Params

@@ -286,7 +286,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/groups
}
```

#### 8.3.2 删除用户组
#### 9.3.2 删除用户组

##### Params

@@ -311,7 +311,7 @@ DELETE http://localhost:8080/graphs/hugegraph/auth/groups/-69:grant
1
```

#### 8.3.3 修改用户组
#### 9.3.3 修改用户组

##### Params

@@ -351,7 +351,7 @@ PUT http://localhost:8080/graphs/hugegraph/auth/groups/-69:grant
}
```

#### 8.3.4 查询用户组列表
#### 9.3.4 查询用户组列表

##### Params

@@ -386,7 +386,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/groups
}
```

#### 8.3.5 查询某个用户组
#### 9.3.5 查询某个用户组

##### Params

@@ -417,12 +417,12 @@ GET http://localhost:8080/graphs/hugegraph/auth/groups/-69:all
}
```

### 8.4 资源(Target)API
### 9.4 资源(Target)API
资源描述了图数据库中的数据,比如符合某一类条件的顶点,每一个资源包括type、label、properties三个要素,共有18种type、
任意label、任意properties的组合形成的资源,一个资源的内部条件是且关系,多个资源之间的条件是或关系。
资源接口包括:资源的创建、删除、修改和查询。

#### 8.4.1 创建资源
#### 9.4.1 创建资源

##### Params
- target_name: 资源名称
@@ -488,7 +488,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/targets
}
```

#### 8.4.2 删除资源
#### 9.4.2 删除资源

##### Params

@@ -513,7 +513,7 @@ DELETE http://localhost:8080/graphs/hugegraph/auth/targets/-77:gremlin
1
```

#### 8.4.3 修改资源
#### 9.4.3 修改资源

##### Params

@@ -568,7 +568,7 @@ PUT http://localhost:8080/graphs/hugegraph/auth/targets/-77:gremlin
}
```

#### 8.4.4 查询资源列表
#### 9.4.4 查询资源列表

##### Params

@@ -627,7 +627,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/targets
}
```

#### 8.4.5 查询某个资源
#### 9.4.5 查询某个资源

##### Params

@@ -666,11 +666,11 @@ GET http://localhost:8080/graphs/hugegraph/auth/targets/-77:grant
}
```

### 8.5 关联角色(Belong)API
### 9.5 关联角色(Belong)API
关联用户和用户组的关系,一个用户可以关联一个或者多个用户组。用户组拥有相关资源的权限,不同用户组的资源权限可以理解为不同的角色。即给用户关联角色。
关联角色接口包括:用户关联角色的创建、删除、修改和查询。

#### 8.5.1 创建用户的关联角色
#### 9.5.1 创建用户的关联角色

##### Params

@@ -713,7 +713,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/belongs
}
```

#### 8.5.2 删除关联角色
#### 9.5.2 删除关联角色

##### Params

@@ -737,7 +737,7 @@ DELETE http://localhost:8080/graphs/hugegraph/auth/belongs/S-63:boss>-82>>S-69:g
1
```

#### 8.5.3 修改关联角色
#### 9.5.3 修改关联角色
关联角色只能修改描述,不能修改 user 和 group 属性,如果需要修改关联角色,需要删除原来关联关系,新增关联角色。

##### Params
@@ -778,7 +778,7 @@ PUT http://localhost:8080/graphs/hugegraph/auth/belongs/S-63:boss>-82>>S-69:gran
}
```

#### 8.5.4 查询关联角色列表
#### 9.5.4 查询关联角色列表

##### Params

@@ -814,7 +814,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/belongs
}
```

#### 8.5.5 查看某个关联角色
#### 9.5.5 查看某个关联角色

##### Params

@@ -845,11 +845,11 @@ GET http://localhost:8080/graphs/hugegraph/auth/belongs/S-63:boss>-82>>S-69:all
}
```

### 8.6 赋权(Access)API
### 9.6 赋权(Access)API
给用户组赋予资源的权限,主要包含:读操作(READ)、写操作(WRITE)、删除操作(DELETE)、执行操作(EXECUTE)等。
赋权接口包括:赋权的创建、删除、修改和查询。

#### 8.6.1 创建赋权(用户组赋予资源的权限)
#### 9.6.1 创建赋权(用户组赋予资源的权限)

##### Params

@@ -900,7 +900,7 @@ POST http://localhost:8080/graphs/hugegraph/auth/accesses
}
```

#### 8.6.2 删除赋权
#### 9.6.2 删除赋权

##### Params

@@ -925,7 +925,7 @@ DELETE http://localhost:8080/graphs/hugegraph/auth/accesses/S-69:all>-88>12>S-77
1
```

#### 8.6.3 修改赋权
#### 9.6.3 修改赋权
赋权只能修改描述,不能修改用户组、资源和权限许可,如果需要修改赋权的关系,可以删除原来的赋权关系,新增赋权。

##### Params
@@ -967,7 +967,7 @@ PUT http://localhost:8080/graphs/hugegraph/auth/accesses/S-69:all>-88>12>S-77:al
}
```

#### 8.6.4 查询赋权列表
#### 9.6.4 查询赋权列表

##### Params

@@ -1003,7 +1003,7 @@ GET http://localhost:8080/graphs/hugegraph/auth/accesses
}
```

#### 8.6.5 查询某个赋权
#### 9.6.5 查询某个赋权

##### Params

@@ -1,6 +1,6 @@
### 1.3 EdgeLabel
### 1.4 EdgeLabel

假设已经创建好了1.1.3中的 PropertyKeys 和 1.2.3中的 VertexLabels
假设已经创建好了1.2.3中的 PropertyKeys 和 1.3.3中的 VertexLabels

Params说明

@@ -14,7 +14,7 @@ Params说明
- enable_label_index: 是否开启类型索引,默认关闭


#### 1.3.1 创建一个EdgeLabel
#### 1.4.1 创建一个EdgeLabel

##### Method & Url

@@ -119,7 +119,7 @@ POST http://localhost:8080/graphs/hugegraph/schema/edgelabels
}
```

#### 1.3.2 为已存在的EdgeLabel添加properties或userdata,或者移除userdata(目前不支持移除properties)
#### 1.4.2 为已存在的EdgeLabel添加properties或userdata,或者移除userdata(目前不支持移除properties)

##### Params

@@ -176,7 +176,7 @@ PUT http://localhost:8080/graphs/hugegraph/schema/edgelabels/created?action=appe
}
```

#### 1.3.3 获取所有的EdgeLabel
#### 1.4.3 获取所有的EdgeLabel

##### Method & Url

@@ -238,7 +238,7 @@ GET http://localhost:8080/graphs/hugegraph/schema/edgelabels
}
```

#### 1.3.4 根据name获取EdgeLabel
#### 1.4.4 根据name获取EdgeLabel

##### Method & Url

@@ -279,7 +279,7 @@ GET http://localhost:8080/graphs/hugegraph/schema/edgelabels/created
}
```

#### 1.3.5 根据name删除EdgeLabel
#### 1.4.5 根据name删除EdgeLabel

删除 EdgeLabel 会导致删除对应的边以及相关的索引数据,会产生一个异步任务

@@ -1,6 +1,6 @@
### 5.1 Graphs
### 6.1 Graphs

#### 5.1.1 列出数据库中全部的图
#### 6.1.1 列出数据库中全部的图

##### Method & Url

@@ -25,7 +25,7 @@ GET http://localhost:8080/graphs
}
```

#### 5.1.2 查看某个图的信息
#### 6.1.2 查看某个图的信息

##### Method & Url

@@ -48,7 +48,7 @@ GET http://localhost:8080/graphs/hugegraph
}
```

#### 5.1.3 清空某个图的全部数据,包括schema、vertex、edge和index等,**该操作需要管理员权限**
#### 6.1.3 清空某个图的全部数据,包括schema、vertex、edge和index等,**该操作需要管理员权限**

##### Params

@@ -68,9 +68,9 @@ DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+t
204
```

### 5.2 Conf
### 6.2 Conf

#### 5.2.1 查看某个图的配置,**该操作需要管理员权限**
#### 6.2.1 查看某个图的配置,**该操作需要管理员权限**

##### Method & Url

@@ -107,7 +107,7 @@ store=hugegraph
...
```

### 5.3 Mode
### 6.3 Mode

合法的图模式包括:NONE,RESTORING,MERGING,LOADING

@@ -129,7 +129,7 @@ Restore 时存在两种不同的模式: Restoring 和 Merging
正常情况下,图模式为 None,当需要 Restore 图时,需要根据需要临时修改图模式为 Restoring 模式或者 Merging 模式,并在完成 Restore 时,恢复图模式为 None。


#### 5.3.1 查看某个图的模式. **该操作需要管理员权限**
#### 6.3.1 查看某个图的模式. **该操作需要管理员权限**

##### Method & Url

@@ -153,7 +153,7 @@ GET http://localhost:8080/graphs/hugegraph/mode

> 合法的图模式包括:NONE,RESTORING,MERGING
#### 5.3.2 设置某个图的模式. **该操作需要管理员权限**
#### 6.3.2 设置某个图的模式. **该操作需要管理员权限**

##### Method & Url

0 comments on commit 6af4918

Please sign in to comment.