added attribute descriptions for Broker Modell

Stonks2Moon · Mar 27, 2021 · fbad7ba · fbad7ba
1 parent a030df9
commit fbad7ba
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/src/broker/models/Broker.model.ts b/src/broker/models/Broker.model.ts
@@ -1,6 +1,24 @@
+import { ApiProperty } from '@nestjs/swagger';
+
 export class BrokerModel {
+  @ApiProperty({
+    description: 'Token of broker, to identify and authenticate.',
+  })
   id: string;
+
+  @ApiProperty({
+    description: 'Type of broker. Important for clearing and access rights',
+    type: 'BrokerType',
+  })
   type: 'private' | 'business' | 'simulation' | 'stockmarket';
+
+  @ApiProperty({
+    description: 'Internal displayName for an specific broker',
+  })
   displayName: string;
+
+  @ApiProperty({
+    description: 'Determines if broker is banned',
+  })
   banned?: boolean;
 }