Merge branch 'SIMSBIOHUB-383' into dataset_security_feature

bcgov · Dec 14, 2023 · 0af3140 · 0af3140
2 parents 68adef6 + 990d05b
commit 0af3140
Show file tree

Hide file tree

Showing 27 changed files with 741 additions and 507 deletions.
diff --git a/api/package-lock.json b/api/package-lock.json
diff --git a/api/src/paths/administrative/submission/reviewed.ts b/api/src/paths/administrative/submission/reviewed.ts
@@ -136,7 +136,7 @@ export function getReviewedSubmissionsForAdmins(): RequestHandler {
 
       return res.status(200).json(response);
     } catch (error) {
-      defaultLog.error({ label: 'getReviewedSubmissions', message: 'error', error });
+      defaultLog.error({ label: 'getReviewedSubmissionsForAdmins', message: 'error', error });
       await connection.rollback();
       throw error;
     } finally {

diff --git a/api/src/paths/administrative/submission/unreviewed.ts b/api/src/paths/administrative/submission/unreviewed.ts
@@ -139,7 +139,7 @@ export function getUnreviewedSubmissionsForAdmins(): RequestHandler {
 
       return res.status(200).json(response);
     } catch (error) {
-      defaultLog.error({ label: 'getUnreviewedSubmissions', message: 'error', error });
+      defaultLog.error({ label: 'getUnreviewedSubmissionsForAdmins', message: 'error', error });
       await connection.rollback();
       throw error;
     } finally {

diff --git a/api/src/paths/administrative/submission/{submissionId}/index.ts b/api/src/paths/administrative/submission/{submissionId}/index.ts
@@ -148,7 +148,7 @@ export function patchSubmissionRecord(): RequestHandler {
 
     const submissionId = Number(req.params.submissionId);
 
-    const patch = req.body as PatchSubmissionRecord;
+    const patch = req.body.patch as PatchSubmissionRecord;
 
     try {
       await connection.open();

diff --git a/api/src/paths/submission/index.ts b/api/src/paths/submission/index.ts
@@ -2,6 +2,7 @@ import { RequestHandler } from 'express';
 import { Operation } from 'express-openapi';
 import { getAPIUserDBConnection } from '../../database/db';
 import { defaultErrorResponses } from '../../openapi/schemas/http-responses';
+import { SECURITY_APPLIED_STATUS } from '../../repositories/security-repository';
 import { SubmissionService } from '../../services/submission-service';
 import { getLogger } from '../../utils/logger';
 
@@ -81,6 +82,14 @@ GET.apiDoc = {
                 revision_count: {
                   type: 'integer',
                   minimum: 0
+                },
+                security: {
+                  type: 'string',
+                  enum: [
+                    SECURITY_APPLIED_STATUS.SECURED,
+                    SECURITY_APPLIED_STATUS.UNSECURED,
+                    SECURITY_APPLIED_STATUS.PARTIALLY_SECURED
+                  ]
                 }
               }
             }

diff --git a/...aths/submission/{submissionUUID}/index.ts → .../paths/submission/{submissionId}/index.ts b/...aths/submission/{submissionUUID}/index.ts → .../paths/submission/{submissionId}/index.ts
@@ -5,12 +5,12 @@ import { defaultErrorResponses } from '../../../openapi/schemas/http-responses';
 import { SubmissionService } from '../../../services/submission-service';
 import { getLogger } from '../../../utils/logger';
 
-const defaultLog = getLogger('paths/submission/{submissionUUID}}');
+const defaultLog = getLogger('paths/submission/{submissionId}');
 
 export const GET: Operation = [getSubmissionInformation()];
 
 GET.apiDoc = {
-  description: 'retrieves submission data from the submission table',
+  description: 'Retrieves a submission record from the submission table',
   tags: ['eml'],
   security: [
     {
@@ -19,19 +19,19 @@ GET.apiDoc = {
   ],
   parameters: [
     {
-      description: 'submission uuid',
+      description: 'Submission ID.',
       in: 'path',
-      name: 'submissionUUID',
+      name: 'submissionId',
       schema: {
-        type: 'string',
-        format: 'uuid'
+        type: 'integer',
+        minimum: 1
       },
       required: true
     }
   ],
   responses: {
     200: {
-      description: 'Dataset metadata response object.',
+      description: 'A submission record and all child submission feature records.',
       content: {
         'application/json': {
           schema: {
@@ -40,26 +40,63 @@ GET.apiDoc = {
             properties: {
               submission: {
                 type: 'object',
-                required: ['submission_id', 'uuid', 'security_review_timestamp', 'create_date', 'create_user'],
+                required: [
+                  'submission_id',
+                  'uuid',
+                  'security_review_timestamp',
+                  'submitted_timestamp',
+                  'source_system',
+                  'name',
+                  'description',
+                  'create_date',
+                  'create_user',
+                  'update_date',
+                  'update_user',
+                  'revision_count'
+                ],
                 properties: {
                   submission_id: {
-                    type: 'number'
+                    type: 'integer',
+                    minimum: 1
                   },
                   uuid: {
                     type: 'string',
                     format: 'uuid'
                   },
                   security_review_timestamp: {
                     type: 'string',
-                    format: 'date-time',
                     nullable: true
                   },
-                  create_date: {
+                  source_system: {
+                    type: 'string'
+                  },
+                  name: {
                     type: 'string',
-                    format: 'date-time'
+                    maxLength: 200
                   },
-                  create_user: {
+                  description: {
+                    type: 'string',
+                    maxLength: 3000
+                  },
+                  create_date: {
                     type: 'string'
+                  },
+                  create_user: {
+                    type: 'integer',
+                    minimum: 1
+                  },
+                  update_date: {
+                    type: 'string',
+                    nullable: true
+                  },
+                  update_user: {
+                    type: 'integer',
+                    minimum: 1,
+                    nullable: true
+                  },
+                  revision_count: {
+                    type: 'integer',
+                    minimum: 0
                   }
                 }
               },
@@ -102,22 +139,22 @@ GET.apiDoc = {
 };
 
 /**
- * Retrieves submission data from the submission table.
+ * Retrieves a submission record and all child submission feature records.
  *
  * @returns {RequestHandler}
  */
 export function getSubmissionInformation(): RequestHandler {
   return async (req, res) => {
     const connection = req['keycloak_token'] ? getDBConnection(req['keycloak_token']) : getAPIUserDBConnection();
 
-    const submissionUUID = String(req.params.submissionUUID);
+    const submissionId = Number(req.params.submissionId);
 
     try {
       await connection.open();
 
       const submissionService = new SubmissionService(connection);
 
-      const result = await submissionService.getSubmissionAndFeaturesBySubmissionUUID(submissionUUID);
+      const result = await submissionService.getSubmissionAndFeaturesBySubmissionId(submissionId);
 
       await connection.commit();