302 lines
10 KiB
YAML
302 lines
10 KiB
YAML
# Generated with protoc-gen-openapi
|
|
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi
|
|
|
|
openapi: 3.0.3
|
|
info:
|
|
title: ""
|
|
version: 0.0.1
|
|
paths:
|
|
/health:
|
|
get:
|
|
tags:
|
|
- Health
|
|
operationId: Health_Check
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.RespHealth'
|
|
/v1/login/dingtalk:
|
|
post:
|
|
tags:
|
|
- User
|
|
description: 手机或账号登录
|
|
operationId: User_LoginByDingtalk
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.ReqUserLoginByDingtalk'
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.RespLogin'
|
|
/v1/login/phone:
|
|
post:
|
|
tags:
|
|
- User
|
|
description: 手机或账号登录
|
|
operationId: User_LoginByPhone
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.ReqUserLoginByPhone'
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.RespLogin'
|
|
/v1/login/renew:
|
|
post:
|
|
tags:
|
|
- User
|
|
description: 续签登录时长
|
|
operationId: User_LoginRenew
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.ReqLoginRenew'
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.RespLogin'
|
|
/v1/login/sendSms:
|
|
post:
|
|
tags:
|
|
- User
|
|
description: 发送登录验证码
|
|
operationId: User_LoginSendSms
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.ReqUserLoginSendSms'
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.RespLoginSendSms'
|
|
/v1/user/info:
|
|
get:
|
|
tags:
|
|
- User
|
|
description: 获取用户信息
|
|
operationId: User_GetInfoUser
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.RespUser'
|
|
/v1/user/products:
|
|
get:
|
|
tags:
|
|
- User
|
|
description: 获取用户产品信息
|
|
operationId: User_GetProducts
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.RespProducts'
|
|
/v1/user/updatePassword:
|
|
post:
|
|
tags:
|
|
- User
|
|
description: 发送登录验证码
|
|
operationId: User_UpdatePassword
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.ReqUserUpdatePassword'
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.RespEmpty'
|
|
/v1/user/welcome:
|
|
get:
|
|
tags:
|
|
- User
|
|
description: 手机或账号登录
|
|
operationId: User_GetWelcome
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/userapi.v1.RespGetWelcome'
|
|
components:
|
|
schemas:
|
|
userapi.v1.ReqLoginRenew:
|
|
type: object
|
|
properties:
|
|
accessToken:
|
|
type: string
|
|
description: 续签登录时间参数
|
|
userapi.v1.ReqUserLoginByDingtalk:
|
|
type: object
|
|
properties:
|
|
authCode:
|
|
type: string
|
|
description: 钉钉扫码登录
|
|
userapi.v1.ReqUserLoginByPhone:
|
|
type: object
|
|
properties:
|
|
phone:
|
|
type: string
|
|
password:
|
|
type: string
|
|
code:
|
|
type: string
|
|
description: 手机登录参数
|
|
userapi.v1.ReqUserLoginSendSms:
|
|
type: object
|
|
properties:
|
|
phone:
|
|
type: string
|
|
description: 手机号
|
|
password:
|
|
type: string
|
|
description: 密码
|
|
description: 发送登录短信验证码
|
|
userapi.v1.ReqUserUpdatePassword:
|
|
type: object
|
|
properties:
|
|
password:
|
|
type: string
|
|
description: 修改密码
|
|
userapi.v1.RespEmpty:
|
|
type: object
|
|
properties: {}
|
|
description: 空返回
|
|
userapi.v1.RespGetWelcome:
|
|
type: object
|
|
properties:
|
|
userDingtalk:
|
|
$ref: '#/components/schemas/userapi.v1.RespUserDingtalk'
|
|
ana:
|
|
type: string
|
|
description: 激励语录
|
|
description: 获取欢迎新页数据
|
|
userapi.v1.RespHealth:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: integer
|
|
format: enum
|
|
description: 健康检查返回
|
|
userapi.v1.RespLogin:
|
|
type: object
|
|
properties:
|
|
accessToken:
|
|
type: string
|
|
isSetPassword:
|
|
type: boolean
|
|
description: 登录成功
|
|
userapi.v1.RespLoginSendSms:
|
|
type: object
|
|
properties:
|
|
countDown:
|
|
type: integer
|
|
format: int32
|
|
description: 登录验证码发送成功
|
|
userapi.v1.RespProduct:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
code:
|
|
type: string
|
|
icon:
|
|
type: string
|
|
text:
|
|
type: string
|
|
url:
|
|
type: string
|
|
description: 产品
|
|
userapi.v1.RespProducts:
|
|
type: object
|
|
properties:
|
|
enableProducts:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/userapi.v1.RespProduct'
|
|
description: 已开通产品
|
|
disableProducts:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/userapi.v1.RespProduct'
|
|
description: 未开通产品
|
|
afterProducts:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/userapi.v1.RespProduct'
|
|
description: 之后上线产品
|
|
description: 产品列表
|
|
userapi.v1.RespUser:
|
|
type: object
|
|
properties:
|
|
userDingtalk:
|
|
$ref: '#/components/schemas/userapi.v1.RespUserDingtalk'
|
|
managerDingtalk:
|
|
$ref: '#/components/schemas/userapi.v1.RespUserDingtalk'
|
|
enableProducts:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/userapi.v1.RespProduct'
|
|
userapi.v1.RespUserDingtalk:
|
|
type: object
|
|
properties:
|
|
avatarURL:
|
|
type: string
|
|
description: "int32 id = 1;\tstring nick = 2;"
|
|
mobile:
|
|
type: string
|
|
name:
|
|
type: string
|
|
description: "string openID = 5;\tstring unionID = 6;\tstring email = 7;\tstring stateCode = 8;\tstring userID = 9;"
|
|
title:
|
|
type: string
|
|
description: string jobNumber = 11;
|
|
hiredDate:
|
|
type: integer
|
|
description: "string extension = 13;\tstring deptIDList = 14;"
|
|
format: int32
|
|
hiredDays:
|
|
type: integer
|
|
format: int32
|
|
department:
|
|
type: string
|
|
description: 用户钉钉数据
|
|
tags:
|
|
- name: Health
|
|
- name: User
|
|
description: 用户相关
|