Merge remote-tracking branch 'origin/dev' into SIMSBIOHUB-449

.github/workflows/custom-linter.yml

@@ -0,0 +1,53 @@
+name: Custom Linter
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, ready_for_review]
+  push:
+    branches:
+      - dev
+
+jobs:
+  # OpenAPI request bodies should contain the property `required` and be set to true
+  #
+  # // Valid (request body required)
+  #
+  # requestBody: {
+  #   required: true,
+  #   content: {}
+  # }
+  #
+  # // Invalid (request body not required)
+  #
+  # requestBody: {
+  #   content: {}
+  # }
+  #
+  openApiRequiredRequestBody:
+    name: OpenAPI requestBody missing required:true
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Find schemas with optional request bodies
+        run: |
+          # For OpenAPI schemas, find all request bodies that don't have `required:true`
+          #
+          # Find all non-test files in apr/src/paths
+          # Find all request bodies that don't contain required:true property
+          # Print to stdout line num + filename and return exit code
+          find api/src/paths -type f ! -name '*.test.ts' -exec \
+          awk '
+          BEGIN {found=0}
+          /requestBody:/ {found=1}
+          /required: true/ {found=0}
+          /content:/ {
+            if (found) print "line: " NR, FILENAME;
+            found=0;
+          }
+          ' {} \; \
+          | grep . && exit 1 || exit 0
+
+
+

api/src/paths/administrative-activity.ts

@@ -23,6 +23,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Administrative Activity post request object.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/administrative-activity/system-access/{administrativeActivityId}/approve.ts

