Rel-19 CR0067 TS 28.310 Introduce energy supply, carbon emission and renewable...

openapi: 3.0.1

info:

  title: EE NRM

  version: 19.0.0

  description: >-

    OAS 3.0.1 specification of the Energy Efficiency NRM

    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

externalDocs:

  description: 3GPP TS 28.310; Energy Efficiency NRM

  url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.310/

paths: {}

components:

  schemas:

#-------- Definition of types-----------------------------------------------------

    EnergySourceInfo:

      type: object

      properties:

        energySourceType:

          type: string

        energySourceCef:

          type: integer

        renewableEnergy:

          type: boolean

        energyCompositionRatio:

          type: integer

          default: 100

          minimum: 0

          maximum: 100

    EnergySupplyMode:

      type: string

      enum:

        - GRID_ELECTRICITY

        - BACKUP_ENERGY

        - LOCALLY_GENERATED_ENERGY

#-------- Definition of concrete IOCs --------------------------------------------

    SubNetwork-ncO-EENrm:

      type: object

      properties:

        EnergySupplyInfo:

          $ref: '#/components/schemas/EnergySupplyInfo-Multiple'

        EnergyInfoGroup:

          $ref: '#/components/schemas/EnergyInfoGroup-Multiple'

        EnergyUsageInfo:

          $ref: '#/components/schemas/EnergyUsageInfo-Multiple'

    EnergySupplyInfo-Single:

      allOf:

        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'

        - type: object

          properties:

            attributes:

              type: object

              properties:

                energySupplyMode:

                  $ref: '#/components/schemas/EnergySupplyMode'

                energySourceList:

                  $ref: '#/components/schemas/EnergySourceInfo'

                plannedOutgates:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/SchedulingTime'

    EnergyInfoGroup-Single:

      allOf:

        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/GenericCollection'

        - type: object

          properties:

            attributes:

              type: object

              properties:

                energyUsageInfoRefList:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

    EnergyUsageInfo-Single:

      allOf:

        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'

        - type: object

          properties:

            attributes:

              type: object

              properties:

                energyConsumptionRatio:

                  type: integer

                  default: 100

                  minimum: 0

                  maximum: 100

                validityPeriod:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'

                energySupplyRef:

                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'

#-------- Definition of JSON arrays for name-contained IOCs ----------------------

    EnergySupplyInfo-Multiple:

      type: array

      items:

        $ref: '#/components/schemas/EnergySupplyInfo-Single'

    EnergyInfoGroup-Multiple:

      type: array

      items:

        $ref: '#/components/schemas/EnergyInfoGroup-Single'

    EnergyUsageInfo-Multiple:

      type: array

      items:

        $ref: '#/components/schemas/EnergyUsageInfo-Single'

#--------------------------------- Definition ------------------------------------                          

    resources-EnergyEfficiency:

      oneOf:

        - $ref: '#/components/schemas/EnergySupplyInfo-Single'

        - $ref: '#/components/schemas/EnergyInfoGroup-Single'        

        - $ref: '#/components/schemas/EnergyUsageInfo-Single'