@golemio/pid 6.3.1-dev.3031287563 → 6.3.1-dev.3047078710

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/docs/openapi-output.yaml +178 -19
  2. package/package.json +1 -1
package/docs/openapi-output.yaml CHANGED
@@ -2269,9 +2269,21 @@ paths:
2269
2269
  schema:
2270
2270
  $ref: "#/components/schemas/PublicDepartureBoardsResponse"
2271
2271
  400:
2272
- $ref: "#/components/responses/BadRequestError"
2272
+ description: Bad request - invalid query parameters
2273
+ content:
2274
+ application/json:
2275
+ schema:
2276
+ $ref: "#/components/schemas/BadRequestErrorObject"
2273
2277
  401:
2274
- $ref: "#/components/responses/UnauthorizedError"
2278
+ description: API key is missing or invalid
2279
+ headers:
2280
+ WWW_Authenticate:
2281
+ schema:
2282
+ type: string
2283
+ content:
2284
+ application/json:
2285
+ schema:
2286
+ $ref: "#/components/schemas/UnauthorizedErrorObject"
2275
2287
  404:
2276
2288
  description: Not found - no stops found for the given query parameters
2277
2289
  content:
@@ -2354,7 +2366,23 @@ components:
2354
2366
  content:
2355
2367
  application/json:
2356
2368
  schema:
2357
- $ref: "#/components/schemas/BadRequestErrorObject"
2369
+ type: object
2370
+ properties:
2371
+ error_message:
2372
+ type: string
2373
+ example: "Bad request"
2374
+ nullable: false
2375
+ error_status:
2376
+ type: integer
2377
+ example: 400
2378
+ nullable: false
2379
+ error_info:
2380
+ type: string
2381
+ example: "{...}"
2382
+ nullable: true
2383
+ required:
2384
+ - error_message
2385
+ - error_status
2358
2386
 
2359
2387
  UnauthorizedError:
2360
2388
  description: API key is missing or invalid
@@ -2365,7 +2393,19 @@ components:
2365
2393
  content:
2366
2394
  application/json:
2367
2395
  schema:
2368
- $ref: "#/components/schemas/UnauthorizedErrorObject"
2396
+ type: object
2397
+ properties:
2398
+ error_message:
2399
+ type: string
2400
+ example: "Unauthorized. Failed to authenticate user."
2401
+ nullable: false
2402
+ error_status:
2403
+ type: integer
2404
+ example: 401
2405
+ nullable: false
2406
+ required:
2407
+ - error_message
2408
+ - error_status
2369
2409
 
2370
2410
 
2371
2411
  parameters:
@@ -4240,24 +4280,19 @@ components:
4240
4280
  - stop_ids
4241
4281
  - departures
4242
4282
 
4243
- PublicDepartureGroup:
4244
- type: array
4245
- items:
4246
- $ref: "#/components/schemas/PublicDepartureItem"
4247
-
4248
4283
  PublicDepartureItem:
4249
4284
  type: object
4250
4285
  properties:
4251
4286
  departure:
4252
- $ref: "#/components/schemas/PublicDeparture"
4287
+ $ref: "#/components/schemas/PublicDepartureItemDeparture"
4253
4288
  stop:
4254
- $ref: "#/components/schemas/PublicDepartureStop"
4289
+ $ref: "#/components/schemas/PublicDepartureItemStop"
4255
4290
  route:
4256
- $ref: "#/components/schemas/PublicDepartureRoute"
4291
+ $ref: "#/components/schemas/PublicDepartureItemRoute"
4257
4292
  trip:
4258
- $ref: "#/components/schemas/PublicDepartureTrip"
4293
+ $ref: "#/components/schemas/PublicDepartureItemTrip"
4259
4294
  vehicle:
4260
- $ref: "#/components/schemas/PublicDepartureVehicle"
4295
+ $ref: "#/components/schemas/PublicDepartureItemVehicle"
4261
4296
  required:
4262
4297
  - departure
4263
4298
  - stop
@@ -4265,7 +4300,7 @@ components:
4265
4300
  - trip
4266
4301
  - vehicle
4267
4302
 
4268
- PublicDeparture:
4303
+ PublicDepartureItemDeparture:
4269
4304
  type: object
4270
4305
  properties:
4271
4306
  timestamp_scheduled:
@@ -4294,7 +4329,7 @@ components:
4294
4329
  - delay_seconds
4295
4330
  - minutes
4296
4331
 
4297
- PublicDepartureStop:
4332
+ PublicDepartureItemStop:
4298
4333
  type: object
4299
4334
  properties:
4300
4335
  id:
@@ -4314,7 +4349,7 @@ components:
4314
4349
  - sequence
4315
4350
  - platform_code
4316
4351
 
4317
- PublicDepartureRoute:
4352
+ PublicDepartureItemRoute:
4318
4353
  type: object
