123

mail@pastecode.io avatar
unknown
plain_text
2 years ago
67 kB
2
Indexable
Never
components:
  examples: {}
  headers: {}
  parameters: {}
  requestBodies: {}
  responses: {}
  schemas:
    IResultWithUrl:
      properties:
        result:
          properties:
            url:
              type: string
          required:
            - url
          type: object
      required:
        - result
      type: object
      additionalProperties: true
    IErrorResponse_string_:
      properties:
        errorMessage:
          type: string
      required:
        - errorMessage
      type: object
      additionalProperties: true
    Sector:
      enum:
        - commerce
        - industry
        - electricHeat
        - household
        - agriculture
        - streetLighting
      type: string
    Nullable_number_:
      type: number
      format: double
      nullable: true
    IETLTimerange:
      properties:
        begin:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
      required:
        - begin
        - end
      type: object
      additionalProperties: true
    IElectricityConsumptionData:
      properties:
        sector:
          $ref: '#/components/schemas/Sector'
        consumption:
          type: number
          format: double
        countInstallations:
          type: number
          format: double
        countPrivateInstallations:
          $ref: '#/components/schemas/Nullable_number_'
        timerange:
          $ref: '#/components/schemas/IETLTimerange'
      required:
        - sector
        - consumption
        - countInstallations
        - timerange
      type: object
      additionalProperties: true
    EnergyCarrier:
      enum:
        - water
        - photovoltaics
        - biomass
        - wind
        - landfillSewageGas
      type: string
    IElectricityFeedInData:
      properties:
        energyCarrier:
          $ref: '#/components/schemas/EnergyCarrier'
        feedIn:
          type: number
          format: double
        countInstallations:
          type: number
          format: double
        countPrivateInstallations:
          $ref: '#/components/schemas/Nullable_number_'
        installedCapacity:
          type: number
          format: double
        monetaryCompensation:
          type: number
          format: double
        timerange:
          $ref: '#/components/schemas/IETLTimerange'
      required:
        - energyCarrier
        - feedIn
        - countInstallations
        - installedCapacity
        - monetaryCompensation
        - timerange
      type: object
      additionalProperties: true
    IElectricityETLData:
      properties:
        consumption:
          items:
            $ref: '#/components/schemas/IElectricityConsumptionData'
          type: array
        feedIn:
          items:
            $ref: '#/components/schemas/IElectricityFeedInData'
          type: array
      required:
        - consumption
        - feedIn
      type: object
      additionalProperties: true
    IElectricityETL:
      properties:
        ags:
          type: string
        calculationId:
          type: string
        data:
          $ref: '#/components/schemas/IElectricityETLData'
      required:
        - ags
        - calculationId
        - data
      type: object
      additionalProperties: true
    IGasConsumptionData:
      properties:
        sector:
          $ref: '#/components/schemas/Sector'
        consumption:
          type: number
          format: double
        countInstallations:
          type: number
          format: double
        countPrivateInstallations:
          $ref: '#/components/schemas/Nullable_number_'
        timerange:
          $ref: '#/components/schemas/IETLTimerange'
      required:
        - sector
        - consumption
        - countInstallations
        - timerange
      type: object
      additionalProperties: true
    IGasETLData:
      properties:
        consumption:
          items:
            $ref: '#/components/schemas/IGasConsumptionData'
          type: array
      required:
        - consumption
      type: object
      additionalProperties: true
    IGasETL:
      properties:
        ags:
          type: string
        calculationId:
          type: string
        data:
          $ref: '#/components/schemas/IGasETLData'
      required:
        - ags
        - calculationId
        - data
      type: object
      additionalProperties: true
    DataCategory:
      enum:
        - installation
        - energyMonitor
      type: string
    IEtlStatus:
      properties:
        result:
          properties:
            status:
              type: string
          required:
            - status
          type: object
      required:
        - result
      type: object
      additionalProperties: true
    IEtlCalculation:
      properties:
        result:
          properties:
            status:
              type: boolean
          required:
            - status
          type: object
      required:
        - result
      type: object
      additionalProperties: true
    Compare:
      properties:
        selectedYearValue:
          type: number
          format: double
          nullable: true
        referenceYearValue:
          type: number
          format: double
          nullable: true
        relativeChange:
          type: number
          format: double
          nullable: true
      required:
        - selectedYearValue
        - referenceYearValue
        - relativeChange
      type: object
      additionalProperties: true
    SummaryCompare:
      properties:
        electricityConsumption:
          $ref: '#/components/schemas/Compare'
        electricityFeedin:
          $ref: '#/components/schemas/Compare'
        feedinConsumptionRatio:
          $ref: '#/components/schemas/Compare'
        installedCapacity:
          $ref: '#/components/schemas/Compare'
        co2Savings:
          $ref: '#/components/schemas/Compare'
        monetaryCompensation:
          $ref: '#/components/schemas/Compare'
        countInstallations:
          $ref: '#/components/schemas/Compare'
        countConsumer:
          $ref: '#/components/schemas/Compare'
        gasConsumption:
          $ref: '#/components/schemas/Compare'
        gasCountConsumer:
          $ref: '#/components/schemas/Compare'
      required:
        - electricityConsumption
        - electricityFeedin
        - feedinConsumptionRatio
        - installedCapacity
        - co2Savings
        - monetaryCompensation
        - countInstallations
        - countConsumer
        - gasConsumption
        - gasCountConsumer
      type: object
      additionalProperties: true
    ISuccessEnvelope_SummaryCompare-or-null_:
      properties:
        result:
          allOf:
            - $ref: '#/components/schemas/SummaryCompare'
          nullable: true
      required:
        - result
      type: object
      additionalProperties: true
    Co2Savings:
      properties:
        year:
          type: number
          format: double
        photovoltaics:
          $ref: '#/components/schemas/Nullable_number_'
        wind:
          $ref: '#/components/schemas/Nullable_number_'
        water:
          $ref: '#/components/schemas/Nullable_number_'
        biomass:
          $ref: '#/components/schemas/Nullable_number_'
      required:
        - year
        - photovoltaics
        - wind
        - water
        - biomass
      type: object
      additionalProperties: true
    ISuccessEnvelope_Array_Co2Savings__:
      properties:
        result:
          items:
            $ref: '#/components/schemas/Co2Savings'
          type: array
      required:
        - result
      type: object
      additionalProperties: true
    AggregationLevel:
      enum:
        - year
        - month
      type: string
    IRegionInstallationsResult:
      properties:
        ownerType:
          type: string
        installedCapacity:
          type: number
          format: double
        comissioningDate:
          type: string
          format: date-time
      required:
        - ownerType
        - installedCapacity
        - comissioningDate
      type: object
      additionalProperties: true
    ISuccessEnvelope_IRegionInstallationsResult_:
      properties:
        result:
          $ref: '#/components/schemas/IRegionInstallationsResult'
      required:
        - result
      type: object
      additionalProperties: true
    IRegionsClusterResult:
      properties:
        ownerType:
          type: string
        installedCapacity:
          type: number
          format: double
      required:
        - ownerType
        - installedCapacity
      type: object
      additionalProperties: true
    ISuccessEnvelope_IRegionsClusterResult_:
      properties:
        result:
          $ref: '#/components/schemas/IRegionsClusterResult'
      required:
        - result
      type: object
      additionalProperties: true
    IFeedInConsumptionResult:
      properties:
        year:
          anyOf:
            - type: number
              format: double
            - items:
                type: number
                format: double
              type: array
        feedIn:
          $ref: '#/components/schemas/Nullable_number_'
        consumption:
          $ref: '#/components/schemas/Nullable_number_'
        feedinConsumptionRatio:
          $ref: '#/components/schemas/Nullable_number_'
        month:
          type: string
      required:
        - year
        - feedIn
        - consumption
        - feedinConsumptionRatio
      type: object
      additionalProperties: true
    ISuccessEnvelope_IFeedInConsumptionResult-Array-or-null_:
      properties:
        result:
          items:
            $ref: '#/components/schemas/IFeedInConsumptionResult'
          type: array
          nullable: true
      required:
        - result
      type: object
      additionalProperties: true
    IConsumptionResult:
      properties:
        year:
          $ref: '#/components/schemas/Nullable_number_'
        commerce:
          $ref: '#/components/schemas/Nullable_number_'
        industry:
          $ref: '#/components/schemas/Nullable_number_'
        household:
          $ref: '#/components/schemas/Nullable_number_'
        agriculture:
          $ref: '#/components/schemas/Nullable_number_'
        streetLighting:
          $ref: '#/components/schemas/Nullable_number_'
        electricHeat:
          $ref: '#/components/schemas/Nullable_number_'
        month:
          type: string
      required:
        - year
        - commerce
        - industry
        - household
        - agriculture
        - streetLighting
        - electricHeat
      type: object
      additionalProperties: true
    ISuccessEnvelope_IConsumptionResult-Array_:
      properties:
        result:
          items:
            $ref: '#/components/schemas/IConsumptionResult'
          type: array
      required:
        - result
      type: object
      additionalProperties: true
    EDivision:
      enum:
        - electricity
        - gas
      type: string
    IFeedInResult:
      properties:
        year:
          $ref: '#/components/schemas/Nullable_number_'
        photovoltaics:
          $ref: '#/components/schemas/Nullable_number_'
        wind:
          $ref: '#/components/schemas/Nullable_number_'
        water:
          $ref: '#/components/schemas/Nullable_number_'
        biomass:
          $ref: '#/components/schemas/Nullable_number_'
        month:
          type: string
      required:
        - year
        - photovoltaics
        - wind
        - water
        - biomass
      type: object
      additionalProperties: true
    ISuccessEnvelope_IFeedInResult-Array_:
      properties:
        result:
          items:
            $ref: '#/components/schemas/IFeedInResult'
          type: array
      required:
        - result
      type: object
      additionalProperties: true
    IInstallationTypeData:
      properties:
        value:
          $ref: '#/components/schemas/Nullable_number_'
        exact:
          type: boolean
      required:
        - value
        - exact
      type: object
      additionalProperties: true
    ICountInstallationsResult:
      properties:
        year:
          type: number
          format: double
        water:
          $ref: '#/components/schemas/IInstallationTypeData'
        photovoltaics:
          $ref: '#/components/schemas/IInstallationTypeData'
        biomass:
          $ref: '#/components/schemas/IInstallationTypeData'
        wind:
          $ref: '#/components/schemas/IInstallationTypeData'
      required:
        - year
        - water
        - photovoltaics
        - biomass
        - wind
      type: object
      additionalProperties: true
    ISuccessEnvelope_ICountInstallationsResult-Array_:
      properties:
        result:
          items:
            $ref: '#/components/schemas/ICountInstallationsResult'
          type: array
      required:
        - result
      type: object
      additionalProperties: true
    MinMax:
      properties:
        min:
          type: number
          format: double
        max:
          type: number
          format: double
      required:
        - min
        - max
      type: object
      additionalProperties: true
    ISuccessEnvelope_MinMax_:
      properties:
        result:
          $ref: '#/components/schemas/MinMax'
      required:
        - result
      type: object
      additionalProperties: true
    ISuccessEnvelope__documentId-string--documentName-string__:
      properties:
        result:
          properties:
            documentName:
              type: string
            documentId:
              type: string
          required:
            - documentName
            - documentId
          type: object
      required:
        - result
      type: object
      additionalProperties: true
    SpicetechGridRequestType:
      enum:
        - gas
        - electricity
      type: string
  securitySchemes:
    BEARER:
      type: apiKey
      name: Authorization
      in: header
    ETL_SECRET:
      type: apiKey
      name: Authorization
      in: header
    MESSAGE_SECRET:
      type: apiKey
      name: Authorization
      in: header
