TS28623_GenericNrm.yaml

openapi: 3.0.1
info:
  title: Generic NRM
  version: 18.6.0
  description: >-
    OAS 3.0.1 definition of the Generic NRM
    © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    All rights reserved.
externalDocs:
  description: 3GPP TS 28.623; Generic NRM
  url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/
paths: {}
components:
  schemas:

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

    RegistrationState:
      type: string
      enum:
        - REGISTERED
        - DEREGISTERED
    VnfParameter:
      type: object
      properties:
        vnfInstanceId:
          type: string
        vnfdId:
          type: string
        flavourId:
          type: string
        autoScalable:
          type: boolean
    PeeParameter:
      type: object
      properties:
        siteIdentification:
          type: string
        siteDescription:
          type: string
        siteLatitude:
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/Latitude'
        siteLongitude:
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/Longitude'
        siteAltitude:
          type: number
          format: float
        equipmentType:
          type: string
        environmentType:
          type: string
        powerInterface:
          type: string
    Operation:
      type: object
      properties:
        name:
          type: string
        allowedNFTypes:
          $ref: '#/components/schemas/NFType'
        operationSemantics:
          $ref: '#/components/schemas/OperationSemantics'
    NFType:
      type: string
      description: ' NF name defined in TS 23.501 or TS 29.510'
      enum:
        - NRF
        - UDM
        - AMF
        - SMF
        - AUSF
        - NEF
        - PCF
        - SMSF
        - NSSF
        - UDR
        - LMF
        - GMLC
        - 5G_EIR
        - SEPP
        - UPF
        - N3IWF
        - AF
        - UDSF
        - DN
        - BSF
        - CHF
        - NWDAF
        - PCSCF
        - CBCF
        - HSS
        - UCMF
        - SOR_AF
        - SPAF
        - MME
        - SCSAS
        - SCEF
        - SCP
        - NSSAAF
        - ICSCF
        - SCSCF
        - DRA
        - IMS_AS
        - AANF
        - 5G_DDNMF
        - NSACF
        - MFAF
        - EASDF
        - DCCF
        - MB_SMF
        - TSCTSF
        - ADRF
        - GBA_BSF
        - CEF
        - MB_UPF
        - NSWOF
        - PKMF
        - MNPF
        - SMS_GMSC
        - SMS_IWMSC
        - MBSF
        - MBSTF
        - PANF
        - TNGF
        - W_AGF
        - TWIF
        - TSN_AF

    OperationSemantics:
      type: string
      enum:
        - REQUEST_RESPONSE
        - SUBSCRIBE_NOTIFY
    SAP:
      type: object
      properties:
        host:
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/HostAddr'
        port:
          type: integer
    NFServiceType:
      type: string
      enum:
        - Namf_Communication
        - Namf_EventExposure
        - Namf_MT
        - Namf_Location
        - Nsmf_PDUSession
        - Nsmf_EventExposure
        - Others
    TransportProtocol:
      anyOf:
        - type: string
          enum:
            - TCP
        - type: string
    SupportedPerfMetricGroup:
      type: object
      properties:
        performanceMetrics:
          type: array
          items:
            type: string
        granularityPeriods:
          type: array
          items:
            type: integer
            minimum: 1
        reportingMethods:
          type: array
          items:
            type: string
            enum:
             - FILE_BASED_LOC_SET_BY_PRODUCER
             - FILE_BASED_LOC_SET_BY_CONSUMER
             - STREAM_BASED 
        reportingPeriods:
          type: array
          items:
            type: integer
            minimum: 1
    ReportingCtrl:
      oneOf:
        - type: object
          properties:
            fileReportingPeriod:
              type: integer
        - type: object
          properties:
            fileReportingPeriod:
              type: integer
            notificationRecipientAddress:
              $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri'            
        - type: object
          properties:
            fileReportingPeriod:
              type: integer
            fileLocation:
              $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri'
        - type: object
          properties:
            streamTarget:
              $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri'
    Scope:
      oneOf:
        - type: object
          properties:
            scopeType:
              type: string
              enum:
                - BASE_ONLY
                - BASE_ALL
                - BASE_NTH_LEVEL
                - BASE_SUBTREE
            scopeLevel:
              type: integer
        - type: object
          properties:
            dataNodeSelector:
              type: string
    ProcessMonitor:
      description: >-
        This data type is the "ProcessMonitor" data type without specialisations.
      type: object
      properties:
        jobId:
          type: string
        status:
          type: string
          enum:
            - NOT_STARTED
            - RUNNING
            - FINSHED
            - FAILED
            - PARTIALLY_FAILED
            - CANCELLING
            - CANCELLED
        progressPercentage:
          type: integer
          minimum: 0
          maximum: 100
        progressStateInfo:
          type: string
        resultStateInfo:
          type: string
        startTime:
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
        endTime:
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
        timer:
          type: integer
    AreaScope:
      oneOf:
      - type: array
        items:
          $ref: '#/components/schemas/EutraCellId'
      - type: array
        items:
          $ref: '#/components/schemas/NrCellId'
      - type: array
        items:
          $ref: '#/components/schemas/Tac'
      - type: array
        items:
          $ref: '#/components/schemas/Tai'
      - type: array
        items:
          $ref: '#/components/schemas/NpnId-Type'

    Tai:
      type: object
      properties:
        mcc:
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc'
        mnc:
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc'
        tac:
          $ref: '#/components/schemas/Tac'
    Tac:
      type: string
      pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)'
    EutraCellId:
      type: string
      pattern: '^[A-Fa-f0-9]{7}$'
    NrCellId:
      type: string
      pattern: '^[A-Fa-f0-9]{9}$'
    IpAddr:
      oneOf:
        - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr'
        - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr'

    SchedulingTime:
      oneOf:
        - $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'
        - type: object
          properties:
            timeIntervals:
              type: array
              items:
                $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeInterval'
        - type: object
          properties:
            timeIntervals:
              type: array
              items:
                $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeInterval'
            daysOfWeek:
              type: array
              items:
                type: string
                enum:
                  - MONDAY
                  - TUESDAY
                  - WEDNESDAY
                  - THURSDAY
                  - FRIDAY
                  - SATURDAY
                  - SUNDAY
        - type: object
          properties:
            timeIntervals:
              type: array
              items:
                $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeInterval'
            daysOfMonth:
              type: array
              items:
                type: integer
                minimum: 0
                maximum: 31
    NpnId-Type:
      type: object
      description: This describes the PLMN id, CAG ID list or the NID of the SNPN within the PLMN.
      properties:
        plmnId:
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId'
        cAGIdList:
          type: array
          items:
            type: string
        nIDList:
          type: array
          items:
            $ref: 'TS28623_ComDefs.yaml#/components/schemas/Nid'

