summaryrefslogtreecommitdiffstats
path: root/vendor/gipfl/openrpc/src/ServerVariable.php
blob: 047dcf65e581c2c15106595963f02df8593c211f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<?php

namespace gipfl\OpenRpc;

use JsonSerializable;

/**
 * An object representing a Server Variable for server URL template substitution.
 */
class ServerVariable implements JsonSerializable
{
    use SimpleJsonSerializer;

    /**
     * REQUIRED. The default value to use for substitution, which SHALL be sent
     * if an alternate value is not supplied. Note this behavior is different
     * than the Schema Object’s treatment of default values, because in those
     * cases parameter values are optional.
     *
     * @var string
     */
    public $default;

    /**
     * An optional description for the server variable. GitHub Flavored Markdown
     * syntax MAY be used for rich text representation.
     *
     * @var string|null
     */
    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
     */
    public function __construct($default)
    {
        $this->default = $default;
    }
}