avatar-api/desc/job/task.api

import "../base.api"

type (
    // The response data of task information | 定时任务信息
    TaskInfo {
        BaseIDInfo

        // Status | 状态
        Status *uint32 `json:"status,optional" validate:"omitempty,lt=20"`

        // Name | 任务名称
        Name *string `json:"name,optional" validate:"omitempty,max=50"`

        // TaskGroup | 任务分组
        TaskGroup *string `json:"taskGroup,optional" validate:"omitempty,max=40"`

        // CronExpression | 定时任务 Cron 表达式
        CronExpression *string `json:"cronExpression,optional" validate:"omitempty,max=80"`

        // Pattern | 任务的标识 (用于区分和确定要执行的任务)
        Pattern *string `json:"pattern,optional" validate:"omitempty,max=100"`

        // Payload | 任务需要数据(JSON 字符串)
        Payload *string `json:"payload,optional"`
    }

    // The response data of task list | 定时任务列表数据
    TaskListResp {
        BaseDataInfo

        // Task list data | 定时任务列表数据
        Data TaskListInfo `json:"data"`
    }

    // Task list data | 定时任务列表数据
    TaskListInfo {
        BaseListInfo

        // The API list data | 定时任务列表数据
        Data  []TaskInfo  `json:"data"`
    }

    // Get task list request params | 定时任务列表请求参数
    TaskListReq {
        PageInfo

        // Name | 任务名称
        Name *string `json:"name,optional"`

        // TaskGroup | 任务分组
        TaskGroup *string `json:"taskGroup,optional"`
    }

    // Task information response | 定时任务信息返回体
    TaskInfoResp {
        BaseDataInfo

        // Task information | 定时任务数据
        Data TaskInfo `json:"data"`
    }
)

@server(
    jwt: Auth
    group: task
    middleware: Authority
)

service Core {
    // Create task information | 创建定时任务
    @handler createTask
    post /task/create (TaskInfo) returns (BaseMsgResp)

    // Update task information | 更新定时任务
    @handler updateTask
    post /task/update (TaskInfo) returns (BaseMsgResp)

    // Delete task information | 删除定时任务信息
    @handler deleteTask
    post /task/delete (IDsReq) returns (BaseMsgResp)

    // Get task list | 获取定时任务列表
    @handler getTaskList
    post /task/list (TaskListReq) returns (TaskListResp)

    // Get task by ID | 通过ID获取定时任务
    @handler getTaskById
    post /task (IDReq) returns (TaskInfoResp)
}