Skip to content

Commit

Permalink
aws/docs: Fix a few nitpicks after merging #7794
Browse files Browse the repository at this point in the history
  • Loading branch information
radeksimko committed Aug 11, 2016
1 parent 78b4923 commit 69f8a03
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ The following arguments are supported:
Not all methods are compatible with all `AWS` integrations.
e.g. Lambda function [can only be invoked](https://github.com/awslabs/aws-apigateway-importer/issues/9#issuecomment-129651005) via `POST`.
* `request_templates` - (Optional) A map of the integration's request templates.
* `request_parameters` - (Optional) Request query string parameters and headers that should be passed to the
* `request_parameters` - (Optional) A map of request query string parameters and headers that should be passed to the backend responder.
For example: `request_parameters = { "integration.request.header.X-Some-Other-Header" = "method.request.header.X-Some-Header" }`
* `passthrough_behavior` - (Optional) The integration passthrough behavior (`WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, `NEVER`). **Required** if `request_templates` is used.
* `request_parameters_in_json` - **Deprecated**, use `request_parameters` instead.
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,6 @@ The following arguments are supported:
If the backend is an `AWS` Lambda function, the AWS Lambda function error header is matched.
For all other `HTTP` and `AWS` backends, the HTTP status code is matched.
* `response_templates` - (Optional) A map specifying the templates used to transform the integration response body
* `response_parameters` - (Optional) Specify the response parameters that can be read from the backend response
* `response_parameters` - (Optional) A map of response parameters that can be read from the backend response.
For example: `response_parameters = { "method.response.header.X-Some-Header" = "integration.response.header.X-Some-Other-Header" }`,
* `response_parameters_in_json` - **Deprecated**, use `response_parameters` instead.
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The following arguments are supported:
* `request_models` - (Optional) A map of the API models used for the request's content type
where key is the content type (e.g. `application/json`)
and value is either `Error`, `Empty` (built-in models) or `aws_api_gateway_model`'s `name`.
* `request_parameters` - (Optional) Specify which request query string parameters and headers that should be passed to the integration
* `request_parameters` - (Optional) A map of request query string parameters and headers that should be passed to the integration.
For example: `request_parameters = { "method.request.header.X-Some-Header" = true }`
would define that the header X-Some-Header must be provided on the request.
would define that the header `X-Some-Header` must be provided on the request.
* `request_parameters_in_json` - **Deprecated**, use `request_parameters` instead.
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The following arguments are supported:
* `http_method` - (Required) The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`)
* `status_code` - (Required) The HTTP status code
* `response_models` - (Optional) A map of the API models used for the response's content type
* `response_parameters` - (Optional) Response parameters that can be sent to the caller
* `response_parameters` - (Optional) A map of response parameters that can be sent to the caller.
For example: `response_parameters = { "method.response.header.X-Some-Header" = true }`
would define that the header X-Some-Header can be provided on the response.
would define that the header `X-Some-Header` can be provided on the response.
* `response_parameters_in_json` - **Deprecated**, use `response_parameters` instead.

2 comments on commit 69f8a03

@radeksimko
Copy link
Member Author

Choose a reason for hiding this comment

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

@nicolai86
Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you, @radeksimko

Please sign in to comment.