From be9353b3d4d2512aefd0ec5cc55505ff15805c33 Mon Sep 17 00:00:00 2001 From: Shaun Ediger Date: Tue, 16 Oct 2018 12:32:16 -0700 Subject: [PATCH] doc(configuration): Add missing documentation for required `healthcheck` property for each function; otherwise, the function is skipped, even if an event is configured for a healthcheck - fix some typos --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ccb2899..aa62c9f 100644 --- a/README.md +++ b/README.md @@ -32,12 +32,23 @@ plugins: - serverless-plugin-healthcheck ``` +* Add a `healthcheck` property to all the functions that contain any events you want to be checked. The value can be a boolean, a stage name, or an array of stage names. + +Boolean: + +```yml +functions: + hello: + healthcheck: true | dev | [ dev, test, prod ] +``` + * Add a `healthcheck` property to all the events in all the functions you want to be checked. ```yml functions: hello: - events + healthcheck: true + events: - http: path: /schema/{TypeID} method: get @@ -52,7 +63,7 @@ functions: params: {"subjectType": "system", "subjectID": "dewey"} ``` -* Add additional format properties to trigger the output of a full diagnotic for each check +* Add additional format properties to trigger the output of a full diagnostic for each check ```yml healthcheck: @@ -114,7 +125,7 @@ custom: endpoint: _show_health ``` -* define a custom header for the healtcheck to give the healtcheck output some contaxt +* define a custom header for the healthcheck to give the healthcheck output some context ```yml endpoint: __health