com.tencent.devops.image.api.ServiceImageResource.kt Maven / Gradle / Ivy

Go to download
/*
 * 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.image.api

import com.tencent.devops.common.api.annotation.ServiceInterface
import com.tencent.devops.common.api.auth.AUTH_HEADER_USER_ID
import com.tencent.devops.common.api.auth.AUTH_HEADER_USER_ID_DEFAULT_VALUE
import com.tencent.devops.common.api.pojo.Result
import com.tencent.devops.image.pojo.DockerRepo
import com.tencent.devops.image.pojo.DockerTag
import com.tencent.devops.image.pojo.ImageListResp
import com.tencent.devops.image.pojo.ImagePageData
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 = "SERVICE_IMAGE", description = "镜像-镜像服务")
@Path("/service/image")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.MULTIPART_FORM_DATA)
@ServiceInterface("misc")
interface ServiceImageResource {

    @Operation(summary = "获取项目Docker构建镜像列表")
    @Path("/projects/{projectId}/listDockerBuildImages")
    @GET
    fun listDockerBuildImages(
        @Parameter(description = "用户ID", required = true, example = AUTH_HEADER_USER_ID_DEFAULT_VALUE)
        @HeaderParam(AUTH_HEADER_USER_ID)
        userId: String,
        @Parameter(description = "项目ID", required = true)
        @PathParam("projectId")
        projectId: String
    ): Result>

    @Operation(summary = "镜像仓库支持升级为构建镜像")
    @Path("/projects/{projectId}/setBuildImage")
    @POST
    fun setBuildImage(
        @Parameter(description = "用户ID", required = true, example = AUTH_HEADER_USER_ID_DEFAULT_VALUE)
        @HeaderParam(AUTH_HEADER_USER_ID)
        userId: String,
        @Parameter(description = "项目ID", required = true)
        @PathParam("projectId")
        projectId: String,
        @Parameter(description = "镜像repo", required = true)
        @QueryParam("imageRepo")
        imageRepo: String,
        @Parameter(description = "镜像tag", required = true)
        @QueryParam("imageTag")
        imageTag: String
    ): Result

    @Operation(summary = "获取公共镜像列表")
    @Path("/listPublicImages")
    @GET
    fun listPublicImages(
        @Parameter(description = "用户ID", required = true, example = AUTH_HEADER_USER_ID_DEFAULT_VALUE)
        @HeaderParam(AUTH_HEADER_USER_ID)
        userId: String,
        @Parameter(description = "查询关键字", required = false)
        @QueryParam("searchKey")
        searchKey: String?,
        @Parameter(description = "分页start", required = false)
        @QueryParam("start")
        start: Int?,
        @Parameter(description = "分页大小", required = false)
        @QueryParam("limit")
        limit: Int?
    ): Result

    @Operation(summary = "获取项目镜像列表")
    @Path("/{projectId}/listImages")
    @GET
    fun listProjectImages(
        @Parameter(description = "用户ID", required = true, example = AUTH_HEADER_USER_ID_DEFAULT_VALUE)
        @HeaderParam(AUTH_HEADER_USER_ID)
        userId: String,
        @Parameter(description = "项目ID", required = true)
        @PathParam("projectId")
        projectId: String,
        @Parameter(description = "查询关键字", required = false)
        @QueryParam("searchKey")
        searchKey: String?,
        @Parameter(description = "分页start", required = false)
        @QueryParam("start")
        start: Int?,
        @Parameter(description = "分页大小", required = false)
        @QueryParam("limit")
        limit: Int?
    ): Result

    @Operation(summary = "获取所有公共镜像列表")
    @Path("/listAllPublicImages")
    @GET
    fun listAllPublicImages(
        @Parameter(description = "用户ID", required = true, example = AUTH_HEADER_USER_ID_DEFAULT_VALUE)
        @HeaderParam(AUTH_HEADER_USER_ID)
        userId: String,
        @Parameter(description = "查询关键字", required = false)
        @QueryParam("searchKey")
        searchKey: String?
    ): Result

    @Operation(summary = "获取所有项目镜像列表")
    @Path("/{projectId}/listAllProjectImages")
    @GET
    fun listAllProjectImages(
        @Parameter(description = "用户ID", required = true, example = AUTH_HEADER_USER_ID_DEFAULT_VALUE)
        @HeaderParam(AUTH_HEADER_USER_ID)
        userId: String,
        @Parameter(description = "项目ID", required = true)
        @PathParam("projectId")
        projectId: String,
        @Parameter(description = "查询关键字", required = false)
        @QueryParam("searchKey")
        searchKey: String?
    ): Result

    @Operation(summary = "获取镜像信息")
    @Path("/getImageInfo")
    @GET
    fun getImageInfo(
        @Parameter(description = "用户ID", required = true, example = AUTH_HEADER_USER_ID_DEFAULT_VALUE)
        @HeaderParam(AUTH_HEADER_USER_ID)
        userId: String,
        @Parameter(description = "镜像repo", required = true)
        @QueryParam("imageRepo")
        imageRepo: String,
        @Parameter(description = "开始索引", required = false)
        @QueryParam("tagStart")
        tagStart: Int?,
        @Parameter(description = "页大小", required = false)
        @QueryParam("tagLimit")
        tagLimit: Int?
    ): Result

    @Operation(summary = "获取构建镜像信息")
    @Path("/getTagInfo")
    @GET
    fun getTagInfo(
        @Parameter(description = "用户ID", required = true, example = AUTH_HEADER_USER_ID_DEFAULT_VALUE)
        @HeaderParam(AUTH_HEADER_USER_ID)
        userId: String,
        @Parameter(description = "镜像repo", required = true)
        @QueryParam("imageRepo")
        imageRepo: String,
        @Parameter(description = "镜像tag", required = true)
        @QueryParam("imageTag")
        imageTag: String
    ): Result

    @Operation(summary = "获取项目DevCloud构建镜像列表")
    @Path("/{projectId}/listDevCloudImages/{public}")
    @GET
    fun listDevCloudImages(
        @Parameter(description = "用户ID", required = true, example = AUTH_HEADER_USER_ID_DEFAULT_VALUE)
        @HeaderParam(AUTH_HEADER_USER_ID)
        userId: String,
        @Parameter(description = "项目ID", required = true)
        @PathParam("projectId")
        projectId: String,
        @Parameter(description = "是否公共镜像", required = true)
        @PathParam("public")
        public: Boolean
    ): Result>
}