#-------- Definition of abstract IOC Top -----------------------------------------

    Top-Attr:
      #  This definition will be deprecated, when all occurances of Top-Attr
      #  are replaced by Top.
      type: object
      properties:
        id:
          type: string
          nullable: true
        objectClass:
          type: string
        objectInstance:
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
        VsDataContainer:
          $ref: '#/components/schemas/VsDataContainer-Multiple'
      required:
        - id
    Top:
      type: object
      properties:
        id:
          type: string
          nullable: true
        objectClass:
          type: string
        objectInstance:
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
        VsDataContainer:
          $ref: '#/components/schemas/VsDataContainer-Multiple'
      required:
        - id

#-------- Definition of IOCs with new name-containments defined in other TS ------

    SubNetwork-Attr:
      type: object
      properties:
        dnPrefix:
          type: string
        userLabel:
          type: string
        userDefinedNetworkType:
          type: string
        setOfMcc:
          type: array
          items:
            $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc'
        priorityLabel:
          type: integer
        supportedPerfMetricGroups:
          type: array
          items:
            $ref: '#/components/schemas/SupportedPerfMetricGroup'
        supportedTraceMetrics:
          type: array
          items:
            type: string
    ManagedElement-Attr:
      type: object
      properties:
        dnPrefix:
          type: string
        managedElementTypeList:
          type: array
          items:
            type: string
        userLabel:
          type: string
        locationName:
          type: string
        managedBy:
          $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
        vendorName:
          type: string
        userDefinedState:
          type: string
        swVersion:
          type: string
        priorityLabel:
          type: integer
        supportedPerfMetricGroups:
          type: array
          items:
            $ref: '#/components/schemas/SupportedPerfMetricGroup'
        supportedTraceMetrics:
          type: array
          items:
            type: string

    SubNetwork-ncO:
      type: object
      properties:
        ManagementNode:
          $ref: '#/components/schemas/ManagementNode-Multiple'
        MnsAgent:
          $ref: '#/components/schemas/MnsAgent-Multiple'
        MeContext:
          $ref: '#/components/schemas/MeContext-Multiple'
        PerfMetricJob:
          $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/PerfMetricJob-Multiple'
        ThresholdMonitor:
          $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdMonitor-Multiple'
        TraceJob:
          $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/TraceJob-Multiple'
        ManagementDataCollection:
          $ref: 'TS28623_ManagementDataCollectionNrm.yaml#/components/schemas/ManagementDataCollection-Multiple'
        NtfSubscriptionControl:
          $ref: 'TS28623_SubscriptionControlNrm.yaml#/components/schemas/NtfSubscriptionControl-Multiple'
        AlarmList:
          $ref: 'TS28111_FaultNrm.yaml#/components/schemas/AlarmList-Single'
        FileDownloadJob:
          $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/FileDownloadJob-Multiple'
        Files:
          $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/Files-Multiple'
        MnsRegistry:
          $ref: 'TS28623_MnSRegistryNrm.yaml#/components/schemas/MnsRegistry-Single'
        Scheduler:
          $ref: '#/components/schemas/Scheduler-Multiple'
        ConditionMonitor:
          $ref: '#/components/schemas/ConditionMonitor-Multiple'
        SupportedNotifications:
          $ref: '#/components/schemas/SupportedNotifications-Single'
        QMCJobs:
          $ref: 'TS28623_QoEMeasurementCollectionNrm.yaml#/components/schemas/QMCJob-Multiple'

    ManagedElement-ncO:
      type: object
      properties:
        MnsAgent:
          $ref: '#/components/schemas/MnsAgent-Multiple'
        PerfMetricJob:
          $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/PerfMetricJob-Multiple'
        ThresholdMonitor:
          $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdMonitor-Multiple'
        TraceJob:
          $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/TraceJob-Multiple'
        NtfSubscriptionControl:
          $ref: 'TS28623_SubscriptionControlNrm.yaml#/components/schemas/NtfSubscriptionControl-Multiple'
        AlarmList:
          $ref: 'TS28111_FaultNrm.yaml#/components/schemas/AlarmList-Single'
        FileDownloadJob:
          $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/FileDownloadJob-Multiple'
        Files:
          $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/Files-Multiple'
        Scheduler:
          $ref: '#/components/schemas/Scheduler-Multiple'
        ConditionMonitor:
          $ref: '#/components/schemas/ConditionMonitor-Multiple'
        SupportedNotifications:  
          $ref: '#/components/schemas/SupportedNotifications-Single'
        QMCJobs:
          $ref: 'TS28623_QoEMeasurementCollectionNrm.yaml#/components/schemas/QMCJob-Multiple'

