xpggame/docs/backend/warn.go

package backend

import (
	"server/call"
	"server/modules/backend/app"
	"server/modules/backend/values"
)

// swagger:route GET /warn/list warn idOfWarnList
// 获取预警列表
// Responses:
//	 200:WarnListResp

// swagger:response WarnListResp
type WarnListResp struct {
	// in:body
	Body values.WarnListResp
}

// swagger:route POST /warn/add warn idOfWarnAdd
// 添加预警
// condition以键值对形式发送，每种预警需包含的字段在condition xx里
// Responses:
//	 200:WarnAddResp

// swagger:response WarnAddResp
type WarnAddResp struct {
	// in:body
	Body app.R
}

// swagger:parameters idOfWarnAdd
type WarnAddReq struct {
	// in:body
	Body struct {
		Req                      values.AddWarnReq
		ConditionRecharge        call.SysWarnRecharge
		ConditionWithdraw        call.SysWarnWithdraw
		ConditionWithdrawStorage call.SysWarnWithdrawStorage
		ConditionWithdrawExamine call.SysWarnWithdrawExamine
		ConditionActivity        call.SysWarnActivity
	}
}

// swagger:route POST /warn/edit warn idOfWarnEdit
// 修改预警
// Responses:
//	 200:WarnEditResp

// swagger:response WarnEditResp
type WarnEditResp struct {
	// in:body
	Body app.R
}

// swagger:parameters idOfWarnEdit
type WarnEditReq struct {
	// in:body
	Body values.EditWarnReq
}

// swagger:route POST /warn/del warn idOfWarnDel
// 删除预警
// Responses:
//	 200:WarnDelResp

// swagger:response WarnDelResp
type WarnDelResp struct {
	// in:body
	Body app.R
}

// swagger:parameters idOfWarnDel
type WarnDelReq struct {
	// in:body
	Body values.DelWarnReq
}