@golemio/pid 3.12.1 → 3.12.2-dev.1783567547

package/docs/asyncapi.yaml

@@ -4,9 +4,20 @@ info:
     version: 1.0.0
     description: PID
 channels:
+    jis.fetchJISEvents:
+        address: vehicle-positions.jis.fetchJISEvents
+        description: Fetch JIS events from data source
+        bindings:
+            amqp:
+                is: queue
+                queue:
+                    durable: true
+        messages:
+            empty:
+                $ref: "#/components/messages/emptyMessage"
     jis.fetchJISInfotexts:
         address: vehicle-positions.jis.fetchJISInfotexts
-        description: Fetch JIS Infotexts from data source
+        description: Fetch JIS infotexts from data source
         bindings:
             amqp:
                 is: queue
@@ -15,9 +26,20 @@ channels:
         messages:
             empty:
                 $ref: "#/components/messages/emptyMessage"
+    jis.refreshJISEvents:
+        address: vehicle-positions.jis.refreshJISEvents
+        description: Refresh JIS events in database
+        bindings:
+            amqp:
+                is: queue
+                queue:
+                    durable: true
+        messages:
+            empty:
+                $ref: "#/components/messages/JISEvents"
     jis.refreshJISInfotexts:
         address: vehicle-positions.jis.refreshJISInfotexts
-        description: Refresh JIS Infotexts in database
+        description: Refresh JIS infotexts in database
         bindings:
             amqp:
                 is: queue
@@ -25,7 +47,7 @@ channels:
                     durable: true
         messages:
             empty:
-                $ref: "#/components/messages/IJISInfotext"
+                $ref: "#/components/messages/JISInfotexts"
     updateGTFSTripId:
         address: vehicle-positions.vehiclepositions.updateGTFSTripId
         description: some description
@@ -256,6 +278,18 @@ channels:
             empty:
                 $ref: "#/components/messages/EmptyObject"
 operations:
+    jis.fetchJISEvents:
+        action: "send"
+        channel:
+            $ref: "#/channels/jis.fetchJISEvents"
+    jis.fetchJISInfotexts:
+        action: "send"
+        channel:
+            $ref: "#/channels/jis.fetchJISInfotexts"
+    jis.refreshJISEvents:
+        action: "send"
+        channel:
+            $ref: "#/channels/jis.refreshJISEvents"
     jis.refreshJISInfotexts:
         action: "send"
         channel:
@@ -458,12 +492,17 @@ components:
                         type: array
                         items:
                             $ref: "#/components/schemas/IScheduleDto"
-        IJISInfotext:
+        JISEvents:
+            payload:
+                type: array
+                items:
+                    $ref: "#/components/schemas/JISEvent"
+        JISInfotexts:
             payload:
                 type: array
-                items: 
-                    $ref: "#/components/schemas/JisInfotext"
-                        
+                items:
+                    $ref: "#/components/schemas/JISInfotext"
+
     schemas:
         IUpdateGTFSTripIdData:
             type: object
@@ -1544,80 +1583,264 @@ components:
                 actual_position_timestamp_scheduled:
                     type: string
                     format: date-time
-        JisInfotext:
-                type: object
-                properties:
-                  id:
+        JISEvent:
+            type: object
+            required:
+                - id
+                - type
+                - header_text
+                - cause
+                - cause_detail
+                - severity_level
+                - active_period
+                - effect
+                - effect_detail
+                - description_text
+                - url
+                - organization_name
+                - created_timestamp
+                - last_modified_timestamp
+            properties:
+                id:
                     type: string
                     format: uuid
-                    description: Unique identifier for the infotext
-                  severity_level:
+                    description: Unique identifier of the event in the UUIDv4 format
+                    example: e5cc7b38-79e1-4f7a-b8de-884971e23412
+                type:
                     type: string
+                    example: INCIDENT
                     enum:
-                      - SEVERE
-                      - WARNING
-                      - INFO
-                    description: Severity level of the infotext
-                  display_type:
-                    type: string
-                    description: How the infotext is displayed
-                  active_period:
+                        - INCIDENT
+                        - DISRUPTION
+                        - SERVICE_CHANGE
+                header_text:
                     type: object
                     properties:
