aws_apigateway: Method responses from default method options set on RestApi not passed to Methods

[commiterate]

Describe the bug

When creating a RestApi and setting RestApiProps.defaultMethodOptions.methodResponses, the method responses aren't passed to methods created on the RestApi that don't have a MethodOptions passed in.

Expected Behavior

Method responses should be passed to methods.

Current Behavior

Method responses aren't passed to methods. Other properties like RestApiProps.defaultMethodOptions.authorizationType seem to be passed though.

Reproduction Steps

TypeScript code:

import { Construct, aws_apigateway } from "aws-cdk-lib";

export class MockApiGatewayRestApi extends Construct {
	constructor(scope: Construct, id: string) {
		super(scope, id);

		const restApi = new aws_apigateway.RestApi(this, "REST_API", {
			defaultIntegration: new aws_apigateway.MockIntegration({
				passthroughBehavior: aws_apigateway.PassthroughBehavior.NEVER,
				requestTemplates: {
					"application/json": '{"statusCode": 200}'
				},
				integrationResponses: [
					{
						statusCode: "200"
					}
				]
			}),
			defaultMethodOptions: {
				authorizationType: aws_apigateway.AuthorizationType.IAM,
				methodResponses: [
					{
						statusCode: "200"
					}
				]
			}
		});

		restApi.root.addResource("test").addMethod("GET");
	}
}

Resulting AWS::ApiGateway::Method:

{
	"{Logical ID}": {
		"Type": "AWS::ApiGateway::Method",
		"Properties": {
			"HttpMethod": "GET",
			"ResourceId": {
				"Ref": "{AWS::ApiGateway::Resource logical ID for test resource}"
			},
			"RestApiId": {
				"Ref": "{AWS::ApiGateway::RestApi logical ID for endpoint}"
			},
			"AuthorizationType": "AWS_IAM",
			"Integration": {
				"IntegrationResponses": [
					{
						"StatusCode": "200"
					}
				],
				"PassthroughBehavior": "NEVER",
				"RequestTemplates": {
					"application/json": "{\"statusCode\": 200}"
				},
				"Type": "MOCK"
			}
		}
	}
}

CDK CLI Version

2.85.0

Framework Version

2.85.0

Node.js Version

20.2.0

OS

macOS Monterey 12.6.6 and Amazon Linux 2

Language

Typescript

Language Version

5.1.3

Other information

If we pass in the integration and method options when creating the method, the resulting template is as expected.

TypeScript code:

import { Construct, aws_apigateway } from "aws-cdk-lib";

export class MockApiGatewayRestApi extends Construct {
	constructor(scope: Construct, id: string) {
		super(scope, id);

		const restApi = new aws_apigateway.RestApi(this, "REST_API");

		const mockIntegration = new aws_apigateway.MockIntegration({
			passthroughBehavior: aws_apigateway.PassthroughBehavior.NEVER,
			requestTemplates: {
				"application/json": '{"statusCode": 200}'
			},
			integrationResponses: [
				{
					statusCode: "200"
				}
			]
		});

		const methodOptions: aws_apigateway.MethodOptions = {
			authorizationType: aws_apigateway.AuthorizationType.IAM,
			methodResponses: [
				{
					statusCode: "200"
				}
			]
		};
		
		restApi.root.addResource("test").addMethod("GET", mockIntegration, methodOptions);
	}
}

Resulting AWS::ApiGateway::Method:

{
	"{Logical ID}": {
		"Type": "AWS::ApiGateway::Method",
		"Properties": {
			"HttpMethod": "GET",
			"ResourceId": {
				"Ref": "{AWS::ApiGateway::Resource logical ID for test resource}"
			},
			"RestApiId": {
				"Ref": "{AWS::ApiGateway::RestApi logical ID for endpoint}"
			},
			"AuthorizationType": "AWS_IAM",
			"Integration": {
				"IntegrationResponses": [
					{
						"StatusCode": "200"
					}
				],
				"PassthroughBehavior": "NEVER",
				"RequestTemplates": {
					"application/json": "{\"statusCode\": 200}"
				},
				"Type": "MOCK"
			},
			"MethodResponses": [
				{
					"StatusCode": "200"
				}
			]
		}
	}
}

[peterwoodworth]

This line is probably the issue

aws-cdk/packages/aws-cdk-lib/aws-apigateway/lib/method.ts

Line 206 in 7f31d9f

this.methodResponses = options.methodResponses ?? [];

Think it should be this.methodResponses = options.methodResponses ?? this.defaultMethodOptions.methodResponses ?? [];

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.