(EKS): camelcase is converted to snake case in undesired scenarios in CDK Python API Ref
- Dominant language
- TypeScript
- Stars
- 2.9k
- Forks
- 267
- Avg merge
- 1d 25m
- Merged PRs (30d)
- 14
Description
### Describe the issue
Using "api_version" as shown in the documentation for KubernetesManifests throws errors upon CDK deployment.
> namespace = cluster.add_manifest("my-namespace", {
"api_version": "v1", <--------------------------------------------------- Wrong way to specify apiVersion
"kind": "Namespace",
"metadata": {"name": "my-app"}
})
Correct/working argument is "apiVersion". Please replace the above in the documentation with the following:
> namespace = cluster.add_manifest("my-namespace", {
> "apiVersion": "v1", <-------------------------------------------------- Here is the change
> "kind": "Namespace",
> "metadata": {"name": "my-app"}
> })
AWS CDK - 2.4.5
Addendum: Other fields like `container_port` also throw errors unless specified as "containerPort"
### Links
https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_eks/KubernetesManifest.html
Contributor guide
Research direction
Start with the KubernetesManifest API reference linked in the issue and compare its documented Python examples with the working camelCase examples provided. Update the api_version example to apiVersion, check related fields such as container_port and containerPort, and confirm the corrected examples match the stated CDK deployment behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100