The Action entity schema contains the necessary information to deploy an OpenWhisk function and define its deployment configurations, inputs and outputs.
| Key Name | Required | Value Type | Default | Description |
|---|---|---|---|---|
| version | no | version | N/A | The optional user-controlled version for the Action. |
| function | yes | string | N/A | Required source location (path inclusive) of the Action code either:Relative to the Package manifest file.Relative to the specified Repository. |
| code | no | string | N/A | This optional field is now replaced by the “function” field. |
| runtime | maybe | string | N/A | he required runtime name (and optional version) that the Action code requires for an execution environment.Note: May be optional if tooling is allowed to make assumptions about file extensions or infer from functional code. |
| inputs | no | list of parameter | N/A | The optional ordered list inputs to the Action. |
| outputs | no | list of parameter | N/A | The optional outputs from the Action. |
| limits | no | map of limit keys and values | N/A | Optional map of limit keys and their values.See section “Valid limit keys” (below) for a listing of recognized keys and values. |
| feed | no | boolean | false | Optional indicator that the Action supports the required parameters (and operations) to be run as a Feed Action. |
| web | no | string | true | false | yes | no | raw | The optional flag that makes the action accessible to REST calls without authentication.For details on all types of Web Actions, see: Web Actions. |
| raw-http | no | boolean | false | The optional flag (annotation) to indicate if a Web Action is able to consume the raw contents within the body of an HTTP request.Note: this option is ONLY valid if “web” or “web-export” is set to ‘true’. |
| docker | no | string | N/A | The optional key that references a Docker image (e.g., openwhisk/skeleton). |
| native | no | boolean | false | The optional key (flag) that indicates the Action is should use the Docker skeleton image for OpenWhisk (i.e., short-form for docker: openwhisk/skeleton). |
| final | no | boolean | false | The optional flag (annotation) which makes all of the action parameters that are already defined immutable.Note: this option is ONLY valid if “web” or “web-export” is set to ‘true’. |
| main | no | string | N/A | The optional name of the function to be aliased as a function named “main”.Note: by convention, Action functions are required to be called “main”; this field allows existing functions not named “main” to be aliased and accessed as if they were named “main”. |
| annotations | no | N/A | The optional map of annotation key-values. See below for Action annotations on actions. |
The following annotations have special meanings for Actions:
| Key Name | Required | Value Type | Default | Description |
|---|---|---|---|---|
| final | no | boolean | not set (false) | Parameters are protected and treated as immutable. This is required for web actions (i.e., web or web-export set to true. |
| web-export | no | boolean | yes | no | raw | not set (false) | The optional annotation used to export an action as a web action which is accessible through an API REST interface (url). |
| web-custom-options | no | boolean | not set (false) | The optional annotation that enables a web action to respond to OPTIONS requests with customized headers, otherwise a default CORS response applies. |
| require-whisk-auth | no | string | integer | boolean | not set (false) | The optional annotation that can secure a web action so that it is only accessible to an authenticated subject.See Securing web actions |
CREATE, DELETE, PAUSE,or UNPAUSE. These operation names MAY be supplied in lowercase (i.e., create, delete, pause, etc.).kind is currently supported as a synonym for the key named ‘runtime’; in the future it MAY be deprecated.code key-value is specified, the runtime SHALL be a required field.require-whisk-auth SHALL only be valid for web actions (i.e., if the web key or web-export annotation is set to true).require-whisk-auth annotation is an integer its value MUST be a positive integer less than or equal to the MAX_INT value of 9007199254740991.web or web-export key is present and set to true the web action's MUST also be marked final. This happens automatically when the web or web-export keys are present and set to true.language:default will be assumed.<actionName>[.<type>]: <Entity schema> version: <version> function: <string> code: <string> runtime: <name>[@<[range of ]version>] inputs: <list of parameter> outputs: <list of parameter> limits: <list of limit key-values> feed: <boolean> # default: false web: <boolean> | yes | no | raw raw-http: <boolean> docker: <string> native: <boolean> final: <boolean> main: <string> 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
Note: the optional [.] grammar is used for naming Web Actions.
my_awesome_action: version: 1.0 description: An awesome action written for node.js function: src/js/action.js runtime: nodejs@>0.12<6.0 web: true inputs: not_awesome_input_value: description: Some input string that is boring type: string outputs: awesome_output_value: description: Impressive output string type: string limits: memorySize: 512 kB logSize: 5 MB annotations: require-whisk-auth: "my-auth-token"
The following runtime values are currently supported by the OpenWhisk platform “out-of-box” at around the time of the Openwhisk platform release 1.0.
| Runtime value | OpenWhisk kind | Docker image | Tag | Description |
|---|---|---|---|---|
| go | go:1.11 (default) | go:1.11 | openwhisk/action-golang-v1.11 | nightly | Go 1.11 runtime |
| nodejs@12 | nodejs:12 | openwhisk/nodejs12action | nightly | NodeJS 12 runtime |
| nodejs | nodejs@10 (default) | nodejs:10 | openwhisk/action-nodejs-v10 | nightly | NodeJS 10 runtime |
| nodejs@8 | nodejs:8 | openwhisk/action-nodejs-v8 | nightly | NodeJS 8 runtime |
| nodejs@6 (deprecated) | nodejs:6 | openwhisk/nodejs6action | nightly | NodeJS 6 runtime |
| java | java8 (default) | java:8 | openwhisk/java8action | nightly | Java (8) language runtime |
| php | php@7.4 (default) | php:7.4 | openwhisk/action-php-v7.4 | nightly | PHP (7.3) language runtime |
| php@7.3 | php:7.3 | openwhisk/action-php-v7.3 | nightly | PHP (7.3) language runtime |
| php@7.2 (deprecated) | php:7.2 | openwhisk/action-php-v7.2 | nightly | PHP (7.2) language runtime |
| php@7.1 (deprecated) | php:7.1 | openwhisk/action-php-v7.1 | nightly | PHP (7.1) language runtime |
| python | python@3 (default) | python:3 | openwhisk/python3action | nightly | Python 3 (3.6) language runtime |
| python@2 | python:2 | openwhisk/python2action | 1.13.0-incubating | Python 2 (2.7) language runtime |
| ruby | (default) | ruby:2.5 | openwhisk/action-ruby-v2.5 | nightly | Ruby 2.5 language runtime |
| swift | swift@4.2 (default) | swift:4.2 | openwhisk/action-swift-v4.2 | nightly | Swift 4.2 language runtime |
| swift@4.1 | swift:4.1 | openwhisk/action-swift-v4.1 | nightly | Swift 4.1 language runtime |
| swift@3.1.1 (deprecated) | swift:3.1.1 | openwhisk/action-swift-v3.1.1 | nightly | Swift 3.1.1 language runtime |
| dotnet | dotnet@2.2 (default) | dotnet:2.2 | openwhisk/action-dotnet-v2.2 | nightly | .NET Core 2.2 runtime |
| dotnet@3.1 | dotnet:3.1 | openwhisk/action-dotnet-v3.1 | nightly | .NET Core 3.1 runtime |
| language:default | N/A | N/A | N/A | Permit the OpenWhisk platform to select the correct default language runtime. |
See the file runtimes.json in the main apache/openwhisk repository for the latest supported runtimes nad versions.
nightly in Docker Hub (e.g, for GitHub pull requests). Production uses of OpenWhisk code may use different images and tagged (released) image versions.runtime is supplied, the value language:default will be assumed.Although it is best practice to provide a runtime value when declaring an Action, it is not required. In those cases, that a runtime is not provided, the package tooling will attempt to derive the correct runtime based upon the the file extension for the Action's function (source code file). The following file extensions are recognized and will be run on the version of corresponding Runtime listed below:
OpenWhisk can turn any Action into a ‘web action’ causing it to return HTTP content without use of an API Gateway. Simply supply a supported ‘type’ extension to indicate which content type is to be returned and identified in the HTTP header (e.g., .json, .html, .text or .http).
Return values from the Action's function are used to construct the HTTP response. The following response parameters are supported in the response object.