feat: add GET /benchmarks/:id route

Author: Mikadows

src/benchmarks/benchmark.controller.ts

@@ -1,16 +1,21 @@
-import { Body, Controller, Get, Post, Request, UseGuards } from '@nestjs/common';
+import { Body, Controller, Get, Param, Post, Request, UseGuards } from '@nestjs/common';
 import { CreateBenchmarkDto } from 'src/benchmarks/dto/create-benchmark.dto';
 import { BenchmarkService } from 'src/benchmarks/benchmark.service';
 import { Benchmark } from './benchmark.entity';
 import { JwtAuthGuard } from '../auth/jwt-auth.guard';
 import { ValidatedJWTReq } from '../auth/dto/validated-jwt-req';
+import { ApiBadRequestResponse, ApiOkResponse, ApiOperation } from '@nestjs/swagger';
+import { BenchmarkIdDto } from './dto/benchmarkId.dto';
 
 
 @Controller('benchmarks')
 export class BenchmarkController {
   constructor(private readonly benchmarkService: BenchmarkService) {
   }
 
+  @ApiOperation({ summary: 'Create a benchmark' })
+  @ApiOkResponse({type: Benchmark, description: 'Created benchmark'})
+
   @Post()
   @UseGuards(JwtAuthGuard)
   async createBenchmark(
@@ -21,10 +26,21 @@ export class BenchmarkController {
     return this.benchmarkService.create(benchmark, req.user);
   }
 
+  @ApiOperation({ summary: 'Get all benchmarks' })
+  @ApiOkResponse({type: [Benchmark], description: 'Array of benchmarks'})
   @Get()
   async getEveryBenchMarks() : Promise<Benchmark[]> {
     return this.benchmarkService.getAll();
   }
 
+  @ApiOperation({ summary: 'Get benchmark by id' })
+  @ApiOkResponse({type: Benchmark, description: 'Requested benchmark'})
+  @Get(':id')
+  async getBenchmarkById(@Param() id: BenchmarkIdDto): Promise<Benchmark | undefined> {
+    const benchmark =  await this.benchmarkService.findOne(id);
+
+    return benchmark;
+  }
+
 
 }

src/benchmarks/benchmark.service.ts

@@ -23,4 +23,8 @@ export class BenchmarkService {
   async getAll() : Promise<Benchmark[]> {
     return this.benchmarkRepository.find({});
   }
+
+  async findOne(id: { id: string }): Promise<Benchmark | undefined> {
+    return this.benchmarkRepository.findOne(id);
+  }
 }

src/benchmarks/dto/benchmarkId.dto.ts

@@ -0,0 +1,8 @@
+import { IsUUID } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class BenchmarkIdDto {
+  @IsUUID('all')
+  @ApiProperty()
+  id: string;
+}