Skip to content

Commit

Permalink
Minor documentation fix [aws_api_gateway] (ansible-collections#291)
Browse files Browse the repository at this point in the history
  • Loading branch information
Sakar authored Nov 12, 2020
1 parent fc7c6fc commit abf2204
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions aws_api_gateway.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
- Allows for the management of API Gateway APIs
- Normally you should give the api_id since there is no other
stable guaranteed unique identifier for the API. If you do
not give api_id then a new API will be create each time
not give api_id then a new API will be created each time
this is run.
- Beware that there are very hard limits on the rate that
you can call API Gateway's REST API. You may need to patch
your boto. See U(https://github.com/boto/boto3/issues/876)
and discuss with your AWS rep.
and discuss it with your AWS rep.
- swagger_file and swagger_text are passed directly on to AWS
transparently whilst swagger_dict is an ansible dict which is
converted to JSON before the API definitions are uploaded.
Expand Down Expand Up @@ -97,7 +97,7 @@
description:
- Type of endpoint configuration, use C(EDGE) for an edge optimized API endpoint,
- C(REGIONAL) for just a regional deploy or PRIVATE for a private API.
- This will flag will only be used when creating a new API Gateway setup, not for updates.
- This flag will only be used when creating a new API Gateway setup, not for updates.
choices: ['EDGE', 'REGIONAL', 'PRIVATE']
type: str
default: EDGE
Expand All @@ -109,7 +109,7 @@
notes:
- A future version of this module will probably use tags or another
ID so that an API can be create only once.
ID so that an API can be created only once.
- As an early work around an intermediate version will probably do
the same using a tag embedded in the API name.
Expand Down

0 comments on commit abf2204

Please sign in to comment.