csantanapr closed pull request #2873: Add documentation for save action feature
URL: https://github.com/apache/incubator-openwhisk/pull/2873
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/actions.md b/docs/actions.md
index a1d161e137..6073ca66fe 100644
--- a/docs/actions.md
+++ b/docs/actions.md
@@ -277,7 +277,9 @@ Rather than pass all the parameters to an action every 
time, you can bind certai
 An action can be invoked through the REST interface via an HTTPS request. To 
get an action URL, execute the following command:
 
 ```
-$ wsk action get actionName --url
+wsk action get actionName --url
+```
+```
 ok: got action actionName
 https://${APIHOST}/api/v1/namespaces/${NAMESPACE}/actions/actionName
 ```
@@ -286,6 +288,26 @@ 
https://${APIHOST}/api/v1/namespaces/${NAMESPACE}/actions/actionName
 action invocations using the REST interface, see
 [Using REST APIs with OpenWhisk](rest_api.md#actions).
 
+### Saving action code
+
+Code associated with an existing action is fetched and saved locally. Saving 
is performed on all actions except sequences and docker actions. When saving 
action code to a file, the code is saved in the current working directory, and 
the saved file path is displayed.
+
+1. Save action code to a filename that corresponds with an existing action 
name. A file extension that corresponds to the action kind is  used, or an 
extension of `.zip` will be used for action code that is a zip file.
+  ```
+  wsk action get actionName --save
+  ```
+  ```
+  ok: saved action code to /absolutePath/currentDirectory/actionName.js
+  ```
+
+2. Instead of allowing the CLI to determine the filename and extension  of the 
saved code, a custom filename and extension can be provided by using the 
`--save-as` flag.
+  ```
+  wsk action get actionName --save-as codeFile.js
+  ```
+  ```
+  ok: saved action code to /absolutePath/currentDirectory/codeFile.js
+  ```
+
 ### Creating asynchronous actions
 
 JavaScript functions that run asynchronously may need to return the activation 
result after the `main` function has returned. You can accomplish this by 
returning a Promise in your action.


 

----------------------------------------------------------------
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:
[email protected]


With regards,
Apache Git Services

Reply via email to