Skip to content

Commit bfa990d

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

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
@@ -1092,7 +1092,7 @@ Here is an example function definition for REST requests with method `GET` and r
10921092
}
10931093
```
10941094

1095-
Note that the [Function Definition](#Function-Definition)'s `operation` property must follow the OpenAPI Paths Object specification definition.
1095+
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.
10961096

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

@@ -1123,6 +1123,7 @@ Example of the `POST` request sending the state data as part of the body:
11231123
"functions":[
11241124
{
11251125
"name": "createUser",
1126+
"type": "rest",
11261127
"operation": {
11271128
"/users": {
11281129
"post": {
@@ -1149,16 +1150,15 @@ Example of the `POST` request sending the state data as part of the body:
11491150
}
11501151
}
11511152
}
1152-
},
1153-
"type": "rest"
1153+
}
11541154
}
11551155
]
11561156
}
11571157
```
11581158

1159-
Note that the `requestBody` content schema is described inline rather than a reference to an external document.
1159+
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.
11601160

1161-
You can reference the `createUser` function and filter the input data to invoke it, as shown in the example below:
1161+
You can reference the `createUser` function and filter the input data to invoke it. Given the workflow input data:
11621162

11631163
```json
11641164
{
@@ -1220,7 +1220,7 @@ In this case, only the contents of the `user` attribute will be passed to the fu
12201220
}
12211221
```
12221222

1223-
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.
1223+
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.
12241224

12251225
#### Using Functions for Async API Service Invocations
12261226

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

34173417
The `name` property defines an unique name of the function definition.
34183418

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

34213421
Depending on the function `type`, the `operation` property can be:
34223422

0 commit comments

Comments
 (0)