resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #5866 from TimeIncOSS/docs-api-gateway-fix 

docs: Fix API Gateway documentation
This commit is contained in:
Paul Hinze 2016-03-25 15:23:18 -05:00
parent 5f94449197 3afbadae75
commit 3abf815508
9 changed files with 72 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
website/source/docs/providers/aws/r/api_gateway_api_key.html.markdown
View File

@ -37,11 +37,18 @@ resource "aws_api_gateway_deployment" "MyDemoDeployment" {
The following arguments are supported:
* `name` - (Required) Name of the API Gateway
* `description` - (Optional) The API Gateway description
* `stage_key` - (Optional) applicable API Gateway stages
* `name` - (Required) The name of the API key
* `description` - (Required) The API key description
* `enabled` - (Optional) Specifies whether the API key can be used by callers. Defaults to `true`.
* `stage_key` - (Optional) A list of stage keys associated with the API key - see below
Stage keys support the following:
`stage_key` block supports the following:
* `rest_api_id` - (Required) The ID of the associated API Gateway Rest API.
* `rest_api_id` - (Required) The ID of the associated REST API.
* `stage_name` - (Required) The name of the API Gateway stage.
## Attribute Reference
The following attributes are exported:
* `id` - The ID of the API key

15
website/source/docs/providers/aws/r/api_gateway_deployment.html.markdown
View File

@ -49,7 +49,14 @@ resource "aws_api_gateway_deployment" "MyDemoDeployment" {
The following arguments are supported:
* `rest_api_id` - (Required) ID of the API Gateway
* `stage_name` - (Required) name of the stage
* `description` - (Optional) name of the stage
* `variables` - (Optional) Stage Variables
* `rest_api_id` - (Required) The ID of the associated REST API
* `stage_name` - (Optional) The name of the stage
* `description` - (Optional) The description of the deployment
* `stage_description` - (Optional) The description of the stage
* `variables` - (Optional) A map that defines variables for the stage
## Attribute Reference
The following attributes are exported:
* `id` - The ID of the deployment

16
website/source/docs/providers/aws/r/api_gateway_integration.html.markdown
View File

@ -43,10 +43,12 @@ resource "aws_api_gateway_integration" "MyDemoIntegration" {
The following arguments are supported:
* `rest_api_id` - (Required) API Gateway ID
* `resource_id` - (Required) API Gateway Resource ID
* `http_method` - (Required) HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTION)
* `type` - (Required) Specifies a put integration input's type (HTTP, MOCK, AWS)
* `uri` - (Optional) Input's Uniform Resource Identifier (HTTP, AWS)
* `integration_http_method` - (Optional) Integration HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTION)
* `rest_api_id` - (Required) The ID of the associated REST API
* `resource_id` - (Required) The API resource ID
* `http_method` - (Required) The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`)
* `type` - (Required) The integration input's type (HTTP, MOCK, AWS)
* `uri` - (Optional) The input's URI (HTTP, AWS). **Required** if `type` is `HTTP` or `AWS`.
* `credentials` - (Optional) The credentials required for the integration. For `AWS` integrations, 2 options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's ARN. To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\*:user/\*`.
* `integration_http_method` - (Optional) The integration HTTP method
(`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`).
* `request_templates` - (Optional) A map of the integration's request templates.

12
website/source/docs/providers/aws/r/api_gateway_integration_response.html.markdown
View File

@ -57,9 +57,9 @@ resource "aws_api_gateway_integration_response" "MyDemoIntegrationResponse" {
The following arguments are supported:
* `rest_api_id` - (Required) API Gateway ID
* `resource_id` - (Required) API Gateway Resource ID
* `http_method` - (Required) HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTION)
* `status_code` - (Required) Specify the HTTP status code.
* `response_models` - (Optional) Specifies the Model resources used for the response's content type
* `response_parameters` - (Optional) Represents response parameters that can be sent back to the caller
* `rest_api_id` - (Required) The ID of the associated REST API
* `resource_id` - (Required) The API resource ID
* `http_method` - (Required) The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`)
* `status_code` - (Required) The HTTP status code
* `selection_pattern` - (Optional) Specifies the regular expression pattern used to choose an integration response based on the response from the backend
* `response_templates` - (Optional) A map specifying the templates used to transform the integration response body

19
website/source/docs/providers/aws/r/api_gateway_method.html.markdown
View File

@ -3,12 +3,12 @@ layout: "aws"
page_title: "AWS: aws_api_gateway_method"
sidebar_current: "docs-aws-resource-api-gateway-method"
description: |-
Provides an HTTP Method for an API Gateway Resource.
Provides a HTTP Method for an API Gateway Resource.
---
# aws\_api\_gateway\_method
Provides an HTTP Method for an API Gateway Resource.
Provides a HTTP Method for an API Gateway Resource.
## Example Usage
@ -30,18 +30,15 @@ resource "aws_api_gateway_method" "MyDemoMethod" {
http_method = "GET"
authorization = "NONE"
}
```
## Argument Reference
The following arguments are supported:
* `rest_api_id` - (Required) API Gateway ID
* `resource_id` - (Required) API Gateway Resource ID
* `http_method` - (Required) HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTION)
* `authorization` - (Required) Type of authorization used for the method.
* `api_key_required` - (Optional) Specify if the method required an ApiKey
* `request_models` - (Optional) Specifies the Model resources used for the request's content type description
* `request_parameters` - (Optional) Represents requests parameters that are sent with the backend request
* `rest_api_id` - (Required) The ID of the associated REST API
* `resource_id` - (Required) The API resource ID
* `http_method` - (Required) The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`)
* `authorization` - (Required) The type of authorization used for the method
* `api_key_required` - (Optional) Specify if the method requires an API key
* `request_models` - (Optional) A map of the API models used for the request's content type

12
website/source/docs/providers/aws/r/api_gateway_method_response.html.markdown
View File

@ -50,10 +50,8 @@ resource "aws_api_gateway_method_response" "200" {
The following arguments are supported:
* `rest_api_id` - (Required) API Gateway ID
* `resource_id` - (Required) API Gateway Resource ID
* `http_method` - (Required) HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTION)
* `status_code` - (Required) Specify the HTTP status code.
* `response_models` - (Optional) Specifies the Model resources used for the response's content type
* `response_parameters` - (Optional) Represents response parameters that can be sent back to the caller
* `rest_api_id` - (Required) The ID of the associated REST API
* `resource_id` - (Required) The API resource ID
* `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