-                      start:
-                        type: string
-                        format: date-time
-                        description: Start time of the active period
-                      end:
-                        type: string
-                        format: date-time
-                        description: End time of the active period
+                        cs:
+                            type: string
+                            example: Nehoda Jiřího z Poděbrad
+                        en:
+                            type: string
+                            example: Accident at Jiřího z Poděbrad
+                            nullable: true
+                    required:
+                        - cs
+                        - en
+                cause:
+                    type: string
+                    example: ACCIDENT
+                    enum:
+                        - ACCIDENT
+                        - STRIKE
+                        - TECHNICAL_PROBLEM
+                        - CONSTRUCTION
+                        - WEATHER
+                        - DEMONSTRATION
+                        - POLICE_ACTIVITY
+                        - MEDICAL_EMERGENCY
+                        - OTHER_CAUSE
+                        - UNKNOWN_CAUSE
+                        - HOLIDAY
+                        - MAINTENANCE
+                cause_detail:
+                    type: object
+                    properties:
+                        cs:
+                            type: string
+                            example: Nehoda na křižovatce
+                        en:
+                            type: string
+                            example: Accident at the intersection
+                            nullable: true
                     required:
-                      - start
-                      - end
-                    description: The period during which the infotext is active
-                  description_text:
+                        - cs
+                        - en
+                severity_level:
+                    type: string
+                    example: SEVERE
+                    enum:
+                        - INFO
+                        - WARNING
+                        - SEVERE
+                    description: |
+                        INFO - priority 3 \
+                        WARNING - priority 2 \
+                        SEVERE - priority 1
+                active_period:
+                    type: object
+                    required:
+                        - start
+                        - end
+                    properties:
+                        start:
+                            type: string
+                            format: date-time
+                            example: "2024-02-29T11:22:20.958Z"
+                        end:
+                            type: string
+                            format: date-time
+                            nullable: true
+                            example: "2024-03-03T14:22:20.958Z"
+                    description: The start and end date/time of the event validity
+                effect:
+                    type: string
+                    example: DETOUR
+                    enum:
+                        - DETOUR
+                        - REDUCED_SERVICE
+                        - MODIFIED_SERVICE
+                        - SIGNIFICANT_DELAYS
+                        - ADDITIONAL_SERVICE
+                        - OTHER_EFFECT
+                        - NO_SERVICE
+                        - STOP_MOVED
+                        - NO_EFFECT
+                        - ACCESSIBILITY_ISSUE
+                        - UNKNOWN_EFFECT
+                effect_detail:
+                    type: object
+                    properties:
+                        cs:
+                            type: string
+                            example: Tramvaje jezdí několik zastávek jinudy.
+                        en:
+                            type: string
+                            example: Trams are running a few stops differently.
+                            nullable: true
+                    required:
+                        - cs
+                        - en
+                description_text:
                     type: object
                     properties:
                       cs:
                         type: string
-                        description: Description in Czech
+                        description: Event description in Czech
                       en:
                         type: string
-                        description: Description in English
+                        nullable: true
+                        description: Event description in English
                     required:
                       - cs
                       - en
-                    description: Localized descriptions of the infotext
-                  informed_entity:
+                    description: Localized descriptions of the event
+                url:
+                    type: object
+                    properties:
+                        cs:
+                            type: string
+                            format: uri
+                            example: https://pid.cz/zmena/cs/nehoda-jiriho-z-podebrad
+                        en:
+                            type: string
+                            format: uri
+                            nullable: true
+                            example: https://pid.cz/zmena/en/accident-jiriho-z-podebrad
+                    required:
+                        - cs
+                        - en
+                organization_name:
+                    type: string
+                    example: ROPID
+                informed_entity:
                     type: object
+                    nullable: true
                     properties:
-                      stops:
+                      routes:
                         type: array
+                        nullable: true
                         items:
                           type: object
                           properties:
-                            stop_id:
+                            route_id:
                               type: string
-                              description: Unique identifier for the stop
+                              description: Unique GTFS identifier of the affected route
                           required:
-                            - stop_id
-                    required:
-                      - stops
-                  created_timestamp:
+                            - route_id
+                last_modified_timestamp:
+                    type: string
+                    format: date-time
+                    example: "2024-02-29T12:22:20.958Z"
+                    description: Timestamp from when the event was last modified in VYMI
+                created_timestamp:
+                    type: string
+                    format: date-time
+                    example: "2024-02-29T12:22:20.958Z"
+                    description: Timestamp from when the event was created in VYMI
+        JISInfotext:
+            type: object
+            properties:
+              id:
+                type: string
+                format: uuid
+                description: Unique identifier for the infotext
+              severity_level:
+                type: string
+                enum:
+                  - SEVERE
+                  - WARNING
+                  - INFO
+                description: Severity level of the infotext
+              display_type:
+                type: string
+                description: How the infotext is displayed
+              active_period:
+                type: object
+                properties:
+                  start:
                     type: string
                     format: date-time
