You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specification.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1089,7 +1089,7 @@ Here is an example function definition for REST requests with method `GET` and r
1089
1089
}
1090
1090
```
1091
1091
1092
-
Note that the [Function Definition](#Function-Definition)'s `operation` property must follow the OpenAPI Paths Object specification definition.
1092
+
Note that the [Function Definition](#Function-Definition)'s `operation` property must follow the [OpenAPI Paths Object](https://spec.openapis.org/oas/v3.1.0#paths-object) specification definition.
1093
1093
1094
1094
The function can be referenced during workflow execution when the invocation of the REST service is desired. For example:
1095
1095
@@ -1120,6 +1120,7 @@ Example of the `POST` request sending the state data as part of the body:
1120
1120
"functions":[
1121
1121
{
1122
1122
"name": "createUser",
1123
+
"type": "rest",
1123
1124
"operation": {
1124
1125
"/users": {
1125
1126
"post": {
@@ -1146,16 +1147,15 @@ Example of the `POST` request sending the state data as part of the body:
1146
1147
}
1147
1148
}
1148
1149
}
1149
-
},
1150
-
"type": "rest"
1150
+
}
1151
1151
}
1152
1152
]
1153
1153
}
1154
1154
```
1155
1155
1156
-
Note that the `requestBody` content schema is described inline rather than a reference to an external document.
1156
+
Note that the `requestBody` [`content` attribute](https://spec.openapis.org/oas/v3.1.0#fixed-fields-10) is described inline rather than a reference to an external document.
1157
1157
1158
-
You can reference the `createUser` function and filter the input data to invoke it, as shown in the example below:
1158
+
You can reference the `createUser` function and filter the input data to invoke it. Given the workflow input data:
1159
1159
1160
1160
```json
1161
1161
{
@@ -1217,7 +1217,7 @@ In this case, only the contents of the `user` attribute will be passed to the fu
1217
1217
}
1218
1218
```
1219
1219
1220
-
The specification does not support the [Security Requirement Object](https://spec.openapis.org/oas/v3.1.0#security-requirement-object). To define authentication for the REST operation, use the [Auth Definition](#Auth-Definition). If provided, this field is ignored.
1220
+
The specification does not support the [Security Requirement Object](https://spec.openapis.org/oas/v3.1.0#security-requirement-object) since its redundat to function [Auth Definition](#Auth-Definition). If provided, this field is ignored.
1221
1221
1222
1222
#### Using Functions for Async API Service Invocations
0 commit comments