@@ -57,6 +57,7 @@ PUT.apiDoc = {
     }
   ],
   requestBody: {
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/funding-sources/index.ts

@@ -183,6 +183,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Funding source post request object.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/funding-sources/{fundingSourceId}.ts

@@ -231,6 +231,7 @@ PUT.apiDoc = {
   ],
   requestBody: {
     description: 'Funding source put request object.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/gcnotify/send.ts

@@ -33,6 +33,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Send notification to given recipient',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/attachments/report/upload.ts

@@ -50,6 +50,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Attachment upload post request object.',
+    required: true,
     content: {
       'multipart/form-data': {
         schema: {

api/src/paths/project/{projectId}/attachments/upload.ts

@@ -51,6 +51,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Attachment upload post request object.',
+    required: true,
     content: {
       'multipart/form-data': {
         schema: {

api/src/paths/project/{projectId}/attachments/{attachmentId}/delete.ts

@@ -55,6 +55,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Current attachment type for project attachment.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/attachments/{attachmentId}/metadata/update.ts

@@ -62,6 +62,7 @@ PUT.apiDoc = {
     }
   ],
   requestBody: {
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/participants/index.ts

@@ -156,6 +156,7 @@ POST.apiDoc = {
     }
   ],
   requestBody: {
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/participants/{projectParticipationId}.ts

@@ -57,6 +57,7 @@ PUT.apiDoc = {
     }
   ],
   requestBody: {
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/create.ts

@@ -61,6 +61,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Survey post request object.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/attachments/report/upload.ts

@@ -59,6 +59,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Attachment upload post request object.',
+    required: true,
     content: {
       'multipart/form-data': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/attachments/telemetry/index.ts

@@ -65,6 +65,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Telemetry device credential file upload post request object.',
+    required: true,
     content: {
       'multipart/form-data': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/attachments/upload.ts

@@ -52,6 +52,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Attachment upload post request object.',
+    required: true,
     content: {
       'multipart/form-data': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/attachments/{attachmentId}/delete.ts

@@ -61,6 +61,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Current attachment type for survey attachment.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/attachments/{attachmentId}/metadata/update.ts

@@ -68,6 +68,7 @@ PUT.apiDoc = {
     }
   ],
   requestBody: {
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/critters/captures/import.ts

@@ -63,6 +63,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Critterbase Captures CSV import file.',
+    required: true,
     content: {
       'multipart/form-data': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/critters/delete.ts

@@ -47,6 +47,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Array of survey critter Ids to be deleted.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/critters/import.ts

@@ -61,6 +61,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Survey critters csv file to import',
+    required: true,
     content: {
       'multipart/form-data': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/critters/index.ts

@@ -140,6 +140,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Critterbase create critter request object',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/critters/markings/import.ts

@@ -63,6 +63,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Critterbase Markings CSV import file.',
+    required: true,
     content: {
       'multipart/form-data': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/critters/measurements/import.ts

@@ -63,6 +63,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Critterbase Measurements CSV import file.',
+    required: true,
     content: {
       'multipart/form-data': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/critters/{critterId}/captures/{critterbaseCaptureId}/attachments/upload.ts

@@ -83,6 +83,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Attachment upload post request object.',
+    required: true,
     content: {
       'multipart/form-data': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/critters/{critterId}/deployments/index.ts

@@ -61,6 +61,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Object with device information and associated captures to create a deployment',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/critters/{critterId}/deployments/{deploymentId}/index.ts

@@ -80,6 +80,7 @@ PATCH.apiDoc = {
   ],
   requestBody: {
     description: 'Specifies a deployment id and the new timerange to update it with.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/critters/{critterId}/index.ts

@@ -52,6 +52,7 @@ PATCH.apiDoc = {
   ],
   requestBody: {
     description: 'Critterbase bulk patch request object',
+    required: true,
     content: {
       'application/json': {
         schema: critterBulkRequestObject

api/src/paths/project/{projectId}/survey/{surveyId}/deployments/delete.ts

@@ -59,6 +59,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Array of one or more deployment IDs to delete.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/deployments/{deploymentId}/index.ts

@@ -308,6 +308,7 @@ PUT.apiDoc = {
   ],
   requestBody: {
     description: 'Specifies a deployment id and the new timerange to update it with.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/export/index.ts

@@ -63,6 +63,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Export SIMS data request object.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/observations/delete.ts

@@ -49,6 +49,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Survey observation record data',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/observations/environments/delete.ts

@@ -57,6 +57,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Survey observation environment delete request body.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/observations/index.ts

@@ -134,6 +134,7 @@ PUT.apiDoc = {
   ],
   requestBody: {
     description: 'Survey observation record data',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/observations/measurements/delete.ts

@@ -57,6 +57,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Survey observation measurement delete request body.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/observations/process.ts

@@ -49,6 +49,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Request body',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/observations/upload.ts

@@ -52,6 +52,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Survey observation submission file to upload',
+    required: true,
     content: {
       'multipart/form-data': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/participants/index.ts

@@ -196,6 +196,7 @@ POST.apiDoc = {
     }
   ],
   requestBody: {
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/participants/{surveyParticipationId}.ts

@@ -64,6 +64,7 @@ PUT.apiDoc = {
     }
   ],
   requestBody: {
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/sample-site/delete.ts

@@ -59,6 +59,7 @@ POST.apiDoc = {
   ],
   requestBody: {
     description: 'Survey sample site delete request object.',
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/sample-site/index.ts

@@ -347,6 +347,7 @@ POST.apiDoc = {
     }
   ],
   requestBody: {
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/sample-site/{surveySampleSiteId}/index.ts

@@ -70,6 +70,7 @@ PUT.apiDoc = {
     }
   ],
   requestBody: {
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/sample-site/{surveySampleSiteId}/sample-method/index.ts

@@ -257,6 +257,7 @@ POST.apiDoc = {
     }
   ],
   requestBody: {
+    required: true,
     content: {
       'application/json': {
         schema: {

api/src/paths/project/{projectId}/survey/{surveyId}/sample-site/{surveySampleSiteId}/sample-method/{surveySampleMethodId}/index.ts

@@ -69,6 +69,7 @@ PUT.apiDoc = {
     }
   ],
   requestBody: {
+    required: true,
     content: {
       'application/json': {
         schema: {