%PDF- %PDF-
Direktori : /var/www/html/shaban/duassis/api/vendor/zircote/swagger-php/src/Annotations/ |
Current File : //var/www/html/shaban/duassis/api/vendor/zircote/swagger-php/src/Annotations/Header.php |
<?php declare(strict_types=1); /** * @license Apache 2.0 */ namespace OpenApi\Annotations; /** * @Annotation * * A "Header Object" https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#headerObject */ class Header extends AbstractAnnotation { /** * $ref See https://swagger.io/docs/specification/using-ref/ * * @var string */ public $ref = UNDEFINED; /** * @var string */ public $header = UNDEFINED; /** * @var string */ public $description = UNDEFINED; /** * A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. * * @var bool */ public $required = UNDEFINED; /** * Schema object * * @var \OpenApi\Annotations\Schema */ public $schema = UNDEFINED; /** * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. * * @var bool */ public $deprecated = UNDEFINED; /** * Sets the ability to pass empty-valued parameters. * This is valid only for query parameters and allows sending a parameter with an empty value. * Default value is false. If style is used, and if behavior is n/a * (cannot be serialized), the value of allowEmptyValue SHALL be ignored. * * @var bool */ public $allowEmptyValue = UNDEFINED; /** * @inheritdoc */ public static $_required = ['header', 'schema']; /** * @inheritdoc */ public static $_types = [ 'header' => 'string', 'description' => 'string', ]; /** * @inheritdoc */ public static $_nested = [ Schema::class => 'schema' ]; /** * @inheritdoc */ public static $_parents = [ Components::class, Response::class ]; }