summaryrefslogtreecommitdiffstats
path: root/vendor/gipfl/openrpc/src/Components.php
blob: 621a9a00c32546c7720266f21481262eb31d329d (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
<?php

namespace gipfl\OpenRpc;

use JsonSerializable;

/**
 * Holds a set of reusable objects for different aspects of the OpenRPC. All
 * objects defined within the components object will have no effect on the API
 * unless they are explicitly referenced from properties outside the components
 * object.
 *
 * All the fixed fields declared are objects that MUST use keys that match the
 * regular expression: ^[a-zA-Z0-9\.\-_]+$
 */
class Components implements JsonSerializable
{
    use SimpleJsonSerializer;

    /**
     * An object to hold reusable Content Descriptor Objects
     *
     * @var ContentDescriptor[] Map[string, Content Descriptor Object]
     */
    public $contentDescriptors;

    /**
     * An object to hold reusable Schema Objects
     *
     * @var SchemaObject[] Map[string, Schema Object]
     */
    public $schemas;

    /**
     * An object to hold reusable Example Objects
     *
     * @var Example[] Map[string, Example Object]
     */
    public $examples;

    /**
     * An object to hold reusable Link Objects
     *
     * @var Link[] Map[string, Link Object]
     */
    public $links;

    /**
     * An object to hold reusable Error Objects
     *
     * @var Error[] Map[string, Error Object]
     */
    public $errors;

    /**
     * An object to hold reusable Example Pairing Objects
     *
     * @var ExamplePairing[] Map[string, Example Pairing Object]
     */
    public $examplePairingObjects;

    /**
     * An object to hold reusable Tag Objects
     *
     * @var TagObject[] Map[string, Tag Object]
     */
    public $tags;
}