@golemio/energetics 1.3.5-dev.1300843460 → 1.3.5

package/docs/openapi-output.yaml

@@ -1,834 +0,0 @@
-openapi: 3.0.3
-info:
-    title: ⚡ Energetics API
-    description: >-
-        <p> ⚡ Energetics </p>
-    version: 1.0.0
-    contact:
-        name: Golemio Prague Data Platform
-        email: golemio@operatorict.cz
-        url: https://golemio.cz
-servers:
-    - url: https://rabin.golemio.cz/v2
-      description: Test (development) server
-    - url: https://api.golemio.cz/v2
-      description: Main (production) server
-tags:
-    - name: ⚡ Energetics (v2)
-      description: 💡 Organizations & measurement devices
-paths:
-    /v2/buildings:
-        get:
-            tags:
-                - ⚡ Energetics (v2)
-            summary: Get all buildings
-            parameters:
-                - name: full
-                  in: query
-                  description: Display full buildings data.
-                  required: false
-                  schema:
-                      type: boolean
-                      default: false
-                      example: false
-            responses:
-                "200":
-                    description: OK
-                    content:
-                        application/json:
-                            schema:
-                                type: array
-                                items:
-                                    $ref: "#/components/schemas/Building"
-
-    /v2/buildings/{id}:
-        get:
-            tags:
-                - ⚡ Energetics (v2)
-            summary: Get a building by ID
-            parameters:
-                - in: path
-                  name: id
-                  required: true
-                  schema:
-                      type: number
-                      example: 100
-            responses:
-                "200":
-                    description: OK
-                    content:
-                        application/json:
-                            schema:
-                                $ref: "#/components/schemas/IFullTransformationSchemaItem"
-
-    /v2/energetics/devices:
-        get:
-            tags:
-                - ⚡ Energetics (v2)
-            summary: List of measurement devices
-            responses:
-                '200':
-                    description: Success
-                    content:
-                        application/json:
-                            schema:
-                                type: array
-                                items:
-                                    $ref: '#/components/schemas/EnergeticsDevice'
-                '401':
-                    $ref: "#/components/responses/UnauthorizedError"
-                '500':
-                    $ref: "#/components/responses/ServerError"
-
-    /v2/energetics/devices/{deviceId}:
-        get:
-            tags:
-                - ⚡ Energetics (v2)
-            summary: Measurement device info
-            parameters:
-                -   name: deviceId
-                    in: path
-                    description: Id of device
-                    required: true
-                    schema:
-                        type: integer
-                        format: int32
-                        example: 16
-            responses:
-                '200':
-                    description: Success
-                    content:
-                        application/json:
-                            schema:
-                                $ref: '#/components/schemas/EnergeticsDevice'
-                '401':
-                    $ref: "#/components/responses/UnauthorizedError"
-                '404':
-                    $ref: "#/components/responses/NotFoundError"
-                '500':
-                    $ref: "#/components/responses/ServerError"
-
-    /v2/energetics/organizations:
-        get:
-            tags:
-                - ⚡ Energetics (v2)
-            summary: List of organizations in brief or full format
-            parameters:
-                -   name: full
-                    in: query
-                    description: Display full organization data.
-                    required: false
-                    schema:
-                        type: boolean
-                        default: false
-                        example: false
-            responses:
-                '200':
-                    description: Success
-                    content:
-                        application/json:
-                            schema:
-                                anyOf:
-                                    -   type: array
-                                        items:
-                                            $ref: '#/components/schemas/EnergeticsOrganizationShort'
-                                    -   type: array
-                                        items:
-                                            $ref: '#/components/schemas/EnergeticsOrganizationFull'
-                '401':
-                    $ref: "#/components/responses/UnauthorizedError"
-                '500':
-                    $ref: "#/components/responses/ServerError"
-
-    /v2/energetics/organizations/{organizationId}:
-        get:
-            tags:
-                - ⚡ Energetics (v2)
-            summary: Organization detail
-            parameters:
-                -   name: organizationId
-                    in: path
-                    description: Id of organization
-                    required: true
-                    schema:
-                        type: integer
-                        format: int32
-                        example: 1
-            responses:
-                '200':
-                    description: Success
-                    content:
-                        application/json:
-                            schema:
-                                $ref: '#/components/schemas/EnergeticsOrganizationFull'
-                '400':
-                    $ref: "#/components/responses/BadRequestError"
-                '401':
-                    $ref: "#/components/responses/UnauthorizedError"
-                '404':
-                    $ref: "#/components/responses/NotFoundError"
-                '500':
-                    $ref: "#/components/responses/ServerError"
-
-components:
-    responses:
-        UnauthorizedError:
-            description: API key is missing or invalid
-            content:
-                application/json; charset=utf-8:
-                    schema:
-                        type: object
-                        properties:
-                            error_message:
-                                type: string
-                                example: Unauthorized
-                            error_status:
-                                type: number
-                                example: 401
-                            error_info:
-                                type: string
-        NotFoundError:
-            description: Record not found
-            content:
-                application/json; charset=utf-8:
-                    schema:
-                        type: object
-                        properties:
-                            error_message:
-                                type: string
-                                example: Not fount
-                            error_status:
-                                type: number
-                                example: 404
-                            error_info:
-                                type: string
-                                example: 'Record with id 1 not fount'
-        BadRequestError:
-            description: Bad request
-            content:
-                application/json; charset=utf-8:
-                    schema:
-                        type: object
-                        properties:
-                            error_message:
-                                type: string
-                                example: Bad request
-                            error_status:
-                                type: number
-                                example: 400
-                            error_info:
-                                type: string
-                                example: '{"limit":{"location":"query","param":"limit","value":"-2","msg":"Invalid value"}}'
-        ServerError:
-            description: Server error
-            content:
-                application/json; charset=utf-8:
-                    schema:
-                        type: object
-                        properties:
-                            error_message:
-                                type: string
-                                example: Server error
-                            error_status:
-                                type: number
-                                example: 500
-                            error_info:
-                                type: string
-
-    schemas:
-        Building:
-            type: object
-            properties:
-                id:
-                    type: number
-                name:
-                    type: string
-                buildingAddressCode:
-                    type: string
-                link:
-                    type: string
-        IFullTransformationSchemaItem:
-            type: object
-            properties:
-                id:
-                    type: number
-                name:
-                    type: string
-                    nullable: true
-                mainUse:
-                    type: string
-                    nullable: true
-                methodOfProtection:
-                    type: string
-                    nullable: true
-                address:
-                    type: object
-                    properties:
-                        city:
-                            type: string
-                            nullable: true
-                        country:
-                            type: string
-                            nullable: true
-                        houseNumber:
-                            type: string
-                            nullable: true
-                        mail:
-                            type: string
-                            nullable: true
-                        phone:
-                            type: string
-                            nullable: true
-                        street:
-                            type: string
-                            nullable: true
-                        webAddress:
-                            type: string
-                            nullable: true
-                    nullable: true
-                allotmentNumber:
-                    type: number
-                    nullable: true
-                bedsCount:
-                    type: number
-                    nullable: true
-                buildingAddressCode:
-                    type: string
-                    nullable: true
-                buildingEnvelope:
-                    type: object
-                    properties:
-                        fillingOfHole:
-                            type: object
-                            properties:
-                                area:
-                                    type: number
-                                    nullable: true
-                                construction:
-                                    type: string
-                                    nullable: true
-                                technicalCondition:
-                                    type: string
-                                    nullable: true
-                                yearOfAdjustment:
-                                    type: string
-                                    nullable: true
-                            nullable: true
-                        floorOfTheLowestHeatedFloor:
-                            type: object
-                            properties:
-                                area:
-                                    type: number
-                                    nullable: true
-                                construction:
-                                    type: string
-                                    nullable: true
-                                yearOfAdjustment:
-                                    type: string
-                                    nullable: true
-                                technicalCondition:
-                                    type: string
-                                    nullable: true
-                                thermalInsulation:
-                                    type: string
-                                    nullable: true
-                            nullable: true
-                        roof:
-                            type: object
-                            properties:
-                                area:
-                                    type: number
-                                    nullable: true
-                                construction:
-                                    type: string
-                                    nullable: true
-                                technicalCondition:
-                                    type: string
-                                    nullable: true
-                                thermalInsulation:
-                                    type: string
-                                    nullable: true
-                                yearOfAdjustment:
-                                    type: string
-                                    nullable: true
-                            nullable: true
-                        sideWall:
-                            type: object
-                            properties:
-                                area:
-                                    type: number
-                                    nullable: true
-                                heatInsulation:
-                                    type: string
-                                    nullable: true
-                                prevailingConstruction:
-                                    type: string
-                                    nullable: true
-                                technicalCondition:
-                                    type: string
-                                    nullable: true
-                                yearOfAdjustment:
-                                    type: string
-                                    nullable: true
-                            nullable: true
-                    nullable: true
-                label:
-                    type: string
-                    nullable: true
-                builtUpArea:
-                    type: number
-                    nullable: true
-                classroomsCount:
-                    type: number
-                    nullable: true
-                csuCode:
-                    type: string
-                    nullable: true
-                currentNote:
-                    type: string
-                    nullable: true
-                description:
-                    type: string
-                    nullable: true
-                employeesCount:
-                    type: number
-                    nullable: true
-                energeticManagement:
-                    type: string
-                    nullable: true
-                energyAudits:
-                    type: object
-                    properties:
-                        createdAt:
-                            type: string
-                            nullable: true
-                        eaRegistrationNumber:
-                            type: number
-                            nullable: true
-                        energyAudit:
-                            type: string
-                            nullable: true
-                    nullable: true
-                enoId:
-                    type: string
-                    nullable: true
-                fuelAndEnergy:
-                    type: object
-                    properties:
-                        coal:
-                            type: boolean
-                            nullable: true
-                        czt:
-                            type: boolean
-                            nullable: true
-                        electricity:
-                            type: boolean
-                            nullable: true
-                        gas:
-                            type: boolean
-                            nullable: true
-                        other:
-                            type: boolean
-                            nullable: true
-                        oze:
-                            type: boolean
-                            nullable: true
-                    nullable: true
-                heatedBuldingVolume:
-                    type: number
-                    nullable: true
-                kuCode:
-                    type: string
-                    nullable: true
-                location:
-                    type: string
-                    nullable: true
-                link:
-                    type: string
-                ozeEnergyProduction:
-                    type: object
-                    properties:
-                        heatPump:
-                            type: string
-                            nullable: true
-                        integratedTurbinesWindEnergy:
-                            type: string
-                            nullable: true
-                        solarEnergyPhotothermal:
-                            type: string
-                            nullable: true
-                        solarEnergyPhotovoltaic:
-                            type: string
-                            nullable: true
-                    nullable: true
-                penb:
-                    type: object
-                    properties:
-                        buildingEnvelope:
-                            type: number
-                            nullable: true
-                        buildingEnvelopeCategory:
-                            type: string
-                            nullable: true
-                        cooling:
-                            type: number
-                            nullable: true
-                        coolingCategory:
-                            type: string
-                            nullable: true
-                        heating:
-                            type: number
-                            nullable: true
-                        heatingCategory:
-                            type: string
-                            nullable: true
-                        humidityAdjustment:
-                            type: number
-                            nullable: true
-                        humidityAdjustmentCategory:
-                            type: string
-                            nullable: true
-                        issueDate:
-                            type: string
-                            nullable: true
-                        lighting:
-                            type: number
-                            nullable: true
-                        lightingCategory:
-                            type: string
-                            nullable: true
-                        penbNumber:
-                            type: number
-                            nullable: true
-                        primaryNonRenewableEnergy:
-                            type: number
-                            nullable: true
-                        primaryNonRenewableEnergyCategory:
-                            type: string
-                            nullable: true
-                        totalBuildingEnvelopeArea:
-                            type: number
-                            nullable: true
-                        totalEnergyReferenceArea:
-                            type: number
-                            nullable: true
-                        totalProvidedEnergy:
-                            type: number
-                            nullable: true
-                        totalProvidedEnergyCategory:
-                            type: string
-                            nullable: true
-                        ventilation:
-                            type: number
-                            nullable: true
-                        ventilationCategory:
-                            type: string
-                            nullable: true
-                        volumeFactorOfAVShape:
-                            type: string
-                            nullable: true
-                        warmWater:
-                            type: number
-                            nullable: true
-                        warmWaterCategory:
-                            type: string
-                            nullable: true
-                    nullable: true
-                registrationUnit:
-                    type: string
-                    nullable: true
-                secondaryUse:
-                    type: string
-                    nullable: true
-                studentsCount:
-                    type: number
-                    nullable: true
-                technicalEquipment:
-                    type: object
-                    properties:
-                        cooling:
-                            type: object
-                            properties:
-                                coolingAreaPercentage:
-                                    type: number
-                                    nullable: true
-                                coolingSystem:
-                                    type: string
-                                    nullable: true
-                                technicalCondition:
-                                    type: string
-                                    nullable: true
-                                year:
-                                    type: string
-                                    nullable: true
-                            nullable: true
-                        heating:
-                            type: object
-                            properties:
-                                heatPercentage:
-                                    type: number
-                                    nullable: true
-                                heatingSystem:
-                                    type: string
-                                    nullable: true
-                                mainSourceOfHeat:
-                                    type: string
-                                    nullable: true
-                                secondarySourceOfHeat:
-                                    type: string
-                                    nullable: true
-                                technicalCondition:
-                                    type: string
-                                    nullable: true
-                                year:
-                                    type: string
-                                    nullable: true
-                            nullable: true
-                        hotWater:
-                            type: object
-                            properties:
-                                hotWaterSource:
-                                    type: string
-                                    nullable: true
-                                predominantWayOfHeatingTv:
-                                    type: string
-                                    nullable: true
-                                technicalCondition:
-                                    type: string
-                                    nullable: true
-                                year:
-                                    type: string
-                                    nullable: true
-                            nullable: true
-                        humidityAdjustment:
-                            type: object
-                            properties:
-                                humidityAdjustment:
-                                    type: string
-                                    nullable: true
-                                technicalCondition:
-                                    type: string
-                                    nullable: true
-                                year:
-                                    type: string
-                                    nullable: true
-                            nullable: true
-                        lighting:
-                            type: object
-                            properties:
-                                lighting:
-                                    type: string
-                                    nullable: true
-                                measurementMethod:
-                                    type: string
-                                    nullable: true
-                                otherTechnologicalElements:
-                                    type: string
-                                    nullable: true
-                                technicalCondition:
-                                    type: string
-                                    nullable: true
-                                year:
-                                    type: string
-                                    nullable: true
-                            nullable: true
-                        ventilation:
-                            type: object
-                            properties:
-                                technicalCondition:
-                                    type: string
-                                    nullable: true
-                                ventilation:
-                                    type: string
-                                    nullable: true
-                                year:
-                                    type: string
-                                    nullable: true
-                            nullable: true
-                    nullable: true
-                wasteAndEmissions:
-                    type: object
-                    properties:
-                        operatingCo2Emissions:
-                            type: string
-                            nullable: true
-                        solidWasteProduction:
-                            type: string
-                            nullable: true
-                        soxEmissions:
-                            type: string
-                            nullable: true
-                        tiedCo2Emissions:
-                            type: string
-                            nullable: true
-                    nullable: true
-                weekendOpeningHours:
-                    type: string
-                    nullable: true
-                openingHours:
-                    type: string
-                    nullable: true
-                yearOfConstruction:
-                    type: number
-                    nullable: true
-        EnergeticsAddress:
-            type: object
-            properties:
-                street:
-                    type: string
-                    nullable: true
-                house_number:
-                    type: string
-                    nullable: true
-                city:
-                    type: string
-                    nullable: true
-                country:
-                    type: string
-                    nullable: true
-                mail:
-                    type: string
-                    nullable: true
-                phone:
-                    type: string
-                    nullable: true
-                web_address:
-                    type: string
-                    nullable: true
-            additionalProperties: false
-        EnergeticsBuildingShort:
-            type: object
-            properties:
-                id:
-                    type: integer
-                    format: int32
-                name:
-                    type: string
-                    nullable: true
-                building_address_code:
-                    type: string
-                    nullable: true
-                link:
-                    type: string
-                    nullable: true
-            additionalProperties: false
-        EnergeticsDevice:
-            type: object
-            properties:
-                id:
-                    type: integer
-                    format: int32
-                addr:
-                    type: string
-                    nullable: true
-                description:
-                    type: string
-                    nullable: true
-                meter_number:
-                    type: string
-                    nullable: true
-                meter_index:
-                    type: integer
-                    format: int32
-                    nullable: true
-                location_number:
-                    type: string
-                    nullable: true
-                location_description:
-                    type: string
-                    nullable: true
-                include_in_evaluation:
-                    type: string
-                    nullable: true
-                meter_type:
-                    type: string
-                    nullable: true
-                category:
-                    type: string
-                    nullable: true
-                unit:
-                    type: string
-                    nullable: true
-                replaced_meter_id:
-                    type: string
-                    nullable: true
-                deleted:
-                    type: string
-                    nullable: true
-                building_id:
-                    type: integer
-                    format: int32
-                    nullable: true
-            additionalProperties: false
-        EnergeticsOrganizationFull:
-            type: object
-            properties:
-                id:
-                    type: integer
-                    format: int32
-                name:
-                    type: string
-                    nullable: true
-                label:
-                    type: string
-                    nullable: true
-                category:
-                    type: string
-                    nullable: true
-                created_by_id:
-                    type: string
-                    nullable: true
-                grafana_url:
-                    type: string
-                    nullable: true
-                address:
-                    $ref: '#/components/schemas/EnergeticsAddress'
-                responsible_user:
-                    type: array
-                    items:
-                        $ref: '#/components/schemas/EnergeticsUser'
-                    nullable: true
-                buildings:
-                    type: array
-                    items:
-                        $ref: '#/components/schemas/EnergeticsBuildingShort'
-                    nullable: true
-                link:
-                    type: string
-                    nullable: true
-            additionalProperties: false
-        EnergeticsOrganizationShort:
-            type: object
-            properties:
-                id:
-                    type: integer
-                    format: int32
-                name:
-                    type: string
-                    nullable: true
-                link:
-                    type: string
-                    nullable: true
-            additionalProperties: false
-        EnergeticsUser:
-            type: object
-            properties:
-                name:
-                    type: string
-                    nullable: true
-                last_name:
-                    type: string
-                    nullable: true
-                position:
-                    type: string
-                    nullable: true
-                phone:
-                    type: string
-                    nullable: true
-                mail:
-                    type: string
-                    nullable: true
-                company:
-                    type: string
-                    nullable: true
-            additionalProperties: false