aws / aws/aws-cdk

APIGateway AWSIntegration undocumented properties

Open
#7,806 5 comments 2 reactions 0 assignees View on GitHub
@aws-cdk/aws-apigateway effort/small feature-request p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.AwsIntegrationProps.html

The type for `service` (name) is simply `string`, while this may be adequate for services like "s3" (the given example) this does not provide adequate documentation for other services.

For DynamoDB for example, is it DynamoDB? Is it Dynamo? Dynamo_DB?
This is just one example, there is a multitude of `string` types that should undoubtedly use Enums for self-documentation.

I would open a PR to add the enums but there is no way for me to discover the proper values but trial-and-error.

It may be possible that this is for internal naming and does not correspond to the actual Service Name within AWS.. If this is the case it is a much simpler fix to convey that this is an internal service name.

---

This is a 📕 documentation issue

Contributor guide

Open the contributing guide

Research direction

Start with the linked AwsIntegrationProps API reference and locate the source definition for the service property in the AWS CDK repository. Check AWS's accepted service names and determine whether the reference should list valid values or explain that the name is internal; done means the property guidance removes this ambiguity.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.