Merge branch 'master' of http://gitlab.fjmaimaimai.com/allied-creation/document

@@ -3,22 +3,19 @@ kind: HttpApi
 metadata:
   service: dictionary
   path: /dictionarys
-  endpoints: 
-  - method: createDictionary
-    route:
-      post: /  
-  - method: updateDictionary
-    route:
-      put: /{Id}
-  - method: getDictionary
-    route:
-      get: /{Id}
-  - method: removeDictionary
-    route:
-      delete: /{Id}
-  - method: listDictionary
-    route:
-      get: /
-    params:
-      - name: offset
-      - name: limit
+  endpoints:
+    - method: createDictionary
+      route:
+        post: /
+    - method: updateDictionary
+      route:
+        put: /{Id}
+    - method: getDictionary
+      route:
+        get: /{Id}
+    - method: listDictionary
+      route:
+        get: /
+      params:
+        - name: offset
+        - name: limit

+version: v1
+kind: HttpApi
+metadata:
+  service: noticeSetting
+  path: /notice-setting
+  endpoints:
+    - method: updateNoticeSetting
+      route:
+        put: /{Id}
+    - method: getNoticeSetting
+      route:
+        get: /{Id}
+    - method: listNoticeSetting
+      route:
+        get: /

+version: v1
+kind: Attribute
+metadata:
+  name: companyId
+  description: 公司id
+  type: 
+    primitive: int64

+version: v1
+kind: Attribute
+metadata:
+  name: content
+  description: 内容模板
+  type: 
+    primitive: string

+version: v1
+kind: Attribute
+metadata:
+  name: isPush
+  description: 是否推送 【是：1】【否：2】
+  type: 
+    primitive: int

+version: v1
+kind: Attribute
+metadata:
+  name: module
+  description: 消息对应的业务模块
+  type: 
+    primitive: string

+version: v1
+kind: Attribute
+metadata:
+  name: moduleAction
+  description: 业务环节
+  type: 
+    primitive: string

+version: v1
+kind: Attribute
+metadata:
+  name: noticeSettingId
+  description: 消息id
+  type: 
+    primitive: int64

+version: v1
+kind: Attribute
+metadata:
+  name: organizationId
+  description: 组织id
+  type: 
+    primitive: int64

+version: v1
+kind: Attribute
+metadata:
+  name: sysCode
+  description: 消息对应的编码
+  type: 
+    primitive: string

@@ -2,7 +2,7 @@ version: v1
 kind: HttpApi
 metadata:
   service: loginAccess
-  path: /v1/web/auth
+  path: /auth
   endpoints:
     - method: loginByAccount
       route:
@@ -16,6 +16,6 @@ metadata:
     - method: getQrcodeForLogin
       route:
         get: /get-qrcode
-    - method: loginInfoByAuthCode
+    - method: AuthCodeToAccessToken
       route:
-        get: /profile
+        get: /access-token

+version: v1
+kind: HttpApi
+metadata:
+  service: menu
+  path: /menus
+  endpoints:
+    - method: menuList
+      route:
+        get: /
+    - method: menuUpdate
+      route:
+        put: /{Id}

+version: v1
+kind: HttpApi
+metadata:
+  service: noticeSetting
+  path: /notice-setting
+  endpoints:
+    - method: noticeSettingList
+      route:
+        get: /
+    - method: noticeSettingProfile
+      route:
+        get: /profile
+    - method: noticeSettingUpdate
+      route:
+        put: /

+version: v1
+kind: HttpApi
+metadata:
+  service: orgs
+  path: /orgs
+  endpoints:
+    - method: orgAdd
+      route:
+        post: /
+    - method: orgUpdate
+      route:
+        put: /{Id}
+    - method: orgList
+      route:
+        post: /search
+    - method: orgGet
+      route:
+        get: /{Id}
+    - method: orgRemove
+      route:
+        delete: /{Id}

+version: v1
+kind: Attribute
+metadata:
+  name: menuAlias
+  description: 菜单别名
+  type:
+    primitive: string

+version: v1
+kind: Attribute
+metadata:
+  name: companyId
+  description: 公司id
+  type: 
+    primitive: int64

