forked from Cutlery/immich
Jason Rasmussen
87 lines
3.2 KiB
TypeScript
87 lines
3.2 KiB
TypeScript
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Post, Put } from '@nestjs/common';
|
|
import { ApiTags } from '@nestjs/swagger';
|
|
import { Endpoint, HistoryBuilder } from 'src/decorators';
|
|
import { ApiKeyCreateDto, ApiKeyCreateResponseDto, ApiKeyResponseDto, ApiKeyUpdateDto } from 'src/dtos/api-key.dto';
|
|
import { AuthDto } from 'src/dtos/auth.dto';
|
|
import { ApiTag, Permission } from 'src/enum';
|
|
import { Auth, Authenticated } from 'src/middleware/auth.guard';
|
|
import { ApiKeyService } from 'src/services/api-key.service';
|
|
import { UUIDParamDto } from 'src/validation';
|
|
|
|
@ApiTags(ApiTag.ApiKeys)
|
|
@Controller('api-keys')
|
|
export class ApiKeyController {
|
|
constructor(private service: ApiKeyService) {}
|
|
|
|
@Post()
|
|
@Authenticated({ permission: Permission.ApiKeyCreate })
|
|
@Endpoint({
|
|
summary: 'Create an API key',
|
|
description: 'Creates a new API key. It will be limited to the permissions specified.',
|
|
history: new HistoryBuilder().added('v1').beta('v1').stable('v2'),
|
|
})
|
|
createApiKey(@Auth() auth: AuthDto, @Body() dto: ApiKeyCreateDto): Promise<ApiKeyCreateResponseDto> {
|
|
return this.service.create(auth, dto);
|
|
}
|
|
|
|
@Get()
|
|
@Authenticated({ permission: Permission.ApiKeyRead })
|
|
@Endpoint({
|
|
summary: 'List all API keys',
|
|
description: 'Retrieve all API keys of the current user.',
|
|
history: new HistoryBuilder().added('v1').beta('v1').stable('v2'),
|
|
})
|
|
getApiKeys(@Auth() auth: AuthDto): Promise<ApiKeyResponseDto[]> {
|
|
return this.service.getAll(auth);
|
|
}
|
|
|
|
@Get('me')
|
|
@Authenticated({ permission: false })
|
|
@Endpoint({
|
|
summary: 'Retrieve the current API key',
|
|
description: 'Retrieve the API key that is used to access this endpoint.',
|
|
history: new HistoryBuilder().added('v1').beta('v1').stable('v2'),
|
|
})
|
|
async getMyApiKey(@Auth() auth: AuthDto): Promise<ApiKeyResponseDto> {
|
|
return this.service.getMine(auth);
|
|
}
|
|
|
|
@Get(':id')
|
|
@Authenticated({ permission: Permission.ApiKeyRead })
|
|
@Endpoint({
|
|
summary: 'Retrieve an API key',
|
|
description: 'Retrieve an API key by its ID. The current user must own this API key.',
|
|
history: new HistoryBuilder().added('v1').beta('v1').stable('v2'),
|
|
})
|
|
getApiKey(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<ApiKeyResponseDto> {
|
|
return this.service.getById(auth, id);
|
|
}
|
|
|
|
@Put(':id')
|
|
@Authenticated({ permission: Permission.ApiKeyUpdate })
|
|
@Endpoint({
|
|
summary: 'Update an API key',
|
|
description: 'Updates the name and permissions of an API key by its ID. The current user must own this API key.',
|
|
history: new HistoryBuilder().added('v1').beta('v1').stable('v2'),
|
|
})
|
|
updateApiKey(
|
|
@Auth() auth: AuthDto,
|
|
@Param() { id }: UUIDParamDto,
|
|
@Body() dto: ApiKeyUpdateDto,
|
|
): Promise<ApiKeyResponseDto> {
|
|
return this.service.update(auth, id, dto);
|
|
}
|
|
|
|
@Delete(':id')
|
|
@Authenticated({ permission: Permission.ApiKeyDelete })
|
|
@HttpCode(HttpStatus.NO_CONTENT)
|
|
@Endpoint({
|
|
summary: 'Delete an API key',
|
|
description: 'Deletes an API key identified by its ID. The current user must own this API key.',
|
|
history: new HistoryBuilder().added('v1').beta('v1').stable('v2'),
|
|
})
|
|
deleteApiKey(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {
|
|
return this.service.delete(auth, id);
|
|
}
|
|
}
|