Class ImageHttpController

web/crux/src/app/image/image.http.controller.ts:54–198

@ApiTags('version/images')
@UseGuards(ImageTeamAccessGuard)
export default class ImageHttpController {
  constructor(private service: ImageService) {}

  @Get()
  @HttpCode(HttpStatus.OK)
  @ApiOperation({
    description:
      "Fetch details of images within a version. `ProjectId` refers to the project's ID, `versionId` refers to the version's ID. Both, and `teamSlug` are required in the URL.</br></br>Details come in an array, including `name`, `id`, `tag`, `order`, and config details of the image.",
    summary: 'Fetch data of all images of a version.',
  })
  @ApiOkResponse({
    type: ImageDetailsDto,
    isArray: true,
    description: 'Data of images listed.',
  })
  @ApiForbiddenResponse({ description: 'Unauthorized request for images.' })
  @UuidParams(PARAM_PROJECT_ID, PARAM_VERSION_ID)
  async getImagesByVersionId(
    @TeamSlug() _: string,
    @ProjectId() _projectId: string,
    @VersionId() versionId: string,
  ): Promise<ImageDetailsDto[]> {
    return await this.service.getImagesByVersionId(versionId)
  }

  @Get(ROUTE_IMAGE_ID)
  @HttpCode(HttpStatus.OK)
  @ApiOperation({
    description:
      "Fetch details of an image within a version. `projectId` refers to the project's ID, `versionId` refers to the version's ID, `imageId` refers to the image's ID. All, and `teamSlug` are required in the URL.</br></br>Image details consists `name`, `id`, `tag`, `order`, and the config of the image.",
    summary: 'Fetch data of an image of a version.',
  })
  @ApiOkResponse({ type: ImageDetailsDto, description: 'Data of an image.' })
  @ApiBadRequestResponse({ description: 'Bad request for image details.' })
  @ApiForbiddenResponse({ description: 'Unauthorized request for image details.' })
  @ApiNotFoundResponse({ description: 'Image not found.' })
  @UuidParams(PARAM_PROJECT_ID, PARAM_VERSION_ID, PARAM_IMAGE_ID)
  async getImageDetails(
    @TeamSlug() _: string,
    @ProjectId() _projectId: string,
    @VersionId() _versionId: string,
    @ImageId() imageId: string,
  ): Promise<ImageDetailsDto> {
    return await this.service.getImageDetails(imageId)
  }

  @Post()
  @HttpCode(HttpStatus.CREATED)
  @CreatedWithLocation()
  @ApiOperation({
    description:
      "Add new images to a version. `projectId` refers to the project's ID, `versionId` refers to the version's ID. These, and `teamSlug` are required in the URL. `registryId` refers to the registry's ID, `images` refers to the name(s) of the images you'd like to add. These are required variables in the body.",
    summary: 'Add images to a version.',
  })
  @ApiBody({ type: AddImagesDto, isArray: true })
  @ApiCreatedResponse({ type: ImageDetailsDto, isArray: true, description: 'New image added.' })
  @ApiBadRequestResponse({ description: 'Bad request for images.' })
  @ApiForbiddenResponse({ description: 'Unauthorized request for images.' })