fix swagger response types

wermarter · Jan 26, 2024 · 33a3748 · 33a3748
1 parent 9bc5a63
commit 33a3748
Show file tree

Hide file tree

Showing 30 changed files with 291 additions and 212 deletions.
diff --git a/apps/hcdc-access-service/src/presentation/http/v1/bio-product/dto/response-dto.ts b/apps/hcdc-access-service/src/presentation/http/v1/bio-product/dto/response-dto.ts
@@ -4,7 +4,7 @@ import { Expose, Type } from 'class-transformer'
 import { ValidateNested } from 'class-validator'
 
 import { BioProductCreateRequestDto } from './create.request-dto'
-import { Branch, exampleBioProduct } from 'src/domain'
+import { exampleBioProduct } from 'src/domain'
 import { BranchUnpopulatedResponseDto } from '../../branch/dto/response-dto'
 
 export class BioProductUnpopulatedResponseDto extends IntersectionType(
@@ -20,5 +20,5 @@ export class BioProductResponseDto extends BioProductUnpopulatedResponseDto {
   })
   @ValidateNested({ each: true })
   @Type(() => BranchUnpopulatedResponseDto)
-  branch?: Branch
+  branch?: BranchUnpopulatedResponseDto
 }
diff --git a/apps/hcdc-access-service/src/presentation/http/v1/bio-product/routes.ts b/apps/hcdc-access-service/src/presentation/http/v1/bio-product/routes.ts
@@ -2,7 +2,10 @@ import { HttpStatus, RequestMethod } from '@nestjs/common'
 import { CustomHttpRouteOptions } from '@diut/nest-core'
 
 import { BioProductSearchResponseDto } from './dto/search.response-dto'
-import { BioProductResponseDto } from './dto/response-dto'
+import {
+  BioProductResponseDto,
+  BioProductUnpopulatedResponseDto,
+} from './dto/response-dto'
 
 export const bioProductRoutes = {
   search: {
@@ -21,11 +24,11 @@ export const bioProductRoutes = {
 
   create: {
     method: RequestMethod.POST,
-    serialize: BioProductResponseDto,
+    serialize: BioProductUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: BioProductResponseDto,
+          type: BioProductUnpopulatedResponseDto,
           status: HttpStatus.CREATED,
         },
       ],
@@ -35,11 +38,11 @@ export const bioProductRoutes = {
   updateById: {
     path: ':id',
     method: RequestMethod.PATCH,
-    serialize: BioProductResponseDto,
+    serialize: BioProductUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: BioProductResponseDto,
+          type: BioProductUnpopulatedResponseDto,
         },
       ],
     },
@@ -61,11 +64,11 @@ export const bioProductRoutes = {
   deleteById: {
     path: ':id',
     method: RequestMethod.DELETE,
-    serialize: BioProductResponseDto,
+    serialize: BioProductUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: BioProductResponseDto,
+          type: BioProductUnpopulatedResponseDto,
         },
       ],
     },

diff --git a/apps/hcdc-access-service/src/presentation/http/v1/branch/dto/response-dto.ts b/apps/hcdc-access-service/src/presentation/http/v1/branch/dto/response-dto.ts
@@ -4,7 +4,7 @@ import { Expose, Type } from 'class-transformer'
 import { IsArray, ValidateNested } from 'class-validator'
 
 import { BranchCreateRequestDto } from './create.request-dto'
