Skip to content

Commit 3afbada

Browse files
author
Radek Simko
committed
docs: Fix API Gateway documentation
1 parent b20f680 commit 3afbada

9 files changed

Lines changed: 72 additions & 53 deletions

‎website/source/docs/providers/aws/r/api_gateway_api_key.html.markdown‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,18 @@ resource "aws_api_gateway_deployment" "MyDemoDeployment" {
3737

3838
The following arguments are supported:
3939

40-
* `name` - (Required) Name of the API Gateway
41-
* `description` - (Optional) The API Gateway description
42-
* `stage_key` - (Optional) applicable API Gateway stages
40+
* `name` - (Required) The name of the API key
41+
* `description` - (Required) The API key description
42+
* `enabled` - (Optional) Specifies whether the API key can be used by callers. Defaults to `true`.
43+
* `stage_key` - (Optional) A list of stage keys associated with the API key - see below
4344

44-
Stage keys support the following:
45+
`stage_key` block supports the following:
4546

46-
* `rest_api_id` - (Required) The ID of the associated API Gateway Rest API.
47+
* `rest_api_id` - (Required) The ID of the associated REST API.
4748
* `stage_name` - (Required) The name of the API Gateway stage.
49+
50+
## Attribute Reference
51+
52+
The following attributes are exported:
53+
54+
* `id` - The ID of the API key

‎website/source/docs/providers/aws/r/api_gateway_deployment.html.markdown‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,14 @@ resource "aws_api_gateway_deployment" "MyDemoDeployment" {
4949

5050
The following arguments are supported:
5151

52-
* `rest_api_id` - (Required) ID of the API Gateway
53-
* `stage_name` - (Required) name of the stage
54-
* `description` - (Optional) name of the stage
55-
* `variables` - (Optional) Stage Variables
52+
* `rest_api_id` - (Required) The ID of the associated REST API
53+
* `stage_name` - (Optional) The name of the stage
54+
* `description` - (Optional) The description of the deployment
55+
* `stage_description` - (Optional) The description of the stage
56+
* `variables` - (Optional) A map that defines variables for the stage
57+
58+
## Attribute Reference
59+
60+
The following attributes are exported:
61+
62+
* `id` - The ID of the deployment

‎website/source/docs/providers/aws/r/api_gateway_integration.html.markdown‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,12 @@ resource "aws_api_gateway_integration" "MyDemoIntegration" {
4343

4444
The following arguments are supported:
4545

46-
* `rest_api_id` - (Required) API Gateway ID
47-
* `resource_id` - (Required) API Gateway Resource ID
48-
* `http_method` - (Required) HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTION)
49-
* `type` - (Required) Specifies a put integration input's type (HTTP, MOCK, AWS)
50-
* `uri` - (Optional) Input's Uniform Resource Identifier (HTTP, AWS)
51-
* `integration_http_method` - (Optional) Integration HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTION)
52-
46+
* `rest_api_id` - (Required) The ID of the associated REST API
47+
* `resource_id` - (Required) The API resource ID
48+
* `http_method` - (Required) The HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`)
49+
* `type` - (Required) The integration input's type (HTTP, MOCK, AWS)
50+
* `uri` - (Optional) The input's URI (HTTP, AWS). **Required** if `type` is `HTTP` or `AWS`.
51+
* `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/\*`.
52+
* `integration_http_method` - (Optional) The integration HTTP method
53+
(`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`).
54+
* `request_templates` - (Optional) A map of the integration's request templates.

‎website/source/docs/providers/aws/r/api_gateway_integration_response.html.markdown‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ resource "aws_api_gateway_integration_response" "MyDemoIntegrationResponse" {
5757

5858
The following arguments are supported:
5959

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

‎website/source/docs/providers/aws/r/api_gateway_method.html.markdown‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ layout: "aws"
33
page_title: "AWS: aws_api_gateway_method"
44
sidebar_current: "docs-aws-resource-api-gateway-method"
55
description: |-
6-
Provides an HTTP Method for an API Gateway Resource.
6+
Provides a HTTP Method for an API Gateway Resource.
77
---
88

99
# aws\_api\_gateway\_method
1010

11-
Provides an HTTP Method for an API Gateway Resource.
11+
Provides a HTTP Method for an API Gateway Resource.
1212

1313
## Example Usage
1414

@@ -30,18 +30,15 @@ resource "aws_api_gateway_method" "MyDemoMethod" {
3030
http_method = "GET"
3131
authorization = "NONE"
3232
}
33-
3433
```
3534

3635
## Argument Reference
3736

3837
The following arguments are supported:
3938

40-
* `rest_api_id` - (Required) API Gateway ID
41-
* `resource_id` - (Required) API Gateway Resource ID
42-
* `http_method` - (Required) HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTION)
43-
* `authorization` - (Required) Type of authorization used for the method.
44-
* `api_key_required` - (Optional) Specify if the method required an ApiKey
45-
* `request_models` - (Optional) Specifies the Model resources used for the request's content type description
46-
* `request_parameters` - (Optional) Represents requests parameters that are sent with the backend request
47-
39+
* `rest_api_id` - (Required) The ID of the associated REST API
40+
* `resource_id` - (Required) The API resource ID
41+
* `http_method` - (Required) The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`)
42+
* `authorization` - (Required) The type of authorization used for the method
43+
* `api_key_required` - (Optional) Specify if the method requires an API key
44+
* `request_models` - (Optional) A map of the API models used for the request's content type

‎website/source/docs/providers/aws/r/api_gateway_method_response.html.markdown‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,8 @@ resource "aws_api_gateway_method_response" "200" {
5050

5151
The following arguments are supported:
5252

53-
* `rest_api_id` - (Required) API Gateway ID
54-
* `resource_id` - (Required) API Gateway Resource ID
55-
* `http_method` - (Required) HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTION)
56-
* `status_code` - (Required) Specify the HTTP status code.
57-
* `response_models` - (Optional) Specifies the Model resources used for the response's content type
58-
* `response_parameters` - (Optional) Represents response parameters that can be sent back to the caller
59-
53+
* `rest_api_id` - (Required) The ID of the associated REST API
54+
* `resource_id` - (Required) The API resource ID
55+
* `http_method` - (Required) The HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`)
56+
* `status_code` - (Required) The HTTP status code
57+
* `response_models` - (Optional) A map of the API models used for the response's content type

