summaryrefslogtreecommitdiffstats
path: root/vendor/gipfl/openrpc/src/ExamplePairing.php
blob: 6f341373f80bb85caf962e348d38a0abe583d945 (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
<?php

namespace gipfl\OpenRpc;

use JsonSerializable;

/**
 * The example Pairing object consists of a set of example params and result.
 * The result is what you can expect from the JSON-RPC service given the exact
 * params.
 */
class ExamplePairing implements JsonSerializable
{
    use SimpleJsonSerializer;

    /** @var string|null Name for the example pairing */
    public $name;

    /** @var string|null A verbose explanation of the example pairing */
    public $summary;

    /** @var string|null Short description for the example pairing */
    public $description;

    /** @var <Example|Reference>[] Example parameters */
    public $params;

    /** @var Example|Reference Example result */
    public $result;
}