ExternalDocumentation
in package
implements
OpenApiAttributeInterface
The attribute may be used at method level or as field of {@see Operation} to add a reference to an external resource for extended documentation of an Operation (OpenAPI specification).
It may also be used to add external documentation to Tag, Header or Schema, or as field of OpenAPIDefinition.
Interfaces, Classes, Traits and Enums
Table of Contents
- $description : string
- $extensions : array<string|int, mixed>
- $url : string
- __construct() : mixed
Properties
$description
public
string
$description
= ""
$extensions
public
array<string|int, mixed>
$extensions
= []
$url
public
string
$url
= ""
Methods
__construct()
public
__construct([string $description = "" ][, string $url = "" ][, array<string|int, Extension> $extensions = [] ]) : mixed
Parameters
- $description : string = ""
-
A short description of the target documentation.
- $url : string = ""
-
The URL for the target documentation. Value must be in the format of a URL.
- $extensions : array<string|int, Extension> = []
-
The list of optional extensions.