aws-cloudformation / aws-cloudformation/cloudformation-coverage-roadmap
[AWS::ApiGateway::Stage] - [Docs] - DeploymentId wrongly stated as not required
- Dominant language
- No language data
- Stars
- 1.1k
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
### Name of the resource
AWS::ApiGateway::Stage
### Resource name
AWS::ApiGateway::Stage
### Reference Link
https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid
### Details
It is a required parameter though. See [API docs](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html).
And without it, you get the error during deployment:
> Resource handler returned message: "DeploymentId cannot be empty" (RequestToken: d3e94518-cddb-c6d9-8743-f0cb5e8f8b59, HandlerErrorCode: InvalidRequest)
Contributor guide
Research direction
Start with the linked CloudFormation reference for AWS::ApiGateway::Stage and compare the DeploymentId property with the linked API CreateStage documentation. Update the reference so its required status matches the documented API behavior, then verify that the property description no longer says it is optional.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100