-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathParameters.php
More file actions
63 lines (60 loc) · 10.1 KB
/
Copy pathParameters.php
File metadata and controls
63 lines (60 loc) · 10.1 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
<?php
namespace Bmlt\SemanticOpenApi\Swagger;
use OpenApi\Attributes as OA;
#[OA\Parameter(parameter: 'MeetingIds', name: 'meeting_ids', in: 'query', description: 'Comma-separated meeting IDs. Positive values include, negative values exclude (e.g. `123,456,-789`).', schema: new OA\Schema(type: 'string'))]
#[OA\Parameter(parameter: 'MeetingIdsArray', name: 'meeting_ids[]', in: 'query', description: 'Repeatable form of `meeting_ids`. Positive includes, negative excludes.', style: 'form', explode: true, schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'integer')))]
#[OA\Parameter(parameter: 'Weekdays', name: 'weekdays', in: 'query', description: 'Days of week as comma-separated values. 1=Sunday … 7=Saturday. Negative values exclude.', schema: new OA\Schema(type: 'string', example: '2,3,4'))]
#[OA\Parameter(parameter: 'WeekdaysArray', name: 'weekdays[]', in: 'query', description: 'Repeatable form of `weekdays`. 1=Sunday … 7=Saturday. Negative values exclude.', style: 'form', explode: true, schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'integer', minimum: -7, maximum: 7)))]
#[OA\Parameter(parameter: 'VenueTypes', name: 'venue_types', in: 'query', description: 'Venue type filter, comma-separated. 1=In-person, 2=Virtual, 3=Hybrid. Negative values exclude.', schema: new OA\Schema(type: 'string'))]
#[OA\Parameter(parameter: 'VenueTypesArray', name: 'venue_types[]', in: 'query', description: 'Repeatable form of `venue_types`. Negative values exclude.', style: 'form', explode: true, schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'integer', enum: [-3, -2, -1, 1, 2, 3])))]
#[OA\Parameter(parameter: 'Formats', name: 'formats', in: 'query', description: 'Format IDs as comma-separated values. Positive includes, negative excludes.', schema: new OA\Schema(type: 'string'))]
#[OA\Parameter(parameter: 'FormatsArray', name: 'formats[]', in: 'query', description: 'Repeatable form of `formats`. Positive includes, negative excludes.', style: 'form', explode: true, schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'integer')))]
#[OA\Parameter(parameter: 'FormatsComparisonOperator', name: 'formats_comparison_operator', in: 'query', description: 'Logical operator for combining multiple `formats` values. Defaults to AND.', schema: new OA\Schema(type: 'string', enum: ['AND', 'OR'], default: 'AND'))]
#[OA\Parameter(parameter: 'Services', name: 'services', in: 'query', description: 'Service body IDs as comma-separated values. Positive includes, negative excludes.', schema: new OA\Schema(type: 'string'))]
#[OA\Parameter(parameter: 'ServicesArray', name: 'services[]', in: 'query', description: 'Repeatable form of `services`. Positive includes, negative excludes.', style: 'form', explode: true, schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'integer')))]
#[OA\Parameter(parameter: 'Recursive', name: 'recursive', in: 'query', description: 'Set to `1` to include child service bodies when filtering by `services`.', schema: new OA\Schema(type: 'string', enum: ['0', '1']))]
#[OA\Parameter(parameter: 'GetUsedFormats', name: 'get_used_formats', in: 'query', description: 'Set to `1` to also return the formats used by the matched meetings (alters response shape).', schema: new OA\Schema(type: 'string', enum: ['0', '1']))]
#[OA\Parameter(parameter: 'GetFormatsOnly', name: 'get_formats_only', in: 'query', description: 'Set to `1` to return only the formats and omit the meetings (requires `get_used_formats=1`).', schema: new OA\Schema(type: 'string', enum: ['0', '1']))]
#[OA\Parameter(parameter: 'SearchString', name: 'SearchString', in: 'query', description: 'Free-text search string. URL-encode the value.', schema: new OA\Schema(type: 'string'))]
#[OA\Parameter(parameter: 'StringSearchIsAnAddress', name: 'StringSearchIsAnAddress', in: 'query', description: 'Set to `1` to interpret `SearchString` as an address to geocode. Requires a Google API key on the server.', schema: new OA\Schema(type: 'string', enum: ['0', '1']))]
#[OA\Parameter(parameter: 'SearchStringRadius', name: 'SearchStringRadius', in: 'query', description: 'Radius for address searches. Positive = distance (miles or km depending on server). Negative integer = auto-radius.', schema: new OA\Schema(type: 'number'))]
#[OA\Parameter(parameter: 'StartsAfterH', name: 'StartsAfterH', in: 'query', description: 'Earliest start hour (0–23).', schema: new OA\Schema(type: 'integer', minimum: 0, maximum: 23))]
#[OA\Parameter(parameter: 'StartsAfterM', name: 'StartsAfterM', in: 'query', description: 'Earliest start minute (0–59).', schema: new OA\Schema(type: 'integer', minimum: 0, maximum: 59))]
#[OA\Parameter(parameter: 'StartsBeforeH', name: 'StartsBeforeH', in: 'query', description: 'Latest start hour (0–23).', schema: new OA\Schema(type: 'integer', minimum: 0, maximum: 23))]
#[OA\Parameter(parameter: 'StartsBeforeM', name: 'StartsBeforeM', in: 'query', description: 'Latest start minute (0–59).', schema: new OA\Schema(type: 'integer', minimum: 0, maximum: 59))]
#[OA\Parameter(parameter: 'EndsBeforeH', name: 'EndsBeforeH', in: 'query', description: 'Latest end hour (0–23).', schema: new OA\Schema(type: 'integer', minimum: 0, maximum: 23))]
#[OA\Parameter(parameter: 'EndsBeforeM', name: 'EndsBeforeM', in: 'query', description: 'Latest end minute (0–59).', schema: new OA\Schema(type: 'integer', minimum: 0, maximum: 59))]
#[OA\Parameter(parameter: 'MinDurationH', name: 'MinDurationH', in: 'query', description: 'Minimum duration, hours portion.', schema: new OA\Schema(type: 'integer', minimum: 0))]
#[OA\Parameter(parameter: 'MinDurationM', name: 'MinDurationM', in: 'query', description: 'Minimum duration, minutes portion (0–59).', schema: new OA\Schema(type: 'integer', minimum: 0, maximum: 59))]
#[OA\Parameter(parameter: 'MaxDurationH', name: 'MaxDurationH', in: 'query', description: 'Maximum duration, hours portion.', schema: new OA\Schema(type: 'integer', minimum: 0))]
#[OA\Parameter(parameter: 'MaxDurationM', name: 'MaxDurationM', in: 'query', description: 'Maximum duration, minutes portion (0–59).', schema: new OA\Schema(type: 'integer', minimum: 0, maximum: 59))]
#[OA\Parameter(parameter: 'LatVal', name: 'lat_val', in: 'query', description: 'Latitude for geographic search.', schema: new OA\Schema(type: 'number', format: 'float', minimum: -90, maximum: 90))]
#[OA\Parameter(parameter: 'LongVal', name: 'long_val', in: 'query', description: 'Longitude for geographic search.', schema: new OA\Schema(type: 'number', format: 'float', minimum: -180, maximum: 180))]
#[OA\Parameter(parameter: 'GeoWidth', name: 'geo_width', in: 'query', description: 'Search radius in miles. Negative integer = auto-radius.', schema: new OA\Schema(type: 'number'))]
#[OA\Parameter(parameter: 'GeoWidthKm', name: 'geo_width_km', in: 'query', description: 'Search radius in kilometers. Negative integer = auto-radius.', schema: new OA\Schema(type: 'number'))]
#[OA\Parameter(parameter: 'SortResultsByDistance', name: 'sort_results_by_distance', in: 'query', description: 'Set to `1` to sort results by distance from `lat_val`/`long_val`.', schema: new OA\Schema(type: 'string', enum: ['0', '1']))]
#[OA\Parameter(parameter: 'MeetingKeyFilter', name: 'meeting_key', in: 'query', description: 'Field key to filter on (used with `meeting_key_value`).', schema: new OA\Schema(type: 'string'))]
#[OA\Parameter(parameter: 'MeetingKeyValue', name: 'meeting_key_value', in: 'query', description: 'Value to match against the field named by `meeting_key`.', schema: new OA\Schema(type: 'string'))]
#[OA\Parameter(parameter: 'DataFieldKey', name: 'data_field_key', in: 'query', description: 'Comma-separated list of fields to include in each returned meeting (whitelist).', schema: new OA\Schema(type: 'string', example: 'id_bigint,meeting_name,weekday_tinyint,start_time'))]
#[OA\Parameter(parameter: 'SortKeys', name: 'sort_keys', in: 'query', description: 'Comma-separated list of fields to sort by.', schema: new OA\Schema(type: 'string'))]
#[OA\Parameter(parameter: 'SortKey', name: 'sort_key', in: 'query', description: 'Predefined sort alias.', schema: new OA\Schema(type: 'string', enum: ['weekday', 'time', 'town', 'state', 'weekday_state']))]
#[OA\Parameter(parameter: 'PageSize', name: 'page_size', in: 'query', description: 'Number of results per page.', schema: new OA\Schema(type: 'integer', minimum: 1))]
#[OA\Parameter(parameter: 'PageNum', name: 'page_num', in: 'query', description: 'Page number, 1-based. Only meaningful when `page_size` is set.', schema: new OA\Schema(type: 'integer', minimum: 1, default: 1))]
#[OA\Parameter(parameter: 'AdvancedPublished', name: 'advanced_published', in: 'query', description: 'Published-status filter. Omit to return only published meetings. `0` returns both. `-1` returns only unpublished (requires authentication).', schema: new OA\Schema(type: 'integer', enum: [-1, 0]))]
#[OA\Parameter(parameter: 'LangEnum', name: 'lang_enum', in: 'query', description: 'Language code for translated format names (en, de, fr, es, it, pl, pt, sv, dk, fa).', schema: new OA\Schema(type: 'string'))]
#[OA\Parameter(parameter: 'ShowAll', name: 'show_all', in: 'query', description: 'Set to `1` to include all formats (including ones not currently used by any meeting).', schema: new OA\Schema(type: 'string', enum: ['0', '1']))]
#[OA\Parameter(parameter: 'RootServerIds', name: 'root_server_ids', in: 'query', description: 'Aggregator mode only. Comma-separated root server IDs. Positive includes, negative excludes.', schema: new OA\Schema(type: 'string'))]
#[OA\Parameter(parameter: 'RootServerIdsArray', name: 'root_server_ids[]', in: 'query', description: 'Aggregator mode only. Repeatable form of `root_server_ids`. Positive includes, negative excludes.', style: 'form', explode: true, schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'integer')))]
#[OA\Response(
response: 'BadRequest',
description: 'Bad request — usually a missing required parameter.',
content: new OA\JsonContent(ref: '#/components/schemas/Error')
)]
#[OA\Response(
response: 'ServerError',
description: 'Internal server error — for example, a geocoding failure when `StringSearchIsAnAddress=1`.',
content: new OA\JsonContent(ref: '#/components/schemas/Error')
)]
class Parameters extends Controller
{
}