Skip to content

Latest commit

 

History

History
97 lines (84 loc) · 2.62 KB

spec_sequences.md

File metadata and controls

97 lines (84 loc) · 2.62 KB

Sequences

Actions can be composed into sequences to, in effect, form a new Action. The Sequence entity allows for a simple, convenient way to describe them in the Package Manifest.

Fields

Key Name Required Value Type Default Description

actions

yes

list of Action

N/A

The required list of two or more actions

Requirements

  • The comma separated list of Actions on the actions key SHALL imply the order of the sequence (from left, to right).
  • There MUST be two (2) or more actions declared in the sequence.

Notes

  • The sequences key exists for convenience; however, it is just one possible instance of a composition of Actions. The composition entity is provided for not only describing sequences, but also for other (future) compositions and additional information needed to compose them.  For example, the composition entity allows for more complex mappings of input and output parameters between Actions.

Grammar

sequences:
  <sequence name>:
     <Entity schema>
     actions: <ordered list of action names>
     web: <boolean> | yes | no | raw
  annotations:
    <map of annotation key-values>
    web-export: <boolean> | yes | no | raw # optional
    web-custom-options: <boolean> # optional, only valid when `web-export` enabled
    require-whisk-auth: <boolean> | <string> | <positive integer> # optional, only valid when `web-export` enabled
  ...

Example

sequences:
  newbot:
    actions: newbot-create, newbot-select-persona, newbot-greeting
    web: true