com.tencent.devops.process.api.builds.BuildSubPipelineResource.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-process Show documentation
Tencent blueking ci project
The newest version!
/*
 * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
 *
 * Copyright (C) 2019 THL A29 Limited, a Tencent company.  All rights reserved.
 *
 * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
 *
 * A copy of the MIT License is included in this file.
 *
 *
 * Terms of the MIT License:
 * ---------------------------------------------------
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
 * the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 * LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
 * NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.tencent.devops.process.api.builds

import com.tencent.devops.common.api.auth.AUTH_HEADER_DEVOPS_BUILD_ID
import com.tencent.devops.common.api.auth.AUTH_HEADER_DEVOPS_EXECUTE_COUNT
import com.tencent.devops.common.api.auth.AUTH_HEADER_DEVOPS_PIPELINE_ID
import com.tencent.devops.common.api.auth.AUTH_HEADER_DEVOPS_PROJECT_ID
import com.tencent.devops.common.api.pojo.Result
import com.tencent.devops.common.pipeline.enums.ChannelCode
import com.tencent.devops.process.pojo.PipelineId
import com.tencent.devops.process.pojo.pipeline.ProjectBuildId
import com.tencent.devops.process.pojo.pipeline.SubPipelineStartUpInfo
import com.tencent.devops.process.pojo.pipeline.SubPipelineStatus
import io.swagger.v3.oas.annotations.tags.Tag
import io.swagger.v3.oas.annotations.Operation
import io.swagger.v3.oas.annotations.Parameter
import javax.ws.rs.Consumes
import javax.ws.rs.GET
import javax.ws.rs.HeaderParam
import javax.ws.rs.POST
import javax.ws.rs.Path
import javax.ws.rs.PathParam
import javax.ws.rs.Produces
import javax.ws.rs.QueryParam
import javax.ws.rs.core.MediaType

@Tag(name = "BUILD_SUBPIPELINE", description = "构建-流水线调用")
@Path("/build/subpipeline")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Suppress("ALL")
interface BuildSubPipelineResource {
    @Operation(summary = "获取子流水线状态")
    @GET
    // @Path("/projects/{projectId}/pipelines/{pipelineId}/builds/{buildId}/detail")
    @Path("/subPipeline/{projectId}/{pipelineId}/{buildId}/detail")
    fun getSubPipelineStatus(
        @Parameter(description = "项目ID", required = true)
        @PathParam("projectId")
        projectId: String,
        @Parameter(description = "流水线ID", required = true)
        @PathParam("pipelineId")
        pipelineId: String,
        @Parameter(description = "构建ID", required = true)
        @PathParam("buildId")
        buildId: String
    ): Result

    @Operation(summary = "从构建机启动子流水线")
    @POST
    // @Path("/pipelines/{callPipelineId}/atoms/{atomCode}/startByPipeline")
    @Path("/pipelines/{callPipelineId}/{atomCode}/startByPipeline")
    fun callPipelineStartup(
        @Parameter(description = "项目ID", required = true)
        @HeaderParam(AUTH_HEADER_DEVOPS_PROJECT_ID)
        projectId: String,
        @Parameter(description = "当前流水线ID", required = true)
        @HeaderParam(AUTH_HEADER_DEVOPS_PIPELINE_ID)
        parentPipelineId: String,
        @Parameter(description = "构建ID", required = true)
        @HeaderParam(AUTH_HEADER_DEVOPS_BUILD_ID)
        buildId: String,
        @Parameter(description = "要启动的流水线ID", required = true)
        @PathParam("callPipelineId")
        callPipelineId: String,
        @Parameter(description = "插件标识", required = true)
        @PathParam("atomCode")
        atomCode: String,
        @Parameter(description = "插件ID", required = true)
        @QueryParam("taskId")
        taskId: String,
        @Parameter(description = "运行方式", required = true)
        @QueryParam("runMode")
        runMode: String,
        @QueryParam("channelCode")
        channelCode: ChannelCode?,
        @Parameter(description = "启动参数", required = true)
        values: Map,
        @Parameter(description = "当前流水线执行次数", required = false)
        @HeaderParam(AUTH_HEADER_DEVOPS_EXECUTE_COUNT)
        executeCount: Int? = 1
    ): Result

    @Operation(summary = "从构建机启动指定项目的子流水线")
    @POST
    // @Path("/pipelines/{callPipelineId}/atoms/{atomCode}/startByPipeline")
    @Path("/projects/{callProjectId}/pipelines/{callPipelineId}/atoms/{atomCode}/startByPipeline")
    fun callOtherProjectPipelineStartup(
        @Parameter(description = "项目ID", required = true)
        @HeaderParam(AUTH_HEADER_DEVOPS_PROJECT_ID)
        projectId: String,
        @Parameter(description = "当前流水线ID", required = true)
        @HeaderParam(AUTH_HEADER_DEVOPS_PIPELINE_ID)
        parentPipelineId: String,
        @Parameter(description = "构建ID", required = true)
        @HeaderParam(AUTH_HEADER_DEVOPS_BUILD_ID)
        buildId: String,
        @Parameter(description = "要启动的流水线ID", required = true)
        @PathParam("callProjectId")
        callProjectId: String,
        @Parameter(description = "要启动的流水线ID", required = true)
        @PathParam("callPipelineId")
        callPipelineId: String,
        @Parameter(description = "插件标识", required = true)
        @PathParam("atomCode")
        atomCode: String,
        @Parameter(description = "插件ID", required = true)
        @QueryParam("taskId")
        taskId: String,
        @Parameter(description = "运行方式", required = true)
        @QueryParam("runMode")
        runMode: String,
        @Parameter(description = "启动参数", required = true)
        values: Map,
        @Parameter(description = "当前流水线执行次数", required = false)
        @HeaderParam(AUTH_HEADER_DEVOPS_EXECUTE_COUNT)
        executeCount: Int? = 1
    ): Result

    @Operation(summary = "获取子流水线启动参数")
    @GET
    @Path("/projects/{projectId}/pipelines/{pipelineId}/manualStartupInfo")
    fun subpipManualStartupInfo(
        @Parameter(description = "用户ID", required = true)
        @QueryParam("userId")
        userId: String,
        @Parameter(description = "项目ID", required = true)
        @PathParam("projectId")
        projectId: String,
        @Parameter(description = "流水线ID", required = false, example = "")
        @PathParam("pipelineId")
        pipelineId: String,
        @Parameter(description = "是否包含常量", required = false, example = "")
        @QueryParam("includeConst")
        includeConst: Boolean? = true,
        @Parameter(description = "是否包含非入参", required = false, example = "")
        @QueryParam("includeNotRequired")
        includeNotRequired: Boolean? = true,
        @Parameter(description = "项目ID", required = true)
        @HeaderParam(AUTH_HEADER_DEVOPS_PROJECT_ID)
        parentProjectId: String,
        @Parameter(description = "当前流水线ID", required = true)
        @HeaderParam(AUTH_HEADER_DEVOPS_PIPELINE_ID)
        parentPipelineId: String
    ): Result>

    @Operation(summary = "根据流水线名称获取流水线ID")
    @GET
    @Path("/projects/{projectId}/pipelines/getPipelineIdByName")
    fun getPipelineByName(
        @Parameter(description = "项目ID", required = true)
        @PathParam("projectId")
        projectId: String,
        @Parameter(description = "流水线名称", required = false, example = "")
        @QueryParam("pipelineName")
        pipelineName: String
    ): Result>
}