-import { Branch, exampleBranch } from 'src/domain'
+import { exampleBranch } from 'src/domain'
 
 export class BranchUnpopulatedResponseDto extends IntersectionType(
   BaseResourceResponseDto,
@@ -15,13 +15,10 @@ export class BranchResponseDto extends BranchUnpopulatedResponseDto {
   @Expose()
   @ApiProperty({
     ...exampleBranch.sampleOrigins,
-    type: () =>
-      class OmittedBranchResponseDto extends OmitType(BranchResponseDto, [
-        'sampleOrigins',
-      ]) {},
+    type: () => BranchUnpopulatedResponseDto,
   })
   @IsArray()
   @ValidateNested({ each: true })
-  @Type(() => BranchResponseDto)
-  sampleOrigins?: (Branch | null)[]
+  @Type(() => BranchUnpopulatedResponseDto)
+  sampleOrigins?: BranchUnpopulatedResponseDto[]
 }
diff --git a/apps/hcdc-access-service/src/presentation/http/v1/branch/routes.ts b/apps/hcdc-access-service/src/presentation/http/v1/branch/routes.ts
@@ -2,7 +2,10 @@ import { HttpStatus, RequestMethod } from '@nestjs/common'
 import { CustomHttpRouteOptions } from '@diut/nest-core'
 
 import { BranchSearchResponseDto } from './dto/search.response-dto'
-import { BranchResponseDto } from './dto/response-dto'
+import {
+  BranchResponseDto,
+  BranchUnpopulatedResponseDto,
+} from './dto/response-dto'
 
 export const branchRoutes = {
   search: {
@@ -21,11 +24,11 @@ export const branchRoutes = {
 
   create: {
     method: RequestMethod.POST,
-    serialize: BranchResponseDto,
+    serialize: BranchUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: BranchResponseDto,
+          type: BranchUnpopulatedResponseDto,
           status: HttpStatus.CREATED,
         },
       ],
@@ -35,11 +38,11 @@ export const branchRoutes = {
   updateById: {
     path: ':id',
     method: RequestMethod.PATCH,
-    serialize: BranchResponseDto,
+    serialize: BranchUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: BranchResponseDto,
+          type: BranchUnpopulatedResponseDto,
         },
       ],
     },
@@ -61,11 +64,11 @@ export const branchRoutes = {
   deleteById: {
     path: ':id',
     method: RequestMethod.DELETE,
-    serialize: BranchResponseDto,
+    serialize: BranchUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: BranchResponseDto,
+          type: BranchUnpopulatedResponseDto,
         },
       ],
     },

diff --git a/apps/hcdc-access-service/src/presentation/http/v1/diagnosis/dto/response-dto.ts b/apps/hcdc-access-service/src/presentation/http/v1/diagnosis/dto/response-dto.ts
@@ -4,8 +4,8 @@ import { Expose, Type } from 'class-transformer'
 import { ValidateNested } from 'class-validator'
 
 import { DiagnosisCreateRequestDto } from './create.request-dto'
-import { Branch, exampleDiagnosis } from 'src/domain'
-import { BranchResponseDto } from '../../branch/dto/response-dto'
+import { exampleDiagnosis } from 'src/domain'
+import { BranchUnpopulatedResponseDto } from '../../branch/dto/response-dto'
 
 export class DiagnosisUnpopulatedResponseDto extends IntersectionType(
   BaseResourceResponseDto,
@@ -14,8 +14,11 @@ export class DiagnosisUnpopulatedResponseDto extends IntersectionType(
 
 export class DiagnosisResponseDto extends DiagnosisUnpopulatedResponseDto {
   @Expose()
-  @ApiProperty({ ...exampleDiagnosis.branch, type: () => BranchResponseDto })
+  @ApiProperty({
+    ...exampleDiagnosis.branch,
+    type: () => BranchUnpopulatedResponseDto,
+  })
   @ValidateNested({ each: true })
-  @Type(() => BranchResponseDto)
-  branch?: Branch
+  @Type(() => BranchUnpopulatedResponseDto)
+  branch?: BranchUnpopulatedResponseDto
 }
diff --git a/apps/hcdc-access-service/src/presentation/http/v1/diagnosis/routes.ts b/apps/hcdc-access-service/src/presentation/http/v1/diagnosis/routes.ts
@@ -2,7 +2,10 @@ import { HttpStatus, RequestMethod } from '@nestjs/common'
 import { CustomHttpRouteOptions } from '@diut/nest-core'
 
 import { DiagnosisSearchResponseDto } from './dto/search.response-dto'
-import { DiagnosisResponseDto } from './dto/response-dto'
+import {
+  DiagnosisResponseDto,
+  DiagnosisUnpopulatedResponseDto,
+} from './dto/response-dto'
 
 export const diagnosisRoutes = {
   search: {
@@ -21,11 +24,11 @@ export const diagnosisRoutes = {
 
   create: {
     method: RequestMethod.POST,
-    serialize: DiagnosisResponseDto,
+    serialize: DiagnosisUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: DiagnosisResponseDto,
+          type: DiagnosisUnpopulatedResponseDto,
           status: HttpStatus.CREATED,
         },
       ],
@@ -35,11 +38,11 @@ export const diagnosisRoutes = {
   updateById: {
     path: ':id',
     method: RequestMethod.PATCH,
-    serialize: DiagnosisResponseDto,
+    serialize: DiagnosisUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: DiagnosisResponseDto,
+          type: DiagnosisUnpopulatedResponseDto,
         },
       ],
     },
@@ -61,11 +64,11 @@ export const diagnosisRoutes = {
   deleteById: {
     path: ':id',
     method: RequestMethod.DELETE,
-    serialize: DiagnosisResponseDto,
+    serialize: DiagnosisUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: DiagnosisResponseDto,
+          type: DiagnosisUnpopulatedResponseDto,
         },
       ],
     },

diff --git a/apps/hcdc-access-service/src/presentation/http/v1/doctor/dto/response-dto.ts b/apps/hcdc-access-service/src/presentation/http/v1/doctor/dto/response-dto.ts
@@ -4,8 +4,8 @@ import { Expose, Type } from 'class-transformer'
 import { ValidateNested } from 'class-validator'
 
 import { DoctorCreateRequestDto } from './create.request-dto'
-import { Branch, exampleDoctor } from 'src/domain'
-import { BranchResponseDto } from '../../branch/dto/response-dto'
+import { exampleDoctor } from 'src/domain'
+import { BranchUnpopulatedResponseDto } from '../../branch/dto/response-dto'
 
 export class DoctorUnpopulatedResponseDto extends IntersectionType(
   BaseResourceResponseDto,
@@ -14,8 +14,11 @@ export class DoctorUnpopulatedResponseDto extends IntersectionType(
 
 export class DoctorResponseDto extends DoctorUnpopulatedResponseDto {
   @Expose()
-  @ApiProperty({ ...exampleDoctor.branch, type: () => BranchResponseDto })
+  @ApiProperty({
+    ...exampleDoctor.branch,
+    type: () => BranchUnpopulatedResponseDto,
+  })
   @ValidateNested({ each: true })
-  @Type(() => BranchResponseDto)
-  branch?: Branch
+  @Type(() => BranchUnpopulatedResponseDto)
+  branch?: BranchUnpopulatedResponseDto
 }
diff --git a/apps/hcdc-access-service/src/presentation/http/v1/doctor/routes.ts b/apps/hcdc-access-service/src/presentation/http/v1/doctor/routes.ts
@@ -2,7 +2,10 @@ import { HttpStatus, RequestMethod } from '@nestjs/common'
 import { CustomHttpRouteOptions } from '@diut/nest-core'
 
 import { DoctorSearchResponseDto } from './dto/search.response-dto'
-import { DoctorResponseDto } from './dto/response-dto'
+import {
+  DoctorResponseDto,
+  DoctorUnpopulatedResponseDto,
+} from './dto/response-dto'
 
 export const doctorRoutes = {
   search: {
@@ -21,11 +24,11 @@ export const doctorRoutes = {
 
   create: {
     method: RequestMethod.POST,
-    serialize: DoctorResponseDto,
+    serialize: DoctorUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: DoctorResponseDto,
+          type: DoctorUnpopulatedResponseDto,
           status: HttpStatus.CREATED,
         },
       ],
@@ -35,11 +38,11 @@ export const doctorRoutes = {
   updateById: {
     path: ':id',
     method: RequestMethod.PATCH,
-    serialize: DoctorResponseDto,
+    serialize: DoctorUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: DoctorResponseDto,
+          type: DoctorUnpopulatedResponseDto,
         },
       ],
     },
@@ -61,11 +64,11 @@ export const doctorRoutes = {
   deleteById: {
     path: ':id',
     method: RequestMethod.DELETE,
-    serialize: DoctorResponseDto,
+    serialize: DoctorUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: DoctorResponseDto,
+          type: DoctorUnpopulatedResponseDto,
         },
       ],
     },

diff --git a/apps/hcdc-access-service/src/presentation/http/v1/instrument/dto/response-dto.ts b/apps/hcdc-access-service/src/presentation/http/v1/instrument/dto/response-dto.ts
@@ -4,8 +4,8 @@ import { Expose, Type } from 'class-transformer'
 import { ValidateNested } from 'class-validator'
 
 import { InstrumentCreateRequestDto } from './create.request-dto'
-import { Branch, exampleInstrument } from 'src/domain'
-import { BranchResponseDto } from '../../branch/dto/response-dto'
+import { exampleInstrument } from 'src/domain'
+import { BranchUnpopulatedResponseDto } from '../../branch/dto/response-dto'
 
 export class InstrumentUnpopulatedResponseDto extends IntersectionType(
   BaseResourceResponseDto,
@@ -14,8 +14,11 @@ export class InstrumentUnpopulatedResponseDto extends IntersectionType(
 
 export class InstrumentResponseDto extends InstrumentUnpopulatedResponseDto {
   @Expose()
-  @ApiProperty({ ...exampleInstrument.branch, type: () => BranchResponseDto })
+  @ApiProperty({
+    ...exampleInstrument.branch,
+    type: () => BranchUnpopulatedResponseDto,
+  })
   @ValidateNested({ each: true })
-  @Type(() => BranchResponseDto)
-  branch?: Branch
+  @Type(() => BranchUnpopulatedResponseDto)
+  branch?: BranchUnpopulatedResponseDto
 }
diff --git a/apps/hcdc-access-service/src/presentation/http/v1/instrument/routes.ts b/apps/hcdc-access-service/src/presentation/http/v1/instrument/routes.ts
@@ -2,7 +2,10 @@ import { HttpStatus, RequestMethod } from '@nestjs/common'
 import { CustomHttpRouteOptions } from '@diut/nest-core'
 
 import { InstrumentSearchResponseDto } from './dto/search.response-dto'
-import { InstrumentResponseDto } from './dto/response-dto'
+import {
+  InstrumentResponseDto,
+  InstrumentUnpopulatedResponseDto,
+} from './dto/response-dto'
 
 export const instrumentRoutes = {
   search: {
@@ -21,11 +24,11 @@ export const instrumentRoutes = {
 
   create: {
     method: RequestMethod.POST,
-    serialize: InstrumentResponseDto,
+    serialize: InstrumentUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: InstrumentResponseDto,
+          type: InstrumentUnpopulatedResponseDto,
           status: HttpStatus.CREATED,
         },
       ],
@@ -35,11 +38,11 @@ export const instrumentRoutes = {
   updateById: {
     path: ':id',
     method: RequestMethod.PATCH,
-    serialize: InstrumentResponseDto,
+    serialize: InstrumentUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: InstrumentResponseDto,
+          type: InstrumentUnpopulatedResponseDto,
         },
       ],
     },
@@ -61,11 +64,11 @@ export const instrumentRoutes = {
   deleteById: {
     path: ':id',
     method: RequestMethod.DELETE,
-    serialize: InstrumentResponseDto,
+    serialize: InstrumentUnpopulatedResponseDto,
     openApi: {
       responses: [
         {
-          type: InstrumentResponseDto,
+          type: InstrumentUnpopulatedResponseDto,
         },
       ],
     },