-                    description: Timestamp when the infotext was created in VYMI
-                  last_modified_timestamp:
+                    description: Start time of the active period
+                  end:
                     type: string
                     format: date-time
-                    description: Timestamp when the infotext was updated in VYMI
+                    description: End time of the active period
                 required:
-                  - id
-                  - severity_level
-                  - display_type
-                  - active_period
-                  - description_text
-                  - informed_entity
-                  - created_timestamp
-                  - last_modified_timestamp
+                  - start
+                  - end
+                description: The period during which the infotext is active
+              description_text:
+                type: object
+                properties:
+                  cs:
+                    type: string
+                    description: Description in Czech
+                  en:
+                    type: string
+                    description: Description in English
+                required:
+                  - cs
+                  - en
+                description: Localized descriptions of the infotext
+              informed_entity:
+                type: object
+                properties:
+                  stops:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        stop_id:
+                          type: string
+                          description: Unique identifier for the stop
+                      required:
+                        - stop_id
+                required:
+                  - stops
+              created_timestamp:
+                type: string
+                format: date-time
+                description: Timestamp when the infotext was created in VYMI
+              last_modified_timestamp:
+                type: string
+                format: date-time
+                description: Timestamp when the infotext was updated in VYMI
+            required:
+              - id
+              - severity_level
+              - display_type
+              - active_period
+              - description_text
+              - informed_entity
+              - created_timestamp
+              - last_modified_timestamp

package/docs/implementation_documentation.md

@@ -215,6 +215,39 @@ _:warning: Původním záměrem bylo využití OIS číselníku během zpracová
             -   prod `0 */1 * * * *`
 -   názvy rabbitmq front
     -   vehicle-positions.ropidpresets.collectAndSaveLogs se zprávou `{ "targetMinutes": n }`
+
+#### _JIS Events_
+
+-   zdroj dat
+    -   baseUrl: module.pid.jis.baseUrl
+    -   VYMI events path: module.pid.jis.events.path
+    -   hlavičky VYMI events dotazu: module.pid.jis.events.headers
+-   formát dat
+    -   protokol: http
+    -   datový typ: json
+    -   validační schéma: [JISEventsJsonSchema](../src/schema-definitions/jis/datasources/JISEventsJsonSchema.ts)
+    -   příklad vstupnich dat: [eventsDataSourceFixture](../test/integration-engine/jis/fixtures/eventsDataSourceFixture.ts)
+-   frekvence stahování
+    -   data jsou stažena pouze po manuálním zaslání zprávy do RabbitMQ fronty (primární způsob aktualizace dat je aktivní posílání)
+-   název rabbitmq fronty
+    -   vehicle-positions.jis.fetchJISEvents
+
+#### _JIS Infotexts_
+
+-   zdroj dat
+    -   baseUrl: module.pid.jis.baseUrl
+    -   VYMI infotexts path: module.pid.jis.infotexts.path
+    -   hlavičky VYMI infotexts dotazu: module.pid.jis.infotexts.headers
+-   formát dat
+    -   protokol: http
+    -   datový typ: json
+    -   validační schéma: [JISInfotextsJsonSchema](../src/schema-definitions/jis/datasources/JISInfotextsJsonSchema.ts)
+    -   příklad vstupnich dat: [infotextsDataSourceFixture](../test/integration-engine/jis/fixtures/infotextsDataSourceFixture.ts)
+-   frekvence stahování
+    -   data jsou stažena pouze po manuálním zaslání zprávy do RabbitMQ fronty (primární způsob aktualizace dat je aktivní posílání)
+-   název rabbitmq fronty
+    -   vehicle-positions.jis.fetchJISInfotexts
+
 ### _Ropid staticka data_
 
 -   zdroj dat
@@ -365,7 +398,18 @@ _:warning: Původním záměrem bylo využití OIS číselníku během zpracová
     -   agregace dat: 1 MB
 -   odhadovaná zátěž
     -   desítky až stovky zpráv za minutu
-#### _JIS Infotexty_
+
+#### _JIS Events_
+
+-   formát dat
+    -   protokol: http
+    -   datový typ: json
+    -   validační schéma: [JISEventsJsonSchema](../src/schema-definitions/jis/datasources/JISEventsJsonSchema.ts)
+    -   příklad vstupnich dat: [eventsDataSourceFixture](../test/integration-engine/jis/fixtures/eventsDataSourceFixture.ts)
+-   název rabbitmq fronty
+    -   vehicle-positions.jis.refreshJISEvents
+
+#### _JIS Infotexts_
 
 -   formát dat
     -   protokol: http