Files
open-im-server/cmd/open_im_api/docs/swagger.yaml
T

85 lines
1.9 KiB
YAML
Raw Normal View History

2022-06-24 20:29:53 +08:00
definitions:
base_info.UpdateSelfUserInfoReq:
properties:
birth:
type: integer
email:
maxLength: 64
type: string
ex:
maxLength: 1024
type: string
faceURL:
maxLength: 1024
type: string
gender:
enum:
- 0
- 1
- 2
type: integer
nickname:
maxLength: 64
minLength: 1
type: string
operationID:
type: string
phoneNumber:
maxLength: 32
type: string
userID:
maxLength: 64
minLength: 1
type: string
required:
- operationID
- userID
type: object
base_info.UpdateUserInfoResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2022-06-24 17:45:33 +08:00
info:
2022-06-24 20:29:53 +08:00
contact: {}
2022-06-24 17:45:33 +08:00
paths:
2022-06-24 20:29:53 +08:00
/user/update_user_info:
post:
2022-06-24 17:45:33 +08:00
consumes:
- application/json
2022-06-24 20:29:53 +08:00
description: 修改用户信息 userID faceURL等
operationId: UpdateUserInfo
2022-06-24 17:45:33 +08:00
parameters:
2022-06-24 20:29:53 +08:00
- description: im token
in: header
name: token
2022-06-24 17:45:33 +08:00
required: true
type: string
2022-06-24 20:29:53 +08:00
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/base_info.UpdateSelfUserInfoReq'
produces:
- application/json
2022-06-24 17:45:33 +08:00
responses:
2022-06-24 20:29:53 +08:00
"0":
description: ""
2022-06-24 17:45:33 +08:00
schema:
2022-06-24 20:29:53 +08:00
$ref: '#/definitions/base_info.UpdateUserInfoResp'
2022-06-24 17:45:33 +08:00
"400":
2022-06-24 20:29:53 +08:00
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/base_info.UpdateUserInfoResp'
"500":
description: errCode为500 一般为服务器内部错误
2022-06-24 17:45:33 +08:00
schema:
2022-06-24 20:29:53 +08:00
$ref: '#/definitions/base_info.UpdateUserInfoResp'
summary: 修改用户信息
2022-06-24 17:45:33 +08:00
tags:
2022-06-24 20:29:53 +08:00
- 用户信息
2022-06-24 17:45:33 +08:00
swagger: "2.0"