chore: make validate api adjustments

IntersectMBO · Jul 31, 2024 · 227e4ec · 227e4ec
1 parent 2373433
commit 227e4ec
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 25 deletions.
diff --git a/govtool/frontend/src/hooks/forms/useVoteContextForm.tsx b/govtool/frontend/src/hooks/forms/useVoteContextForm.tsx
@@ -71,7 +71,6 @@ export const useVoteContextForm = (
         const result = await validateMetadata({
           hash: localHash,
           url,
-          noStandard: true,
         });
 
         if (result.status) {

diff --git a/govtool/frontend/src/models/metadataValidation.ts b/govtool/frontend/src/models/metadataValidation.ts
@@ -22,5 +22,4 @@ export type MetadataValidationDTO = {
   url: string;
   hash: string;
   standard?: MetadataStandard;
-  noStandard?: boolean;
 };
diff --git a/govtool/metadata-validation/src/app.controller.ts b/govtool/metadata-validation/src/app.controller.ts
@@ -4,12 +4,36 @@ import { ValidateMetadataDTO } from '@dto';
 import { ValidateMetadataResult } from '@types';
 
 import { AppService } from './app.service';
+import { ApiBody, ApiResponse } from '@nestjs/swagger';
 
 @Controller()
 export class AppController {
   constructor(private readonly appService: AppService) {}
 
   @Post('validate')
+  @ApiBody({
+    schema: {
+      type: 'object',
+      properties: {
+        url: { type: 'string' },
+        hash: { type: 'string' },
+        standard: { type: 'string' },
+      },
+      required: ['url', 'hash'],
+    },
+  })
+  @ApiResponse({
+    status: 200,
+    description: 'Validation result',
+    schema: {
+      type: 'object',
+      properties: {
+        valid: { type: 'boolean' },
+        status: { type: 'string' },
+        metadata: { type: 'object' },
+      },
+    },
+  })
   validateMetadata(
     @Body() validateMetadataDto: ValidateMetadataDTO,
   ): Promise<ValidateMetadataResult> {

diff --git a/govtool/metadata-validation/src/app.service.ts b/govtool/metadata-validation/src/app.service.ts
@@ -6,7 +6,7 @@ import * as blake from 'blakejs';
 import { ValidateMetadataDTO } from '@dto';
 import { LoggerMessage, MetadataValidationStatus } from '@enums';
 import { validateMetadataStandard, parseMetadata } from '@utils';
-import { MetadataStandard, ValidateMetadataResult } from '@types';
+import { ValidateMetadataResult } from '@types';
 
 @Injectable()
 export class AppService {
@@ -15,9 +15,7 @@ export class AppService {
   async validateMetadata({
     hash,
     url,
-    standard = MetadataStandard.CIP108,
-    // workaround property to not break the haskell backend
-    noStandard = false,
+    standard,
   }: ValidateMetadataDTO): Promise<ValidateMetadataResult> {
     let status: MetadataValidationStatus;
     let metadata: any;
@@ -30,13 +28,8 @@ export class AppService {
         ),
       );
 
-      Logger.debug(LoggerMessage.METADATA_DATA, data);
-
-      if (standard && !noStandard) {
+      if (standard) {
         await validateMetadataStandard(data, standard);
-      }
-
-      if (!noStandard) {
         metadata = parseMetadata(data.body, standard);
       }
 

diff --git a/govtool/metadata-validation/src/dto/validateMetadata.dto.ts b/govtool/metadata-validation/src/dto/validateMetadata.dto.ts
@@ -6,6 +6,4 @@ export class ValidateMetadataDTO {
   url: string;
 
   standard?: MetadataStandard;
-
-  noStandard?: boolean;
 }
diff --git a/govtool/metadata-validation/src/main.ts b/govtool/metadata-validation/src/main.ts
@@ -7,14 +7,13 @@ import { AppModule } from './app.module';
 async function bootstrap() {
   const app = await NestFactory.create(AppModule, {
     cors: true,
-    logger: ['debug', 'error', 'log'],
+    logger: ['error', 'log'],
   });
 
   const config = new DocumentBuilder()
-    .setTitle('Submission Tool')
-    .setDescription('The Submission Tool API description')
-    .setVersion('1.0')
-    .addTag('submission')
+    .setTitle('Metadata Validation Tool')
+    .setDescription('The Metadata Validation Tool API description')
+    .setVersion('1.0.11')
     .build();
 
   const document = SwaggerModule.createDocument(app, config);

diff --git a/govtool/metadata-validation/src/utils/parseMetadata.ts b/govtool/metadata-validation/src/utils/parseMetadata.ts
@@ -22,9 +22,7 @@ export const parseMetadata = (
           );
         }
       }
-      Logger.debug(LoggerMessage.PARSED_METADATA_BODY, parsedMetadata, {
-        standard,
-      });
+
       return parsedMetadata;
 
     case MetadataStandard.CIPQQQ:
@@ -38,9 +36,6 @@ export const parseMetadata = (
           );
         }
       }
-      Logger.debug(LoggerMessage.PARSED_METADATA_BODY, parsedMetadata, {
-        standard,
-      });
       return parsedMetadata;
     default:
       Logger.warn(LoggerMessage.CANNOT_PARSE_METADATA_BODY, { standard });