You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Open-IM-Server/cmd/open_im_api/docs/swagger.json

124 lines
3.8 KiB

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