archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-25 15:07:39 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3800 from Sequoia/patch-1

Browse Source 
invoke local docs fixup
This commit is contained in:
Philipp Muens 2017-06-16 07:19:44 +01:00 committed by GitHub
commit 6a9e99656d
2 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/providers/aws/cli-reference/invoke-local.md
View File

@ -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.

15
docs/providers/aws/cli-reference/invoke.md
View File

@ -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. //
}
```