summaryrefslogtreecommitdiffstats
path: root/vendor/gipfl/openrpc/src/Info.php
blob: 3c957c9b8613cdc219f490436a40fcf6bd79748c (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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<?php

namespace gipfl\OpenRpc;

use JsonSerializable;

/**
 * The object provides metadata about the API. The metadata MAY be used by the
 * clients if needed, and MAY be presented in editing or documentation
 * generation tools for convenience.
 */
class Info implements JsonSerializable
{
    use SimpleJsonSerializer;

    /**
     * REQUIRED. The title of the application
     *
     * @var string
     */
    public $title;
    /**
     * A verbose description of the application. GitHub Flavored Markdown syntax
     * MAY be used for rich text representation.
     *
     * @var string|null
     */
    public $description;

    /**
     * A URL to the Terms of Service for the API. MUST be in the format of a URL
     *
     * @var string|null
     */
    public $termsOfService;

    /**
     * The contact information for the exposed API
     *
     * @var Contact|null
     */
    public $contact;

    /**
     * 	The license information for the exposed API
     *
     * @var License|null
     */
    public $license;

    /**
     * REQUIRED. The version of the OpenRPC document (which is distinct from the
     * OpenRPC Specification version or the API implementation version)
     *
     * @var string
     */
    public $version;

    /**
     * Info constructor.
     * @param string $title
     * @param string $version
     */
    public function __construct($title, $version)
    {
        $this->title = $title;
        $this->version = $version;
    }
}