Merge pull request #557 from SciCatProject/swap-3349

Swap 3349 - Issue 450
SciCatProject · Jun 15, 2023 · e64f9d6 · e64f9d6
2 parents b9aa0d3 + f067c63
commit e64f9d6
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 8 deletions.
diff --git a/src/datablocks/dto/create-datablock.dto.ts b/src/datablocks/dto/create-datablock.dto.ts
@@ -1,8 +1,10 @@
+import { ApiProperty } from "@nestjs/swagger";
 import { Type } from "class-transformer";
 import {
   ArrayNotEmpty,
   IsArray,
   IsInt,
+  IsNotEmpty,
   IsOptional,
   IsString,
   ValidateNested,
@@ -12,22 +14,59 @@ import { OwnableDto } from "src/common/dto/ownable.dto";
 import { DataFile } from "src/common/schemas/datafile.schema";
 
 export class CreateDatablockDto extends OwnableDto {
+  @ApiProperty({
+    type: String,
+    required: true,
+    description:
+      "Persistent identifier of the dataset this orig datablock belongs to.",
+  })
   @IsString()
   readonly datasetId: string;
 
+  @ApiProperty({
+    type: String,
+    required: true,
+    description:
+      "Unique identifier given by the archive system to the stored datablock. This id is used when data is retrieved back.",
+  })
   @IsString()
   readonly archiveId: string;
 
+  @ApiProperty({
+    type: Number,
+    required: true,
+    description:
+      "Total size in bytes of all files in the datablock when on accessible.",
+  })
   @IsInt()
   readonly size: number;
 
+  @ApiProperty({
+    type: Number,
+    required: true,
+    description:
+      "Total size in bytes of all files in the datablock when on archived.",
+  })
   @IsInt()
   readonly packedSize: number;
 
+  @ApiProperty({
+    type: String,
+    required: false,
+    description:
+      "Name of the hasing algorithm used to compute the hash for each file.",
+  })
   @IsOptional()
   @IsString()
+  @IsNotEmpty()
   readonly chkAlg: string;
 
+  @ApiProperty({
+    type: String,
+    required: true,
+    description:
+      "Version string defining the format of how data is packed and stored in archive.",
+  })
   @IsString()
   readonly version: string;
 

diff --git a/src/datablocks/schemas/datablock.schema.ts b/src/datablocks/schemas/datablock.schema.ts
@@ -1,5 +1,5 @@
 import { Prop, Schema, SchemaFactory } from "@nestjs/mongoose";
-import { ApiProperty } from "@nestjs/swagger";
+import { ApiProperty, getSchemaPath } from "@nestjs/swagger";
 import { DataFile, DataFileSchema } from "src/common/schemas/datafile.schema";
 import { OwnableClass } from "src/common/schemas/ownable.schema";
 import { v4 as uuidv4 } from "uuid";
@@ -35,6 +35,7 @@ export class Datablock extends OwnableClass {
 
   @ApiProperty({
     type: String,
+    required: true,
     description:
       "Unique identifier given by the archive system to the stored datablock. This id is used when data is retrieved back.",
   })
@@ -50,7 +51,7 @@ export class Datablock extends OwnableClass {
     type: Number,
     required: true,
     description:
-      "Total size in bytes of all files in the datablock when unpacked.",
+      "Total size in bytes of all files in the datablock when on accessible.",
   })
   @Prop({
     type: Number,
@@ -61,7 +62,8 @@ export class Datablock extends OwnableClass {
   @ApiProperty({
     type: Number,
     required: true,
-    description: "Size of the datablock package file.",
+    description:
+      "Total size in bytes of all files in the datablock when on archived.",
   })
   @Prop({
     type: Number,
@@ -71,6 +73,7 @@ export class Datablock extends OwnableClass {
 
   @ApiProperty({
     type: String,
+    required: false,
     description:
       "Algorithm used for calculation of file checksums. Should be lowercase, e.g., sha2 or blake2b.",
   })
@@ -82,6 +85,7 @@ export class Datablock extends OwnableClass {
 
   @ApiProperty({
     type: String,
+    required: true,
     description:
       "Version string defining the format of how data is packed and stored in archive.",
   })
@@ -92,10 +96,15 @@ export class Datablock extends OwnableClass {
   version: string;
 
   @ApiProperty({
-    description:
-      "Embedded schema definition for which fields are required for each file.",
+    type: "array",
+    items: { $ref: getSchemaPath(DataFile) },
+    required: true,
+    description: "Embedded schema definition for each file.",
+  })
+  @Prop({
+    type: [DataFileSchema],
+    required: true,
   })
-  @Prop([DataFileSchema])
   dataFileList: DataFile[];
 }
 

diff --git a/src/origdatablocks/schemas/origdatablock.schema.ts b/src/origdatablocks/schemas/origdatablock.schema.ts
@@ -1,5 +1,5 @@
 import { Prop, Schema, SchemaFactory } from "@nestjs/mongoose";
-import { ApiProperty } from "@nestjs/swagger";
+import { ApiProperty, getSchemaPath } from "@nestjs/swagger";
 import { OwnableClass } from "src/common/schemas/ownable.schema";
 import { v4 as uuidv4 } from "uuid";
 import { DataFile, DataFileSchema } from "../../common/schemas/datafile.schema";
@@ -59,9 +59,15 @@ export class OrigDatablock extends OwnableClass {
   chkAlg: string;
 
   @ApiProperty({
+    type: "array",
+    items: { $ref: getSchemaPath(DataFile) },
+    required: true,
     description: "Embedded schema definitions for each file.",
   })
-  @Prop([DataFileSchema])
+  @Prop({
+    type: [DataFileSchema],
+    required: true,
+  })
   dataFileList: DataFile[];
 }