Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(aws-apigateway-*): add optional request templates for non-default content-types. #888

Merged
merged 10 commits into from
Feb 6, 2023
Merged

feat(aws-apigateway-*): add optional request templates for non-default content-types. #888

merged 10 commits into from
Feb 6, 2023

Conversation

georgebearden
Copy link
Contributor

@georgebearden georgebearden commented Jan 23, 2023 •
edited
Loading

Issue #, if available:

This Draft PR explores directly adding inline, optional properties for specifying additional content-type mappings for API Gateway request templates. Please see #876 for additional context.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@aws-solutions-constructs-team
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: githubautobuild-for-cdk-v2
  • Commit ID: 2e75412
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@georgebearden georgebearden mentioned this pull request Jan 25, 2023
Closed
2 tasks
@thchia
Copy link

thchia commented Jan 26, 2023

Thanks @georgebearden. The implementation looks good to me, and should eliminate the need for the workaround I mentioned in #876.

@aws-solutions-constructs-team
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: githubautobuild-for-cdk-v2
  • Commit ID: 1491eab
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-solutions-constructs-team
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: githubautobuild-for-cdk-v2
  • Commit ID: c81eea1
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-solutions-constructs-team
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: githubautobuild-for-cdk-v2
  • Commit ID: e0a8ed6
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-solutions-constructs-team
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: githubautobuild-for-cdk-v2
  • Commit ID: 2349d37
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@georgebearden georgebearden marked this pull request as ready for review February 1, 2023 15:18
@georgebearden georgebearden changed the title [DRAFT] Add optional request templates for non-default content-types. Add optional request templates for non-default content-types. Feb 1, 2023
@aws-solutions-constructs-team
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: githubautobuild-for-cdk-v2
  • Commit ID: e687a2c
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-solutions-constructs-team
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: githubautobuild-for-cdk-v2
  • Commit ID: e284d2f
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@georgebearden georgebearden mentioned this pull request Feb 2, 2023
Closed
2 tasks
biffgaut
biffgaut requested changes Feb 2, 2023
View reviewed changes
source/patterns/@aws-solutions-constructs/aws-apigateway-dynamodb/README.md Outdated Show resolved Hide resolved
source/patterns/@aws-solutions-constructs/aws-apigateway-dynamodb/README.md
|allowDeleteOperation?|`boolean`|Whether to deploy API Gateway Method for Delete operation on DynamoDB table.|
|deleteRequestTemplate?|`string`|Optional API Gateway Request template for Delete method, it will use the default template if `allowDeleteOperation` is true and `deleteRequestTemplate` is not provided. The default template only supports a partition key and not partition + sort keys.|
|allowCreateOperation?|`boolean`|Whether to deploy an API Gateway Method for POST HTTP operations on the DynamoDB table (i.e. dynamodb:PutItem).|
|createRequestTemplate?|`string`|API Gateway Request Template for the create method for the default `application/json` content-type. This property is required if the `allowCreateOperation` property is set to true.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a paragraph of prose below this section that explains how all these properties interact. It can be longer and more explanatory than individual comments on each property and only needs to be included once (not repeated for every property).

This is in addition to what you've already done, do not remove anything.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took a crack at it. Give it a read and let me know if it needs to be more clear.

source/patterns/@aws-solutions-constructs/aws-apigateway-dynamodb/README.md Outdated Show resolved Hide resolved
source/patterns/@aws-solutions-constructs/core/lib/apigateway-helper.ts Outdated Show resolved Hide resolved
source/patterns/@aws-solutions-constructs/core/lib/apigateway-helper.ts Show resolved Hide resolved
...@aws-solutions-constructs/aws-apigateway-dynamodb/test/integ.custom-integration-responses.ts Outdated Show resolved Hide resolved
source/patterns/@aws-solutions-constructs/aws-apigateway-kinesisstreams/lib/index.ts Outdated Show resolved Hide resolved
...erns/@aws-solutions-constructs/aws-apigateway-kinesisstreams/test/apigateway-kinesis.test.ts Show resolved Hide resolved
source/patterns/@aws-solutions-constructs/aws-apigateway-sqs/lib/index.ts Outdated Show resolved Hide resolved
source/patterns/@aws-solutions-constructs/aws-apigateway-sqs/test/apigateway-sqs.test.ts Show resolved Hide resolved
@aws-solutions-constructs-team
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: githubautobuild-for-cdk-v2
  • Commit ID: 7fa9ae9
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-solutions-constructs-team
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: githubautobuild-for-cdk-v2
  • Commit ID: b6e251e
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@biffgaut biffgaut changed the title Add optional request templates for non-default content-types. feat(aws-apigateway-*): add optional request templates for non-default content-types. Feb 6, 2023
@biffgaut biffgaut merged commit ace70f0 into main Feb 6, 2023
@biffgaut biffgaut deleted the add-apigw-request-templates branch February 6, 2023 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@biffgaut biffgaut biffgaut approved these changes

@hayesry hayesry Awaiting requested review from hayesry hayesry is a code owner

@mobri2a mobri2a Awaiting requested review from mobri2a mobri2a is a code owner

@emcfins emcfins Awaiting requested review from emcfins emcfins is a code owner

@mickychetta mickychetta Awaiting requested review from mickychetta

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@georgebearden @aws-solutions-constructs-team @thchia @biffgaut