@golemio/pid 6.4.1-dev.3053867815 → 6.4.1-dev.3054859807

package/docs/openapi-output.yaml

@@ -2346,6 +2346,63 @@ paths:
                     $ref: "#/components/responses/BadRequestError"
                 401:
                     $ref: "#/components/responses/UnauthorizedError"
+    /v1/jis/delayed-segments:
+        get:
+            tags:
+                - ⚠ JIS (v1) - internal
+            summary: Get all currently detected delayed segments
+            description: |
+                Returns segments of the network with a significant delay, detected by Mapa PID and enriched with GTFS data:
+                stops of the segment, affected routes and nearby stops with info panels. Refreshed every 5 minutes.
+
+                A segment is a directed corridor of stops. Its `id` is derived from its endpoints; as segments may grow or shrink
+                between refreshes, consumers should match segments by their stops rather than by `id`.
+
+                If fetching the segments fails, the last known segments are kept and their `last_detected_at` stops advancing,
+                so consumers should judge freshness by `last_detected_at`. This does not cover the detection itself stalling:
+                the source provides no time of its calculation, so a stalled detection keeps being fetched and
+                `last_detected_at` keeps advancing.
+
+                Only segments with a delay of at least 5 minutes and info panel stops at most 5 stops from the segment are
+                detected; the query parameters can only narrow them down further.
+            parameters:
+                - name: minDelaySeconds
+                  in: query
+                  required: false
+                  schema:
+                    type: integer
+                    minimum: 0
+                    example: 600
+                  description: Minimum `expected_delay_seconds` of the returned segments.
+                - name: minDistanceStops
+                  in: query
+                  required: false
+                  schema:
+                    type: integer
+                    example: -2
+                  description: |
+                    Minimum `distance_stops` of info panel stop routes. Routes outside the range given by `minDistanceStops`
+                    and `maxDistanceStops` are left out, and so are info panel stops left without a route.
+                - name: maxDistanceStops
+                  in: query
+                  required: false
+                  schema:
+                    type: integer
+                    example: 2
+                  description: Maximum `distance_stops` of info panel stop routes, see `minDistanceStops`.
+            responses:
+                200:
+                    description: OK
+                    content:
+                        application/json:
+                            schema:
+                                type: array
+                                items:
+                                    $ref: "#/components/schemas/JISDelayedSegment"
+                400:
+                    $ref: "#/components/responses/BadRequestError"
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
 
 
 components:
@@ -4897,3 +4954,122 @@ components:
                     format: date-time
                     example: "2024-02-29T12:22:20.958Z"
                     description: Timestamp from when the event was created in VYMI
+        JISDelayedSegmentStop:
+            type: object
+            required:
+                - id
+                - name
+            properties:
+                id:
+                    type: string
+                    example: U1234Z1P
+                    description: GTFS stop id
+                name:
+                    type: string
+                    example: Vozovna Střešovice
+        JISDelayedSegment:
+            type: object
+            required:
+                - id
+                - from_stop
+                - to_stop
+                - expected_delay_seconds
+                - first_detected_at
+                - last_detected_at
+                - stops
+                - routes
+                - info_panel_stops
+            properties:
+                id:
+                    type: string
+                    example: 1234/1-5678/2
+                    description: Identifier of the segment derived from its endpoints
+                from_stop:
+                    $ref: "#/components/schemas/JISDelayedSegmentStop"
+                to_stop:
+                    $ref: "#/components/schemas/JISDelayedSegmentStop"
+                expected_delay_seconds:
+                    type: integer
+                    example: 900
+                    description: Expected additional delay of a vehicle passing the whole segment
+                first_detected_at:
+                    type: string
+                    format: date-time
+                    example: "2026-10-27T08:50:00.000Z"
+                    description: |
+                        Start of the current continuous detection of the segment; resets when the segment is missing from a successful
+                        refresh or its `id` changes
+                last_detected_at:
+                    type: string
+                    format: date-time
+                    example: "2026-10-27T09:00:00.000Z"
+                    description: Time of the last detection of the segment
+                stops:
+                    type: array
+                    description: |
+                        Stops of the segment, including its endpoints, ordered along the segment. A stop with several GTFS stop ids
+                        (variants) is represented by the alphabetically first of them, so its id stays the same between refreshes
+                        unless the GTFS stops change.
+                    items:
+                        $ref: "#/components/schemas/JISDelayedSegmentStop"
+                routes:
+                    type: array
+                    description: |
+                        Routes with a regular trip travelling at least one hop of the segment within the configured time window
+                        (default 2 hours) before or after the detection
+                    items:
+                        type: object
+                        required:
+                            - id
+                            - short_name
+                            - type
+                        properties:
+                            id:
+                                type: string
+                                example: L119
+                                description: GTFS route id
+                            short_name:
+                                type: string
+                                example: "119"
+                            type:
+                                type: integer
+                                example: 3
+                                description: GTFS route type
+                info_panel_stops:
+                    type: array
+                    description: |
+                        Stops with an info panel (departure preset) in or near the segment along the affected routes. The stop id
+                        is the variant the preset is assigned to, so it may differ from the id of the same stop in `stops`; a stop
+                        inside the segment is recognized by `distance_stops` 0.
+                    items:
+                        type: object
+                        required:
+                            - stop
+                            - preset_route_names
+                            - routes
+                        properties:
+                            stop:
+                                $ref: "#/components/schemas/JISDelayedSegmentStop"
+                            preset_route_names:
+                                type: array
+                                description: Route names of the departure presets assigned to the stop
+                                items:
+                                    type: string
+                                    example: bustec-vozovna_strasovice-876_2
+                            routes:
+                                type: array
+                                description: Affected routes passing the stop
+                                items:
+                                    type: object
+                                    required:
+                                        - id
+                                        - distance_stops
+                                    properties:
+                                        id:
+                                            type: string
+                                            example: L119
+                                            description: GTFS route id
+                                        distance_stops:
+                                            type: integer
+                                            example: -2
+                                            description: Distance of the stop from the segment in stops along the route (negative before the segment, 0 inside, positive after it)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/pid",
-    "version": "6.4.1-dev.3053867815",
+    "version": "6.4.1-dev.3054859807",
     "description": "Golemio PID Module",
     "type": "module",
     "main": "dist/index.js",