-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSchemas.php
More file actions
140 lines (137 loc) · 7.98 KB
/
Copy pathSchemas.php
File metadata and controls
140 lines (137 loc) · 7.98 KB
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?php
namespace Bmlt\SemanticOpenApi\Swagger;
use OpenApi\Attributes as OA;
#[OA\Schema(
schema: 'Meeting',
type: 'object',
description: "A meeting record. The actual field set depends on the server's enabled fields and the `data_field_key` parameter.",
additionalProperties: true,
properties: [
new OA\Property(property: 'id_bigint', type: 'string', description: 'Numeric meeting ID, returned as a string.'),
new OA\Property(property: 'worldid_mixed', type: 'string', description: 'NAWS world committee code.'),
new OA\Property(property: 'shared_group_id_bigint', type: 'string'),
new OA\Property(property: 'service_body_bigint', type: 'string'),
new OA\Property(property: 'weekday_tinyint', type: 'string', description: '1=Sunday … 7=Saturday.'),
new OA\Property(property: 'venue_type', type: 'string', description: '1=In-person, 2=Virtual, 3=Hybrid.'),
new OA\Property(property: 'start_time', type: 'string', description: 'Local start time, HH:MM:SS.'),
new OA\Property(property: 'duration_time', type: 'string', description: 'Duration, HH:MM:SS.'),
new OA\Property(property: 'time_zone', type: 'string'),
new OA\Property(property: 'formats', type: 'string', description: 'Comma-separated format key strings.'),
new OA\Property(property: 'lang_enum', type: 'string'),
new OA\Property(property: 'longitude', type: 'string'),
new OA\Property(property: 'latitude', type: 'string'),
new OA\Property(property: 'distance_in_km', type: 'string', description: 'Present only when sorting by distance.'),
new OA\Property(property: 'distance_in_miles', type: 'string', description: 'Present only when sorting by distance.'),
new OA\Property(property: 'meeting_name', type: 'string'),
new OA\Property(property: 'location_text', type: 'string'),
new OA\Property(property: 'location_info', type: 'string'),
new OA\Property(property: 'location_street', type: 'string'),
new OA\Property(property: 'location_city_subsection', type: 'string'),
new OA\Property(property: 'location_neighborhood', type: 'string'),
new OA\Property(property: 'location_municipality', type: 'string'),
new OA\Property(property: 'location_sub_province', type: 'string'),
new OA\Property(property: 'location_province', type: 'string'),
new OA\Property(property: 'location_postal_code_1', type: 'string'),
new OA\Property(property: 'location_nation', type: 'string'),
new OA\Property(property: 'comments', type: 'string'),
new OA\Property(property: 'train_lines', type: 'string'),
new OA\Property(property: 'bus_lines', type: 'string'),
new OA\Property(property: 'phone_meeting_number', type: 'string'),
new OA\Property(property: 'virtual_meeting_link', type: 'string'),
new OA\Property(property: 'virtual_meeting_additional_info', type: 'string'),
new OA\Property(property: 'contact_name_1', type: 'string'),
new OA\Property(property: 'contact_phone_1', type: 'string'),
new OA\Property(property: 'contact_email_1', type: 'string'),
new OA\Property(property: 'root_server_id', type: 'string', description: 'Aggregator mode only — ID of the root server this meeting came from.'),
new OA\Property(property: 'root_server_uri', type: 'string'),
new OA\Property(property: 'format_shared_id_list', type: 'string'),
]
)]
#[OA\Schema(
schema: 'Format',
type: 'object',
additionalProperties: true,
properties: [
new OA\Property(property: 'key_string', type: 'string'),
new OA\Property(property: 'name_string', type: 'string'),
new OA\Property(property: 'description_string', type: 'string'),
new OA\Property(property: 'lang', type: 'string'),
new OA\Property(property: 'id', type: 'string'),
new OA\Property(property: 'world_id', type: 'string'),
new OA\Property(property: 'root_server_id', type: 'string', description: 'Aggregator mode only.'),
new OA\Property(property: 'root_server_uri', type: 'string', description: 'Aggregator mode only.'),
new OA\Property(property: 'format_type_enum', type: 'string'),
]
)]
#[OA\Schema(
schema: 'ServiceBody',
type: 'object',
additionalProperties: true,
properties: [
new OA\Property(property: 'id', type: 'string'),
new OA\Property(property: 'parent_id', type: 'string'),
new OA\Property(property: 'name', type: 'string'),
new OA\Property(property: 'description', type: 'string'),
new OA\Property(property: 'type', type: 'string'),
new OA\Property(property: 'url', type: 'string'),
new OA\Property(property: 'helpline', type: 'string'),
new OA\Property(property: 'world_id', type: 'string'),
new OA\Property(property: 'root_server_id', type: 'string', description: 'Aggregator mode only.'),
new OA\Property(property: 'root_server_uri', type: 'string', description: 'Aggregator mode only.'),
]
)]
#[OA\Schema(
schema: 'MeetingChange',
type: 'object',
additionalProperties: true,
properties: [
new OA\Property(property: 'date_int', type: 'string', description: 'Unix timestamp of the change.'),
new OA\Property(property: 'date_string', type: 'string'),
new OA\Property(property: 'change_type', type: 'string', description: 'e.g. comdef_change_type_change, comdef_change_type_new, comdef_change_type_delete.'),
new OA\Property(property: 'meeting_id', type: 'string'),
new OA\Property(property: 'meeting_name', type: 'string'),
new OA\Property(property: 'user_id', type: 'string'),
new OA\Property(property: 'user_name', type: 'string'),
new OA\Property(property: 'service_body_id', type: 'string'),
new OA\Property(property: 'service_body_name', type: 'string'),
new OA\Property(property: 'details', type: 'object', additionalProperties: true, description: 'Per-field before/after values for change events.'),
]
)]
#[OA\Schema(
schema: 'ServerInfo',
type: 'object',
additionalProperties: true,
properties: [
new OA\Property(property: 'version', type: 'string'),
new OA\Property(property: 'versionInt', type: 'string'),
new OA\Property(property: 'langs', type: 'string', description: 'Comma-separated language codes.'),
new OA\Property(property: 'nativeLang', type: 'string'),
new OA\Property(property: 'centerLongitude', type: 'string'),
new OA\Property(property: 'centerLatitude', type: 'string'),
new OA\Property(property: 'centerZoom', type: 'string'),
new OA\Property(property: 'defaultDuration', type: 'string'),
new OA\Property(property: 'regionBias', type: 'string'),
new OA\Property(property: 'charSet', type: 'string'),
new OA\Property(property: 'distanceUnits', type: 'string', enum: ['mi', 'km']),
new OA\Property(property: 'semanticAdmin', type: 'string'),
new OA\Property(property: 'emailEnabled', type: 'string'),
new OA\Property(property: 'emailIncludesServiceBodies', type: 'string'),
new OA\Property(property: 'changesPerMeeting', type: 'string'),
new OA\Property(property: 'meeting_states_and_provinces', type: 'string'),
new OA\Property(property: 'meeting_counties_and_sub_provinces', type: 'string'),
new OA\Property(property: 'available_keys', type: 'string', description: 'Comma-separated list of field keys exposed by this server.'),
new OA\Property(property: 'google_api_key', type: 'string'),
new OA\Property(property: 'aggregator_mode_enabled', oneOf: [new OA\Schema(type: 'string'), new OA\Schema(type: 'boolean')], description: '1 / true if this server is running in aggregator mode.'),
]
)]
#[OA\Schema(
schema: 'Error',
type: 'object',
additionalProperties: true,
properties: [
new OA\Property(property: 'error', type: 'string', description: 'Human-readable error message.'),
]
)]
class Schemas extends Controller
{
}