‎website/source/docs/providers/aws/r/api_gateway_model.html.markdown‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,14 @@ EOF
3535

3636
The following arguments are supported:
3737

38-
* `rest_api_id` - (Required) API Gateway ID
39-
* `name` - (Required) Name of the model
40-
* `description` - (Optional) Model description
41-
* `content_type` - (Required) Model content type
42-
* `schema` - (Required) Model schema
38+
* `rest_api_id` - (Required) The ID of the associated REST API
39+
* `name` - (Required) The name of the model
40+
* `description` - (Optional) The description of the model
41+
* `content_type` - (Required) The content type of the model
42+
* `schema` - (Required) The schema of the model in a JSON form
43+
44+
## Attributes Reference
45+
46+
The following attributes are exported:
47+
48+
* `id` - The ID of the model

‎website/source/docs/providers/aws/r/api_gateway_resource.html.markdown‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: |-
88

99
# aws\_api\_gateway\_resource
1010

11-
Provides an API Gateway REST API Resource.
11+
Provides an API Gateway Resource.
1212

1313
## Example Usage
1414

@@ -29,12 +29,13 @@ resource "aws_api_gateway_resource" "MyDemoResource" {
2929

3030
The following arguments are supported:
3131

32-
* `rest_api_id` - (Required) API Gateway ID
33-
* `parent_id` - (Required) Parent resource ID
34-
* `path_part` - (Required) The resource path
32+
* `rest_api_id` - (Required) The ID of the associated REST API
33+
* `parent_id` - (Required) The ID of the parent API resource
34+
* `path_part` - (Required) The last path segment of this API resource.
3535

3636
## Attributes Reference
3737

3838
The following attributes are exported:
3939

40-
* `path` - The complete path for this resource, including all parent paths
40+
* `id` - The ID of the API resource
41+
* `path` - The complete path for this API resource, including all parent paths

‎website/source/docs/providers/aws/r/api_gateway_rest_api.html.markdown‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ resource "aws_api_gateway_rest_api" "MyDemoAPI" {
2323

2424
The following arguments are supported:
2525

26-
* `name` - (Required) Name of the API Gateway
27-
* `description` - (Optional) The API Gateway description
26+
* `name` - (Required) The name of the REST API
27+
* `description` - (Optional) The description of the REST API
2828

2929
## Attributes Reference
3030

3131
The following attributes are exported:
3232

33-
* `root_resource_id` - The resource ID of the APIs root
33+
* `id` - The ID of the REST API
34+
* `root_resource_id` - The resource ID of the REST API's root

0 commit comments

Comments
 (0)