@golemio/microclimate 1.1.3 → 1.1.4

package/docs/openapi.yaml

@@ -0,0 +1,298 @@
+openapi: 3.0.3
+
+info:
+    title: 🌡️ Microclimate
+    description: Microclimate info
+    version: 1.0.0
+    contact:
+        name: Golemio Prague Data Platform
+        email: golemio@operatorict.cz
+        url: https://golemio.cz
+
+servers:
+    - url: https://api.golemio.cz/v2
+      description: Main (production) server
+    - url: https://rabin.golemio.cz/v2
+      description: Test (development) server
+
+tags:
+    - name: 🌡️ Microclimate
+      description: 💡 Microclimate Sensors Info
+
+paths:
+    /microclimate/locations:
+        get:
+            summary: GET All Microclimate Sensor Locations
+            operationId: GETAllMicroclimateSensorLocations
+            description: ""
+            tags:
+                - 🌡️ Microclimate
+            parameters:
+                -   name: locationId
+                    in: query
+                    description: Filter by location
+                    required: false
+                    example: 130
+                    schema:
+                      type: number
+            responses:
+                "200":
+                    description: OK
+                    headers: {}
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                type: array
+                                items:
+                                    $ref: "#/components/schemas/Location"
+
+                "401":
+                    $ref: "#/components/responses/UnauthorizedError"
+                "403":
+                    $ref: "#/components/responses/ForbiddenError"
+
+    /microclimate/points:
+        get:
+            summary: GET Microclimate Sensor Points
+            operationId: GETMicroclimateSensorPoints
+            description: ""
+            tags:
+                - 🌡️ Microclimate
+            parameters:
+                -   name: locationId
+                    in: query
+                    description: Filter by location
+                    required: false
+                    example: 130
+                    schema:
+                        type: number
+                -   name: pointId
+                    in: query
+                    description: Filter by location
+                    required: false
+                    example: 131
+                    schema:
+                        type: number
+            responses:
+                "200":
+                    description: OK
+                    headers: {}
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                $ref: "#/components/schemas/Point"
+                "401":
+                    $ref: "#/components/responses/UnauthorizedError"
+                "403":
+                    $ref: "#/components/responses/ForbiddenError"
+
+    /microclimate/measurements:
+        get:
+            summary: GET All Microclimate Sensor Measurements
+            operationId: GETAllMicroclimateSensorMeasurements
+            description: ""
+            tags:
+                - 🌡️ Microclimate
+            parameters:
+                -   name: locationId
+                    in: query
+                    description: Filter by location
+                    required: false
+                    example: 130
+                    schema:
+                        type: number
+                -   name: pointId
+                    in: query
+                    description: Filter by location
+                    required: false
+                    example: 131
+                    schema:
+                        type: number
+                -   name: measure
+                    in: query
+                    description: Filter by measure type
+                    required: false
+                    example: air_temp200
+                    schema:
+                        type: string
+                -   name: from
+                    in: query
+                    description: Filter by measured_at
+                    required: false
+                    example: 2023-02-16T23:03:42.588Z
+                    schema:
+                        type: string
+                        format: date-time
+                -   name: to
+                    in: query
+                    description: Filter by measured_at
+                    required: false
+                    example: 2023-02-16T23:03:42.588Z
+                    schema:
+                        type: string
+                        format: date-time
+            responses:
+                "200":
+                    description: OK
+                    headers: {}
+                    content:
+                        application/json; charset=utf-8:
+                            schema:
+                                type: array
+                                items:
+                                    $ref: "#/components/schemas/Measurement"
+                "401":
+                    $ref: "#/components/responses/UnauthorizedError"
+                "403":
+                    $ref: "#/components/responses/ForbiddenError"
+components:
+    responses:
+        UnauthorizedError:
+            description: API key is missing or invalid
+            headers:
+                WWW_Authenticate:
+                    schema:
+                        type: string
+        ForbiddenError:
+            description: Forbidden
+            headers: { }
+            content:
+                application/json; charset=utf-8:
+                    schema:
+                        type: object
+                        properties:
+                            error_message:
+                                type: string
+                            error_status:
+                                type: number
+                        required:
+                            - error_message
+                            - error_status
+                    examples:
+                        response:
+                            value:
+                                error_message: Forbidden
+                                error_status: 403
+    schemas:
+        Location:
+            type: object
+            properties:
+                location_id:
+                    type: integer
+                    example: 130
+                location:
+                    type: string
+                    example: Pražská Holešovická tržnice
+                loc_description:
+                    type: string
+                    example: areál bez zeleně
+                loc_orientation:
+                    type: string
+                    example: východ-západ
+                loc_surface:
+                    type: string
+                    example: asfalt/beton
+                address:
+                    type: string
+                    example: Pražská tržnice
+                points:
+                    type: array
+                    items:
+                        type: object
+                        properties:
+                            point_id:
+                                type: integer
+                                example: 131
+                            point_name:
+                                type: string
+                                example: Pražská tržnice osvětlení
+            required:
+                - location_id
+        Point:
+            type: object
+            properties:
+                point_id:
+                    type: integer
+                    example: 131
+                location_id:
+                    type: integer
+                    example: 130
+                point_named:
+                    type: string
+                    example: Pražská tržnice osvětlení
+                location:
+                    type: string
+                    example: Pražská Holešovická tržnice
+                loc_description:
+                    type: string
+                    example: areál bez zeleně
+                loc_orientation:
+                    type: string
+                    example:  východ-západ
+                loc_surface:
+                    type: string
+                    example: asfalt/beton
+                lat:
+                    type: number
+                    example: 50.098934
+                lng:
+                    type: number
+                    example: 14.445023
+                x_jtsk:
+                    type: number
+                    example: -741926.70
+                y_jtsk:
+                    type: number
+                    example: -1040946.85
+                elevation_m:
+                    type: number
+                    example: 184.3
+                measures:
+                    type: array
+                    items:
+                        type: object
+                        properties:
+                            measure:
+                                type: string
+                                example: air_temp200
+                            measure_cz:
+                                type: string
+                                example: Teplota vzduchu
+                            unit:
+                                type: string
+                                example: °C
+                        required:
+                            - measure
+                            - unit
+                sensor_position:
+                    type: string
+                    example: veřejné osvětlení
+                sensor_position_detail:
+                    type: string
+                    example: veřejné osvětlení ve středu Tržnice
+            required:
+                - point_id
+                - location_id
+        Measurement:
+            type: object
+            properties:
+                point_id:
+                    type: number
+                    example: 131
+                location_id:
+                    type: number
+                    example: 130
+                measured_at:
+                    type: string
+                    example: 2022-08-21T17:30:00.000Z
+                measure:
+                    type: string
+                    example: air_temp200
+                value:
+                    type: number
+                    example: 20
+                unit:
+                    type: string
+                    example: °C
+            required:
+                - measured_at

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/microclimate",
-    "version": "1.1.3",
+    "version": "1.1.4",
     "description": "Golemio Microclimate Module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -71,4 +71,4 @@
     "dependencies": {
         "geojson": "^0.5.0"
     }
-}
+}