作者 yangfu

api 描述调整

正在显示 27 个修改的文件 包含 50 行增加24 行删除
@@ -13,6 +13,6 @@ metadata: @@ -13,6 +13,6 @@ metadata:
13 - method: phoneAuthResetPassword 13 - method: phoneAuthResetPassword
14 route: 14 route:
15 post: /phone-auth/reset-password 15 post: /phone-auth/reset-password
16 - - method: phoneAuthResetPassword 16 + - method: destoryAccount
17 route: 17 route:
18 post: /destory-account 18 post: /destory-account
@@ -22,6 +22,10 @@ metadata: @@ -22,6 +22,10 @@ metadata:
22 params: 22 params:
23 - name: offset 23 - name: offset
24 - name: limit 24 - name: limit
  25 + - name: roleName
  26 + - name: orgName
  27 + - name: orgId
  28 + - name: inOrgIds
25 - method: getRoleRelatedUsers 29 - method: getRoleRelatedUsers
26 route: 30 route:
27 get: /{roleId}/related-users 31 get: /{roleId}/related-users
@@ -22,6 +22,10 @@ metadata: @@ -22,6 +22,10 @@ metadata:
22 params: 22 params:
23 - name: offset 23 - name: offset
24 - name: limit 24 - name: limit
  25 + - name: companyId
  26 + - name: orgId
  27 + - name: usersName
  28 + - name: depName
