This is an automated email from the ASF dual-hosted git repository.
dgrove pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openwhisk.git
The following commit(s) were added to refs/heads/master by this push:
new 3763967 Rephrase description of `provide-api-key` (#4654)
3763967 is described below
commit 3763967939799aaada9bdd5f19a3b936972f3040
Author: Mathieu Bacou <[email protected]>
AuthorDate: Tue Oct 1 15:15:22 2019 +0200
Rephrase description of `provide-api-key` (#4654)
Move the description of the default value of `provide-api-key` for new
actions to the beginning of the description, before explaining the behavior
when not specified in an existing action.
Related to [this
suggestion](https://github.com/apache/openwhisk-catalog/issues/309#issuecomment-536907037).
---
docs/annotations.md | 5 +----
1 file changed, 1 insertion(+), 4 deletions(-)
diff --git a/docs/annotations.md b/docs/annotations.md
index 5137033..4923894 100644
--- a/docs/annotations.md
+++ b/docs/annotations.md
@@ -61,10 +61,7 @@ The annotations are _not_ checked. So while it is
conceivable to use the annotat
The following annotations on an action are available.
-* `provide-api-key`: This annotation may be attached to actions which require
an API key, for example to make REST API calls to the OpenWhisk host.
-The absence of this annotation, or its presence with a value that is not
_falsy_ (i.e., a value that is different from zero, null, false, and the empty
string)
-will cause an API key to be present in the [action execution
context](./actions.md#accessing-action-metadata-within-the-action-body). This
annotation is added
-to newly created actions, if not already specified, with a default false value.
+* `provide-api-key`: This annotation may be attached to actions which require
an API key, for example to make REST API calls to the OpenWhisk host. For newly
created actions, if not specified, it defaults to a false value. For existing
actions, the absence of this annotation, or its presence with a value that is
not _falsy_ (i.e., a value that is different from zero, null, false, and the
empty string) will cause an API key to be present in the [action execution
context](./actions.md#acce [...]
# Annotations specific to web actions
