rest-api/src/PhpListRestBundle.php at 1bd7755039e3e8513ba46be160d964eee401d0e4 · phpList/rest-api · GitHub

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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<?php

declare(strict_types=1);

namespace PhpList\RestBundle;

use Symfony\Component\HttpKernel\Bundle\Bundle;
use OpenApi\Attributes as OA;

/**
 * This bundle provides the REST API for phpList.
 *
 * @author Oliver Klee <oliver@phplist.com>
 * @author Tatevik Grigoryan <tatevik@phplist.com>
 */
#[OA\Info(
    version: '1.0.0',
    description: 'This is the OpenAPI documentation for phpList API.',
    title: 'phpList API Documentation',
    contact: new OA\Contact(
        email: 'tatevik@phplist.com'
    ),
    license: new OA\License(
        name: 'AGPL-3.0-or-later',
        url: 'https://www.gnu.org/licenses/agpl.txt'
    )
)]
#[OA\Server(
    url: 'https://www.phplist.com/api/v2',
    description: 'Production server'
)]
#[OA\Schema(
    schema: 'DetailedDomainStats',
    properties: [
        new OA\Property(
            property: 'domains',
            type: 'array',
            items: new OA\Items(
                properties: [
                    new OA\Property(property: 'domain', type: 'string'),
                    new OA\Property(
                        property: 'confirmed',
                        properties: [
                            new OA\Property(property: 'count', type: 'integer'),
                            new OA\Property(property: 'percentage', type: 'number', format: 'float'),
                        ],
                        type: 'object'
                    ),
                    new OA\Property(
                        property: 'unconfirmed',
                        properties: [
                            new OA\Property(property: 'count', type: 'integer'),
                            new OA\Property(property: 'percentage', type: 'number', format: 'float'),
                        ],
                        type: 'object'
                    ),
                    new OA\Property(
                        property: 'blacklisted',
                        properties: [
                            new OA\Property(property: 'count', type: 'integer'),
                            new OA\Property(property: 'percentage', type: 'number', format: 'float'),
                        ],
                        type: 'object'
                    ),
                    new OA\Property(
                        property: 'total',
                        properties: [
                            new OA\Property(property: 'count', type: 'integer'),
                            new OA\Property(property: 'percentage', type: 'number', format: 'float'),
                        ],
                        type: 'object'
                    ),
                ],
                type: 'object'
            )
        ),
        new OA\Property(property: 'total', type: 'integer'),
    ],
    type: 'object',
    nullable: true
)]
class PhpListRestBundle extends Bundle
{
}