From 6ec13b48a42529584ebb71a73712336663e18466 Mon Sep 17 00:00:00 2001 From: "Eslam A. Hefnawy" Date: Tue, 26 Jul 2016 17:01:56 +0900 Subject: [PATCH] fixed typos --- docs/guide/custom-provider-resources.md | 4 ++-- lib/plugins/aws/deploy/compile/events/apiGateway/README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guide/custom-provider-resources.md b/docs/guide/custom-provider-resources.md index 6b0b4d976..d986b6262 100644 --- a/docs/guide/custom-provider-resources.md +++ b/docs/guide/custom-provider-resources.md @@ -28,7 +28,7 @@ resources: ``` ### Example custom resources - HTTP Proxy -As a practical example for adding a custom resource to your service, we're going to demonstrate how you can create an API Gateway HTTP proxy using Cloud Formation templates/resources. +As a practical example for adding a custom resource to your service, we're going to demonstrate how you can create an API Gateway HTTP proxy using CloudFormation templates/resources. To set up an HTTP proxy, you'll need two CloudFormation templates, one for the endpoint (known as resource in CF), and one for method. These two templates will work together to construct your proxy. So if you want to set `your-app.com/serverless` as a proxy for `serverless.com`, you'll need the following two templates in your `serverless.yaml`: @@ -39,6 +39,7 @@ service: service-name provider: aws functions: ... + resources: Resources: ProxyResource: @@ -76,7 +77,6 @@ resources: ResponseParameters: {} ResponseTemplates: application/json: "" - ``` There's a lot going on in these two templates, but all you need to know to set up a simple proxy is setting the method & endpoint of your proxy, and the URI you want to set a proxy to. diff --git a/lib/plugins/aws/deploy/compile/events/apiGateway/README.md b/lib/plugins/aws/deploy/compile/events/apiGateway/README.md index 6f8713b54..fd09033b1 100644 --- a/lib/plugins/aws/deploy/compile/events/apiGateway/README.md +++ b/lib/plugins/aws/deploy/compile/events/apiGateway/README.md @@ -121,4 +121,4 @@ functions: ``` ### Setting an HTTP proxy on API Gateway -Setting an API Gateway proxy can easily be done by adding two custom Cloud Formation resource templates to your `serverless.yaml` file. [Check this guide for more info on how to set up a proxy using custom CloudFormation resources in `serverless.yaml`](https://github.com/serverless/serverless/blob/v1.0/docs/guide/custom-provider-resources.md). \ No newline at end of file +Setting an API Gateway proxy can easily be done by adding two custom CloudFormation resource templates to your `serverless.yaml` file. [Check this guide for more info on how to set up a proxy using custom CloudFormation resources in `serverless.yaml`](https://github.com/serverless/serverless/blob/v1.0/docs/guide/custom-provider-resources.md). \ No newline at end of file