@golemio/pid 2.3.2-dev.660767513 → 2.3.2-dev.661128816

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 (4) hide show
  1. package/db/example/pb/alerts.pb +0 -0
  2. package/docs/openapi-output.yaml +64 -9
  3. package/package.json +1 -1
  4. package/docs/pid_docs_trains_proposal.pdf +0 -0
package/db/example/pb/alerts.pb CHANGED
Binary file
package/docs/openapi-output.yaml CHANGED
@@ -686,6 +686,25 @@ paths:
686
686
  "404":
687
687
  description: Not found
688
688
 
689
+ /vehiclepositions/gtfsrt/alerts.pb:
690
+ get:
691
+ summary: GET GTFS RealTime Alerts Protocol Buffer
692
+ description: ""
693
+ tags:
694
+ - 🗺 GTFS RealTime Vehicle Positions
695
+ responses:
696
+ "200":
697
+ description: successful operation
698
+ content:
699
+ application/octet-stream:
700
+ schema:
701
+ type: string
702
+ format: binary
703
+ "401":
704
+ $ref: "#/components/responses/UnauthorizedError"
705
+ "404":
706
+ description: Not found
707
+
689
708
  /pid/departureboards:
690
709
  get:
691
710
  summary: GET Departure Board
@@ -835,7 +854,7 @@ paths:
835
854
  - 🚏 PID Departure Boards
836
855
  responses:
837
856
  "200":
838
- description: Can return empty data in departures property (empty array []) if no departures were found
857
+ description: List of all active infotexts
839
858
  content:
840
859
  application/json:
841
860
  schema:
@@ -845,6 +864,25 @@ paths:
845
864
  - $ref: "#/components/schemas/PIDDepartureBoardInfotext"
846
865
  - type: object
847
866
  properties:
867
+ related_stops:
868
+ type: array
869
+ description: ""
870
+ items:
871
+ type: object
872
+ properties:
873
+ id:
874
+ type: string
875
+ example: "U118S1"
876
+ description: GTFS station IDs for which the infotexts apply.
877
+ name:
878
+ type: string
879
+ example: "Flora"
880
+ description: GTFS station name.
881
+ platform_code:
882
+ type: string
883
+ nullable: true
884
+ example: null
885
+ description: GTFS station platform code.
848
886
  related_routes:
849
887
  type: array
850
888
  description: ""
@@ -853,6 +891,14 @@ paths:
853
891
  example: "L152"
854
892
  description: ""
855
893
  example: ["L152", "L177"]
894
+ vymi_id:
895
+ type: number
896
+ description: ROPID VYMI event identifier.
897
+ example: 83
898
+ vymi_id_dtb:
899
+ type: number
900
+ description: ROPID VYMI database identifier.
901
+ example: 3
856
902
  expiration_date:
857
903
  type: string
858
904
  nullable: true
@@ -860,6 +906,10 @@ paths:
860
906
  last_updated:
861
907
  type: string
862
908
  example: "2021-01-07T12:48:06+01:00"
909
+ last_updated_user:
910
+ type: string
911
+ description: ROPID VYMI user.
912
+ example: "user"
863
913
  "401":
864
914
  $ref: "#/components/responses/UnauthorizedError"
865
915
  "404":
@@ -1471,7 +1521,18 @@ components:
1471
1521
  type: array
1472
1522
  description: List of active infotexts for selected stops.
1473
1523
  items:
1474
- $ref: "#/components/schemas/PIDDepartureBoardInfotext"
1524
+ allOf:
1525
+ - $ref: "#/components/schemas/PIDDepartureBoardInfotext"
1526
+ - type: object
1527
+ properties:
1528
+ related_stops:
1529
+ type: array
1530
+ description: ""
1531
+ items:
1532
+ type: string
1533
+ example: "U118S1"
1534
+ description: GTFS station IDs for which the infotexts apply.
1535
+
1475
1536
 
1476
1537
  PIDDepartureBoardDeparture:
1477
1538
  title: PID Departure Board Departure
@@ -1519,13 +1580,7 @@ components:
1519
1580
  type: string
1520
1581
  description: Type of display on board by the intended form of presentation (where applicable). Enumerating `inline` (to be presented along with departures, usually in a marquee), `general` (to be displayed full screen instead of departures), `general-alternate` (full screen alternates with departures).
1521
1582
  example: "inline"
1522
- related_stops:
1523
- type: array
1524
- description: Type of display on board by the intended form of presentation (where applicable). Enumerating `inline` (to be presented along with departures, usually in a marquee), `general` (to be displayed full screen instead of departures), `general-alternate` (full screen alternates with departures).
1525
- items:
1526
- type: string
1527
- example: "U118S1"
1528
- description: GTFS station IDs for which the infotexts apply.
1583
+
1529
1584
  required:
1530
1585
  - valid_from
1531
1586
  - valid_to
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@golemio/pid",
3
- "version": "2.3.2-dev.660767513",
3
+ "version": "2.3.2-dev.661128816",
4
4
  "description": "Golemio PID Module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/docs/pid_docs_trains_proposal.pdf DELETED
Binary file