docs: JS doc

Author: tstephen-nhs

packages/cdkConstructs/src/constructs/RestApiGateway.ts

@@ -29,18 +29,26 @@ import {ApiGateway as ApiGatewayTarget} from "aws-cdk-lib/aws-route53-targets"
 import {NagSuppressions} from "cdk-nag"
 
 export interface RestApiGatewayProps {
+  /** Stack name, used as prefix for resource naming and DNS records. */
   readonly stackName: string
+  /** Shared retention period for API and deployment-related log groups. */
   readonly logRetentionInDays: number
+  /** Truststore object key to enable mTLS; leave undefined to disable mTLS. */
   readonly mutualTlsTrustStoreKey: string | undefined
+  /** Enables creation of a second subscription filter to forward logs to CSOC. */
   readonly forwardCsocLogs: boolean
+  /** Destination ARN used by the optional CSOC subscription filter. */
   readonly csocApiGatewayDestination: string
+  /** Managed policies attached to the API Gateway execution role. */
   readonly executionPolicies: Array<IManagedPolicy>
 }
 
+/** Creates a regional REST API with standard logging, DNS, and optional mTLS/CSOC integration. */
 export class RestApiGateway extends Construct {
   public readonly api: RestApi
   public readonly role: IRole
 
+  /** Builds API Gateway infrastructure and validates CSOC forwarding configuration. */
   public constructor(scope: Construct, id: string, props: RestApiGatewayProps) {
     super(scope, id)
 

packages/cdkConstructs/src/constructs/RestApiGateway/LambdaEndpoint.ts

@@ -4,20 +4,28 @@ import {HttpMethod, IFunction} from "aws-cdk-lib/aws-lambda"
 import {Construct} from "constructs"
 
 export interface LambdaFunctionHolder {
+  /** Lambda invoked by this API resource method. */
   readonly function: IFunction
 }
 
 export interface LambdaEndpointProps {
+  /** Parent API resource under which this endpoint path is created. */
   parentResource: IResource
+  /** Path segment added beneath the parent resource. */
   readonly resourceName: string
+  /** HTTP method exposed on the created API resource. */
   readonly method: HttpMethod
+  /** Role assumed by API Gateway when invoking the integration Lambda. */
   restApiGatewayRole: IRole
+  /** Lambda reference used by the generated integration. */
   lambdaFunction: LambdaFunctionHolder
 }
 
+/** Adds a child API resource and wires it to a Lambda integration with explicit credentials. */
 export class LambdaEndpoint extends Construct {
   resource: IResource
 
+  /** Creates the resource/method pair and stores the resulting API resource handle. */
   public constructor(scope: Construct, id: string, props: LambdaEndpointProps) {
     super(scope, id)
 

packages/cdkConstructs/src/constructs/RestApiGateway/accessLogFormat.ts

@@ -1,5 +1,6 @@
 import {AccessLogFormat} from "aws-cdk-lib/aws-apigateway"
 
+/** Returns the structured API Gateway access log schema expected by platform observability pipelines. */
 export const accessLogFormat = () => {
   return AccessLogFormat.custom(JSON.stringify({
     requestId: "$context.requestId",