feat(apigatewayv2): add description property for stage (aws#30820)

### Issue # (if applicable) ### Reason for this change The `description` property existed in the L1 construct but was not present in the L2 construct ### Description of changes Add the `description` property for `HttpStage` and `WebSocketStage`, which was missing in the L2 construct. ### Description of how you validated changes I Added both unit test and integration tests. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
obraafo · Jul 25, 2024 · d93a773 · d93a773
1 parent 33e1c7d
commit d93a773
Show file tree

Hide file tree

Showing 20 changed files with 158 additions and 70 deletions.
diff --git a/...tewayv2/test/http/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-http-stage.assets.json b/...tewayv2/test/http/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-http-stage.assets.json
diff --git a/...wayv2/test/http/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-http-stage.template.json b/...wayv2/test/http/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-http-stage.template.json
@@ -13,11 +13,12 @@
     "ApiId": {
      "Ref": "HttpApiF5A9A8A7"
     },
-    "StageName": "$default",
     "DefaultRouteSettings": {
      "ThrottlingBurstLimit": 1000,
      "ThrottlingRateLimit": 1000
-    }
+    },
+    "Description": "My Stage",
+    "StageName": "$default"
    }
   }
  },

diff --git a/...k-testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/cdk.out b/...k-testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/cdk.out
diff --git a/...esting/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/integ.json b/...esting/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/integ.json
diff --git a/...ing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/manifest.json b/...ing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/manifest.json
diff --git a/...testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/tree.json b/...testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/tree.json
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.ts
@@ -12,6 +12,7 @@ new apigw.HttpStage(stack, 'HttpStageWithProperties', {
     rateLimit: 1000,
     burstLimit: 1000,
   },
+  description: 'My Stage',
 });
 
 app.synth();
diff --git a/...st/websocket/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-websocket-stage.assets.json b/...st/websocket/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-websocket-stage.assets.json
diff --git a/.../websocket/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-websocket-stage.template.json b/.../websocket/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-websocket-stage.template.json
@@ -14,11 +14,12 @@
     "ApiId": {
      "Ref": "WebSocketApi34BCF99B"
     },
-    "StageName": "dev",
     "DefaultRouteSettings": {
      "ThrottlingBurstLimit": 1000,
      "ThrottlingRateLimit": 1000
-    }
+    },
+    "Description": "My Stage",
+    "StageName": "dev"
    }
   }
  },

diff --git a/...ting/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/cdk.out b/...ting/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/cdk.out
diff --git a/...g/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/integ.json b/...g/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/integ.json
diff --git a/...ramework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/manifest.json b/...ramework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/manifest.json
diff --git a/...ng/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/tree.json b/...ng/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/tree.json
diff --git a/...ages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.ts b/...ages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.ts
@@ -13,6 +13,7 @@ new apigw.WebSocketStage(stack, 'WebSocketStage', {
     rateLimit: 1000,
     burstLimit: 1000,
   },
+  description: 'My Stage',
 });
 
 app.synth();