Callback
in package
implements
OpenApiAttributeInterface
The attribute may be used at method level to add one ore more callbacks to the operation definition.
Interfaces, Classes, Traits and Enums
Table of Contents
- $callbackUrlExpression : string
- $extensions : array<string|int, mixed>
- $name : string
- $operation : array<string|int, mixed>
- $ref : string
- __construct() : mixed
Properties
$callbackUrlExpression
public
string
$callbackUrlExpression
= ""
$extensions
public
array<string|int, mixed>
$extensions
= []
$name
public
string
$name
= ""
$operation
public
array<string|int, mixed>
$operation
= []
$ref
public
string
$ref
= ""
Methods
__construct()
public
__construct([string $name = "" ][, string $callbackUrlExpression = "" ][, array<string|int, Operation> $operation = [] ][, array<string|int, Extension> $extensions = [] ][, string $ref = "" ]) : mixed
Parameters
- $name : string = ""
-
The friendly name used to refer to this callback.
- $callbackUrlExpression : string = ""
-
An absolute URL which defines the destination which will be called with the supplied operation definition.
- $operation : array<string|int, Operation> = []
-
The array of operations that will be called out-of band.
- $extensions : array<string|int, Extension> = []
-
The list of optional extensions.
- $ref : string = ""
-
A reference to a Callback defined in components Callbacks.