25 - method: getUsersAccessMenus 29 - method: getUsersAccessMenus
26 route: 30 route:
27 get: /access-menus 31 get: /access-menus
  1 +version: v1
  2 +kind: Attribute
  3 +metadata:
  4 + name: code
  5 + description: 编码
  6 + type:
  7 + primitive: int
  1 +version: v1
  2 +kind: Attribute
  3 +metadata:
  4 + name: msg
  5 + description: 应答消息
  6 + type:
  7 + primitive: string
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: createMenu 4 name: createMenu
5 type: command 5 type: command
6 - description: 创建菜单服务 6 + description: 创建菜单
7 payload: 7 payload:
8 - name: parentId 8 - name: parentId
9 description: 父级id 9 description: 父级id
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: getMenu 4 name: getMenu
5 type: query 5 type: query
6 - description: 返回菜单服务 6 + description: 返回菜单
7 payload: 7 payload:
8 - ref: menuId 8 - ref: menuId
9 required: true 9 required: true
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: listMenu 4 name: listMenu
5 type: query 5 type: query
6 - description: 返回菜单服务列表 6 + description: 返回菜单列表
7 payload: 7 payload:
8 - name: menuCategory 8 - name: menuCategory
9 description: 菜单类别 web app 9 description: 菜单类别 web app
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: removeMenu 4 name: removeMenu
5 type: command 5 type: command
6 - description: 移除菜单服务 6 + description: 移除菜单
7 payload: 7 payload:
8 - ref: menuId 8 - ref: menuId
9 required: true 9 required: true
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: updateMenu 4 name: updateMenu
5 type: command 5 type: command
6 - description: 更新菜单服务 6 + description: 更新菜单
7 payload: 7 payload:
8 - ref: menuId 8 - ref: menuId
9 required: true 9 required: true
@@ -2,4 +2,4 @@ version: v1 @@ -2,4 +2,4 @@ version: v1
2 kind: Service 2 kind: Service
3 metadata: 3 metadata:
4 name: menu 4 name: menu
5 - description: 菜单服务 5 + description: 菜单
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: createOrg 4 name: createOrg
5 type: command 5 type: command
6 - description: 创建组织管理 6 + description: 创建组织
7 payload: 7 payload:
8 - ref: companyId 8 - ref: companyId
9 required: true 9 required: true
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: getOrg 4 name: getOrg
5 type: query 5 type: query
6 - description: 返回组织管理 6 + description: 返回组织
7 payload: 7 payload:
8 - ref: orgId 8 - ref: orgId
9 required: true 9 required: true
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: listOrg 4 name: listOrg
5 type: query 5 type: query
6 - description: 返回组织管理列表 6 + description: 返回组织列表
7 payload: 7 payload:
8 - ref: offset 8 - ref: offset
9 required: false 9 required: false
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: removeOrg 4 name: removeOrg
5 type: command 5 type: command
6 - description: 移除组织管理 6 + description: 移除组织
7 payload: 7 payload:
8 - ref: orgId 8 - ref: orgId
9 required: true 9 required: true
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: updateOrg 4 name: updateOrg
5 type: command 5 type: command
6 - description: 更新组织管理 6 + description: 更新组织
7 payload: 7 payload:
8 - ref: orgId 8 - ref: orgId
9 required: true 9 required: true
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: createRole 4 name: createRole
5 type: command 5 type: command
6 - description: 创建角色管理 6 + description: 创建角色
7 payload: 7 payload:
8 - ref: roleName 8 - ref: roleName
9 required: true 9 required: true
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: getRole 4 name: getRole
5 type: query 5 type: query
6 - description: 返回角色管理 6 + description: 返回角色
7 payload: 7 payload:
8 - ref: roleId 8 - ref: roleId
9 required: true 9 required: true
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: listRole 4 name: listRole
5 type: query 5 type: query
6 - description: 返回角色管理列表 6 + description: 返回角色列表
7 payload: 7 payload:
8 - ref: offset 8 - ref: offset
9 required: true 9 required: true
@@ -3,7 +3,7 @@ kind: Method @@ -3,7 +3,7 @@ kind: Method
3 metadata: 3 metadata:
4 name: removeRole 4 name: removeRole
5 type: command 5 type: command
6 - description: 移除角色管理 6 + description: 移除角色
7 payload: 7 payload:
8 - ref: roleId 8 - ref: roleId
9 required: true 9 required: true
@@ -3,14 +3,14 @@ kind: Method @@ -3,14 +3,14 @@ kind: Method
3 metadata: 3 metadata:
4 name: updateRole 4 name: updateRole
5 type: command 5 type: command
6 - description: 更新角色管理 6 + description: 更新角色
7 payload: 7 payload:
8 - ref: roleId 8 - ref: roleId
9 required: true 9 required: true
10 - ref: roleName 10 - ref: roleName
11 required: true 11 required: true
12 - ref: desc 12 - ref: desc
13 - required: false 13 + required: false
14 result: 14 result:
15 - name: role 15 - name: role
16 type: 16 type:
@@ -2,4 +2,4 @@ version: v1 @@ -2,4 +2,4 @@ version: v1
2 kind: Service 2 kind: Service
3 metadata: 3 metadata:
4 name: role 4 name: role
5 - description: 角色管理 5 + description: 角色
@@ -8,7 +8,7 @@ metadata: @@ -8,7 +8,7 @@ metadata:
8 - ref: usersId 8 - ref: usersId
9 required: true 9 required: true
10 result: 10 result:
11 - - name: users 11 + - name: favoriteMenus
12 type: 12 type:
13 - schema: users 13 + array: string
14 required: true 14 required: true
@@ -11,6 +11,8 @@ metadata: @@ -11,6 +11,8 @@ metadata:
11 required: false 11 required: false
12 - ref: usersBaseId 12 - ref: usersBaseId
13 required: false 13 required: false
  14 + - ref: usersCode
  15 + required: false
14 result: 16 result:
15 - name: users 17 - name: users
16 type: 18 type:
@@ -9,6 +9,10 @@ metadata: @@ -9,6 +9,10 @@ metadata:
9 required: true 9 required: true
10 - ref: limit 10 - ref: limit
11 required: true 11 required: true
  12 + - ref: companyId
  13 + required: false
  14 + - ref: orgId
  15 + required: false
12 - ref: usersName 16 - ref: usersName
13 required: false 17 required: false
14 - ref: depName 18 - ref: depName
@@ -7,8 +7,6 @@ metadata: @@ -7,8 +7,6 @@ metadata:
7 payload: 7 payload:
8 - ref: usersId 8 - ref: usersId
9 required: true 9 required: true
10 - - ref: usersCode  
11 - required: true  
12 - name: organizationId 10 - name: organizationId
13 description: 组织机构 11 description: 组织机构
14 type: 12 type:
@@ -2,4 +2,4 @@ version: v1 @@ -2,4 +2,4 @@ version: v1
2 kind: Service 2 kind: Service
3 metadata: 3 metadata:
4 name: users 4 name: users
5 - description: 用户管理 5 + description: 用户