Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(apigateway): SpecRestApi ignores disableExecuteApiEndpoint property #21295

Closed
caldermc-at-amazon opened this issue Jul 22, 2022 · 1 comment · Fixed by #22133
Closed

(apigateway): SpecRestApi ignores disableExecuteApiEndpoint property #21295

caldermc-at-amazon opened this issue Jul 22, 2022 · 1 comment · Fixed by #22133
Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway bug This issue is a bug. effort/small Small work item – less than a day of effort p2

Comments

@caldermc-at-amazon
Copy link

Describe the bug

In this commit the disableExecuteApiEndpoint property was added to RestApiBaseProps, which is used by both RestApi and SpecRestApi. The property is correctly propagated to the resulting CfnRestApi when specified for a RestApi, but is ignored when specified for a SpecRestApi.

Expected Behavior

"MySpecRestApi": {
  "Type": "AWS::ApiGateway::RestApi",
  "Properties": {
    "Name": "MySpecRestApiName",
    "DisableExecuteApiEndpoint": true
  }
}

Current Behavior

"MySpecRestApi": {
  "Type": "AWS::ApiGateway::RestApi",
  "Properties": {
    "Name": "MySpecRestApiName"
  }
}

Reproduction Steps

new SpecRestApi(myStack, 'MySpecRestApi', {
  restApiName: 'MySpecRestApiName',
  apiDefinition: ApiDefinition.fromInline({
    openapi: '3.0.2'
  }),
  disableExecuteApiEndpoint: true
})

Possible Solution

Pass the parameter along to the CfnRestApi in the SpecRestApi constructor.

Additional Information/Context

No response

CDK CLI Version

2.33.0

Framework Version

No response

Node.js Version

14

OS

OSX

Language

Typescript

Language Version

No response

Other information

No response

@caldermc-at-amazon caldermc-at-amazon added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Jul 22, 2022
@github-actions github-actions bot added the @aws-cdk/aws-apigateway Related to Amazon API Gateway label Jul 22, 2022
@otaviomacedo otaviomacedo added effort/small Small work item – less than a day of effort p2 and removed needs-triage This issue or PR still needs to be triaged. labels Aug 10, 2022
@otaviomacedo otaviomacedo removed their assignment Aug 10, 2022
TheRealAmazonKendra added a commit that referenced this issue Sep 20, 2022

Verified

This commit was signed with the committer’s verified signature.
In this commit the disableExecuteApiEndpoint property was added to RestApiBaseProps, which is used by both RestApi and SpecRestApi. The property is correctly propagated to the resulting CfnRestApi when specified for a RestApi, but is ignored when specified for a SpecRestApi.

Closes #21295.
@mergify mergify bot closed this as completed in #22133 Sep 20, 2022
mergify bot pushed a commit that referenced this issue Sep 20, 2022

Verified

This commit was signed with the committer’s verified signature.
…rty (#22133)

In this [PR](#14526) the disableExecuteApiEndpoint property was added to RestApiBaseProps, which is used by both RestApi and SpecRestApi. The property is propagated to the resulting CfnRestApi when specified for a RestApi, but is ignored when specified for a SpecRestApi.

Closes #21295.


----

### All Submissions:

* [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

⚠️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.

homakk pushed a commit to homakk/aws-cdk that referenced this issue Dec 1, 2022

Verified

This commit was signed with the committer’s verified signature.
…rty (aws#22133)

In this [PR](aws#14526) the disableExecuteApiEndpoint property was added to RestApiBaseProps, which is used by both RestApi and SpecRestApi. The property is propagated to the resulting CfnRestApi when specified for a RestApi, but is ignored when specified for a SpecRestApi.

Closes aws#21295.


----

### All Submissions:

* [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway bug This issue is a bug. effort/small Small work item – less than a day of effort p2
Projects
None yet
2 participants