fix(aws-apigateway): add optional property to spec-restapi to be able to enable compression

packages/@aws-cdk/aws-apigateway/README.md

@@ -1423,6 +1423,10 @@ for more details.
 properties that can be configured directly in the OpenAPI specification file. This is to prevent people duplication
 of these properties and potential confusion.
 
+**Note:** Compression of payload can be enabled by setting a value for `minimumCompressionSize` property. 
+When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. 
+Setting it to zero allows compression for any payload size.
+
 ### Endpoint configuration
 
 By default, `SpecRestApi` will create an edge optimized endpoint.

packages/@aws-cdk/aws-apigateway/lib/restapi.ts

@@ -261,6 +261,18 @@ export interface SpecRestApiProps extends RestApiBaseProps {
    * @see https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html
    */
   readonly apiDefinition: ApiDefinition;
+
+  /**
+   * A nullable integer that is used to enable compression (with non-negative
+   * between 0 and 10485760 (10M) bytes, inclusive) or disable compression
+   * (when undefined) on an API. When compression is enabled, compression or
+   * decompression is not applied on the payload if the payload size is
+   * smaller than this value. Setting it to zero allows compression for any
+   * payload size.
+   *
+   * @default - Compression is disabled.
+   */
+  readonly minimumCompressionSize?: number;
 }
 
 /**
@@ -648,6 +660,7 @@ export class SpecRestApi extends RestApiBase {
       name: this.restApiName,
       policy: props.policy,
       failOnWarnings: props.failOnWarnings,
+      minimumCompressionSize: props.minimumCompressionSize,
       body: apiDefConfig.inlineDefinition ?? undefined,
       bodyS3Location: apiDefConfig.inlineDefinition ? undefined : apiDefConfig.s3Location,
       endpointConfiguration: this._configureEndpoints(props),

packages/@aws-cdk/aws-apigateway/test/integ.spec-restapi.compression.js.snapshot/apigatewayspecrestapicompressionDefaultTestDeployAssert473E8E6B.assets.json

@@ -0,0 +1,19 @@
+{
+  "version": "21.0.0",
+  "files": {
+    "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22": {
+      "source": {
+        "path": "apigatewayspecrestapicompressionDefaultTestDeployAssert473E8E6B.template.json",
+        "packaging": "file"
+      },
+      "destinations": {
+        "current_account-current_region": {
+          "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
+          "objectKey": "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22.json",
+          "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
+        }
+      }
+    }
+  },
+  "dockerImages": {}
+}

packages/@aws-cdk/aws-apigateway/test/integ.spec-restapi.compression.js.snapshot/apigatewayspecrestapicompressionDefaultTestDeployAssert473E8E6B.template.json

@@ -0,0 +1,36 @@
+{
+ "Parameters": {
+  "BootstrapVersion": {
+   "Type": "AWS::SSM::Parameter::Value<String>",
+   "Default": "/cdk-bootstrap/hnb659fds/version",
+   "Description": "Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip]"
+  }
+ },
+ "Rules": {
+  "CheckBootstrapVersion": {
+   "Assertions": [
+    {
+     "Assert": {
+      "Fn::Not": [
+       {
+        "Fn::Contains": [
+         [
+          "1",
+          "2",
+          "3",
+          "4",
+          "5"
+         ],
+         {
+          "Ref": "BootstrapVersion"
+         }
+        ]
+       }
+      ]
+     },
+     "AssertDescription": "CDK bootstrap stack version 6 required. Please run 'cdk bootstrap' with a recent version of the CDK CLI."
+    }
+   ]
+  }
+ }
+}

packages/@aws-cdk/aws-apigateway/test/integ.spec-restapi.compression.js.snapshot/asset.68497ac876de4e963fc8f7b5f1b28844c18ecc95e3f7c6e9e0bf250e03c037fb.yaml

@@ -0,0 +1,30 @@
+openapi: "3.0.2"
+info:
+  version: 1.0.0
+  title: Test API for CDK
+paths:
+  /pets:
+    get:
+      summary: Test Method
+      operationId: testMethod
+      responses:
+        "200":
+          description: A paged array of pets
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Empty"
+      x-amazon-apigateway-integration:
+        responses:
+          default:
+            statusCode: "200"
+        requestTemplates:
+          application/json: "{\"statusCode\": 200}"
+        passthroughBehavior: when_no_match
+        type: mock
+
+components:
+  schemas:
+    Empty:
+      title: Empty Schema
+      type: object

packages/@aws-cdk/aws-apigateway/test/integ.spec-restapi.compression.js.snapshot/cdk.out

@@ -0,0 +1 @@
+{"version":"21.0.0"}

packages/@aws-cdk/aws-apigateway/test/integ.spec-restapi.compression.js.snapshot/integ.json

@@ -0,0 +1,12 @@
+{
+  "version": "21.0.0",
+  "testCases": {
+    "apigateway-spec-restapi-compression/DefaultTest": {
+      "stacks": [
+        "test-apigateway-spec-restapi-compression"
+      ],
+      "assertionStack": "apigateway-spec-restapi-compression/DefaultTest/DeployAssert",
+      "assertionStackName": "apigatewayspecrestapicompressionDefaultTestDeployAssert473E8E6B"
+    }
+  }
+}