info:
  title: energy-gridconnection
  version: 1.0.0
  license:
    name: SEE LICENSE IN <LICENSE.md>>
  contact:
    name: Berkay Uener
openapi: 3.0.0
paths:
  /status:
    get:
      operationId: GetWelcome
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
      tags:
        - docs
      security: []
      parameters: []
  /contract/swagger:
    get:
      operationId: GetSwaggerContract
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
      tags:
        - docs
      security: []
      parameters: []
  /etl/installations:
    post:
      operationId: FillInstallations
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/IResultWithUrl'
                  - {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - etl
      security:
        - ETL_SECRET: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema: {}
  /etl/emission-factor:
    post:
      operationId: FillEmissions
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/IResultWithUrl'
                  - {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - etl
      security:
        - ETL_SECRET: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              items: {}
              type: array
  /etl/feedin:
    post:
      operationId: FillFeedin
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/IResultWithUrl'
                  - {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - etl
      deprecated: true
      security:
        - ETL_SECRET: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema: {}
  /etl/consumption:
    post:
      operationId: FillConsumption
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/IResultWithUrl'
                  - {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - etl
      deprecated: true
      security:
        - ETL_SECRET: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema: {}
  /etl/electricity:
    post:
      operationId: FillElectricity
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/IResultWithUrl'
                  - {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - etl
      security:
        - ETL_SECRET: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IElectricityETL'
  /etl/gas:
    post:
      operationId: FillGas
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/IResultWithUrl'
                  - {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - etl
      security:
        - ETL_SECRET: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IGasETL'
  /etl/data-version:
    get:
      operationId: GetDataVersion
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - etl
      security:
        - ETL_SECRET: []
      parameters:
        - in: query
          name: regionId
          required: true
          schema:
            type: string
        - in: query
          name: category
          required: true
          schema:
            $ref: '#/components/schemas/DataCategory'
        - in: query
          name: type
          required: true
          schema:
            type: string
            enum:
              - gas
              - electricity
  /etl/job/status/{jobId}:
    get:
      operationId: GetEtlJobState
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IEtlStatus'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - etl
      security:
        - ETL_SECRET: []
      parameters:
        - in: path
          name: jobId
          required: true
          schema:
            type: string
  /etl/job/status/calculation/{calculationId}:
    get:
      operationId: GetEtlCalculationState
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IEtlCalculation'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - etl
      security:
        - ETL_SECRET: []
      parameters:
        - in: query
          name: type
          required: true
          schema:
            type: string
        - in: path
          name: calculationId
          required: true
          schema:
            type: string
  /regions/{regionId}/summary/compare:
    get:
      operationId: GetCompareSummary
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_SummaryCompare-or-null_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: query
          name: selectedYear
          required: true
          schema:
            format: double
            type: number
        - in: query
          name: referenceYear
          required: true
          schema:
            format: double
            type: number
        - in: path
          name: regionId
          required: true
          schema:
            type: string
  /regions/{regionId}/feed-in-consumption/co2-savings:
    get:
      operationId: GetCo2Savings
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_Array_Co2Savings__'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: query
          name: aggregation_level
          required: false
          schema:
            $ref: '#/components/schemas/AggregationLevel'
        - in: query
          name: year
          required: false
          schema:
            type: array
            items:
              type: number
              format: double
  /regions/{regionId}/installations/{installationId}:
    get:
      operationId: GetInstallation
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ISuccessEnvelope_IRegionInstallationsResult_'
                  - {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: path
          name: installationId
          required: true
          schema:
            type: string
  /regions/{regionId}/installations/cluster/{clusterId}:
    get:
      operationId: GetClusterInstallations
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IRegionsClusterResult_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: path
          name: clusterId
          required: true
          schema:
            type: string
  /regions/{regionId}/feed-in-consumption:
    get:
      operationId: GetFeedInConsumption
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IFeedInConsumptionResult-Array-or-null_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: query
          name: aggregation_level
          required: false
          schema:
            default: year
            type: string
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: query
          name: year
          required: false
          schema:
            type: array
            items:
              type: number
              format: double
  /regions/{regionId}/consumption/count-consumer:
    get:
      operationId: GetCountConsumer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IConsumptionResult-Array_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: query
          name: division
          required: true
          schema:
            $ref: '#/components/schemas/EDivision'
        - in: query
          name: year
          required: false
          schema:
            type: array
            items:
              type: number
              format: double
  /regions/{regionId}/consumption:
    get:
      operationId: GetConsumption
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IConsumptionResult-Array_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: query
          name: division
          required: true
          schema:
            $ref: '#/components/schemas/EDivision'
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: query
          name: year
          required: false
          schema:
            type: array
            items:
              type: number
              format: double
  /regions/{regionId}/feed-in/monetary-compensation:
    get:
      operationId: GetMonetaryCompensation
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IFeedInResult-Array_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: query
          name: aggregation_level
          required: false
          schema:
            default: year
            type: string
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: query
          name: year
          required: false
          schema:
            type: array
            items:
              type: number
              format: double
  /regions/{regionId}/feed-in:
    get:
      operationId: GetFeedIn
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IFeedInResult-Array_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: query
          name: aggregation_level
          required: false
          schema:
            default: year
            type: string
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: query
          name: year
          required: false
          schema:
            type: array
            items:
              type: number
              format: double
  /regions/{regionId}/feed-in/installed-capacity:
    get:
      operationId: GetInstalledCapacity
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IFeedInResult-Array_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: query
          name: aggregation_level
          required: false
          schema:
            default: year
            type: string
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: query
          name: year
          required: false
          schema:
            type: array
            items:
              type: number
              format: double
  /regions/{regionId}/feed-in/count-installations:
    get:
      operationId: GetCountInstallations
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_ICountInstallationsResult-Array_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: query
          name: aggregation_level
          required: false
          schema:
            default: year
            type: string
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: query
          name: year
          required: false
          schema:
            type: array
            items:
              type: number
              format: double
  /regions/{regionId}/years:
    get:
      operationId: GetYears
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_MinMax_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: query
          name: division
          required: false
          schema:
            $ref: '#/components/schemas/EDivision'
  /regions/import-region-map:
    post:
      operationId: FillRegionIdAgs
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters: []
  /map/regions/{regionId}:
    get:
      operationId: GetInstallation
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - map
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
  /regions/{regionId}/feed-in/{year}:
    get:
      operationId: GetFeedIn
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IFeedInResult-Array_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: path
          name: year
          required: true
          schema:
            format: double
            type: number
  /regions/{regionId}/feed-in/installed-capacity/{year}:
    get:
      operationId: GetInstalledCapacity
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IFeedInResult-Array_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: path
          name: year
          required: true
          schema:
            format: double
            type: number
  /regions/{regionId}/feed-in-consumption/co2-savings/{year}:
    get:
      operationId: GetCo2Savings
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_Array_Co2Savings__'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: path
          name: year
          required: true
          schema:
            format: double
            type: number
  /regions/{regionId}/feed-in-consumption/{year}:
    get:
      operationId: GetFeedInConsumption
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IFeedInConsumptionResult-Array-or-null_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: path
          name: year
          required: true
          schema:
            format: double
            type: number
  /regions/{regionId}/consumption/{year}:
    get:
      operationId: GetConsumption
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IConsumptionResult-Array_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: path
          name: year
          required: true
          schema:
            format: double
            type: number
  /regions/{regionId}/feed-in/monetary-compensation/{year}:
    get:
      operationId: GetMonetaryCompensation
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope_IFeedInResult-Array_'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      tags:
        - regions
      security:
        - BEARER: []
      parameters:
        - in: path
          name: regionId
          required: true
          schema:
            type: string
        - in: path
          name: year
          required: true
          schema:
            format: double
            type: number
  /file/heat/document:
    get:
      operationId: GetHeatDocument
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                properties:
                  documentId:
                    type: string
                    nullable: true
                  documentName:
                    type: string
                    nullable: true
                required:
                  - documentId
                  - documentName
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      security:
        - BEARER: []
      parameters:
        - in: query
          name: ags
          required: true
          schema:
            type: string
  /file/heat/excel:
    get:
      operationId: GetHeatExcel
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
                format: byte
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      security:
        - BEARER: []
      parameters:
        - in: query
          name: documentId
          required: true
          schema:
            type: string
  /file/cumin/document/{type}:
    get:
      operationId: GetTypedDocumentData
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISuccessEnvelope__documentId-string--documentName-string__'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      security:
        - BEARER: []
      parameters:
        - in: query
          name: ags
          required: true
          schema:
            type: string
        - in: path
          name: type
          required: true
          schema:
            $ref: '#/components/schemas/SpicetechGridRequestType'
  /file/cumin/excel/{type}:
    get:
      operationId: GetExcelByDocumentId
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
                format: byte
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
        '500':
          description: Internal error ocurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IErrorResponse_string_'
      security:
        - BEARER: []
      parameters:
        - in: query
          name: documentId
          required: true
          schema:
            type: string
        - in: path
          name: type
          required: true
          schema:
            $ref: '#/components/schemas/SpicetechGridRequestType'
servers:
  - url: /api