rest-api/src/Common/SwaggerSchemasResponse.php at c678b302c358f997701de9e220ec2f031b85df5a · 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<?php

declare(strict_types=1);

namespace PhpList\RestBundle\Common;

use OpenApi\Attributes as OA;

#[OA\Schema(
    schema: 'ErrorDetails',
    type: 'object',
    example: [
        'format.formatOptions[0]' => ['The value you selected is not a valid choice.'],
        'schedule.repeatUntil' => ['This value is not a valid datetime.'],
        'schedule.requeueUntil' => ['This value is not a valid datetime.'],
    ],
    additionalProperties: new OA\AdditionalProperties(
        type: 'array',
        items: new OA\Items(type: 'string')
    )
)]
#[OA\Schema(
    schema: 'UnauthorizedResponse',
    required: ['message'],
    properties: [
        new OA\Property(
            property: 'message',
            type: 'string',
            example: 'No valid session key was provided as basic auth password.'
        )
    ],
    type: 'object'
)]
#[OA\Schema(
    schema: 'ValidationErrorResponse',
    required: ['message', 'errors'],
    properties: [
        new OA\Property(
            property: 'message',
            type: 'string',
            example: 'Validation failed'
        ),
        new OA\Property(
            property: 'errors',
            ref: '#/components/schemas/ErrorDetails'
        )
    ],
    type: 'object'
)]
#[OA\Schema(
    schema: 'BadRequestResponse',
    required: ['message'],
    properties: [
        new OA\Property(
            property: 'message',
            type: 'string',
            example: 'Invalid json format'
        )
    ],
    type: 'object'
)]
#[OA\Schema(
    schema: 'AlreadyExistsResponse',
    required: ['message'],
    properties: [
        new OA\Property(
            property: 'message',
            type: 'string',
            example: 'This resource already exists.'
        )
    ],
    type: 'object'
)]
#[OA\Schema(
    schema: 'NotFoundErrorResponse',
    required: ['message'],
    properties: [
        new OA\Property(
            property: 'message',
            type: 'string',
            example: 'There is no entity with that ID.'
        ),
    ],
    type: 'object'
)]
#[OA\Schema(
    schema: 'GenericErrorResponse',
    required: ['message'],
    properties: [
        new OA\Property(
            property: 'message',
            type: 'string',
            example: 'An unexpected error occurred.'
        )
    ],
    type: 'object'
)]
#[OA\Schema(
    schema: 'CursorPagination',
    properties: [
        new OA\Property(property: 'total', type: 'integer', example: 100),
        new OA\Property(property: 'limit', type: 'integer', example: 25),
        new OA\Property(property: 'has_more', type: 'boolean', example: true),
        new OA\Property(property: 'next_cursor', type: 'integer', example: 129)
    ],
    type: 'object'
)]
class SwaggerSchemasResponse
{
}