Allow string argument for action get API (#105)
authorJames Dubee <jwdubee@us.ibm.com>
Thu, 15 Mar 2018 07:46:07 +0000 (03:46 -0400)
committerJames Thomas <jthomas.uk@gmail.com>
Thu, 15 Mar 2018 07:46:07 +0000 (07:46 +0000)
* Allow string argument for action get API

* Group optional params together in README

README.md
lib/actions.js
test/unit/actions.test.js

index 0009c8e..d11110d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -255,6 +255,12 @@ The following optional parameters are supported for all resource retrievals:
 Optional parameters for action resource retrievals are shown below:
 - `code` - set to `true` or `false` depending on whether action code should be included or excluded respectively
 
+This method also supports passing the `name` property directly without wrapping within an object.
+```javascript
+const name = "actionName"
+ow.actions.get(name)
+```
+
 If you pass in an array for the first parameter, the `get` call will be executed for each array item. The function returns a Promise which resolves with the results when all operations have finished.
 
 ```javascript
index 87d190b..c76ff15 100644 (file)
@@ -22,7 +22,7 @@ class Actions extends Resources {
   }
 
   get (options) {
-    options = options || {}
+    options = this.parse_options(options)
     options.qs = this.qs(options, ['code'])
 
     return this.operation_with_id('GET', options)
index 1a5ec1c..715639a 100644 (file)
@@ -79,7 +79,7 @@ test('should retrieve action from string identifier', t => {
     t.is(path, `namespaces/${ns}/actions/12345`)
   }
 
-  return actions.get({name: '12345'})
+  return actions.get('12345')
 })
 
 test('should delete action from identifier', t => {