作者 tangxuhui

更新

version: v1
kind: HttpApi
metadata:
service: systemSetting
path: /system-settings
endpoints:
- method: updateSystemSetting
route:
put: /
- method: getSystemSetting
route:
post: /get
- method: listSystemSetting
route:
post: /search
... ...
version: v1
kind: Attribute
metadata:
name: pageIndex
description: 页码
type:
primitive: int
... ...
version: v1
kind: Attribute
metadata:
name: pageSize
description: 每页数量
type:
primitive: int
... ...
version: v1
kind: Attribute
metadata:
name: companyId
description: 企业id
type:
primitive: int64
... ...
version: v1
kind: Attribute
metadata:
name: controlLevel
description: 管控层级
type:
primitive: string
... ...
version: v1
kind: Attribute
metadata:
name: description
description: 描述
type:
primitive: string
... ...
version: v1
kind: Attribute
metadata:
name: settingCode
description: 设置对应的编码
type:
primitive: string
... ...
version: v1
kind: Attribute
metadata:
name: settingName
description: 设置对应的名称
type:
primitive: string
... ...
version: v1
kind: Attribute
metadata:
name: systemSettingId
description: 数据id
type:
primitive: int64
... ...
version: v1
kind: Attribute
metadata:
name: value
description: 设定的值
type:
primitive: string
... ...
version: v1
kind: Attribute
metadata:
name: valueType
description: 值类型
type:
primitive: string
... ...
swagger: "2.0"
info:
title: ""
description: 天联基础
contact:
name: ""
email: ""
home: ""
version: 0.0.1
paths: {}
definitions:
LoginAccessGetQrcodeForLoginResponseBody:
title: 'Mediatype identifier: LoginAccessGetQrcodeForLoginResponseBody'
type: object
properties:
authCode:
type: string
description: 登录认证的凭证
imgBase64:
type: string
description: base64形式的二维码图片
loginAccess:
$ref: '#/definitions/loginAccessResponseBody'
LoginAccessLoginByAccountRequestBody:
title: LoginAccessLoginByAccountRequestBody
type: object
properties:
account:
type: string
description: 账号
passwd:
type: string
description: 密码
LoginAccessLoginByAccountResponseBody:
title: 'Mediatype identifier: LoginAccessLoginByAccountResponseBody'
type: object
properties:
authcode:
type: string
description: 登录认证的凭证
loginAccess:
$ref: '#/definitions/loginAccessResponseBody'
LoginAccessLoginByScanQrcodeRequestBody:
title: LoginAccessLoginByScanQrcodeRequestBody
type: object
properties:
authCode:
type: string
description: 登录认证的凭证
LoginAccessLoginByScanQrcodeResponseBody:
title: 'Mediatype identifier: LoginAccessLoginByScanQrcodeResponseBody'
type: object
properties:
accessToken:
type: string
description: 真正的登录凭证
isLogin:
type: string
description: 是否可以登录
loginAccess:
$ref: '#/definitions/loginAccessResponseBody'
LoginAccessLoginBySmsCodeRequestBody:
title: LoginAccessLoginBySmsCodeRequestBody
type: object
properties:
phone:
type: string
description: 手机号
smsCode:
type: string
description: 短信验证码
LoginAccessLoginBySmsCodeResponseBody:
title: 'Mediatype identifier: LoginAccessLoginBySmsCodeResponseBody'
type: object
properties:
authcode:
type: string
description: 登录认证的凭证
loginAccess:
$ref: '#/definitions/loginAccessResponseBody'
LoginAccessLoginInfoByAuthCodeRequestBody:
title: LoginAccessLoginInfoByAuthCodeRequestBody
type: object
properties:
authCode:
type: string
description: 登录认证的凭证
companyId:
type: string
description: 公司id
organizationId:
type: string
description: 组织id
LoginAccessLoginInfoByAuthCodeResponseBody:
title: 'Mediatype identifier: LoginAccessLoginInfoByAuthCodeResponseBody'
type: object
properties:
accessToken:
type: string
description: 登录系统的凭证
loginAccess:
$ref: '#/definitions/loginAccessResponseBody'
loginAccessResponseBody:
title: loginAccessResponseBody
type: object
properties:
accessExpired:
type: integer
description: 登录凭证过期时间,时间戳精度秒
format: int64
accessToken:
type: string
description: 登录凭证存储
account:
type: string
description: 账号
companyId:
type: integer
description: 公司id
format: int64
createdTime:
type: string
description: 创建时间
format: datetime
organizationId:
type: integer
description: 组织id
format: int64
platform:
type: string
description: 对应平台
refreshExpired:
type: integer
description: 刷新登录凭证过期时间,时间戳精度秒
format: int64
refreshToken:
type: string
description: 刷新登录凭证
updatedTime:
type: string
description: 更新时间
format: datetime
description: 登录凭证存储
... ...
version: v1
kind: Schema
metadata:
name: systemSetting
description: 系统参数设置
attributes:
- ref: companyId
required: true
- ref: controlLevel
required: true
- ref: description
required: true
- ref: settingCode
required: true
- ref: settingName
required: true
- ref: systemSettingId
required: true
- ref: value
required: true
- ref: valueType
required: true
... ...
... ... @@ -5,14 +5,14 @@ metadata:
type: query
description: 返回数据字典设置列表
payload:
- ref: offset
required: true
- ref: limit
required: true
- ref: pageIndex
required: true
- ref: pageSize
required: true
result:
- ref: count
required: true
- name: dictionarys
type:
array: dictionary
required: true
- ref: count
required: true
- name: dictionarys
type:
array: dictionary
required: true
... ...
... ... @@ -9,14 +9,10 @@ metadata:
description: 接收方用户的id
type:
primitive: int64
- name: offset
description: 分页偏移量
type:
primitive: int64
- name: limit
description: 每页限制数量 默认20
type:
primitive: int64
- ref: pageIndex
required: true
- ref: pageSize
required: true
- name: isRead
description: 是否是已读
type:
... ...
... ... @@ -5,14 +5,14 @@ metadata:
type: query
description: 返回编排消息通知内容列表
payload:
- ref: offset
required: true
- ref: limit
required: true
- ref: pageIndex
required: true
- ref: pageSize
required: true
result:
- ref: count
required: true
- name: noticeSettings
type:
array: noticeSetting
required: true
- ref: count
required: true
- name: noticeSettings
type:
array: noticeSetting
required: true
... ...
version: v1
kind: Method
metadata:
name: getSystemSetting
type: query
description: 返回用户的系统设置
payload:
- ref: settingCode
required: true
- name: companyId
description: 企业id
type:
primitive: int64
result:
- name: systemSetting
type:
schema: systemSetting
required: true
... ...
version: v1
kind: Method
metadata:
name: listSystemSetting
type: query
description: 返回用户的系统设置列表
payload:
- name: companyId
description: 公司id
type:
primitive: int64
- ref: settingCode
result:
- name: systemSettings
type:
array: systemSetting
required: true
... ...
version: v1
kind: Method
metadata:
name: updateSystemSetting
type: command
description: 更新用户的系统设置
payload:
- ref: settingCode
required: true
- ref: companyId
required: true
result:
- name: systemSetting
type:
schema: systemSetting
required: true
... ...
version: v1
kind: Service
metadata:
name: systemSetting
description: 用户的系统设置
... ...