golang-yitisheng-server/server/docs/docs.go

1449 lines
46 KiB
Go

// Package docs Code generated by swaggo/swag. DO NOT EDIT
package docs
import "github.com/swaggo/swag"
const docTemplate = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/auth/info": {
"get": {
"tags": [
"认证"
],
"summary": "获取当前登录用户信息",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/auth/login": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"认证"
],
"summary": "用户登录",
"parameters": [
{
"description": "登录信息",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/controller.LoginRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/auth/logout": {
"post": {
"tags": [
"认证"
],
"summary": "用户登出",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/sys-users": {
"get": {
"tags": [
"用户管理"
],
"summary": "获取用户列表",
"parameters": [
{
"type": "integer",
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"name": "size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"post": {
"tags": [
"用户管理"
],
"summary": "创建用户",
"parameters": [
{
"description": "用户信息",
"name": "item",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysUser"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/sys-users/{id}": {
"get": {
"tags": [
"用户管理"
],
"summary": "获取单个用户",
"parameters": [
{
"type": "string",
"description": "用户ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"put": {
"tags": [
"用户管理"
],
"summary": "更新用户",
"parameters": [
{
"type": "string",
"description": "用户ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "用户信息",
"name": "item",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.SysUser"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"delete": {
"tags": [
"用户管理"
],
"summary": "删除用户",
"parameters": [
{
"type": "string",
"description": "用户ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"patch": {
"tags": [
"用户管理"
],
"summary": "动态字段更新",
"parameters": [
{
"type": "string",
"description": "用户ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "要更新的字段",
"name": "fields",
"in": "body",
"required": true,
"schema": {
"type": "object",
"additionalProperties": true
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/sys-users/{id}/password": {
"put": {
"tags": [
"用户管理"
],
"summary": "修改密码",
"parameters": [
{
"type": "string",
"description": "用户ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "密码信息",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/controller.UpdatePasswordRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/yx-calculation-majors": {
"get": {
"tags": [
"计算专业"
],
"summary": "获取计算专业列表",
"parameters": [
{
"type": "integer",
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"name": "size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"post": {
"tags": [
"计算专业"
],
"summary": "创建计算专业",
"parameters": [
{
"description": "计算专业信息",
"name": "item",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.YxCalculationMajor"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/yx-calculation-majors/batch": {
"post": {
"tags": [
"计算专业"
],
"summary": "批量创建计算专业",
"parameters": [
{
"description": "计算专业列表",
"name": "items",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.YxCalculationMajor"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"delete": {
"tags": [
"计算专业"
],
"summary": "批量删除计算专业",
"parameters": [
{
"description": "ID列表",
"name": "ids",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/yx-calculation-majors/{id}": {
"get": {
"tags": [
"计算专业"
],
"summary": "获取单个计算专业",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"put": {
"tags": [
"计算专业"
],
"summary": "更新计算专业",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "计算专业信息",
"name": "item",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.YxCalculationMajor"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"delete": {
"tags": [
"计算专业"
],
"summary": "删除计算专业",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"patch": {
"tags": [
"计算专业"
],
"summary": "动态字段更新",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "要更新的字段",
"name": "fields",
"in": "body",
"required": true,
"schema": {
"type": "object",
"additionalProperties": true
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/yx-history-enrolls": {
"get": {
"tags": [
"历年招生"
],
"summary": "获取历年招生列表",
"parameters": [
{
"type": "integer",
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"name": "size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"post": {
"tags": [
"历年招生"
],
"summary": "创建历年招生记录",
"parameters": [
{
"description": "历年招生信息",
"name": "item",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.YxHistoryMajorEnroll"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/yx-history-enrolls/batch": {
"post": {
"tags": [
"历年招生"
],
"summary": "批量创建历年招生记录",
"parameters": [
{
"description": "历年招生列表",
"name": "items",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.YxHistoryMajorEnroll"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"delete": {
"tags": [
"历年招生"
],
"summary": "批量删除历年招生记录",
"parameters": [
{
"description": "ID列表",
"name": "ids",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/yx-history-enrolls/{id}": {
"get": {
"tags": [
"历年招生"
],
"summary": "获取单个历年招生记录",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"put": {
"tags": [
"历年招生"
],
"summary": "更新历年招生记录",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "历年招生信息",
"name": "item",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.YxHistoryMajorEnroll"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"delete": {
"tags": [
"历年招生"
],
"summary": "删除历年招生记录",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"patch": {
"tags": [
"历年招生"
],
"summary": "动态字段更新",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "要更新的字段",
"name": "fields",
"in": "body",
"required": true,
"schema": {
"type": "object",
"additionalProperties": true
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/yx-school-majors": {
"get": {
"tags": [
"院校专业"
],
"summary": "获取院校专业列表",
"parameters": [
{
"type": "integer",
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"name": "size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"post": {
"tags": [
"院校专业"
],
"summary": "创建院校专业",
"parameters": [
{
"description": "院校专业信息",
"name": "item",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.YxSchoolMajor"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/yx-school-majors/batch": {
"post": {
"tags": [
"院校专业"
],
"summary": "批量创建院校专业",
"parameters": [
{
"description": "院校专业列表",
"name": "items",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/entity.YxSchoolMajor"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"delete": {
"tags": [
"院校专业"
],
"summary": "批量删除院校专业",
"parameters": [
{
"description": "ID列表",
"name": "ids",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
},
"/yx-school-majors/{id}": {
"get": {
"tags": [
"院校专业"
],
"summary": "获取单个院校专业",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"put": {
"tags": [
"院校专业"
],
"summary": "更新院校专业",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "院校专业信息",
"name": "item",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/entity.YxSchoolMajor"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"delete": {
"tags": [
"院校专业"
],
"summary": "删除院校专业",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
},
"patch": {
"tags": [
"院校专业"
],
"summary": "动态字段更新",
"parameters": [
{
"type": "string",
"description": "ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "要更新的字段",
"name": "fields",
"in": "body",
"required": true,
"schema": {
"type": "object",
"additionalProperties": true
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.Response"
}
}
}
}
}
},
"definitions": {
"common.Response": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"data": {},
"message": {
"type": "string"
}
}
},
"controller.LoginRequest": {
"type": "object",
"required": [
"password",
"username"
],
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"controller.UpdatePasswordRequest": {
"type": "object",
"required": [
"newPassword",
"oldPassword"
],
"properties": {
"newPassword": {
"type": "string"
},
"oldPassword": {
"type": "string"
}
}
},
"entity.SysUser": {
"type": "object",
"properties": {
"activitiSync": {
"description": "同步工作流引擎",
"type": "integer"
},
"avatar": {
"description": "头像",
"type": "string"
},
"birthday": {
"description": "生日",
"type": "string"
},
"bpmStatus": {
"description": "流程状态",
"type": "string"
},
"clientId": {
"description": "设备ID",
"type": "string"
},
"createBy": {
"description": "创建人",
"type": "string"
},
"createTime": {
"description": "创建时间",
"type": "string"
},
"delFlag": {
"description": "删除状态(0-正常,1-已删除)",
"type": "integer"
},
"departIds": {
"description": "负责部门",
"type": "string"
},
"dyOpenId": {
"description": "抖音openId",
"type": "string"
},
"email": {
"description": "电子邮件",
"type": "string"
},
"id": {
"type": "string"
},
"ip": {
"description": "注册时ip",
"type": "string"
},
"loginTenantId": {
"description": "上次登录租户ID",
"type": "integer"
},
"orgCode": {
"description": "机构编码",
"type": "string"
},
"phone": {
"description": "电话",
"type": "string"
},
"programType": {
"description": "所属程序",
"type": "string"
},
"realname": {
"description": "真实姓名",
"type": "string"
},
"sex": {
"description": "性别(0-未知,1-男,2-女)",
"type": "integer"
},
"showLinediff": {
"description": "是否显示历年线差",
"type": "string"
},
"status": {
"description": "状态(1-正常,2-冻结)",
"type": "integer"
},
"telephone": {
"description": "座机号",
"type": "string"
},
"thirdId": {
"description": "第三方登录唯一标识",
"type": "string"
},
"thirdType": {
"description": "第三方类型",
"type": "string"
},
"updateBy": {
"description": "更新人",
"type": "string"
},
"updateTime": {
"description": "更新时间",
"type": "string"
},
"userIdentity": {
"description": "身份(1普通成员 2上级)",
"type": "integer"
},
"username": {
"description": "登录账号",
"type": "string"
},
"workNo": {
"description": "工号",
"type": "string"
},
"wxOpenId": {
"description": "微信openId",
"type": "string"
}
}
},
"entity.YxCalculationMajor": {
"type": "object",
"properties": {
"batch": {
"type": "string"
},
"category": {
"type": "string"
},
"createTime": {
"type": "string"
},
"detail": {
"type": "string"
},
"enrollProbability": {
"type": "number"
},
"enrollmentCode": {
"type": "string"
},
"id": {
"type": "string"
},
"kslx": {
"type": "string"
},
"limitation": {
"type": "string"
},
"mainSubjects": {
"type": "string"
},
"majorCode": {
"type": "string"
},
"majorName": {
"type": "string"
},
"majorType": {
"type": "string"
},
"majorTypeChild": {
"type": "string"
},
"otherScoreLimitation": {
"type": "string"
},
"planNum": {
"type": "integer"
},
"privateProbabilityOperator": {
"type": "string"
},
"privateRulesEnrollProbability": {
"type": "string"
},
"privateStudentConvertedScore": {
"type": "number"
},
"probabilityOperator": {
"type": "string"
},
"rulesEnrollProbability": {
"type": "string"
},
"rulesEnrollProbabilitySx": {
"type": "string"
},
"schoolCode": {
"type": "string"
},
"scoreId": {
"type": "string"
},
"state": {
"type": "string"
},
"studentConvertedScore": {
"type": "number"
},
"studentOldConvertedScore": {
"type": "number"
},
"tuition": {
"type": "string"
}
}
},
"entity.YxHistoryMajorEnroll": {
"type": "object",
"properties": {
"actualPitcherNum": {
"type": "integer"
},
"admissionLine": {
"type": "number"
},
"admissionNum": {
"type": "integer"
},
"batch": {
"type": "string"
},
"category": {
"type": "string"
},
"checkMaster": {
"type": "string"
},
"controlLine": {
"type": "number"
},
"createBy": {
"type": "string"
},
"createTime": {
"type": "string"
},
"detail": {
"type": "string"
},
"enrollNum": {
"type": "integer"
},
"enrollmentCode": {
"type": "string"
},
"id": {
"type": "string"
},
"institutionCode": {
"type": "string"
},
"mainSubjects": {
"type": "string"
},
"majorCode": {
"type": "string"
},
"majorName": {
"type": "string"
},
"majorType": {
"type": "string"
},
"majorTypeChild": {
"type": "string"
},
"oneVolunteerAdmissionNum": {
"type": "integer"
},
"probabilityOperator": {
"type": "string"
},
"rulesEnrollProbability": {
"type": "string"
},
"schoolCode": {
"type": "string"
},
"schoolName": {
"type": "string"
},
"scoreLineDifference": {
"type": "number"
},
"sysOrgCode": {
"type": "string"
},
"tuition": {
"type": "string"
},
"updateBy": {
"type": "string"
},
"updateTime": {
"type": "string"
},
"year": {
"type": "string"
}
}
},
"entity.YxSchoolMajor": {
"type": "object",
"properties": {
"batch": {
"type": "string"
},
"category": {
"type": "string"
},
"checkMaster": {
"type": "string"
},
"chineseScoreLimitation": {
"type": "number"
},
"createBy": {
"type": "string"
},
"createTime": {
"type": "string"
},
"culturalControlLine": {
"type": "number"
},
"culturalScoreLimitation": {
"type": "number"
},
"detail": {
"type": "string"
},
"englishScoreLimitation": {
"type": "number"
},
"enrollmentCode": {
"type": "string"
},
"id": {
"type": "string"
},
"kslx": {
"type": "string"
},
"limitation": {
"type": "string"
},
"mainSubjects": {
"type": "string"
},
"majorCode": {
"type": "string"
},
"majorName": {
"type": "string"
},
"majorType": {
"type": "string"
},
"majorTypeChild": {
"type": "string"
},
"planNum": {
"type": "integer"
},
"privateProbabilityOperator": {
"type": "string"
},
"privateRulesEnrollProbability": {
"type": "string"
},
"probabilityOperator": {
"type": "string"
},
"professionalScoreLimitation": {
"type": "number"
},
"rulesEnrollProbability": {
"type": "string"
},
"rulesEnrollProbabilitySx": {
"type": "string"
},
"schoolCode": {
"type": "string"
},
"schoolName": {
"type": "string"
},
"semester": {
"type": "string"
},
"specialControlLine": {
"type": "number"
},
"state": {
"type": "string"
},
"tuition": {
"type": "string"
},
"updateBy": {
"type": "string"
},
"updateTime": {
"type": "string"
}
}
}
},
"securityDefinitions": {
"Bearer": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "2.0",
Host: "localhost:8080",
BasePath: "/api",
Schemes: []string{},
Title: "艺考招生管理系统 API",
Description: "提供用户认证、院校专业、历年招生、计算专业的管理接口",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",
RightDelim: "}}",
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}