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

MockIntegration requestTemplate incorrect example #5997

Closed
Townsheriff opened this issue Jan 28, 2020 · 0 comments · Fixed by #6124
Closed

MockIntegration requestTemplate incorrect example #5997

Townsheriff opened this issue Jan 28, 2020 · 0 comments · Fixed by #6124
Assignees
@nija-at
Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway docs/inline Related to inline documentation of the API Reference effort/small Small work item – less than a day of effort in-progress This issue is being actively worked on. p2

Comments

@Townsheriff
Copy link

link to reference doc page:
https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.IntegrationOptions.html

describe your issue:
property "requestTemplates" has incorrect example. Given example - { "application/json": "{\n "statusCode": "200"\n}" }, but instead should be { "application/json": "{\n "statusCode": 200\n}" }. I'm getting an error that statusCode should be a number.

This is a 📕 documentation issue
@Townsheriff Townsheriff added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Jan 28, 2020
@SomayaB SomayaB added bug This issue is a bug. and removed feature-request A feature should be added or improved. labels Jan 28, 2020
@SomayaB SomayaB added @aws-cdk/aws-apigateway Related to Amazon API Gateway docs/generated Related to the generated API Reference documentation labels Jan 30, 2020
@nija-at nija-at added p2 docs/inline Related to inline documentation of the API Reference and removed needs-triage This issue or PR still needs to be triaged. docs/generated Related to the generated API Reference documentation bug This issue is a bug. labels Jan 30, 2020
nija-at pushed a commit that referenced this issue Feb 5, 2020
docs(apigateway): incorrect docs for requestTemplate property
e038a6e 
closes #5997
@nija-at nija-at mentioned this issue Feb 5, 2020
Merged
@nija-at nija-at added the effort/small Small work item – less than a day of effort label Feb 5, 2020
@SomayaB SomayaB added the in-progress This issue is being actively worked on. label Feb 5, 2020
@mergify mergify bot closed this as completed in #6124 Mar 3, 2020
mergify bot added a commit that referenced this issue Mar 3, 2020
@nija-at @mergify
docs(apigateway): incorrect docs for requestTemplate property (#6124)
5ebff39 
* docs(apigateway): incorrect docs for requestTemplate property

closes #5997

* code fence

* code fence

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
eladb pushed a commit that referenced this issue Mar 9, 2020
@nija-at @mergify
docs(apigateway): incorrect docs for requestTemplate property (#6124)
e780c8e 
* docs(apigateway): incorrect docs for requestTemplate property

closes #5997

* code fence

* code fence

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nija-at nija-at

Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway docs/inline Related to inline documentation of the API Reference effort/small Small work item – less than a day of effort in-progress This issue is being actively worked on. p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(apigateway): incorrect docs for requestTemplate property aws/aws-cdk
3 participants
@Townsheriff @nija-at @SomayaB