Info
in package
implements
OpenApiAttributeInterface
The attribute may be used in {@see OpenAPIDefinition::$info} to populate the Info section of the OpenAPI document.
Interfaces, Classes, Traits and Enums
Table of Contents
- $contact : Contact|null
- $description : string
- $extensions : array<string|int, mixed>
- $license : License|null
- $termsOfService : string
- $title : string
- $version : string
- __construct() : mixed
Properties
$contact
public
Contact|null
$contact
= null
$description
public
string
$description
= ""
$extensions
public
array<string|int, mixed>
$extensions
= []
$license
public
License|null
$license
= null
$termsOfService
public
string
$termsOfService
= ""
$title
public
string
$title
= ""
$version
public
string
$version
= ""
Methods
__construct()
public
__construct([string $title = "" ][, string $description = "" ][, string $termsOfService = "" ][, Contact|null $contact = null ][, License|null $license = null ][, string $version = "" ][, array<string|int, Extension> $extensions = [] ]) : mixed
Parameters
- $title : string = ""
-
The title of the application.
- $description : string = ""
-
A short description of the application. CommonMark syntax can be used for rich text representation.
- $termsOfService : string = ""
-
A URL to the Terms of Service for the API. Must be in the format of a URL.
- $contact : Contact|null = null
-
The contact information for the exposed API.
- $license : License|null = null
-
The license information for the exposed API.
- $version : string = ""
-
The version of the API definition.
- $extensions : array<string|int, Extension> = []
-
The list of optional extensions.