coupon-admin/vendor/zircote/swagger-php/src/Annotations/ServerVariable.php

76 lines
1.7 KiB
PHP

<?php declare(strict_types=1);
/**
* @license Apache 2.0
*/
namespace OpenApi\Annotations;
use OpenApi\Generator;
/**
* @Annotation
* A Server Variable Object https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#server-variable-object
* An object representing a Server Variable for server URL template substitution.
*/
class ServerVariable extends AbstractAnnotation
{
/**
* The key into Server->variables array.
*
* @var string
*/
public $serverVariable = Generator::UNDEFINED;
/**
* An enumeration of string values to be used if the substitution options are from a limited set.
*
* @var string[]
*/
public $enum = Generator::UNDEFINED;
/**
* The default value to use for substitution, and to send, if an alternate value is not supplied.
* Unlike the Schema Object's default, this value must be provided by the consumer.
*
* @var string
*/
public $default = Generator::UNDEFINED;
/**
* A map between a variable name and its value.
* The value is used for substitution in the server's URL template.
*
* @var array
*/
public $variables = Generator::UNDEFINED;
/**
* An optional description for the server variable.
* CommonMark syntax MAY be used for rich text representation.
*
* @var string
*/
public $description = Generator::UNDEFINED;
/**
* @inheritdoc
*/
public static $_parents = [
Server::class,
];
/**
* @inheritdoc
*/
public static $_required = ['default'];
/**
* @inheritdoc
*/
public static $_types = [
'default' => 'string',
'description' => 'string',
];
}