@golemio/pid 3.15.3-dev.1840989210 → 3.15.3-dev.1841156396

package/docs/openapi-input.yaml

@@ -571,6 +571,22 @@ components:
                                 nullable: true
                                 example: "2024-03-03T14:22:20.958Z"
                         description: The start and end date/time of the event validity
+                    display_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 visibility
                     effect:
                         type: string
                         example: DETOUR
@@ -613,6 +629,20 @@ components:
                           - cs
                           - en
                         description: Localized descriptions of the event
+                    description_html:
+                        type: object
+                        properties:
+                          cs:
+                            type: string
+                            description: Event description in Czech in html format
+                          en:
+                            type: string
+                            nullable: true
+                            description: Event description in English in html format
+                        required:
+                          - cs
+                          - en
+                        description: Localized descriptions of the event in html format
                     url:
                         type: object
                         properties:
@@ -824,11 +854,15 @@ components:
                         },
                         "severity_level": "SEVERE",
                         "active_period": { "start": "2024-02-07T12:11:00.000Z", "end": null },
+                        "display_period": { "start": "2024-02-07T12:11:00.000Z", "end": null },
                         "effect": "MODIFIED_SERVICE",
                         "effect_detail": { "cs": "Provoz omezen" },
                         "description_text": {
                             "cs": "V Libni je omezen provoz tramvají. Důvodem je technická závada trolejbusu na kolejích."
                         },
+                        "description_html": {
+                            "cs": "<p>V Libni je omezen provoz tramvají. Důvodem je technická závada trolejbusu na kolejích.</p>"
+                        },
                         "url": {
                             "cs": "https://dpp.cz/omezeni-a-mimoradne-udalosti/detail/test-0"
                         },
@@ -893,4 +927,4 @@ components:
                         "created_timestamp": "2024-11-08T10:44:34.701Z",
                         "last_modified_timestamp": "2024-11-08T10:44:34.701Z"
                     }
-                ]
+                ]

package/docs/openapi-output.yaml

@@ -44,6 +44,8 @@ tags:
 
     - name: 🕒 Public Departures (v2)
       description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" />
+    - name: 🪧 JIS (v1)
+      description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" />
 
 paths:
     /v2/gtfs/services:
@@ -1740,6 +1742,53 @@ paths:
                                     maxItems: 0
                                     items:
                                         type: object
+    /v1/jis/events/custom-format:
+        get:
+            tags:
+                - 🪧 JIS (v1)
+            summary: Get all published events in custom format for external use
+            parameters:
+                - name: displayPeriodStart
+                  in: query
+                  required: false
+                  schema:
+                    type: string
+                    format: date-time
+                    example: "2024-02-29T11:22:20.958Z"
+                  description: Start of the display period
+                - name: displayPeriodEnd
+                  in: query
+                  required: false
+                  schema:
+                    type: string
+                    format: date-time
+                    example: "2024-03-03T14:22:20.958Z"
+                  description: End of the display period
+                - name: organizationNames
+                  in: query
+                  required: false
+                  schema:
+                    type: array
+                    items:
+                      type: string
+                      example: "ROPID"
+                  description: List of organization names to filter events by.
+            responses:
+                200:
+                    description: OK
+                    content:
+                        application/json:
+                            schema:
+                                type: array
+                                items:
+                                    $ref: "#/components/schemas/EventCustomFormat"
+                400:
+                    $ref: "#/components/responses/BadRequestError"
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
+                
+
+
 
 
 
@@ -3274,3 +3323,221 @@ components:
                     type: boolean
                     example: true
                     nullable: true
+        EventId:
+            type: string
+            format: uuid
+            example: 1b75c16b-d5a3-40ca-8560-5a7dc011655d
+        Effect:
+            type: object
+            properties:
+              cs:
+                  type: string
+                  example: Zpoždění
+              en:
+                  type: string
+                  example: Delay
+                  nullable: true
+            required:
+              - cs
+        RouteType:
+            type: number
+            example: 0
+            enum:
+                - 0
+                - 1
+                - 2
+                - 3
+                - 4
+                - 7
+                - 11
+            description: |
+                0 - tram \
+                1 - metro \
+                2 - rail \
+                3 - bus \
+                4 - ferry \
+                7 - funicular \
+                11 - trolleybus
+
+        InformedEntityRoute:
+            type: object
+            properties:
+                id:
+                    type: string
+                    example: L13
+                route_short_name:
+                    type: string
+                    example: "13"
+                route_long_name:
+                    type: string
+                    example: "Čechovo náměstí - Olšanské hřbitovy"
+                route_type:
+                    $ref: "#/components/schemas/RouteType"
+            required:
+                - id
+                - route_short_name
+                - route_type
+                - route_long_name
+
+        EventCustomFormat:
+            type: object
+            required:
+                - id
+                - type
+                - header_text
+                - cause
+                - cause_detail
+                - severity_level
+                - active_period
+                - display_period
+                - effects
+                - description_text
+                - description_html
+                - url
+                - organization_name
+                - created_timestamp
+                - last_modified_timestamp
+            properties:
+                id:
+                    $ref: "#/components/schemas/EventId"
+                    description: Unique identifier of the event in the UUIDv4 format
+                type:
+                    type: string
+                    example: INCIDENT
+                    enum:
+                        - INCIDENT
+                        - DISRUPTION
+                        - SERVICE_CHANGE
+                header_text:
+                    type: object
+                    properties:
+                        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
+                cause:
+                    type: object
+                    properties:
+                        cs:
+                            type: string
+                            example: Nehoda
+                        en:
+                            type: string
+                            example: Accident
+                            nullable: true
+                    required:
+                        - cs
+                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:
+                        - cs
+                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
+                display_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 when the event should be displayed
+                effects:
+                    type: array
+                    minItems: 1
+                    items:
+                        $ref: "#/components/schemas/Effect"
+                description_text:
+                    type: object
+                    properties:
+                      cs:
+                        type: string
+                        description: Event description in Czech in plain text
+                      en:
+                        type: string
+                        nullable: true
+                        description: Event description in English in plain text
+                    required:
+                      - cs
+                    description: Localized descriptions of the event in plain text
+                description_html:
+                    type: object
+                    properties:
+                      cs:
+                        type: string
+                        description: Event description in Czech in HTML format
+                      en:
+                        type: string
+                        nullable: true
+                        description: Event description in English in HTML format
+                    required:
+                      - cs
+                    description: Localized descriptions of the event in HTML format
+                organization_name:
+                    type: string
+                    example: ROPID
+                informed_entity:
+                    type: object
+                    nullable: true
+                    properties:
+                      routes:
+                        type: array
+                        nullable: true
+                        items:
+                          type: object
+                          $ref: "#/components/schemas/InformedEntityRoute"
+                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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/pid",
-    "version": "3.15.3-dev.1840989210",
+    "version": "3.15.3-dev.1841156396",
     "description": "Golemio PID Module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",