Add document for support array result #5311

ningyougang · 2022-08-17T08:35:05Z

Description

Add document for support array result, corresponding same document has been added to openwhisk-runtime-$image repos
Fix test case for swift

Related issue and scope

I opened an issue to propose and discuss this change (#????)

My changes affect the following components

Types of changes

Bug fix (generally a non-breaking change which closes an issue).
Enhancement or new feature (adds new functionality).
Breaking change (a bug fix or enhancement which changes existing behavior).

Checklist:

I signed an Apache CLA.
I reviewed the style guides and followed the recommendations (Travis CI will check :).
I added tests to cover my changes.
My changes require further changes to the documentation.
I updated the documentation where necessary.

ningyougang · 2022-08-17T08:39:23Z

tests/dat/actions/unicode.tests/swift-4.2.txt

-    if let str = args["delimiter"] as? String {
+func main(args: Any) -> Any {
+    let dict = args as! [String:Any]
+    if let str = dict["delimiter"] as? String {


Found relative test cases failed in our downstream, so need to fix it in upstream firstly.

codecov-commenter · 2022-08-17T09:52:21Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.09%. Comparing base (9005a08) to head (4b7d7ea).
Report is 98 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (9005a08) and HEAD (4b7d7ea). Click for more details.

HEAD has 15 uploads less than BASE

Flag BASE (9005a08) HEAD (4b7d7ea)

20 5

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5311      +/-   ##
==========================================
- Coverage   81.12%   76.09%   -5.03%     
==========================================
  Files         239      239              
  Lines       14192    14192              
  Branches      580      580              
==========================================
- Hits        11513    10800     -713     
- Misses       2679     3392     +713

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ningyougang · 2022-08-18T01:34:20Z

docs/actions-docker.md

+And support array result for sequence action as well, the first action's array result can be used as next action's input parameter
+```
+#!/bin/bash
+echo $1


This is sequence action's second action. can accept the array as input parameter, and we can do some sort operation here,
But here, i just return it directly(don't add sort operation), just a example.

But there seems to be a bad point here, due to shell, it implies that any type of parameter can be received, but my example's exact meaning is, it here just can accept array type.

for some strong type language, e.g. java, we can know the input/out data type from main signature

style95 · 2022-08-18T01:32:06Z

docs/actions-docker.md

@@ -236,6 +236,18 @@ DATE=`date`
 echo "{ \"message\": \"Hello $NAME! It is $DATE.\" }"
 ```

+For the return result, not only support `dictionary` but also support `array`


Suggested change

For the return result, not only support `dictionary` but also support `array`

Action support not only `dictionary` but also `array` as a return value.

Updated accordingly

style95 · 2022-08-18T01:33:45Z

docs/actions-docker.md

+echo '["a", "b"]''
+```
+
+And support array result for sequence action as well, the first action's array result can be used as next action's input parameter


Suggested change

And support array result for sequence action as well, the first action's array result can be used as next action's input parameter

You can also create a sequence action with actions returning an array result.

You can easily figure out the parameters with the following example.

Updated accordingly

style95 · 2022-08-18T01:34:18Z

docs/actions-dotnet.md

@@ -79,6 +79,47 @@ cd out
 zip -r -0 helloDotNet.zip *
 ```

+For the return result, not only support `dictionary` but also support `array`


Suggested change

For the return result, not only support `dictionary` but also support `array`

Action support not only a JSON object but also a JSON array as a return value.

Updated accordingly

style95 · 2022-08-18T01:35:50Z

docs/actions-dotnet.md

@@ -79,6 +79,47 @@ cd out
 zip -r -0 helloDotNet.zip *
 ```

+For the return result, not only support `dictionary` but also support `array`
+
+So a very simple `hello array` function would be:


Suggested change

So a very simple `hello array` function would be:

It would be a simple example that uses an array as a return value.

Updated accordingly

style95 · 2022-08-18T01:36:41Z

docs/actions-dotnet.md

+And support array result for sequence action as well, the first action's array result can be used as next action's input parameter.
+
+So the function can be:


Suggested change

And support array result for sequence action as well, the first action's array result can be used as next action's input parameter.

So the function can be:

You can also create a sequence action with actions returning an array result.

You can easily figure out the parameters with the following example.

Updated accordingly

style95 · 2022-08-18T01:44:06Z

docs/actions-php.md

+For the return result, not only support `dictionary` but also support `array`
+
+So a very simple `hello array` function would be:


Suggested change

For the return result, not only support `dictionary` but also support `array`

So a very simple `hello array` function would be:

Action support not only a JSON object but also a JSON array as a return value.

Updated accordingly

style95 · 2022-08-18T01:45:54Z

docs/actions-python.md

+For the return result, not only support `dictionary` but also support `array`

+So a very simple `hello array` function would be:


Suggested change

For the return result, not only support `dictionary` but also support `array`

So a very simple `hello array` function would be:

Action support not only a JSON object but also a JSON array as a return value.

Updated accordingly

style95 · 2022-08-18T01:46:30Z

docs/actions-ruby.md

+For the return result, not only support `dictionary` but also support `array`
+
+So a very simple `hello array` function would be:


Suggested change

For the return result, not only support `dictionary` but also support `array`

So a very simple `hello array` function would be:

Action support not only a JSON object but also a JSON array as a return value.

Updated accordingly

style95 · 2022-08-18T01:46:39Z

docs/actions-rust.md

+For the return result, not only support `A JSON serde Value` but also support `Array serde Value`
+
+So a simple `hello array` funtion would be:


Suggested change

For the return result, not only support `A JSON serde Value` but also support `Array serde Value`

So a simple `hello array` funtion would be:

Action support not only a JSON object but also a JSON array as a return value.

Updated accordingly

style95 · 2022-08-18T01:47:07Z

docs/actions-swift.md

+For the return result, not only support `dictionary`, but also support `array`
+
+So a very simple `hello array` function woule be:


Suggested change

For the return result, not only support `dictionary`, but also support `array`

So a very simple `hello array` function woule be:

Action support not only a JSON object but also a JSON array as a return value.

Updated accordingly

* Fix test case failed for swift * Add document based on support array result feature * Apply review comments

ningyougang added 2 commits August 17, 2022 16:08

Fix test case failed for swift

ea9867f

Add document based on support array result feature

26eca14

ningyougang commented Aug 17, 2022

View reviewed changes

ningyougang commented Aug 18, 2022

View reviewed changes

jiangpengcheng approved these changes Aug 18, 2022

View reviewed changes

style95 reviewed Aug 18, 2022

View reviewed changes

Apply review comments

4b7d7ea

ningyougang force-pushed the add-document-for-support-array-result branch from a7eda48 to 4b7d7ea Compare August 18, 2022 03:47

ningyougang merged commit 7de8bad into apache:master Aug 18, 2022

msciabarra pushed a commit to nuvolaris/openwhisk that referenced this pull request Nov 23, 2022

Add document for support array result (apache#5311)

e8a2b7c

* Fix test case failed for swift * Add document based on support array result feature * Apply review comments

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add document for support array result #5311

Add document for support array result #5311

ningyougang commented Aug 17, 2022 •

edited

Loading

ningyougang Aug 17, 2022

codecov-commenter commented Aug 17, 2022 •

edited

Loading

ningyougang Aug 18, 2022

ningyougang Aug 18, 2022 •

edited

Loading

style95 Aug 18, 2022

ningyougang Aug 18, 2022

style95 Aug 18, 2022

ningyougang Aug 18, 2022

style95 Aug 18, 2022

ningyougang Aug 18, 2022

style95 Aug 18, 2022

ningyougang Aug 18, 2022

style95 Aug 18, 2022

ningyougang Aug 18, 2022

style95 Aug 18, 2022

ningyougang Aug 18, 2022

style95 Aug 18, 2022

ningyougang Aug 18, 2022

style95 Aug 18, 2022

ningyougang Aug 18, 2022

style95 Aug 18, 2022

ningyougang Aug 18, 2022

style95 Aug 18, 2022

ningyougang Aug 18, 2022

	For the return result, not only support `dictionary` but also support `array`
	Action support not only `dictionary` but also `array` as a return value.

	And support array result for sequence action as well, the first action's array result can be used as next action's input parameter
	You can also create a sequence action with actions returning an array result.
	You can easily figure out the parameters with the following example.

	For the return result, not only support `dictionary` but also support `array`
	Action support not only a JSON object but also a JSON array as a return value.

	So a very simple `hello array` function would be:
	It would be a simple example that uses an array as a return value.

		And support array result for sequence action as well, the first action's array result can be used as next action's input parameter.

		So the function can be:

		For the return result, not only support `A JSON serde Value` but also support `Array serde Value`

		So a simple `hello array` funtion would be:

Add document for support array result #5311

Add document for support array result #5311

Conversation

ningyougang commented Aug 17, 2022 • edited Loading

Description

Related issue and scope

My changes affect the following components

Types of changes

Checklist:

Choose a reason for hiding this comment

codecov-commenter commented Aug 17, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

ningyougang Aug 18, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ningyougang commented Aug 17, 2022 •

edited

Loading

codecov-commenter commented Aug 17, 2022 •

edited

Loading

ningyougang Aug 18, 2022 •

edited

Loading