Remove misleading web-export key (#1092)

* Remove misleading web-export key * Support the top-level web-export field. * Revert changes on test data to keep the sanity check for the top-level web-export field.
apache · Apr 30, 2020 · 5073943 · 5073943
1 parent 9e02625
commit 5073943
Show file tree

Hide file tree

Showing 21 changed files with 109 additions and 56 deletions.
diff --git a/docs/examples/manifest_hello_world_apigateway.yaml b/docs/examples/manifest_hello_world_apigateway.yaml
@@ -23,7 +23,8 @@ packages:
     actions:
       hello_world:
         function: src/hello.js
-        web-export: true
+        annotations:
+          web-export: true
     apis:
       hello-world:
         hello:

diff --git a/docs/examples/manifest_hello_world_apigateway_http.yaml b/docs/examples/manifest_hello_world_apigateway_http.yaml
@@ -23,10 +23,12 @@ packages:
     actions:
       hello_world:
         function: src/hello_http.js
-        web-export: true
+        annotations:
+          web-export: true
       hello_world_promise:
         function: src/hello_http_promise.js
-        web-export: true
+        annotations:
+          web-export: true
     apis:
       hello-world:
         hello:

diff --git a/docs/examples/manifest_hello_world_apigateway_open_api_spec.yaml b/docs/examples/manifest_hello_world_apigateway_open_api_spec.yaml
@@ -25,4 +25,5 @@ project:
       actions:
         hello_world:
           function: src/hello.js
+        annotations:
           web-export: true
diff --git a/docs/export.md b/docs/export.md
@@ -191,13 +191,13 @@ packages:
         namespace: your_namespace/lib1_package
         credential: ""
         exposedUrl: ""
-        web-export: ""
         main: ""
         limits: null
         inputs: {}
         outputs: {}
         annotations:
           exec: nodejs:default
+          web-export: ""
       lib1_greeting2:
         name: lib1_greeting2
         location: ""
@@ -208,13 +208,13 @@ packages:
         namespace: your_namespace/lib1_package
         credential: ""
         exposedUrl: ""
-        web-export: ""
         main: ""
         limits: null
         inputs: {}
         outputs: {}
         annotations:
           exec: nodejs:default
+          web-export: ""
       lib1_greeting3:
         name: lib1_greeting3
         location: ""

diff --git a/docs/wskdeploy_apigateway_helloworld.md b/docs/wskdeploy_apigateway_helloworld.md
@@ -37,7 +37,8 @@ packages:
     actions:
       hello_world:
         function: src/hello.js
-        web-export: true
+        annotations:
+          web-export: true
     apis:
       hello-world:
         hello:
@@ -47,7 +48,7 @@ packages:
 ```
 
 There are two key changes to this file:
-- the `hello_world` action now has the `web-export` flag set to `true`.
+- the `hello_world` action now has the `web-export` annotation set to `true`.
 - a new `apis` block has been created.
 
 The `apis` block contains a number of groups of API endpoint. Each endpoint is then defined by the hierarchy. In this case, we are creating the `hello/world` endpoint. The leaf in the structure specifies the action to trigger when the given HTTP verb is sent to that endpoint, in this case, when the HTTP verb `GET` is used on the `hello/world` endpoint, trigger the `hello_world` action.

diff --git a/docs/wskdeploy_apigateway_open_api_spec.md b/docs/wskdeploy_apigateway_open_api_spec.md
@@ -39,6 +39,7 @@ project:
       actions:
         hello_world:
           function: src/hello.js
+        annotations:
           web-export: true
 ```
 ### Open API Specification

diff --git a/parsers/yamlparser.go b/parsers/yamlparser.go
@@ -109,7 +109,7 @@ type Action struct {
 	Main        string                 `yaml:"main"`
 	Docker      string                 `yaml:"docker,omitempty"`
 	Native      bool                   `yaml:"native,omitempty"`
-	Conductor   bool               	   `yaml:"conductor,omitempty"`
+	Conductor   bool                   `yaml:"conductor,omitempty"`
 	Limits      *Limits                `yaml:"limits"`
 	Inputs      map[string]Parameter   `yaml:"inputs"`
 	Outputs     map[string]Parameter   `yaml:"outputs"`

diff --git a/specification/html/spec_actions.md b/specification/html/spec_actions.md
@@ -42,7 +42,7 @@ The Action entity schema contains the necessary information to deploy an OpenWhi
 | 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 | boolean | false | Optional indicator that the Action supports the required parameters (and operations) to be run as a Feed Action. |
-| web&nbsp;&#124; web-export | no | string | true&nbsp;&#124; false&nbsp;&#124; yes&nbsp;&#124; no&nbsp;&#124; raw | The optional flag 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/openwhisk/blob/master/docs/webactions.md).</p>|
+| web | no | string | true&nbsp;&#124; false&nbsp;&#124; yes&nbsp;&#124; no&nbsp;&#124; raw | The optional flag 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/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). |
@@ -78,7 +78,7 @@ The following annotations have special meanings for Actions:
 - When the `code` key-value is specified, the `runtime` **SHALL** be a required field.
 
 #### Annotation requirements
-- The annotation `require-whisk-auth` **SHALL** only be valid for web actions (i.e., if the `web` or `web-export` key (or `web-export` annotation) is set to `true`).
+- The annotation `require-whisk-auth` **SHALL** only be valid for web actions (i.e., if the `web` key or `web-export` annotation is set to `true`).
 - If the value of the `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`.
 - When the `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`.
 

diff --git a/specification/html/spec_apis.md b/specification/html/spec_apis.md
@@ -79,7 +79,8 @@ packages:
     actions:
       hello_world:
         function: src/hello.js
-        web-export: true
+        annotations:
+          web-export: true
     apis:
       hello-world:
         hello:

diff --git a/tests/dat/manifest_data_compose_actions_for_invalid_web.yaml b/tests/dat/manifest_data_compose_actions_for_invalid_web.yaml
@@ -20,4 +20,5 @@ packages:
     actions:
       hello:
         function: ../tests/src/integration/helloworld/actions/hello.js
-        web-export: raw123
+        annotations:
+          web-export: raw123
diff --git a/tests/dat/manifest_data_compose_actions_for_web.yaml b/tests/dat/manifest_data_compose_actions_for_web.yaml
@@ -33,3 +33,4 @@ packages:
       hello5:
         function: ../src/integration/helloworld/actions/hello.js
         web-export: no
+
diff --git a/tests/dat/manifest_data_compose_actions_for_web_and_web_export.yaml b/tests/dat/manifest_data_compose_actions_for_web_and_web_export.yaml
@@ -22,19 +22,23 @@ packages:
         function: ../src/integration/helloworld/actions/hello.js
         runtime: nodejs
         web: true
-        web-export: true
+        annotations:
+          web-export: true
       hello2:
         function: ../src/integration/helloworld/actions/hello.js
         runtime: nodejs
         web: true
-        web-export: false
+        annotations:
+          web-export: false
       hello3:
         function: ../src/integration/helloworld/actions/hello.js
         runtime: nodejs
         web: false
-        web-export: true
+        annotations:
+          web-export: true
       hello4:
         function: ../src/integration/helloworld/actions/hello.js
         runtime: nodejs
         web: raw
-        web-export: true
+        annotations:
+          web-export: true
diff --git a/tests/dat/manifest_data_compose_api_records.yaml b/tests/dat/manifest_data_compose_api_records.yaml
@@ -20,7 +20,8 @@ packages:
         actions:
             putBooks:
                 function: ../tests/src/integration/helloworld/actions/hello.js
-                web-export: true
+                annotations:
+                    web-export: true
             deleteBooks:
                 function: ../tests/src/integration/helloworld/actions/hello.js
             listMembers:

diff --git a/tests/src/integration/apigateway/manifest.yml b/tests/src/integration/apigateway/manifest.yml
@@ -21,7 +21,8 @@ packages:
         license: Apache-2.0
         actions:
             greeting:
-                web-export: true
+                annotations:
+                    web-export: true
                 version: 1.0
                 function: src/greeting.js
                 runtime: nodejs:default

diff --git a/tests/src/integration/defaultpackage/manifest-with-project.yaml b/tests/src/integration/defaultpackage/manifest-with-project.yaml
@@ -23,7 +23,8 @@ project:
                 helloInDefaultPackage:
                     function: actions/hello.js
                     runtime: nodejs:default
-                    web-export: true
+                    annotations:
+                        web-export: true
                     inputs:
                         name:
                             type: string
@@ -82,7 +83,8 @@ project:
                 greetingInsidePackage:
                     function: actions/hello.js
                     runtime: nodejs:default
-                    web-export: true
+                    annotations:
+                        web-export: true
                     inputs:
                         name:
                             type: string

diff --git a/tests/src/integration/defaultpackage/manifest.yaml b/tests/src/integration/defaultpackage/manifest.yaml
@@ -21,7 +21,8 @@ packages:
             helloInDefaultPackage:
                 function: actions/hello.js
                 runtime: nodejs:default
-                web-export: true
+                annotations:
+                    web-export: true
                 inputs:
                     name:
                         type: string
@@ -80,7 +81,8 @@ packages:
             greetingInsidePackage:
                 function: actions/hello.js
                 runtime: nodejs:default
-                web-export: true
+                annotations:
+                    web-export: true
                 inputs:
                     name:
                         type: string

diff --git a/tests/src/integration/export/manifest_apiexp.yaml b/tests/src/integration/export/manifest_apiexp.yaml
@@ -21,7 +21,8 @@ packages:
         license: Apache-2.0
         actions:
             greeting:
-                web-export: true
+                annotations:
+                    web-export: true
                 version: 1.0
                 function: src/greeting.js
                 runtime: nodejs:default

diff --git a/tests/src/integration/flagstests/manifest.yaml b/tests/src/integration/flagstests/manifest.yaml
@@ -21,7 +21,8 @@ packages:
       license: Apache-2.0
       actions:
         greeting:
-          web-export: true
+          annotations:
+            web-export: true
           version: 1.0
           function: src/greeting.js
           runtime: nodejs:default

diff --git a/tests/src/integration/flagstests/manifest.yml b/tests/src/integration/flagstests/manifest.yml
@@ -21,7 +21,8 @@ packages:
       license: Apache-2.0
       actions:
         greeting:
-          web-export: true
+          annotations:
+            web-export: true
           version: 1.0
           function: src/greeting.js
           runtime: nodejs:default