You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@openwhisk.apache.org by GitBox <gi...@apache.org> on 2018/06/06 20:46:19 UTC
[GitHub] mrutkows commented on a change in pull request #950: Continue spec.
conversion to markdown and add navigation
mrutkows commented on a change in pull request #950: Continue spec. conversion to markdown and add navigation
URL: https://github.com/apache/incubator-openwhisk-wskdeploy/pull/950#discussion_r193553489
##########
File path: specification/html/spec_actions.md
##########
@@ -19,87 +19,44 @@
## Actions
+#### Subsections
+- [Fields](#fields)
+- [Requirements](#requirements)
+- [Notes](#notes)
+- [Grammar](#grammar)
+- [Example](#example)
+- [Valid Runtime names](#valid-runtime-names)
+- [Recognized File extensions](#recognized-file-extensions)
+- [Valid Limit keys](#valid-limit-keys)
+
The Action entity schema contains the necessary information to deploy an OpenWhisk function and define its deployment configurations, inputs and outputs.
### Fields
-<html>
-<table>
- <tr>
- <th width="80">Key Name</th>
- <th>Required</th>
- <th>Value Type</th>
- <th>Default</th>
- <th>Description</th>
- </tr>
- <tr>
- <td>version</td>
- <td>no</td>
- <td>version</td>
- <td>N/A</td>
- <td>The optional user-controlled version for the Action.</td>
- </tr>
- <tr>
- <td>function</td>
- <td>yes</td>
- <td>string</td>
- <td>N/A</td>
- <td>Required source location (path inclusive) of the Action code either:
- <ul>
- <li>Relative to the Package manifest file.</li>
- <li>Relative to the specified Repository.</li>
- </ul>
- </td>
- </tr>
- <tr>
- <td>runtime</td>
- <td>no</td>
- <td>string</td>
- <td>N/A</td>
- <td>The required runtime name (and optional version) that the Action code requires for an execution environment.
- <p><i>Note: May be optional if tooling allowed to make assumptions about file extensions.</i></p>
- </td>
- </tr>
- <tr>
- <td>inputs</td>
- <td>no</td>
- <td>list of parameter</td>
- <td>N/A</td>
- <td>The optional ordered list inputs to the Action.</td>
- </tr>
- <tr>
- <td>outputs</td>
- <td>no</td>
- <td>list of parameter</td>
- <td>N/A</td>
- <td>The optional outputs from the Action.</td>
- </tr>
- <tr>
- <td>limits</td>
- <td>no</td>
- <td>map of limit keys and values</a></td>
- <td>N/A</td>
- <td>Optional map of limit keys and their values.
- <p><i>See section '</i><a href="#TABLE_LIMIT_KEYS"><i>Valid limit keys</i></a><i>' below for a listing of recognized keys and values.</i></p>
- </td>
- </tr>
- <tr>
- <td>feed</td>
- <td>no</td>
- <td>boolean</td>
- <td>false</td>
- <td>Optional indicator that the Action supports the required parameters (and operations) to be run as a Feed Action.</td>
- </tr>
- <tr>
- <td>web-export</td>
- <td>no</td>
- <td>boolean</td>
- <td>false</td>
- <td>Optionally, turns the Action into a <a href="https://github.com/apache/incubator-openwhisk/blob/master/docs/webactions.md">"<em><u>web actions</u></em>"</a>
- causing it to return HTTP content without use of an API Gateway.
- </td>
- </tr>
-</table>
-</html>
+| Key Name | Required | Value Type | Default | Description |
+|:---|:---|:---|:---|:---|
+| version | no | [version](spec_parameter_types.md#openwhisk-types) | 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:<ul><li>Relative to the Package manifest file.</li><li>Relative to the specified Repository.</li></ul> |
+| runtime | no | string | N/A | he required runtime name (and optional version) that the Action code requires for an execution environment.<p><i>Note: May be optional if tooling allowed to make assumptions about file extensions.</i></p> |
+| inputs | no | list of [parameter](spec_parameters.md) | N/A | The optional ordered list inputs to the Action. |
+| outputs | no | list of [parameter](spec_parameters.md) | N/A | The optional outputs from the Action. |
+| limits | no | map of [limit keys and values](#valid-limit-keys) | N/A | Optional map of limit keys and their values.</br>See section "[Valid limit keys](#valid-limit-keys)" (below) for a listing of recognized keys and values. |
+| feed | no | boolen | false | Optional indicator that the Action supports the required parameters (and operations) to be run as a Feed Action. |
+| web \| web-export | no | boolean | yes \| no \| raw \| false | The optional flag (annotation) that makes the action accessible to REST calls without authentication.<p>For details on all types of Web Actions, see: [Web Actions](https://github.com/apache/incubator-openwhisk/blob/master/docs/webactions.md).</p>|
+| 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.<p><b>Note</b>: this option is ONLY valid if <em>"web"</em> or <em>"web-export"</em> is set to <em>‘true’</em>.<p> |
+| 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.<p><b>Note</b>: this option is ONLY valid if <em>"web"</em> or <em>"web-export"</em> is set to <em>‘true’</em>.<p> |
+| web-custom-options | no | boolean | false | The optional flag (annotation) enables a web action to respond to OPTIONS requests with customized headers, otherwise a [default CORS response](https://github.com/apache/openwhisk/blob/master/docs/webactions.md#options-requests) applies. |
+| require-whisk-auth | no | boolean | false | The optional flag (annotation) protects the web action so that it is only accessible to an authenticated subject. |
+| main | no | string | N/A | The optional name of the function to be aliased as a function named “main”.<p><em><b>Note</b>: 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”.</em></p>|
+
+### Deprecated Fields
+
+The following fields are considered deprecated as of the current specification version.
Review comment:
@pritidesai corrected and also added new req. (and to .pptx that I will need to upload at the end of this conversion so they reflect each other).
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services