@golemio/pid 6.0.3-dev.2946669933 → 6.0.3-dev.2950030701

package/docs/openapi-output.yaml

@@ -400,6 +400,21 @@ paths:
                   schema:
                       type: string
                       example: "U476Z103P"
+                - name: locationTypes
+                  in: query
+                  description: >-
+                      Get stops by GTFS `location_type` (0 = stop/platform, 1 = station, 2 = entrance/exit, 3 = generic node,
+                      4 = boarding area). Preferably use with square brackets `locationTypes[]=1&locationTypes[]=2`
+                      (though repeating the parameter without brackets is also accepted).
+                  required: false
+                  style: form
+                  explode: true
+                  schema:
+                      type: array
+                      items:
+                          type: integer
+                          enum: [0, 1, 2, 3, 4]
+                      example: [0]
                 - name: aswIds
                   in: query
                   description: Get stops by ASW, use `_` instead of `/` or encode the slash sign with `%2F`. Use with square brackets `aswId[]`.
@@ -576,6 +591,129 @@ paths:
                 "404":
                     description: Not found
 
+    /v2/gtfs/levels:
+        get:
+            summary: GET All GTFS Levels
+            description: Levels within stations from GTFS `levels.txt`, ordered by `level_id` ascending.
+            tags:
+                - 🧾 GTFS Static (v2)
+            parameters:
+                - name: limit
+                  in: query
+                  description: Limits number of retrieved items. The maximum is 10000 (default value).
+                  required: false
+                  schema:
+                      type: number
+                      format: int64
+                      example: 10
+                - name: offset
+                  in: query
+                  description: Number of the first items that are skipped.
+                  required: false
+                  schema:
+                      type: number
+                      format: int64
+                      example: 0
+            responses:
+                "200":
+                    description: successful operation
+                    headers:
+                        Cache-Control:
+                            description: Cache control directive for caching proxies
+                            schema:
+                                type: string
+                                example: public, s-maxage=14400, stale-while-revalidate=60
+                    content:
+                        application/json:
+                            schema:
+                                type: array
+                                items:
+                                    $ref: "#/components/schemas/GTFSLevel"
+                "401":
+                    $ref: "#/components/responses/UnauthorizedError"
+
+    /v2/gtfs/pathways:
+        get:
+            summary: GET All GTFS Pathways
+            description: Pathways linking locations within stations from GTFS `pathways.txt`, ordered by `pathway_id` ascending.
+            tags:
+                - 🧾 GTFS Static (v2)
+            parameters:
+                - name: limit
+                  in: query
+                  description: Limits number of retrieved items. The maximum is 10000 (default value).
+                  required: false
+                  schema:
+                      type: number
+                      format: int64
+                      example: 10
+                - name: offset
+                  in: query
+                  description: Number of the first items that are skipped.
+                  required: false
+                  schema:
+                      type: number
+                      format: int64
+                      example: 0
+            responses:
+                "200":
+                    description: successful operation
+                    headers:
+                        Cache-Control:
+                            description: Cache control directive for caching proxies
+                            schema:
+                                type: string
+                                example: public, s-maxage=14400, stale-while-revalidate=60
+                    content:
+                        application/json:
+                            schema:
+                                type: array
+                                items:
+                                    $ref: "#/components/schemas/GTFSPathway"
+                "401":
+                    $ref: "#/components/responses/UnauthorizedError"
+
+    /v2/gtfs/transfers:
+        get:
+            summary: GET All GTFS Transfers
+            description: Transfer rules from GTFS `transfers.txt`, ordered by `from_stop_id`, `to_stop_id`, `from_trip_id` and `to_trip_id`, all ascending with empty values last.
+            tags:
+                - 🧾 GTFS Static (v2)
+            parameters:
+                - name: limit
+                  in: query
+                  description: Limits number of retrieved items. The maximum is 10000 (default value).
+                  required: false
+                  schema:
+                      type: number
+                      format: int64
+                      example: 10
+                - name: offset
+                  in: query
+                  description: Number of the first items that are skipped.
+                  required: false
+                  schema:
+                      type: number
+                      format: int64
+                      example: 0
+            responses:
+                "200":
+                    description: successful operation
+                    headers:
+                        Cache-Control:
+                            description: Cache control directive for caching proxies
+                            schema:
+                                type: string
+                                example: public, s-maxage=14400, stale-while-revalidate=60
+                    content:
+                        application/json:
+                            schema:
+                                type: array
+                                items:
+                                    $ref: "#/components/schemas/GTFSTransfer"
+                "401":
+                    $ref: "#/components/responses/UnauthorizedError"
+
     /v2/vehiclepositions:
         get:
             summary: GET All Vehicle Positions
@@ -2632,6 +2770,160 @@ components:
                 - route_type
                 - route_url
 
