feature request: support "name" for get, invoke operations about openwhisk-client-js HOT 9 CLOSED

This is a good idea. I would need to bump the version number as this would be a breaking change.

We should probably review the API to see what other usability changes we can include if we're going to push out a major version upgrade.

from openwhisk-client-js.

support both for backward compatibility?

from openwhisk-client-js.

as long as we prefer xName to name... this should be sufficient, in terms of backwards compatibility? the only cases i can think of are those that, before, would result in an error, and now will not; e.g. ow.actions.create({name: 'foo'}) would before result in an error, and now succeed...

perhaps that is ok?

from openwhisk-client-js.

+1 that's better than breaking all the existing actions. since we just forced everyone to get off whisk.js would be nice not to make another forced change.

from openwhisk-client-js.

i just added a projection suggestion to the initial feature request comment (i.e. at the top). either ow.x.getXxx or ow.x.get('foo', 'xxx')

if the former, i would start with any of the fields that are of array type. e.g. parameters for all entity types, plus actions packages.

from openwhisk-client-js.

Supporting Different Parameters

I'm going to support the resource identifiers returned by the platform API to chaining promises together. This will be name in most examples but there are additional edge cases like activationId.

I will maintain support for the existing parameter names for backwards capability.

Support String Parameters

I also might support passing in the identifier as a string, in addition to the object, to simplify simple invocations.

ow.actions.invoke('actionName')

Any objections?

Chaining Promises

Looking at the example above about chaining promises, it will encounter an issue that the API uses inheritance to share a base class and needs the lexical context bound to the invocation. Arrow functions will be needed to resolve this without resorting to function.bind

Promise.all(triggers.map(trigger => ow.triggers.invoke(trigger)))

I don't like the style of having a separate method for interacting with multiple resources. It feels cluttered to me.

I suggest supporting array parameters for the relevant resource methods, as shown here:

ow.actions.list()
  .then(actions => ow.actions.invoke(actions))
  .then(result => ...)

That seems to be a relatively clean way to support interacting with multiple resources without having to remember different API calls.

Thoughts? @starpit @rabbah

from openwhisk-client-js.

this all seems reasonable. thanks!

from openwhisk-client-js.

I've been refactoring the library to make supporting these features easier. id is now supported along with the old style.

Remaining items.

• update docs with new features
• support string identifiers
• support array of identifiers
• verify changes with integration tests

from openwhisk-client-js.

This is now ready with v3.3.0.

from openwhisk-client-js.