Syntax
operationSettings:
'$ref': <string>
flow:
- <flow>
method: <string>
path: <string>
status: <int>
tag: <string>
operationSettings:
'$ref': <string>
flow:
- <flow>
method: <string>
path: <string>
status: <int>
tag: <string>
Attributes
| Name | Required | Default | Description | Examples |
|---|---|---|---|---|
| $ref | false | - | Reference a component defined under components. | - |
| method | false | - | HTTP method exposed for this operation. Defaults to POST. GET and DELETE have no request body: the input message fields named in the path template become path parameters, and the remaining fields become query parameters. A field that carries more than a single value, such as a nested structure or a repeating element, cannot be passed this way and is rejected at startup — expose such an operation as POST. An XSD attribute is addressed by its plain name, without the @ the JSON request body uses for it. | GET |
| path | false | - | URL path segment for this operation. | budget-structures |
| status | false | 200 | HTTP status code a successful response carries, published in the OpenAPI document alongside it. Defaults to 200, or to 204 for an operation the WSDL declares without an output message: there is no response message to put into a body, so such an operation is answered without one whatever status is configured for it. A configured status always wins over the derived default. Does not apply to SOAP faults or conversion errors, which stay 500. | 201 |
| tag | false | - | OpenAPI tag assigned to this operation. Groups the operation under the given tag in API documentation. | Partner |
Child Structure
| Element | Cardinality | Description |
|---|---|---|
| flow | 0..* | Interceptors applied to this operation. On the request side they run before JSON-to-SOAP conversion and before the SOAP backend call, so plugins like apiKey or rateLimiter can reject early. On the response side they run after SOAP-to-JSON conversion on the final JSON body, and for an operation with no output message on the empty response. A plugin that gives such a response a body is not stopped from doing so: what the response carries stays the operator's decision. |