@golemio/parkings 1.22.5 → 1.22.6-dev.2011057324

package/docs/openapi-output.yaml

@@ -17,7 +17,7 @@ servers:
       description: Main (production) server
 tags:
     - name: 🅿️ Parking (v1)
-      description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> 💡 Parking Lots
+      description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> ❌ Removed
     - name: 🅿️ Parking (v2)
       description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> 💡 Parking spaces
     - name: 🅿️ Parking (v2) - internal
@@ -26,165 +26,6 @@ tags:
       description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> 💡 Parking, occupancy, measurements, tariffs, machines. <em>Note that only a select subset of the data is published as open data.</em>
 
 paths:
-    /v1/parkings:
-        get:
-            tags:
-                - 🅿️ Parking (v1)
-            summary: GET All Parking Lots within the region of interest
-            parameters:
-                -   name: latlng
-                    in: query
-                    description: Sorting by location (Latitude and Longitude separated by comma,
-                        latitude first).
-                    schema:
-                        type: string
-                        example: 50.124935,14.457204
-                -   name: range
-                    in: query
-                    description: Filter by distance from latlng in meters (range query). Depends
-                        on the latlng parameter.
-                    schema:
-                        type: number
-                        example: 5000
-                -   name: districts
-                    in: query
-                    description: Filter by Prague city districts (slug) separated by comma.
-                    required: false
-                    example: ['praha-4']
-                    schema:
-                        type: array
-                        items: {}
-                -   name: limit
-                    in: query
-                    description: Limits number of retrieved items.
-                    schema:
-                        type: number
-                        example: 10
-                -   name: offset
-                    in: query
-                    description: Number of the first items that are skipped.
-                    schema:
-                        type: number
-                        example: 0
-                -   name: updatedSince
-                    in: query
-                    description: Filters all results with older updated_at than this parameter
-                    required: false
-                    example: 2019-05-18T07:38:37.000Z
-                    schema:
-                        type: string
-            responses:
-                200:
-                    description: OK
-                    headers:
-                        Cache-Control:
-                            description: Cache control directive for caching proxies
-                            schema:
-                                type: string
-                                example: public, s-maxage=300, stale-while-revalidate=5
-                    content:
-                        application/json; charset=utf-8:
-                            schema:
-                                type: object
-                                properties:
-                                    features:
-                                        type: array
-                                        items:
-                                            $ref: '#/components/schemas/ParkingLotFeature'
-                                    type:
-                                        type: string
-                                        example: FeatureCollection
-                401:
-                    $ref: "#/components/responses/UnauthorizedError"
-                404:
-                    description: Not found
-    /v1/parkings/{id}:
-        get:
-            tags:
-                - 🅿️ Parking (v1)
-            summary: GET Parking Lot
-            parameters:
-                -   name: id
-                    in: path
-                    description: Id of parking location.
-                    required: true
-                    schema:
-                        type: string
-                        example: "534015"
-            responses:
-                200:
-                    description: OK
-                    headers:
-                        Cache-Control:
-                            description: Cache control directive for caching proxies
-                            schema:
-                                type: string
-                                example: public, s-maxage=300, stale-while-revalidate=5
-                    content:
-                        application/json; charset=utf-8:
-                            schema:
-                                $ref: '#/components/schemas/ParkingLotFeature'
-                401:
-                    $ref: "#/components/responses/UnauthorizedError"
-                404:
-                    description: Not found
-    /v1/parkings/history:
-        get:
-            tags:
-                - 🅿️ Parking (v1)
-            summary: GET Parking Lot History
-            parameters:
-                -   name: limit
-                    in: query
-                    description: Limits number of retrieved items.
-                    schema:
-                        type: number
-                        example: 10
-                -   name: offset
-                    in: query
-                    description: Number of the first items that are skipped.
-                    schema:
-                        type: number
-                        example: 0
-                -   name: from
-                    in: query
-                    description: Date in ISO8601, limits data measured from this datetime
-                    required: false
-                    schema:
-                        type: string
-                        example: 2019-05-18T07:38:37.000Z
-                -   name: to
-                    in: query
-                    description: Date in ISO8601, limits data measured up to this datetime
-                    required: false
-                    schema:
-                        type: string
-                        example: 2019-05-19T07:38:37.000Z
-                -   name: sensorId
-                    in: query
-                    description: Limits data measured by sensor with this id (parameter `id` of the parking)
-                    schema:
-                        type: string
-                        example: tsk-143
-            responses:
-                200:
-                    description: OK
-                    headers:
-                        Cache-Control:
-                            description: Cache control directive for caching proxies
-                            schema:
-                                type: string
-                                example: public, s-maxage=300, stale-while-revalidate=5
-                    content:
-                        application/json; charset=utf-8:
-                            schema:
-                                type: array
-                                items:
-                                    $ref: '#/components/schemas/ParkingLotHistory'
-                401:
-                    $ref: "#/components/responses/UnauthorizedError"
-                404:
-                    description: Not found
     /v2/parking:
         get:
             tags:
@@ -331,7 +172,7 @@ paths:
                     description: Filter by data provider.
                     schema:
                         type: string
-                        example: tsk
+                        example: tsk_v2
                 -   name: sourceId
                     in: query
                     description: Filter by parking group id. Unique per data provider.
@@ -1118,172 +959,6 @@ components:
                     schema:
                         type: string
     schemas:
-        ParkingLotFeature:
-            type: object
-            properties:
-                geometry:
-                    type: object
-                    description: GeoJson geometry
-                    properties:
-                        coordinates:
-                            oneOf:
-                                -   type: array
-                                    items:
-                                        type: number
-                                    example: [14.441252, 50.109318]
-                                    description: Point
-                                -   type: array
-                                    items:
-                                        type: array
-                                        items:
-                                            type: array
-                                            items:
-                                                type: number
-                                    example:
-                                      [[
-                                          [14.50823156003554, 50.10498927328214],
-                                          [14.505782430390298, 50.1031042405622],
-                                          [14.509701037821998, 50.1029471511537],
-                                          [14.50823156003554, 50.10498927328214]
-                                      ]]
-                                    description: Polygon
-                                -   type: array
-                                    items:
-                                        type: array
-                                        items:
-                                            type: array
-                                            items:
-                                                type: array
-                                                items:
-                                                    type: number
-                                    example:
-                                      [
-                                          [[
-                                              [14.50823156003554, 50.10498927328214],
-                                              [14.505782430390298, 50.1031042405622],
-                                              [14.509701037821998, 50.1029471511537],
-                                              [14.50823156003554, 50.10498927328214]
-                                          ]],
-                                          [[
-                                              [14.50823156003554, 50.10498927328214],
-                                              [14.505782430390298, 50.1031042405622],
-                                              [14.509701037821998, 50.1029471511537],
-                                              [14.50823156003554, 50.10498927328214]
-                                          ]]
-                                      ]
-                                    description: MultiPolygon
-                        type:
-                            type: string
-                            enum:
-                                - Point
-                                - Polygon
-                                - MultiPolygon
-                properties:
-                    type: object
-                    properties:
-                        id:
-                            oneOf:
-                                - type: string
-                                  example: tsk-143
-                                - type: integer
-                                  example: 1234
-                        name:
-                            type: string
-                            example: Holešovice
-                        parking_type:
-                            type: object
-                            properties:
-                                id:
-                                    type: number
-                                    example: 1
-                                description:
-                                    type: string
-                                    example: P+R parkoviště
-                            required:
-                                - id
-                                - description
-                        num_of_free_places:
-                            type: number
-                            example: 2
-                        num_of_taken_places:
-                            type: number
-                            example: 63
-                        updated_at:
-                            type: string
-                            example: '2020-05-18T07:38:37.000Z'
-                        total_num_of_places:
-                            type: number
-                            example: 65
-                        average_occupancy:
-                            type: object
-                            properties:
-                                00:
-                                    $ref: '#/components/schemas/AverageOccupancyDay'
-                                01:
-                                    $ref: '#/components/schemas/AverageOccupancyDay'
-                                02:
-                                    $ref: '#/components/schemas/AverageOccupancyDay'
-                                03:
-                                    $ref: '#/components/schemas/AverageOccupancyDay'
-                                04:
-                                    $ref: '#/components/schemas/AverageOccupancyDay'
-                                05:
-                                    $ref: '#/components/schemas/AverageOccupancyDay'
-                                06:
-                                    $ref: '#/components/schemas/AverageOccupancyDay'
-                        area:
-                            type: number
-                            example: 130
-                        district:
-                            type: string
-                            example: praha-10
-                            nullable: true
-                        address:
-                            type: object
-                            nullable: true
-                            properties:
-                                address_country:
-                                    type: string
-                                    example: Česko
-                                address_formatted:
-                                    type: string
-                                    example: Vrbenského, 17000 Praha Holešovice, Česko
-                                address_locality:
-                                    type: string
-                                    example: Praha
-                                address_region:
-                                    type: string
-                                    example: Holešovice
-                                postal_code:
-                                    type: string
-                                    example: 17000
-                                street_address:
-                                    type: string
-                                    example: Vrbenského
-                                house_number:
-                                    type: string
-                                    example: 123
-                        last_updated:
-                            type: number
-                            example: 1556868553000
-                            nullable: true
-                        payment_link:
-                            type: string
-                            example: 'https://ke-utc.appspot.com/static/onstreet.html?shortname=143'
-                            nullable: true
-                        payment_shortname:
-                            type: string
-                            example: 143
-                            nullable: true
-                    required:
-                        - id
-                        - name
-                        - num_of_free_places
-                        - num_of_taken_places
-                        - total_num_of_places
-                type:
-                    type: string
-                    example: Feature
         AverageOccupancyDay:
             type: object
             properties:
