This repository has been archived by the owner on Jul 23, 2021. It is now read-only.
use CloudFormation DocumentationPart resources instead of direct creation #100
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The plugin at the moment makes AWS calls to create the documentation part resources for Request/Response Body, Path Params, Header Params, etc. A CloudFormation resource type now exists for these (
AWS::ApiGateway::DocumentationPart). This patch changes the plugin to use the new resource type.NOTE: This ought to be considered a breaking change to the plugin, because existing stacks will need to be cleaned up and redeployed, otherwise there will be a conflict with the existing documentation part resources (created without CF) and new ones (added with CF).
It should also address an underlying assumption (bug?) that the stack manages the API Gateway resource - where you have stack splitting (e.g. to manage the CF 200 resources limit), the documentation part resources from another stack are blown away before this stack's documentation parts are installed. The patch addresses this by only using CF resources for the documentation parts.