dubeejw commented on a change in pull request #2490: CLI summaries for actions
without annotations
URL:
https://github.com/apache/incubator-openwhisk/pull/2490#discussion_r131735840
##########
File path: docs/packages.md
##########
@@ -42,15 +42,21 @@ Several packages are registered with OpenWhisk. You can
get a list of packages i
```
```
package /whisk.system/cloudant: Cloudant database service
- (params: BluemixServiceName host username password dbname includeDoc
overwrite)
+ (parameters: *apihost, *bluemixServiceName, *dbname, *host, overwrite,
*password, *username)
action /whisk.system/cloudant/read: Read document from database
- action /whisk.system/cloudant/write: Write document to database
+ (parameters: dbname, id, params)
+ action /whisk.system/cloudant/write: Write document in database
+ (parameters: dbname, doc)
feed /whisk.system/cloudant/changes: Database change feed
+ (parameters: dbname, filter, query_params)
+ ...
```
- This output shows that the Cloudant package provides two actions, `read` and
`write`, and one trigger feed called `changes`. The `changes` feed causes
triggers to be fired when documents are added to the specified Cloudant
database.
+ **Note**: Parameters listed under the package with a prefix `*` are
predefined, bound parameters. Parameters without a `*` are those listed under
the [annotations](./annotations.md) for each entity. Any entity listed under a
package inherits specific bound parameters from the package. To view the list
of known parameters of an entity belonging to a package, you will need to run a
`get --summary` of the individual entity.
Review comment:
Need to explain what `**` denotes in the docs.
----------------------------------------------------------------
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:
[email protected]
With regards,
Apache Git Services
