From fba685d8b13df17277a5ef58f5c139d2eed57fe5 Mon Sep 17 00:00:00 2001 From: Sequoia McDowell Date: Wed, 14 Jun 2017 19:28:16 -0400 Subject: [PATCH] invoke + invoke local docs fixup - removed erroneous statement about "context and event properties" in mock event data files - added example data.json @TODO: the `invoke` docs should be the main source of truth here, the `invoke local` docs should describe *only what's different from invoke* and defer to `invoke` for the rest. Duplicating across the two files is not ideal. --- docs/providers/aws/cli-reference/invoke-local.md | 13 ++++++++++++- docs/providers/aws/cli-reference/invoke.md | 15 +++++++++++++-- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/providers/aws/cli-reference/invoke-local.md b/docs/providers/aws/cli-reference/invoke-local.md index 53fb5526c..5967b495e 100644 --- a/docs/providers/aws/cli-reference/invoke-local.md +++ b/docs/providers/aws/cli-reference/invoke-local.md @@ -21,7 +21,7 @@ serverless invoke local --function functionName ## Options - `--function` or `-f` The name of the function in your service that you want to invoke locally. **Required**. -- `--path` or `-p` The path to a json file holding input data to be passed to the invoked function. This path is relative to the root directory of the service. The json file should have event and context properties to hold your mocked event and context data. +- `--path` or `-p` The path to a json file holding input data to be passed to the invoked function as the `event`. This path is relative to the root directory of the service. - `--data` or `-d` String data to be passed as an event to your function. Keep in mind that if you pass both `--path` and `--data`, the data included in the `--path` file will overwrite the data you passed with the `--data` flag. ## Environment @@ -65,6 +65,17 @@ serverless invoke local --function functionName --path lib/data.json This example will pass the json data in the `lib/data.json` file (relative to the root of the service) while invoking the specified/deployed function. +### Example `data.json` + +```json +{ + "resource": "/", + "path": "/", + "httpMethod": "GET", + // etc. // +} +``` + ### Limitations Currently, `invoke local` only supports the NodeJs and Python runtimes. diff --git a/docs/providers/aws/cli-reference/invoke.md b/docs/providers/aws/cli-reference/invoke.md index cf3f1fa64..e52eeab20 100644 --- a/docs/providers/aws/cli-reference/invoke.md +++ b/docs/providers/aws/cli-reference/invoke.md @@ -41,8 +41,8 @@ serverless invoke local --function functionName ## Options - `--function` or `-f` The name of the function in your service that you want to invoke locally. **Required**. -- `--path` or `-p` The path to a json file holding input data to be passed to the invoked function. This path is relative to the -root directory of the service. The json file should have event and context properties to hold your mocked event and context data. +- `--path` or `-p` The path to a json file holding input data to be passed to the invoked function as the `event`. This path is relative to the +root directory of the service. - `--data` or `-d` String data to be passed as an event to your function. Keep in mind that if you pass both `--path` and `--data`, the data included in the `--path` file will overwrite the data you passed with the `--data` flag. ## Examples @@ -84,3 +84,14 @@ serverless invoke --function functionName --stage dev --region us-east-1 --path This example will pass the json data in the `lib/data.json` file (relative to the root of the service) while invoking the specified/deployed function. + +#### Example `data.json` + +```json +{ + "resource": "/", + "path": "/", + "httpMethod": "GET", + // etc. // +} +```