+version: v1
+kind: Attribute
+metadata:
+  name: content
+  description: 内容模板
+  type: 
+    primitive: string

+version: v1
+kind: Attribute
+metadata:
+  name: isPush
+  description: 是否推送 【是：1】【否：2】
+  type: 
+    primitive: int

+version: v1
+kind: Attribute
+metadata:
+  name: module
+  description: 消息对应的业务模块
+  type: 
+    primitive: string

+version: v1
+kind: Attribute
+metadata:
+  name: moduleAction
+  description: 业务环节
+  type: 
+    primitive: string

+version: v1
+kind: Attribute
+metadata:
+  name: noticeSettingId
+  description: 消息id
+  type: 
+    primitive: int64

+version: v1
+kind: Attribute
+metadata:
+  name: organizationId
+  description: 组织id
+  type: 
+    primitive: int64

+version: v1
+kind: Attribute
+metadata:
+  name: sysCode
+  description: 消息对应的编码
+  type: 
+    primitive: string

@@ -39,11 +39,11 @@ metadata:
     - name: usersOrg
       description: 关联的组织机构
       type:
-        array: org
+        array: orgs
     - name: usersRole
       description: 关联的组织结构
       type:
-        array: role
+        array: roles
     - name: avator
       description: 头像
       type:

+version: v1
+kind: Schema
+metadata:
+  name: noticeSetting
+  description: 编排消息通知内容
+  attributes:
+    - ref: companyId
+      required: true
+    - ref: content
+      required: true
+    - ref: isPush
+      required: true
+    - ref: module
+      required: true
+    - ref: moduleAction
+      required: true
+    - ref: noticeSettingId
+      required: true
+    - ref: organizationId
+      required: true
+    - ref: sysCode
+      required: true
+    - ref: createdAt
+      required: true
+    - ref: deletedAt
+      required: true
+    - ref: updatedAt
+      required: true

+version: v1
+kind: Schema
+metadata:
+  name: noticeSettingModule
+  description: 编排消息模块列表
+  attributes:
+    - ref: module
+      required: true
+    - name: moduleAction
+      description: 模块环节
+      type:
+        array: string

+version: v1
+kind: Schema
+metadata:
+  name: noticeSettingParam
+  description: 编排消息需要的变量
+  attributes:
+    - name: paramCode
+      description: 变量的代码标识
+      type:
+        primitive: string
+    - name: paramName
+      description: 变量名称描述
+    - ref: moduleAction
+      required: true
+    - ref: module
+      required: true

+version: v1
+kind: Schema
+metadata:
+  name: noticeSettingProfile
+  description: 编排消息需要的候选参数
+  attributes:
+    - name: paramList
+      description: 可选变量列表
+      type:
+        array: noticeSettingParam
+    - name: moduleList
+      description: 业务模块列表
+      type:
+        schema: noticeSettingModule

 version: v1
 kind: Schema
 metadata:
-  name: org
+  name: orgs
   description: 组织organization
   attributes:
     - ref: orgId

 version: v1
 kind: Schema
 metadata:
-  name: role
-  description: 角色 （base)
+  name: roleListItem
+  description: 角色列表
   attributes:
     - ref: roleId
       required: true

 version: v1
 kind: Schema
 metadata:
-  name: role
+  name: roles
   description: 角色 （base)
   attributes:
     - ref: roleId

@@ -25,11 +25,11 @@ metadata:
     - name: usersOrg
       description: 用户关联的组织
       type:
-        array: org
+        array: orgs
     - name: usersRole
       description: 用户关联的角色
       type:
-        array: role
+        array: roles
     - name: favoriteMenus
       description: 收藏的菜单(工作台)(菜单编码列表)
       type:

 version: v1
 kind: Method
 metadata:
-  name: loginInfoByAuthCode
+  name: AuthCodeToAccessToken
   type: query
   description: 获取具体的进入系统的凭证
   payload:

@@ -2,4 +2,4 @@ version: v1
 kind: Service
 metadata:
   name: loginAccess
-  description: 登录访问
+  description: web端登录访问