@@ -1320,290 +995,64 @@ components:
                 10:
                     type: number
                     example: 51
-                11:
-                    type: number
-                    example: 51
-                12:
-                    type: number
-                    example: 51
-                13:
-                    type: number
-                    example: 51
-                14:
-                    type: number
-                    example: 51
-                15:
-                    type: number
-                    example: 51
-                16:
-                    type: number
-                    example: 51
-                17:
-                    type: number
-                    example: 48
-                18:
-                    type: number
-                    example: 46
-                19:
-                    type: number
-                    example: 29
-                20:
-                    type: number
-                    example: 28
-                21:
-                    type: number
-                    example: 29
-                22:
-                    type: number
-                    example: 18
-                23:
-                    type: number
-                    example: 16
-        AverageOccupancyWeek:
-            type: object
-            nullable: true
-            properties:
-                0:
-                    $ref: '#/components/schemas/AverageOccupancyDay'
-                1:
-                    $ref: '#/components/schemas/AverageOccupancyDay'
-                2:
-                    $ref: '#/components/schemas/AverageOccupancyDay'
-                3:
-                    $ref: '#/components/schemas/AverageOccupancyDay'
-                4:
-                    $ref: '#/components/schemas/AverageOccupancyDay'
-                5:
-                    $ref: '#/components/schemas/AverageOccupancyDay'
-                6:
-                    $ref: '#/components/schemas/AverageOccupancyDay'
-            description: "The day of the week (0 - 6; Sunday is 0)"
-        ParkingLotHistory:
-            type: object
-            properties:
-                id:
-                    type: string
-                    example: tsk-143
-                num_of_free_places:
-                    type: number
-                    example: 2
-                num_of_taken_places:
-                    type: number
-                    example: 63
-                updated_at:
-                    type: string
-                    example: '2020-05-18T07:38:37.000Z'
-                total_num_of_places:
-                    type: number
-                    example: 65
-                last_updated:
-                    type: number
-                    example: 1556868553000
-                    nullable: true
-            required:
-                - id
-                - name
-                - num_of_free_places
-                - num_of_taken_places
-                - total_num_of_places
-        ParkingSpaceFeature:
-            type: object
-            properties:
-                geometry:
-                    type: object
-                    description: GeoJson geometry
-                    properties:
-
-                        coordinates:
-                            oneOf:
-                                - type: array
-                                  items:
-                                      type: number
-                                  example: [14.441252, 50.109318]
-                                  description: Point
-                                - type: array
-                                  items:
-                                      type: array
-                                      items:
-                                          type: array
-                                          items:
-                                              type: number
-                                  example:
-                                    [[
-                                        [14.50823156003554, 50.10498927328214],
-                                        [14.505782430390298, 50.1031042405622],
-                                        [14.509701037821998, 50.1029471511537],
-                                        [14.50823156003554, 50.10498927328214]
-                                    ]]
-                                  description: Polygon
-                                - type: array
-                                  items:
-                                      type: array
-                                      items:
-                                          type: array
-                                          items:
-                                              type: array
-                                              items:
-                                                  type: number
-                                  example:
-                                    [
-                                        [[
-                                            [14.50823156003554, 50.10498927328214],
-                                            [14.505782430390298, 50.1031042405622],
-                                            [14.509701037821998, 50.1029471511537],
-                                            [14.50823156003554, 50.10498927328214]
-                                        ]],
-                                        [[
-                                            [14.50823156003554, 50.10498927328214],
-                                            [14.505782430390298, 50.1031042405622],
-                                            [14.509701037821998, 50.1029471511537],
-                                            [14.50823156003554, 50.10498927328214]
-                                        ]]
-                                    ]
-                                  description: MultiPolygon
-                        type:
-                            type: string
-                            enum:
-                                - Point
-                                - Polygon
-                                - MultiPolygon
-                properties:
-                    type: object
-                    properties:
-                        id:
-                            type: string
-                            example: 78267c44-62f1-41e8-be12-d8f919e7be20
-                        source:
-                            type: string
-                            example: tsk
-                        source_id:
-                            type: string
-                            example: "534002"
-                        data_provider:
-                            type: string
-                            nullable: true
-                            example: www.tsk-praha.cz
-                        name:
-                            type: string
-                            example: Holešovice
-                            nullable: true
-                        category:
-                            type: string
-                            nullable: true
-                            example: park_and_ride
-                        date_modified:
-                            type: string
-                            example: '2020-05-18T07:38:37.000Z'
-                            nullable: true
-                        address_formatted:
-                            type: string
-                            nullable: true
-                            example: 'Vrbenského, 17000 Praha Holešovice, Česko'
-                        address:
-                            type: object
-                            nullable: true
-                            properties:
-                                address_country:
-                                    type: string
-                                    example: Česko
-                                address_formatted:
-                                    type: string
-                                    example: Vrbenského, 17000 Praha Holešovice, Česko
-                                address_locality:
-                                    type: string
-                                    example: Praha
-                                address_region:
-                                    type: string
-                                    example: Holešovice
-                                postal_code:
-                                    type: string
-                                    example: 17000
-                                street_address:
-                                    type: string
-                                    example: Vrbenského
-                                house_number:
-                                    type: string
-                                    example: 123
-                        area_served:
-                            type: string
-                            nullable: true
-                        web_app_payment_url:
-                            type: string
-                            nullable: true
-                            example: 'https://ke-utc.appspot.com/static/select_offstreet.html?shortname=139'
-                        android_app_payment_url:
-                            type: string
-                            nullable: true
-                        ios_app_payment_url:
-                            type: string
-                            nullable: true
-                        total_spot_number:
-                            type: number
-                            example: 74
-                        tariff_id:
-                            type: string
-                            nullable: true
-                            example: 20
-                        valid_from:
-                            type: string
-                            nullable: true
-                            example: '2020-05-31T00:00:00.000Z'
-                        valid_to:
-                            type: string
-                            nullable: true
-                            example: '2022-05-31T00:00:00.000Z'
-                        parking_type:
-                            type: string
-                            enum:
-                                - park_and_ride
-                                - park_paid_private
-                                - on_street
-                                - park_sharing
-                                - disabled_parking
-                                - underground
-                                - other
-                        zone_type:
-                            type: string
-                            nullable: true
-                            enum:
-                                - zone_residential
-                                - zone_mixed
-                                - zone_visitors
-                                - zone_other
-                                - zone_free
-                                - null
-                        centroid:
-                            type: object
-                            properties:
-                                type:
-                                    type: string
-                                    example: Point
-                                coordinates:
-                                    type: array
-                                    items:
-                                        type: number
-                                        example: [14.441252, 50.109318]
-                        available_spots_last_updated:
-                            type: number
-                            nullable: true
-                            example: '2021-03-01T00:19:47+01:00'
-                        available_spots_number:
-                            type: number
-                            nullable: true
-                            example: 17
-                    required:
-                        - id
-                        - source
-                        - source_id
-                        - name
-                        - date_modified
-                        - parking_type
-                        - centroid
-                        - available_spots_last_updated
-                        - available_spots_number
-                type:
-                    type: string
-                    example: Feature
+                11:
+                    type: number
+                    example: 51
+                12:
+                    type: number
+                    example: 51
+                13:
+                    type: number
+                    example: 51
+                14:
+                    type: number
+                    example: 51
+                15:
+                    type: number
+                    example: 51
+                16:
+                    type: number
+                    example: 51
+                17:
+                    type: number
+                    example: 48
+                18:
+                    type: number
+                    example: 46
+                19:
+                    type: number
+                    example: 29
+                20:
+                    type: number
+                    example: 28
+                21:
+                    type: number
+                    example: 29
+                22:
+                    type: number
+                    example: 18
+                23:
+                    type: number
+                    example: 16
+        AverageOccupancyWeek:
+            type: object
+            nullable: true
+            properties:
+                0:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                1:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                2:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                3:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                4:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                5:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+                6:
+                    $ref: '#/components/schemas/AverageOccupancyDay'
+            description: "The day of the week (0 - 6; Sunday is 0)"
         ParkingMeasurement:
             title: Parking Measurement
             type: object
