Skip to content

Commit 85b970a

Browse files
committed
Incorporating Tiho's comment
Signed-off-by: Ricardo Zanini <[email protected]>
1 parent cf36d87 commit 85b970a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

specification.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1089,7 +1089,7 @@ Here is an example function definition for REST requests with method `GET` and r
10891089
}
10901090
```
10911091

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.
10931093

10941094
The function can be referenced during workflow execution when the invocation of the REST service is desired. For example:
10951095

@@ -1120,6 +1120,7 @@ Example of the `POST` request sending the state data as part of the body:
11201120
"functions":[
11211121
{
11221122
"name": "createUser",
1123+
"type": "rest",
11231124
"operation": {
11241125
"/users": {
11251126
"post": {
@@ -1146,16 +1147,15 @@ Example of the `POST` request sending the state data as part of the body:
11461147
}
11471148
}
11481149
}
1149-
},
1150-
"type": "rest"
1150+
}
11511151
}
11521152
]
11531153
}
11541154
```
11551155

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.
11571157

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:
11591159

11601160
```json
11611161
{
@@ -1217,7 +1217,7 @@ In this case, only the contents of the `user` attribute will be passed to the fu
12171217
}
12181218
```
12191219

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.
12211221

12221222
#### Using Functions for Async API Service Invocations
12231223

@@ -3402,7 +3402,7 @@ operation: https://hellworldservice.api.com/api.json#helloWorld
34023402

34033403
The `name` property defines an unique name of the function definition.
34043404

3405-
The `type` property defines the function type. Its value can be either `rest`, `openapi` or `expression`. Default value is `openapi`.
3405+
The `type` enum property defines the function type. Its value can be either `rest`, `openapi` or `expression`. Default value is `openapi`.
34063406

34073407
Depending on the function `type`, the `operation` property can be:
34083408

0 commit comments

Comments
 (0)