@golemio/pid 2.23.2 → 2.23.3-dev.1527535265

package/docs/openapi-output.yaml

@@ -32,7 +32,7 @@ tags:
       description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" />
 
     - name: 🚏 PID Departure Boards (v3)
-      description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" />
+      description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> <img src="https://img.shields.io/badge/stability-experimental-orange" alt="golemioapi-stability-badge" />
 
     - name: 🗓️ Public GTFS Static Lookup (v2)
       description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> <img src="https://img.shields.io/badge/stability-experimental-orange" alt="golemioapi-stability-badge" />
@@ -1100,6 +1100,157 @@ paths:
                 "404":
                     description: Not found
 
+    /v3/pid/transferboards:
+        get:
+            tags:
+              - 🚏 PID Departure Boards (v3)
+            summary: GET Transfer Boards
+            description: |
+                ⚠️ Note: This endpoint is experimental and may be subject to change.
+                Tested and optimized for train transfers only (as in transfering from a train to other all kinds of transport).
+            parameters:
+                - name: cisId
+                  in: query
+                  description: CIS identifier of the stop. A list of CIS IDs can be found in [Prague Open data](https://opendata.praha.eu/datasets/https%3A%2F%2Fapi.opendata.praha.eu%2Flod%2Fcatalog%2F6ac8381f-ea19-4ea9-8949-92076809dc5a).
+                  required: true
+                  schema:
+                    type: number
+                    example: 5454956 # Praha-Uhříněves
+                - name: tripNumber
+                  in: query
+                  description: Trip number of the vehicle in which the transfer is planned. Use to filter out transfers for a specific trip. Represents the numeric part of the GTFS `trip_short_name` (Os 2547 -> 2547).
+                  required: true
+                  schema:
+                    type: number
+                    example: 2547
+                - name: timeFrom
+                  in: query
+                  description: Set initial timestamp for time interval given by `minutesBefore` (hardcoded to 0) and `minutesAfter` (hardcoded to 60). Use to simulate query time different from now. Use ISO 8601 time format and URL encoded symbols - `%3A` for `:`, `%2B` for `.`, `%2F` for `+`. Time zone is set to `Europe/Prague`. Applicable range is -6 hours +2 days from now.
+                  required: false
+                  schema:
+                      type: string
+                      example: "2024-11-04T16:51:00"
+            responses:
+                "200":
+                    description: List of all active transfer boards
+                    headers:
+                        Cache-Control:
+                            description: Cache control directive for caching proxies
+                            schema:
+                                type: string
+                                example: public, s-maxage=5, stale-while-revalidate=5
+                    content:
+                        application/json:
+                            schema:
+                                type: object
+                                required:
+                                  - departures
+                                  - infotexts
+                                properties:
+                                    departures:
+                                        type: array
+                                        items:
+                                            type: object
+                                            required:
+                                              - departure_timestamp
+                                              - route
+                                              - stop
+                                              - trip
+                                            properties:
+                                                departure_timestamp:
+                                                    type: object
+                                                    required:
+                                                      - minutes
+                                                    properties:
+                                                        minutes:
+                                                            type: string
+                                                            example: "<1"
+                                                            nullable: true
+                                                route:
+                                                    type: object
+                                                    required:
+                                                      - short_name
+                                                      - type
+                                                    properties:
+                                                        short_name:
+                                                            type: string
+                                                            example: "S9"
+                                                            nullable: true
+                                                        type:
+                                                            type: number
+                                                            example: 2
+                                                            nullable: true
+                                                stop:
+                                                    type: object
+                                                    required:
+                                                      - platform_code
+                                                    properties:
+                                                        platform_code:
+                                                            type: string
+                                                            example: "2/3"
+                                                            nullable: true
+                                                trip:
+                                                    type: object
+                                                    required:
+                                                      - headsign
+                                                      - id
+                                                    properties:
+                                                        headsign: 
+                                                            type: string
+                                                            example: "Benešov u Prahy"
+                                                            nullable: false
+                                                        id:
+                                                            type: string
+                                                            example: "1309_2547_231210"
+                                                            nullable: false
+                                    infotexts:
+                                        type: array
+                                        items:
+                                            type: object
+                                            required:
+                                              - text
+                                              - text_en
+                                              - display_type
+                                            properties:
+                                                text:
+                                                    type: string
+                                                    example: "Nehoda na trase, odklon linek mimo tuto stanici."
+                                                    nullable: false
+                                                text_en:
+                                                    type: string
+                                                    example: "Trips are cancelled due to accident on route."
+                                                    nullable: true
+                                                display_type:
+                                                    type: string
+                                                    example: "inline"
+                                                    enum:
+                                                      - "inline"
+                                                      - "general"
+                                                    nullable: false
+                                    
+                "401":
+                    $ref: "#/components/responses/UnauthorizedError"
+                "404":
+                    description: Not found - no valid GTFS stop found for the given CIS ID
+                    content:
+                      application/json:
+                        schema:
+                            type: object
+                            required:
+                              - departures
+                              - infotexts
+                            properties:
+                                departures:
+                                    type: array
+                                    example: []
+                                    items:
+                                        type: object
+                                infotexts:
+                                    type: array
+                                    example: []
+                                    items:
+                                        type: object
+
     /v3/pid/infotexts:
         get:
             summary: GET Infotexts (export from the VYMI (JIS) Infotexts system)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/pid",
-    "version": "2.23.2",
+    "version": "2.23.3-dev.1527535265",
     "description": "Golemio PID Module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -76,7 +76,7 @@
         "@golemio/core": ">=1.14.1-rc.1470811358"
     },
     "dependencies": {
-        "@golemio/ovapi-gtfs-realtime-bindings": "1.2.3",
+        "@golemio/ovapi-gtfs-realtime-bindings": "1.2.4-dev.1288219308",
         "@turf/turf": "^6.5.0",
         "cheap-ruler": "^3.0.2",
         "csv-parser": "^3.0.0",
@@ -84,4 +84,4 @@
         "html-entities": "^2.3.3",
         "pg-copy-streams": "^5.1.1"
     }
-}
+}