erasys\OpenApi\Spec\v3\ServerVariable

Complexity

Total Complexity

1

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1

<?php

namespace erasys\OpenApi\Spec\v3;

/**
 * An object representing a Server Variable for server URL template substitution.
 *
 * @see https://swagger.io/specification/#serverVariableObject
 */
class ServerVariable extends AbstractObject implements ExtensibleInterface
{
    /**
     * REQUIRED. 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;

    /**
     * An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
     *
     * @var string
     */
    public $description;

    /**
     * An enumeration of string values to be used if the substitution options are from a limited set.
     *
     * @var string[]
     */
    public $enum;

    /**
     * @param string   $default
     * @param string   $description
     * @param string[] $enum
     * @param array    $additionalProperties
     */
    public function __construct(
        string $default,
        string $description = null,
        array $enum = null,
        array $additionalProperties = []
    ) {
        parent::__construct($additionalProperties);
        $this->default     = $default;
        $this->description = $description;
        $this->enum        = $enum;
    }
}