[GitHub] csantanapr closed pull request #3535: --web-secure option doc update

[GitBox <gi...@apache.org>]

csantanapr closed pull request #3535: --web-secure option doc update
URL: https://github.com/apache/incubator-openwhisk/pull/3535
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/webactions.md b/docs/webactions.md
index 6bd1f3159f..e08a9ea45b 100644
--- a/docs/webactions.md
+++ b/docs/webactions.md
@@ -284,6 +284,12 @@ The result of these changes is that the `name` is bound to `Jane` and may not be
 
 By default, a web action can be invoked by anyone having the web action's invocation URL. Use the `require-whisk-auth` [web action annotation](annotations.md#annotations-specific-to-web-actions) to secure the web action. When the `require-whisk-auth` annotation is set to `true`, the action will authenticate the invocation request's Basic Authorization credentials against the action owner's whisk auth key.  When set to a number or a case-sensitive string, the action's invocation request must include a `X-Require-Whisk-Auth` header having this same value. Secured web actions will return a `Not Authorized` when credential validation fails.
 
+Alternatively, use the `--web-secure` flag to automatically set the `require-whisk-auth` annotation.  When set to `true` a random number is generated as the `require-whisk-auth` annotation value. When set to `false` the `require-whisk-auth` annotation is removed.  When set to any other value, that value is used as the `require-whisk-auth` annotation value.
+
+```bash
+$ wsk action update /guest/demo/hello hello.js --web true --web-secure my-secret
+```
+or
 ```bash
 $ wsk action update /guest/demo/hello hello.js --web true -a require-whisk-auth my-secret
 ```


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services