Documentation

Link
in package
implements OpenApiAttributeInterface

The attribute may be applied in {@see \OpenApi\Attributes\Responses\ApiResponse::$links} to add OpenAPI links to a response.

Interfaces, Classes, Traits and Enums

OpenApiAttributeInterface

Table of Contents

$description  : string
$extensions  : array<string|int, mixed>
$name  : string
$operationId  : string
$operationRef  : string
$parameters  : array<string|int, mixed>
$ref  : string
$requestBody  : string
$server  : Server|null
__construct()  : mixed

Properties

$description

public string $description = ""

$extensions

public array<string|int, mixed> $extensions = []

$name

public string $name = ""

$operationId

public string $operationId = ""

$operationRef

public string $operationRef = ""

$parameters

public array<string|int, mixed> $parameters = []

$ref

public string $ref = ""

$requestBody

public string $requestBody = ""

Methods

__construct()

public __construct([string $name = "" ][, string $operationRef = "" ][, string $operationId = "" ][, array<string|int, LinkParameter> $parameters = [] ][, string $description = "" ][, string $requestBody = "" ][, Server|null $server = null ][, array<string|int, Extension> $extensions = [] ][, string $ref = "" ]) : mixed
Parameters
$name : string = ""

The name of this link.

$operationRef : string = ""

A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and must point to an Operation Object. Relative operationRef values may be used to locate an existing Operation Object in the OpenAPI definition. Ignored if the operationId property is specified.

$operationId : string = ""

The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.

$parameters : array<string|int, LinkParameter> = []

Array of parameters to pass to an operation as specified with operationId or identified via operationRef.

$description : string = ""

A description of the link. CommonMark syntax may be used for rich text representation.

$requestBody : string = ""

A literal value or {expression} to use as a request body when calling the target operation.

$server : Server|null = null

An alternative server to service this operation.

$extensions : array<string|int, Extension> = []

The list of optional extensions.

$ref : string = ""

A reference to a link defined in components links.

Return values
mixed —

Search results