aws-sdk-perl icon indicating copy to clipboard operation
aws-sdk-perl copied to clipboard

RFC: include size constrains on attribute documentation

Open melo opened this issue 5 years ago • 1 comments

Hi,

Please compare the attribute declaration on the AWS API docs and the Perldoc generated by Paws. As an example, the name attribute in the StartExecution of the StepFunctions service:

Both the required and type hints are included in the generated pod but the Length Constraints are not.

Would it be possible to include it? I believe this would enhance substantially the quality of the documentation.

Thanks!

melo avatar Feb 17 '20 15:02 melo

Hi,

Paws gets its service documentation from the botocore project, in this case it would be in https://github.com/boto/botocore/blob/develop/botocore/data/stepfunctions/2016-11-23/service-2.json (Look for StartExecutionInput), looks like it would need updating to add that line about the allowed size.

Maybe send them a patch?

castaway avatar Feb 24 '20 10:02 castaway