+version: v1
+kind: Method
+metadata:
+  name: menuList
+  type: query
+  description: 返回菜单列表
+  result:
+    - name: menus
+      type:
+        array: menu
+      required: true

+version: v1
+kind: Method
+metadata:
+  name: menuUpdate
+  type: query
+  description: 更新菜单
+  payload:
+    - ref: companyId
+      required: true
+    - ref: menuId
+      required: true
+    - ref: menuName
+      required: true
+    - ref: sort
+      required: true
+  result:
+    - name: menus
+      type:
+        schema: menu
+      required: true

+version: v1
+kind: Service
+metadata:
+  name: menu
+  description: 用户菜单维护

+version: v1
+kind: Method
+metadata:
+  name: roleList
+  type: query
+  description: 返回role列表
+  payload:
+    - ref: offset
+      required: true
+    - ref: limit
+      required: true
+  result:
+    - ref: count
+      required: true
+    - name: roles
+      type:
+        array: roles
+      required: true

+version: v1
+kind: Method
+metadata:
+  name: noticeSettingList
+  type: command
+  description: 推送消息配置列表
+  payload:
+    - ref: limit
+      required: true
+    - ref: offset
+      required: true
+  result:
+    - name: count
+      type:
+        primitive: int
+    - name: noticeSetting
+      type:
+        schema: noticeSetting
+      required: true

+version: v1
+kind: Method
+metadata:
+  name: noticeSettingProfile
+  type: query
+  description: 推送消息配置需求的参数候选项
+  result:
+    - name: profile
+      type:
+        schema: noticeSettingProfile
+      required: true

+version: v1
+kind: Method
+metadata:
+  name: noticeSettingUpdate
+  type: query
+  description: 推送消息配置需求的参数候选项
+  payload:
+    - ref: module
+      required: true
+    - ref: moduleAction
+      required: true
+    - ref: isPush
+      required: true
+    - ref: content
+      required: true
+  result:
+    - name: profile
+      type:
+        schema: noticeSettingProfile
+      required: true

+version: v1
+kind: Service
+metadata:
+  name: noticeSetting
+  description: 推送消息配置

@@ -5,18 +5,18 @@ metadata:
   type: command
   description: 创建组织管理
   payload:
-  - ref: companyId
-    required: true
-  - ref: orgCode
-    required: true
-  - ref: orgName
-    required: true
-  - name: isOrg
-    required: true
-  - ref: parentId
-    required: true
+    - ref: companyId
+      required: true
+    - ref: orgCode
+      required: true
+    - ref: orgName
+      required: true
+    - name: isOrg
+      required: true
+    - ref: parentId
+      required: true
   result:
-  - name: org
-    type: 
-      schema: org
-    required: true
+    - name: org
+      type:
+        schema: orgs
+      required: true

@@ -5,10 +5,10 @@ metadata:
   type: query
   description: 返回组织管理
   payload:
-  - ref: orgId
-    required: true
+    - ref: orgId
+      required: true
   result:
-  - name: org
-    type: 
-      schema: org
-    required: true
+    - name: org
+      type:
+        schema: orgs
+      required: true

@@ -5,20 +5,20 @@ metadata:
   type: query
   description: 返回组织管理列表
   payload:
-  - ref: offset
-    required: true
-  - ref: limit
-    required: true
-  - ref: orgCode
-    required: false
-  - ref: depName
-    required: false
-  - ref: parentId
-    required: false
+    - ref: offset
+      required: true
+    - ref: limit
+      required: true
+    - ref: orgCode
+      required: false
+    - ref: depName
+      required: false
+    - ref: parentId
+      required: false
   result:
-  - ref: count
-    required: true 
-  - name: orgs
-    type: 
-      array: org
-    required: true
+    - ref: count
+      required: true
+    - name: orgs
+      type:
+        array: orgs
+      required: true

@@ -5,10 +5,10 @@ metadata:
   type: command
   description: 移除组织管理
   payload:
-  - ref: orgId
-    required: true
+    - ref: orgId
+      required: true
   result:
-  - name: org
-    type: 
-      schema: org
-    required: true
+    - name: org
+      type:
+        schema: orgs
+      required: true

@@ -5,18 +5,18 @@ metadata:
   type: command
   description: 更新组织管理
   payload:
-  - ref: orgId
-    required: true
-  - ref: orgCode
-    required: true
-  - ref: orgName
-    required: true
-  - name: isOrg
-    required: true
-  - ref: parentId
-    required: true
+    - ref: orgId
+      required: true
+    - ref: orgCode
+      required: true
+    - ref: orgName
+      required: true
+    - name: isOrg
+      required: true
+    - ref: parentId
+      required: true
   result:
-  - name: org
-    type: 
-      schema: org
-    required: true
+    - name: org
+      type:
+        schema: orgs
+      required: true

+version: v1
+kind: Method
+metadata:
+  name: orgAdd
+  type: command
+  description: 创建组织管理
+  payload:
+    - ref: companyId
+      required: true
+    - ref: orgCode
+      required: true
+    - ref: orgName
+      required: true
+    - name: isOrg
+      required: true
+    - ref: parentId
+      required: true
+  result:
+    - name: org
+      type:
+        schema: orgs
+      required: true

+version: v1
+kind: Method
+metadata:
+  name: orgGet
+  type: query
+  description: 返回组织管理
+  payload:
+    - ref: orgId
+      required: true
+  result:
+    - name: org
+      type:
+        schema: orgs
+      required: true

+version: v1
+kind: Method
+metadata:
+  name: orgList
+  type: query
+  description: 返回组织管理列表
+  result:
+    - ref: count
+      required: true
+    - name: orgs
+      type:
+        array: orgs
+      required: true

+version: v1
+kind: Method
+metadata:
+  name: orgRemove
+  type: command
+  description: 移除组织管理
+  payload:
+    - ref: orgId
+      required: true
+  result:
+    - name: org
+      type:
+        schema: orgs
+      required: true

+version: v1
+kind: Method
+metadata:
+  name: orgUpdate
+  type: command
+  description: 更新组织管理
+  payload:
+    - ref: orgId
+      required: true
+    - ref: orgCode
+      required: true
+    - ref: orgName
+      required: true
+    - name: isOrg
+      required: true
+    - ref: parentId
+      required: true
+  result:
+    - name: org
+      type:
+        schema: orgs
+      required: true

+version: v1
+kind: Service
+metadata:
+  name: orgs
+  description: 组织管理

@@ -7,10 +7,10 @@ metadata:
   payload:
     - name: role
       type:
-        schema: role
+        schema: roles
       required: true
   result:
     - name: role
       type:
-        schema: role
+        schema: roles
       required: true

@@ -14,5 +14,5 @@ metadata:
       required: true
     - name: roles
       type:
-        array: role
+        array: roles
       required: true

@@ -10,7 +10,7 @@ metadata:
   result:
     - name: roles
       type:
-        array: role
+        array: roles
       required: true
     - name: menus
       type:

@@ -10,5 +10,5 @@ metadata:
   result:
     - name: role
       type:
-        schema: role
+        schema: roles
       required: true

@@ -7,10 +7,10 @@ metadata:
   payload:
     - name: role
       type:
-        schema: role
+        schema: roles
       required: true
   result:
     - name: role
       type:
-        schema: role
+        schema: roles
       required: true

@@ -7,8 +7,8 @@ metadata:
   result:
     - name: roles
       type:
-        array: role
+        array: roles
       required: true
     - name: orgs
       type:
-        array: org
+        array: orgs

@@ -51,11 +51,11 @@ metadata:
     - name: usersOrg
       description: 关联的组织机构
       type:
-        array: org
+        array: orgs
     - name: usersRole
       description: 关联的角色
       type:
-        array: role
+        array: roles
     - name: avator
       description: 头像
       type:

@@ -36,11 +36,11 @@ metadata:
     - name: usersOrg
       description: 关联的组织机构
       type:
-        array: org
+        array: orgs
     - name: usersRole
       description: 关联的组织结构
       type:
-        array: role
+        array: roles
     - name: avator
       description: 头像
       type: