This is an automated email from the ASF dual-hosted git repository.
csantanapr pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/incubator-openwhisk-package-cloudant.git
The following commit(s) were added to refs/heads/master by this push:
new 41f8876 Documentation updates for IAM Cloudant service instance
support (#194)
41f8876 is described below
commit 41f88762d9d12c7ae39642bcac5ba0cdf7c43c50
Author: Jason Peterson <jason...@us.ibm.com>
AuthorDate: Thu Jan 24 19:36:03 2019 -0500
Documentation updates for IAM Cloudant service instance support (#194)
---
README.md | 18 +++++++++++++++++-
1 file changed, 17 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index c94adfe..9a4b7d2 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,23 @@ The `/whisk.system/cloudant` package enables you to work
with a Cloudant databas
| `/whisk.system/cloudant` | package | dbname, host, username, password | Work
with a Cloudant database |
| `/whisk.system/cloudant/read` | action | dbname, id | Read a document from a
database |
| `/whisk.system/cloudant/write` | action | dbname, overwrite, doc | Write a
document to a database |
-| `/whisk.system/cloudant/changes` | feed | dbname, filter, query_params,
maxTriggers | Fire trigger events on changes to a database |
+| `/whisk.system/cloudant/changes` | feed | dbname, iamApiKey, iamUrl, filter,
query_params, maxTriggers | Fire trigger events on changes to a database |
+
+## Firing a trigger on database changes
+
+Use the `changes` feed to configure a service to fire a trigger on every
change to your Cloudant database. The parameters are as follows:
+
+- `dbname` (*required*): The name of the Cloudant database.
+
+- `iamApiKey` (*optional*): The IAM API key for the Cloudant database. If
specified will be used as the credentials instead of username and password.
+
+- `iamUrl` (*optional*): The IAM token service url that is used when
`iamApiKey` is specified. Defaults to
`https://iam.bluemix.net/identity/token`.
+
+- `maxTriggers` (*optional*): Stop firing triggers when this limit is reached.
Defaults to infinite.
+
+- `filter` (*optional*): Filter function that is defined on a design document.
+
+- `query_params` (*optional*): Extra query parameters for the filter function.
The following topics walk through setting up a Cloudant database, configuring
an associated package, and using the actions and feeds in the
`/whisk.system/cloudant` package.
