作者 yangfu

api 描述调整

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