+        GTFSLevel:
+            title: GTFS Level
+            description: See GTFS Schedule Reference for [levels.txt](https://gtfs.org/documentation/schedule/reference/#levelstxt).
+            type: object
+            properties:
+                level_id:
+                    type: string
+                    example: "U400L1"
+                level_index:
+                    type: number
+                    format: double
+                    description: Numeric index of the level that indicates its relative position. Ground level is 0.
+                    example: -1
+                level_name:
+                    type: string
+                    nullable: true
+                    example: "Chodba"
+            required:
+                - level_id
+                - level_index
+                - level_name
+
+        GTFSPathway:
+            title: GTFS Pathway
+            description: See GTFS Schedule Reference for [pathways.txt](https://gtfs.org/documentation/schedule/reference/#pathwaystxt).
+            type: object
+            properties:
+                pathway_id:
+                    type: string
+                    example: "U400P13"
+                from_stop_id:
+                    type: string
+                    example: "U400N11"
+                to_stop_id:
+                    type: string
+                    example: "U400N29"
+                pathway_mode:
+                    type: integer
+                    enum: [1, 2, 3, 4, 5, 6, 7]
+                    description: >-
+                        1 = walkway, 2 = stairs, 3 = moving sidewalk/travelator, 4 = escalator, 5 = elevator,
+                        6 = fare gate, 7 = exit gate
+                    example: 1
+                is_bidirectional:
+                    type: integer
+                    enum: [0, 1]
+                    description: 0 = unidirectional (from `from_stop_id` to `to_stop_id` only), 1 = bidirectional
+                    example: 1
+                length:
+                    type: number
+                    format: double
+                    nullable: true
+                    description: Horizontal length in meters.
+                    example: null
+                traversal_time:
+                    type: integer
+                    nullable: true
+                    description: Average time in seconds needed to walk through the pathway.
+                    example: 30
+                stair_count:
+                    type: integer
+                    nullable: true
+                    description: Number of stairs, positive when going up from `from_stop_id` to `to_stop_id`, negative when going down.
+                    example: -28
+                max_slope:
+                    type: number
+                    format: double
+                    nullable: true
+                    description: Maximum slope ratio of the pathway.
+                    example: null
+                min_width:
+                    type: number
+                    format: double
+                    nullable: true
+                    description: Minimum width of the pathway in meters.
+                    example: null
+                signposted_as:
+                    type: string
+                    nullable: true
+                    description: Public facing text from physical signage visible to riders.
+                    example: "Linka C, Line C"
+                reversed_signposted_as:
+                    type: string
+                    nullable: true
+                    description: Same as `signposted_as`, but when the pathway is used from `to_stop_id` to `from_stop_id`.
+                    example: "E4, E5 Vinohradská, Legerova"
+                bikes_prohibited:
+                    type: integer
+                    enum: [0, 1]
+                    nullable: true
+                    description: 0 = bicycles allowed, 1 = bicycles prohibited. A PID extension of GTFS.
+                    example: 0
+            required:
+                - pathway_id
+                - from_stop_id
+                - to_stop_id
+                - pathway_mode
+                - is_bidirectional
+                - length
+                - traversal_time
+                - stair_count
+                - max_slope
+                - min_width
+                - signposted_as
+                - reversed_signposted_as
+                - bikes_prohibited
+
+        GTFSTransfer:
+            title: GTFS Transfer
+            description: See GTFS Schedule Reference for [transfers.txt](https://gtfs.org/documentation/schedule/reference/#transferstxt).
+            type: object
+            properties:
+                from_stop_id:
+                    type: string
+                    nullable: true
+                    example: "U1071Z3P"
+                to_stop_id:
+                    type: string
+                    nullable: true
+                    example: "U1071Z3P"
+                from_trip_id:
+                    type: string
+                    nullable: true
+                    example: "909_271_251110"
+                to_trip_id:
+                    type: string
+                    nullable: true
+                    example: "916_175_260101"
+                transfer_type:
+                    type: integer
+                    enum: [0, 1, 2, 3, 4, 5]
+                    description: >-
+                        0 = recommended transfer point, 1 = timed transfer point, 2 = transfer requires `min_transfer_time`,
+                        3 = transfer not possible, 4 = in-seat transfer, 5 = in-seat transfer not allowed
+                    example: 1
+                min_transfer_time:
+                    type: integer
+                    nullable: true
+                    description: Minimum time in seconds needed for the transfer.
+                    example: null
+                max_waiting_time:
+                    type: integer
+                    nullable: true
+                    description: Maximum time in seconds the connecting vehicle waits. A PID extension of GTFS.
+                    example: 180
+            required:
+                - from_stop_id
+                - to_stop_id
+                - from_trip_id
+                - to_trip_id
+                - transfer_type
+                - min_transfer_time
+                - max_waiting_time
+
         Point:
             title: Point
             type: array

package/package.json

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