Documentation

Tag
in package
implements OpenApiAttributeInterface

The attribute may be applied at class or method level, or in {@see \OpenApi\Attributes\Operation::$tags} to define tags for the single operation (when applied at method level) or for all operations of a class (when applied at class level).

It can also be used in OpenAPIDefinition::$tags to define spec level tags. When applied at method or class level, if only a name is provided, the tag will be added to operation only; if additional fields are also defined, like description or externalDocs, the Tag will also be added to openAPI.tags field

Interfaces, Classes, Traits and Enums

OpenApiAttributeInterface

Table of Contents

$description  : string
$extensions  : array<string|int, mixed>
$externalDocs  : ExternalDocumentation|null
$name  : string
__construct()  : void

Properties

$description

public string $description = ""

$extensions

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

$name

public string $name

Methods

__construct()

public __construct(string $name[, string $description = "" ][, ExternalDocumentation|null $externalDocs = null ][, array<string|int, Extension> $extensions = [] ]) : void
Parameters
$name : string

The name of this tag.

$description : string = ""

A short description for this tag.

$externalDocs : ExternalDocumentation|null = null

Additional external documentation for this tag.

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

The list of optional extensions.

Return values
void —

Search results