aws-cloudformation / cloudformation-cli-typescript-plugin

The CloudFormation Provider Development Toolkit Node.js Plugin allows you to autogenerate TypeScript code based on an input schema.
Apache License 2.0
45 stars 15 forks source link

doc: add links to contract tests with example comments #120

Open hanseltime opened 1 year ago

hanseltime commented 1 year ago

Issue #, if available: N/A

Description of changes:

This PR adds some helpful comments and changes to the base handler.ts template to help new users understand the contracts that each endpoint (specifically list and read) are under.

Comments with links to relevant AWS doc are added as well as some changes to the initial code so that it doesn't look like we really should make and return models from the request back.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.