aws / aws/aws-cdk

apigateway: CfnBasePathMapping Python constructor id vs id_

Open
#20,829 1 comment 0 reactions 0 assignees View on GitHub
@aws-cdk/aws-apigateway bug documentation effort/small p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
1d 19h
Merged PRs (30d)
74

Description

### Describe the issue

Because `CfnBasePathMapping` has an actual keyword argument named `id` (itself a decision I hope won't be repeated due to the confusion it causes), the second positional parameter is named `id_`. This is correct in the method signature, but in the "Parameters" section, it incorrectly shows it as `id`, so there are two parameters with the same name.

### Links

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_apigateway/CfnBasePathMapping.html

Contributor guide

Open the contributing guide

Research direction

Start with the linked CfnBasePathMapping Python API documentation and compare its constructor signature with the Parameters section. Trace the documentation source or generation entry point responsible for that page; done means the second positional parameter is consistently shown as id_ rather than duplicated as id.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, typescript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.