@@ -2752,3 +2201,201 @@ components:
                             type: string
                             nullable: true
                             example: "https://www.liberec.cz/cz/prakticke-informace/doprava-udrzba-komunikaci/parkovaci-mista/parkovaci-mista.html"
+        ParkingSpaceFeature:
+            type: object
+            properties:
+                geometry:
+                    type: object
+                    description: GeoJson geometry
+                    properties:
+
+                        coordinates:
+                            oneOf:
+                                - type: array
+                                  items:
+                                      type: number
+                                  example: [14.441252, 50.109318]
+                                  description: Point
+                                - type: array
+                                  items:
+                                      type: array
+                                      items:
+                                          type: array
+                                          items:
+                                              type: number
+                                  example:
+                                    [[
+                                        [14.50823156003554, 50.10498927328214],
+                                        [14.505782430390298, 50.1031042405622],
+                                        [14.509701037821998, 50.1029471511537],
+                                        [14.50823156003554, 50.10498927328214]
+                                    ]]
+                                  description: Polygon
+                                - type: array
+                                  items:
+                                      type: array
+                                      items:
+                                          type: array
+                                          items:
+                                              type: array
+                                              items:
+                                                  type: number
+                                  example:
+                                    [
+                                        [[
+                                            [14.50823156003554, 50.10498927328214],
+                                            [14.505782430390298, 50.1031042405622],
+                                            [14.509701037821998, 50.1029471511537],
+                                            [14.50823156003554, 50.10498927328214]
+                                        ]],
+                                        [[
+                                            [14.50823156003554, 50.10498927328214],
+                                            [14.505782430390298, 50.1031042405622],
+                                            [14.509701037821998, 50.1029471511537],
+                                            [14.50823156003554, 50.10498927328214]
+                                        ]]
+                                    ]
+                                  description: MultiPolygon
+                        type:
+                            type: string
+                            enum:
+                                - Point
+                                - Polygon
+                                - MultiPolygon
+                properties:
+                    type: object
+                    properties:
+                        id:
+                            type: string
+                            example: 78267c44-62f1-41e8-be12-d8f919e7be20
+                        source:
+                            type: string
+                            example: tsk
+                        source_id:
+                            type: string
+                            example: "534002"
+                        data_provider:
+                            type: string
+                            nullable: true
+                            example: www.tsk-praha.cz
+                        name:
+                            type: string
+                            example: Holešovice
+                            nullable: true
+                        category:
+                            type: string
+                            nullable: true
+                            example: park_and_ride
+                        date_modified:
+                            type: string
+                            example: '2020-05-18T07:38:37.000Z'
+                            nullable: true
+                        address_formatted:
+                            type: string
+                            nullable: true
+                            example: 'Vrbenského, 17000 Praha Holešovice, Česko'
+                        address:
+                            type: object
+                            nullable: true
+                            properties:
+                                address_country:
+                                    type: string
+                                    example: Česko
+                                address_formatted:
+                                    type: string
+                                    example: Vrbenského, 17000 Praha Holešovice, Česko
+                                address_locality:
+                                    type: string
+                                    example: Praha
+                                address_region:
+                                    type: string
+                                    example: Holešovice
+                                postal_code:
+                                    type: string
+                                    example: 17000
+                                street_address:
+                                    type: string
+                                    example: Vrbenského
+                                house_number:
+                                    type: string
+                                    example: 123
+                        area_served:
+                            type: string
+                            nullable: true
+                        web_app_payment_url:
+                            type: string
+                            nullable: true
+                            example: 'https://ke-utc.appspot.com/static/select_offstreet.html?shortname=139'
+                        android_app_payment_url:
+                            type: string
+                            nullable: true
+                        ios_app_payment_url:
+                            type: string
+                            nullable: true
+                        total_spot_number:
+                            type: number
+                            example: 74
+                        tariff_id:
+                            type: string
+                            nullable: true
+                            example: 20
+                        valid_from:
+                            type: string
+                            nullable: true
+                            example: '2020-05-31T00:00:00.000Z'
+                        valid_to:
+                            type: string
+                            nullable: true
+                            example: '2022-05-31T00:00:00.000Z'
+                        parking_type:
+                            type: string
+                            enum:
+                                - park_and_ride
+                                - park_paid_private
+                                - on_street
+                                - park_sharing
+                                - disabled_parking
+                                - underground
+                                - other
+                        zone_type:
+                            type: string
+                            nullable: true
+                            enum:
+                                - zone_residential
+                                - zone_mixed
+                                - zone_visitors
+                                - zone_other
+                                - zone_free
+                                - null
+                        centroid:
+                            type: object
+                            properties:
+                                type:
+                                    type: string
+                                    example: Point
+                                coordinates:
+                                    type: array
+                                    items:
+                                        type: number
+                                        example: [14.441252, 50.109318]
+                        available_spots_last_updated:
+                            type: number
+                            nullable: true
+                            example: '2021-03-01T00:19:47+01:00'
+                        available_spots_number:
+                            type: number
+                            nullable: true
+                            example: 17
+                    required:
+                        - id
+                        - source
+                        - source_id
+                        - name
+                        - date_modified
+                        - parking_type
+                        - centroid
+                        - available_spots_last_updated
+                        - available_spots_number
+                type:
+                    type: string
+                    example: Feature