chore(apigateway): remove default* properties from SpecRestApi #9099
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SpecRestApiProps contained `defaultMethodOptions`, `defaultCorsPreflightOptions` and `defaultIntegration` as properties. However, these defaults are only applied to Methods and Resources defined via addMethod() and addResource() APIs. These do *not* apply to Resources and Methods defined in the OpenAPI spec. Users have complained that this is unclear[1][2]. This PR removes these options from the constructor properties of `SpecRestApi`. Users can still specify these when adding new Resources and new Methods. These options don't make much sense to be specified on a `SpecRestApi` since they cannot be applied to the Resources and Methods in the OpenAPI spec. This will match up with the functionality available. closes #8347 [1]: #8347 (comment) [2]: #8347 (comment) BREAKING CHANGE: `defaultMethodOptions`, `defaultCorsPreflightOptions` and `defaultIntegration` have been removed from `SpecRestApiProps`.
eladb
approved these changes
Jul 16, 2020
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
curtiseppel
pushed a commit
to curtiseppel/aws-cdk
that referenced
this pull request
Aug 11, 2020
) SpecRestApiProps contained `defaultMethodOptions`, `defaultCorsPreflightOptions` and `defaultIntegration` as properties. However, these defaults are only applied to Methods and Resources defined via addMethod() and addResource() APIs. These do *not* apply to Resources and Methods defined in the OpenAPI spec. Users have complained that this is unclear [1] [2]. This PR removes these options from the constructor properties of `SpecRestApi`. Users can still specify these when adding new Resources and new Methods. These options don't make much sense to be specified on a `SpecRestApi` since they cannot be applied to the Resources and Methods in the OpenAPI spec. This will match up with the functionality available. closes aws#8347 [1]: aws#8347 (comment) [2]: aws#8347 (comment) BREAKING CHANGE: `defaultMethodOptions`, `defaultCorsPreflightOptions` and `defaultIntegration` have been removed from `SpecRestApiProps`. These can be specifed directly in the OpenAPI spec or via `addMethod()` and `addResource()` APIs. ---- *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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SpecRestApiProps contained
defaultMethodOptions,defaultCorsPreflightOptionsanddefaultIntegrationas properties.However, these defaults are only applied to Methods and Resources
defined via addMethod() and addResource() APIs. These do not apply to
Resources and Methods defined in the OpenAPI spec.
Users have complained that this is unclear 1 2. This PR removes
these options from the constructor properties of
SpecRestApi. Userscan still specify these when adding new Resources and new Methods.
These options don't make much sense to be specified on a
SpecRestApisince they cannot be applied to the Resources and Methods in the OpenAPI
spec. This will match up with the functionality available.
closes #8347
BREAKING CHANGE:
defaultMethodOptions,defaultCorsPreflightOptionsand
defaultIntegrationhave been removed fromSpecRestApiProps.These can be specifed directly in the OpenAPI spec or via
addMethod()and
addResource()APIs.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license