TS28318_DsoNrm.yaml

openapi: 3.0.1
info:
  title: 3GPP NRM
  version: 18.5.0
  description: >-
    OAS 3.0.1 specification of the OutageAndRecoveryInfo NRM
    © 2024, 3GPP Organizational OutageAndRecoveryInfo Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    All rights reserved.
externalDocs:
  description: 3GPP TS 28.318; OutageAndRecoveryInfo NRM
  url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.318/
paths: {}
components:
  schemas:
  
#-------- Definition of types-----------------------------------------------------
    EnergyServiceLocation:
      type: object
      properties:
        CGI:
          type: string
        energySupplyId:
          type: string



#-------- Definition of concrete IOCs --------------------------------------------
    MnS:
      oneOf:
        - type: object
          properties:
            SubNetwork:
              $ref: '#/components/schemas/SubNetwork-Multiple'

    SubNetwork-Single:
      allOf:
        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
        - type: object
          properties:
            attributes:
              allOf:
                - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr'
        - type: object
          properties:
            Subnetwork:
              $ref: '#/components/schemas/SubNetwork-Multiple'
            OutageAndRecoveryInfo:
              $ref: '#/components/schemas/OutageAndRecoveryInfo-Multiple'
            DsoThresholdMonitor:
              $ref: '#/components/schemas/DsoThresholdMonitor-Multiple'
        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO'

    OutageAndRecoveryInfo-Single:
      allOf:
        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
        - type: object
          properties:
            outageStartTime:
              $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
            expectedOutageEndTime:
              $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
            dsoRapidInterventionTime:
              $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
            dsoRapidInterventionDuration:
              type: integer
            mnoInterventionTime:
              $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
            mnoInterventionDuration:
              type: integer
            mnoMaxServiceDuration:
              type: integer
            affectedArea:
              $ref: '#/components/schemas/EnergyServiceLocation'
            isAffectedAreaPriority:
              type: boolean
            actualOutageEndTime:
              $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
    DsoThresholdMonitor-Single:
      allOf:
        - $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdMonitor-Single'
        - type: object
          properties:
            targetThresholdLocation:
              $ref: 'TS28623_ComDefs.yaml#/components/schemas/AreaOfInterest'



#-------- Definition of JSON arrays for name-contained IOCs ----------------------                               
          
    SubNetwork-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/SubNetwork-Single'
    OutageAndRecoveryInfo-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/OutageAndRecoveryInfo-Single'
    DsoThresholdMonitor-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/DsoThresholdMonitor-Single'
        
#--------------------------------- Definition ------------------------------------                          

    resources-DSORecovery:
      oneOf:
        - $ref: '#/components/schemas/MnS'
        - $ref: '#/components/schemas/SubNetwork-Single'
        - $ref: '#/components/schemas/OutageAndRecoveryInfo-Single'
        - $ref: '#/components/schemas/DsoThresholdMonitor-Single'