4319
4354
  properties:
4320
4355
  type:
@@ -4330,7 +4365,7 @@ components:
4330
4365
  - type
4331
4366
  - short_name
4332
4367
 
4333
- PublicDepartureTrip:
4368
+ PublicDepartureItemTrip:
4334
4369
  type: object
4335
4370
  properties:
4336
4371
  id:
@@ -4350,7 +4385,7 @@ components:
4350
4385
  - headsign
4351
4386
  - is_canceled
4352
4387
 
4353
- PublicDepartureVehicle:
4388
+ PublicDepartureItemVehicle:
4354
4389
  type: object
4355
4390
  properties:
4356
4391
  id:
@@ -4375,6 +4410,130 @@ components:
4375
4410
  - is_air_conditioned
4376
4411
  - has_charger
4377
4412
 
4413
+ PublicDepartureGroup:
4414
+ type: array
4415
+ items:
4416
+ type: object
4417
+ properties:
4418
+ departure:
4419
+ $ref: "#/components/schemas/PublicDeparture"
4420
+ stop:
4421
+ $ref: "#/components/schemas/PublicDepartureStop"
4422
+ route:
4423
+ $ref: "#/components/schemas/PublicDepartureRoute"
4424
+ trip:
4425
+ $ref: "#/components/schemas/PublicDepartureTrip"
4426
+ vehicle:
4427
+ $ref: "#/components/schemas/PublicDepartureVehicle"
4428
+ required:
4429
+ - departure
4430
+ - stop
4431
+ - route
4432
+ - trip
4433
+ - vehicle
4434
+
4435
+ PublicDeparture:
4436
+ type: object
4437
+ properties:
4438
+ timestamp_scheduled:
4439
+ type: string
4440
+ format: date-time
4441
+ example: "2024-04-05T16:09:00+02:00"
4442
+ nullable: false
4443
+ timestamp_predicted:
4444
+ type: string
4445
+ format: date-time
4446
+ example: "2024-04-05T16:09:16+02:00"
4447
+ nullable: false
4448
+ delay_seconds:
4449
+ type: number
4450
+ description: Delay in seconds
4451
+ example: 0
4452
+ nullable: true
4453
+ minutes:
4454
+ type: number
4455
+ description: Minutes until the departure
4456
+ example: 0
4457
+ nullable: false
4458
+ required:
4459
+ - timestamp_scheduled
4460
+ - timestamp_predicted
4461
+ - minutes
4462
+
4463
+ PublicDepartureStop:
4464
+ type: object
4465
+ properties:
4466
+ id:
4467
+ type: string
4468
+ example: "U717Z5P" # Strossmayerovo náměstí
4469
+ nullable: false
4470
+ sequence:
4471
+ type: number
4472
+ example: 8
4473
+ nullable: false
4474
+ platform_code:
4475
+ type: string
4476
+ example: "E"
4477
+ nullable: true
4478
+ required:
4479
+ - id
4480
+ - sequence
4481
+
4482
+ PublicDepartureRoute:
4483
+ type: object
4484
+ properties:
4485
+ type:
4486
+ type: string
4487
+ example: "tram"
4488
+ enum: ["tram", "metro", "train", "bus", "ferry", "funicular", "trolleybus", "ext_miscellaneous"]
4489
+ nullable: false
4490
+ short_name:
4491
+ type: string
4492
+ example: "27"
4493
+ nullable: false
4494
+ required:
4495
+ - type
4496
+ - short_name
4497
+
4498
+ PublicDepartureTrip:
4499
+ type: object
4500
+ properties:
4501
+ id:
4502
+ type: string
4503
+ example: "27_3206_240318"
4504
+ nullable: false
4505
+ headsign:
4506
+ type: string
4507
+ example: "Libuš"
4508
+ nullable: false
4509
+ is_canceled:
4510
+ type: boolean
4511
+ example: false
4512
+ nullable: true
4513
+ required:
4514
+ - id
4515
+ - headsign
4516
+
4517
+ PublicDepartureVehicle:
4518
+ type: object
4519
+ properties:
4520
+ id:
4521
+ type: string
4522
+ example: "service-0-9072"
4523
+ nullable: true
4524
+ is_wheelchair_accessible:
4525
+ type: boolean
4526
+ example: true
4527
+ nullable: true
4528
+ is_air_conditioned:
4529
+ type: boolean
4530
+ example: false
4531
+ nullable: true
4532
+ has_charger:
4533
+ type: boolean
4534
+ example: true
4535
+ nullable: true
4536
+
4378
4537
  EventId:
4379
4538
  type: string
4380
4539
  format: uuid
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@golemio/pid",
3
- "version": "6.3.1-dev.3031287563",
3
+ "version": "6.3.1-dev.3047078710",
4
4
  "description": "Golemio PID Module",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",