CCM-11580: Updates for OAS Spec V1 (#139)

* CCM-11580: OAS syntax fixes

Remove 'requestedProductionStatus' from letter-related JSON schemas and update examples to singular form

CCM-11580: Update serve-oas command

CCM-11580: Update serve-oas command

CCM-11580: Remove unneeded endpoints and resource types

+ Move getData endpoint under letter

CCM-11580: Remove hello world endpoint

CCM-11580: Remove hello world endpoint

CCM-11580: Add sandbox handler metadata to endpoints

CCM-11580: More fixes to examples syntax

CCM-11580: Remove remaining reference to hello-world lambda

CCM-11580: Remove remaining reference to hello-world lambda

CCM-11580: add limit parameter to list letters endpoint

CCM-11580: Update sandbox endpoints to match OAS

CCM-11580: Update letter responses in Sandbox to match spec changes

CCM-11580: implement get letter status endpoint in sandbox

Add groupId to schema and examples

* CCM-11580: remove x-eov extension from non sandox spec

---------

Co-authored-by: mark.slowey1 <[email protected]>

Author: m-houston

Makefile

@@ -36,7 +36,6 @@ guard-%:
 serve:
 	npm run serve
 
-
 lint-oas:
 	npm run lint-oas
 
@@ -82,7 +81,7 @@ bundle-oas:
 
 generate-sandbox:
 	$(MAKE) build-json-oas-spec APIM_ENV=sandbox
-	jq --slurpfile status sandbox/HealthcheckEndpoint.json '.paths += $$status[0]' build/notify-supplier.json > tmp.json && mv tmp.json build/notify-supplier.json
+	# jq --slurpfile status sandbox/HealthcheckEndpoint.json '.paths += $$status[0]' build/notify-supplier.json > tmp.json && mv tmp.json build/notify-supplier.json
 	jq '.security = []' build/notify-supplier.json > tmp.json && mv tmp.json build/notify-supplier.json
 	npm run generate-sandbox
 

infrastructure/terraform/components/api/README.md

@@ -31,8 +31,9 @@ No requirements.
 |------|--------|---------|
 | <a name="module_authorizer_lambda"></a> [authorizer\_lambda](#module\_authorizer\_lambda) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-lambda.zip | n/a |
 | <a name="module_domain_truststore"></a> [domain\_truststore](#module\_domain\_truststore) | git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/s3bucket | v2.0.17 |
+| <a name="module_get_letters"></a> [get\_letters](#module\_get\_letters) | git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/lambda | v2.0.10 |
+| <a name="module_kms"></a> [kms](#module\_kms) | git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/kms | v2.0.10 |
 | <a name="module_get_letters"></a> [get\_letters](#module\_get\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-lambda.zip | n/a |
-| <a name="module_hello_world"></a> [hello\_world](#module\_hello\_world) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-lambda.zip | n/a |
 | <a name="module_kms"></a> [kms](#module\_kms) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-kms.zip | n/a |
 | <a name="module_logging_bucket"></a> [logging\_bucket](#module\_logging\_bucket) | git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/s3bucket | v2.0.17 |
 | <a name="module_patch_letters"></a> [patch\_letters](#module\_patch\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-lambda.zip | n/a |

infrastructure/terraform/components/api/iam_role_api_gateway_execution_role.tf

@@ -49,7 +49,6 @@ data "aws_iam_policy_document" "api_gateway_execution_policy" {
 
     resources = [
       module.authorizer_lambda.function_arn,
-      module.hello_world.function_arn,
       module.get_letters.function_arn,
       module.patch_letters.function_arn
     ]

infrastructure/terraform/components/api/locals.tf

@@ -8,9 +8,8 @@ locals {
     APIG_EXECUTION_ROLE_ARN  = aws_iam_role.api_gateway_execution_role.arn
     AWS_REGION               = var.region
     AUTHORIZER_LAMBDA_ARN    = module.authorizer_lambda.function_arn
-    HELLO_WORLD_LAMBDA_ARN   = module.hello_world.function_arn
-    GET_LETTERS_LAMBDA_ARN   = module.get_letters.function_arn
-    PATCH_LETTERS_LAMBDA_ARN = module.patch_letters.function_arn
+    GET_LETTERS_LAMBDA_ARN  = module.get_letters.function_arn
+    PATCH_LETTERS_LAMBDA_ARN  = module.patch_letters.function_arn
   })
 
   destination_arn = "arn:aws:logs:${var.region}:${var.shared_infra_account_id}:destination:nhs-main-obs-firehose-logs"

infrastructure/terraform/components/api/module_lambda_hello_world.tf

@@ -1,4 +1,3 @@
 // Export all handlers for ease of access
 export { getLetters } from './handlers/get-letters';
 export { patchLetters } from './handlers/patch-letters';
-export { helloWorld } from './handlers/hello-world';

lambdas/api-handler/src/handlers/__tests__/hello-world.test.ts

@@ -62,7 +62,7 @@
     "publish-oas": "mkdir -p build && redocly bundle specification/api/notify-supplier-phase1.yml --dereferenced -k --remove-unused-components --ext json > build/notify-supplier.json",
     "serve": "npm run serve-html-docs",
     "serve-html-docs": "npx serve sdk/html -p 3050",
-    "serve-oas": "redocly preview-docs -p 5000 build/notify-supplier.json",
+    "serve-oas": "redocly preview -p 5001 -d specification/api",
     "serve-swagger-docs": "npx serve sdk/swagger -p 3051",
     "start": "npm run start --workspace frontend",
     "test:unit": "npm run test:unit --workspaces",