16
website/source/docs/providers/aws/r/api_gateway_model.html.markdown
View File

@ -35,8 +35,14 @@ EOF
The following arguments are supported:
* `rest_api_id` - (Required) API Gateway ID
* `name` - (Required) Name of the model
* `description` - (Optional) Model description
* `content_type` - (Required) Model content type
* `schema` - (Required) Model schema
* `rest_api_id` - (Required) The ID of the associated REST API
* `name` - (Required) The name of the model
* `description` - (Optional) The description of the model
* `content_type` - (Required) The content type of the model
* `schema` - (Required) The schema of the model in a JSON form
## Attributes Reference
The following attributes are exported:
* `id` - The ID of the model

11
website/source/docs/providers/aws/r/api_gateway_resource.html.markdown
View File

@ -8,7 +8,7 @@ description: |-
# aws\_api\_gateway\_resource
Provides an API Gateway REST API Resource.
Provides an API Gateway Resource.
## Example Usage
@ -29,12 +29,13 @@ resource "aws_api_gateway_resource" "MyDemoResource" {
The following arguments are supported:
* `rest_api_id` - (Required) API Gateway ID
* `parent_id` - (Required) Parent resource ID
* `path_part` - (Required) The resource path
* `rest_api_id` - (Required) The ID of the associated REST API
* `parent_id` - (Required) The ID of the parent API resource
* `path_part` - (Required) The last path segment of this API resource.
## Attributes Reference
The following attributes are exported:
* `path` - The complete path for this resource, including all parent paths
* `id` - The ID of the API resource
* `path` - The complete path for this API resource, including all parent paths

7
website/source/docs/providers/aws/r/api_gateway_rest_api.html.markdown
View File

@ -23,11 +23,12 @@ resource "aws_api_gateway_rest_api" "MyDemoAPI" {
The following arguments are supported:
* `name` - (Required) Name of the API Gateway
* `description` - (Optional) The API Gateway description
* `name` - (Required) The name of the REST API
* `description` - (Optional) The description of the REST API
## Attributes Reference
The following attributes are exported:
* `root_resource_id` - The resource ID of the APIs root
* `id` - The ID of the REST API
* `root_resource_id` - The resource ID of the REST API's root