#-------- Definition of abstract IOCs --------------------------------------------

    ManagedFunction-Attr:
      type: object
      properties:
        userLabel:
          type: string
        vnfParametersList:
          type: array
          items:
            $ref: '#/components/schemas/VnfParameter'
        peeParametersList:
          type: array
          items:
            $ref: '#/components/schemas/PeeParameter'
        priorityLabel:
          type: integer
        supportedPerfMetricGroups:
          type: array
          items:
            $ref: '#/components/schemas/SupportedPerfMetricGroup'
        supportedTraceMetrics:
          type: array
          items:
            type: string
    EP_RP-Attr:
      type: object
      properties:
        userLabel:
          type: string
        farEndEntity:
          type: string
        supportedPerfMetricGroups:
          type: array
          items:
            $ref: '#/components/schemas/SupportedPerfMetricGroup'

    ManagedFunction-ncO:
      type: object
      properties:
        PerfMetricJob:
          $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/PerfMetricJob-Multiple'
        ThresholdMonitor:
          $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdMonitor-Multiple'
        ManagedNFService:
          $ref: '#/components/schemas/ManagedNFService-Multiple'
        TraceJob:
          $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/TraceJob-Multiple'

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

    VsDataContainer-Single:
      type: object
      properties:
        id:
          type: string
        attributes:
          type: object
          properties:
            vsDataType:
              type: string
            vsDataFormatVersion:
              type: string
            vsData:
              nullable: true
        VsDataContainer:
          $ref: '#/components/schemas/VsDataContainer-Multiple'
    ManagedNFService-Single:
      allOf:
        - $ref: '#/components/schemas/Top'
        - type: object
          properties:
            attributes:
              type: object
              properties:
                userLabel:
                  type: string
                nFServiceType:
                  $ref: '#/components/schemas/NFServiceType'
                sAP:
                  $ref: '#/components/schemas/SAP'
                operations:
                  type: array
                  items:
                    $ref: '#/components/schemas/Operation'
                administrativeState:
                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState'
                operationalState:
                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState'
                usageState:
                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/UsageState'
                registrationState:
                  $ref: '#/components/schemas/RegistrationState'
    ManagementNode-Single:
      allOf:
        - $ref: '#/components/schemas/Top'
        - type: object
          properties:
            attributes:
              type: object
              properties:
                userLabel:
                  type: string
                managedElements:
                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
                vendorName:
                  type: string
                userDefinedState:
                  type: string
                locationName:
                  type: string
                swVersion:
                  type: string
            MnsAgent:
              $ref: '#/components/schemas/MnsAgent-Multiple'
    MnsAgent-Single:
      allOf:
        - $ref: '#/components/schemas/Top'
        - type: object
          properties:
            attributes:
              type: object
              properties:
                systemDN:
                  $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
    MeContext-Single:
      allOf:
        - $ref: '#/components/schemas/Top'
        - type: object
          properties:
            attributes:
              type: object
              properties:
                dnPrefix:
                  type: string
    Scheduler-Single:
      allOf:
        - $ref: '#/components/schemas/Top'
        - type: object
          properties:
            attributes:
              type: object
              properties:
                schedulingTimes:
                  type: array
                  items:
                    $ref: '#/components/schemas/SchedulingTime'
                  minItems: 1
                schedulerStatus:
                  type: boolean
    ConditionMonitor-Single:
      allOf:
        - $ref: '#/components/schemas/Top'
        - type: object
          properties:
            attributes:
              type: object
              properties:
                condition:
                  type: string
                conditionStatus:
                  type: boolean

    SupportedNotifications-Single:
      allOf:
        - $ref: '#/components/schemas/Top'
        - type: object
          properties:
            attributes:
              type: object
              properties:
                notificationTypes:
                  type: array
                  items:
                    $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationType'
                notificationProtocols:
                  type: array
                  items:
                    type: string
                    enum:
                      - HTTP
                      - HTTP_VES_ENCAPS
                    minItems: 1


    SubNetwork-Single:
      allOf:
        - $ref: '#/components/schemas/Top' 
        - $ref: '#/components/schemas/SubNetwork-Attr'
        - $ref: '#/components/schemas/SubNetwork-ncO'
        - $ref: '#/components/schemas/SubNetwork-Multiple'
        - $ref: '#/components/schemas/ManagedElement-Multiple'
        - $ref: 'TS28104_MdaNrm.yaml#/components/schemas/SubNetwork-ncO-MdaNrm'
        - $ref: 'TS28105_AiMlNrm.yaml#/components/schemas/SubNetwork-ncO-AiMlNrm'
        - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/SubNetwork-ncO-IntentNrm'
        - $ref: 'TS28317_RanScNrm.yaml#/components/schemas/SubNetwork-ncO-RanScNrm'
        - $ref: 'TS28536_CoslaNrm.yaml#/components/schemas/SubNetwork-ncO-CoslaNrm'
        - $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/SubNetwork-ncO-EdgeNrm'
        - $ref: 'TS28541_SliceNrm.yaml#/components/schemas/SubNetwork-ncO-SliceNrm'
        - $ref: 'TS28541_NrNrm.yaml#/components/schemas/SubNetwork-ncO-NrNrm'
        - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/SubNetwork-ncO-5GcNrm'

    ManagedElement-Single:
      allOf:
        - $ref: '#/components/schemas/Top'
        - $ref: '#/components/schemas/ManagedElement-Attr'
        - $ref: '#/components/schemas/ManagedElement-ncO'
        - $ref: 'TS28104_MdaNrm.yaml#/components/schemas/ManagedElement-ncO-MdaNrm'
        - $ref: 'TS28105_AiMlNrm.yaml#/components/schemas/ManagedElement-ncO-AiMlNrm'
        - $ref: 'TS28536_CoslaNrm.yaml#/components/schemas/ManagedElement-ncO-CoslaNrm'
        - $ref: 'TS28541_NrNrm.yaml#/components/schemas/ManagedElement-ncO-NrNrm'
        - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/ManagedElement-ncO-5GcNrm'

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

    VsDataContainer-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/VsDataContainer-Single'
    ManagedNFService-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/ManagedNFService-Single'
    ManagementNode-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/ManagementNode-Single'
    MnsAgent-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/MnsAgent-Single'
    MeContext-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/MeContext-Single'
    Scheduler-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/Scheduler-Single'
    ConditionMonitor-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/ConditionMonitor-Single'
    SubNetwork-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/SubNetwork-Single'
    ManagedElement-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/ManagedElement-Single'


#-------- Definitions in TS 28.623 for TS 28.532 ---------------------------------

    resources-genericNrm:
      oneOf:

       - $ref: '#/components/schemas/VsDataContainer-Single'
       - $ref: '#/components/schemas/ManagementNode-Single'
       - $ref: '#/components/schemas/MnsAgent-Single'
       - $ref: '#/components/schemas/MeContext-Single'
       - $ref: '#/components/schemas/ManagedNFService-Single'
       - $ref: '#/components/schemas/Scheduler-Single'
       - $ref: '#/components/schemas/ConditionMonitor-Single'
       - $ref: '#/components/schemas/SupportedNotifications-Single' 
       - $ref: '#/components/schemas/SubNetwork-Single'
       - $ref: '#/components/schemas/ManagedElement-Single'