Commit 78683864 authored by mouqueta's avatar mouqueta
Browse files

Merge branch 'Integration_Rel18_SA5_153_YAML' into 'Rel-18' 

Inregration_Rel18_SA5_153_YAML

See merge request !1057
parents fa1e1a06 e32a7ec1

OpenAPI/README.md

+52 −15
Original line number Diff line number Diff line
@@ -15,10 +15,38 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f 
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_ComDefs.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_ComDefs.yaml))



* Management Data Collection NRM (TS 28.623)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_ManagementDataCollectionNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_ManagementDataCollectionNrm.yaml))



* MnS Registry NRM (TS 28.623)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_MnSRegistryNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_MnSRegistryNrm.yaml))



* PM control NRM (TS 28.623)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_PmControlNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_PmControlNrm.yaml))



* QoE Measurement Collection NRM (TS 28.623)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_QoEMeasurementCollectionNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_QoEMeasurementCollectionNrm.yaml))



* Subscription Control NRM NRM (TS 28.623)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_SubscriptionControlNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_SubscriptionControlNrm.yaml))



* Threshold Monitor NRM(TS 28.623)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_ThresholdMonitorNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_ThresholdMonitorNrm.yaml))



* Trace Control NRM (TS 28.623)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_TraceControlNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_TraceControlNrm.yaml))



* Fault Management NRM(TS 28.111)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28111_FaultNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28111_FaultNrm.yaml))



* NR NRM (TS 28.541)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28541_NrNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28541_NrNrm.yaml))
@@ -35,18 +63,6 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f 
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28536_CoslaNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28536_CoslaNrm.yaml))



* Intent NRM (TS 28.312)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_IntentNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28312_IntentNrm.yaml))



* Intent Scenario specific Intent Expectations (TS 28.312)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_IntentExpectations.yamll))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28312_IntentExpectations.yaml))



* Edge NRM (TS 28.538)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28538_EdgeNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28538_EdgeNrm.yaml))



* MDA NRM (TS 28.104)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28104_MdaNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28104_MdaNrm.yaml))
@@ -59,19 +75,40 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f 
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28105_AiMlNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28105_AiMlNrm.yaml))



* Intent NRM (TS 28.312)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_IntentNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28312_IntentNrm.yaml))



* Intent Scenario specific Intent Expectations (TS 28.312)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_IntentExpectations.yamll))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28312_IntentExpectations.yaml))



* Edge NRM (TS 28.538)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28538_EdgeNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28538_EdgeNrm.yaml))



* RANSC NRM (TS 28.317)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28317_RanScNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28317_RanScNrm.yaml))



* OutageAndRecoveryInfo NRM (TS 28.318)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28319_MsacNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28319_MsacNrm.yaml))



* MSAC NRM (TS 28.319)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28318_DsoNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28318_DsoNrm.yaml))





## Management Services (MnS)



* Provisioning MnS (TS 28.532)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28532_ProvMnS.yaml))



* Fault Supervision MnS (TS 28.532)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_FaultMnS.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28532_FaultMnS.yaml))

* Fault Management Notifications(TS 28.111)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28111_FaultNotifications.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28111_FaultNotifications.yaml))



* Performance Measurement Job Control MnS (28.550)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28550_PerfMeasJobCtrlMnS.yaml))

OpenAPI/TS28104_MdaNrm.yaml

+31 −60
Original line number Diff line number Diff line 
openapi: 3.0.1

info:

  title: MDA NRM

  version: 18.0.0

  version: 18.3.0

  description: >-

    OAS 3.0.1 specification of the MDA NRM

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

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

    All rights reserved.

externalDocs:

  description: 3GPP TS 28.104; MDA
@@ -25,6 +25,18 @@ components: 
      items:

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



    AnalyticsScopeType:

      oneOf:

        - type: object

          properties:

            managedEntitiesScope:

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

        - type: object

          properties:

            areaScope:

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

 



    MDAOutputPerMDAType:

      type: object

      properties:
@@ -59,17 +71,6 @@ components: 
    ReportingTarget:

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

      

    AnalyticsScopeType:

      oneOf:

        - type: object

          properties:

            managedEntitiesScope:

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

        - type: object

          properties:

            areaScope:

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



    AnalyticsSchedule:

      oneOf:

        - type: object
@@ -106,45 +107,25 @@ components: 
              format: float

              minimum: 0



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







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



    SubNetwork-Single:

      allOf:

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

        - type: object

          properties:

            attributes:

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

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

        - type: object

#-------- Definition of types for name-containments ------

    SubNetwork-ncO-MdaNrm:

      type: object

      properties:

            SubNetwork:

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

            ManagedElement:

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

        MDAFunction:

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

        MDAReport:

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





    ManagedElement-Single:

      allOf:

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

        - type: object

          properties:

            attributes:

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

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

        - type: object

    ManagedElement-ncO-MdaNrm:

      type: object

      properties:

        MDAFunction:

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

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







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

    MDAFunction-Single:

      allOf:

        - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
@@ -184,21 +165,14 @@ components: 
                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'

                    stopTime:

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

                    recommendationFilter:

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



    MDAReport-Single:

      $ref: 'TS28104_MdaReport.yaml#/components/schemas/MDAReport'





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



    SubNetwork-Multiple:

      type: array

      items:

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

    ManagedElement-Multiple:

      type: array

      items:

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

    MDAFunction-Multiple:

      type: array

      items:
@@ -217,9 +191,6 @@ components: 


    resources-mdaNrm:

      oneOf:

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

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



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

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

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

OpenAPI/TS28104_MdaReport.yaml

+4 −4
Original line number Diff line number Diff line 
openapi: 3.0.1

info:

  title: MDA Report

  version: 18.2.0

  version: 18.3.0

  description: >-

    OAS 3.0.1 specification of the MDA Report

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

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

    All rights reserved.

externalDocs:

  description: 3GPP TS 28.104; MDA Report
@@ -24,8 +24,6 @@ components: 
          type: array

          items:

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

        mDARequestRef:

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

        analyticsWindow:

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

        confidenceDegree:
@@ -64,3 +62,5 @@ components: 
                      type: string

                    mDAOutputs:

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

                    mDARequestRef:

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

OpenAPI/TS28105_AiMlNrm.yaml

+512 −91

File changed.

Preview size limit exceeded, changes collapsed.

OpenAPI/TS28111_FaultNotifications.yaml

0 → 100644
+57 −0
Original line number Diff line number Diff line 
openapi: 3.0.1

info:

  title: Fault Management Notifications

  version: 18.1.0

  description: >-

    OAS 3.0.1 definition of the Fault Supervision MnS

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

    All rights reserved.

externalDocs:

  description: 3GPP TS 28.111; Fault Management

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

servers:

  - url: '{notificationRecipientAddress}'

    variables:

      notificationRecipientAddress:

        description: Address on the MnS consumer side defined by NtfSubscriptionControl.notificationRecipientAddress. See 3GPP TS 28.622 clause 4.3.22

        default: http://exampleConsumer.com/notificationReceiver

      MnSversion:

        description: Version number of the OpenAPI definition

        default: XXX

paths:

  /:

    post:

      summary: Receive one of a set of alarm related notifications

      description: >-

        The MnS producer sends an alarm to the consumer. 

        This interface shall be implemented by the notification-receiver and 

        used by the notification-sender.

      requestBody:

        required: true

        content:

          application/json:

            schema:

              oneOf:

                - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyNewAlarm'

                - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyNewSecAlarm'

                - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyClearedAlarm'

                - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyChangedAlarm'

                - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyChangedAlarmGeneral'

                - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyChangedSecAlarmGeneral'

                - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyCorrelatedNotificationChanged'                      

                - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyAckStateChanged'

                - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyComments'

                - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyPotentialFaultyAlarmList'

                - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyAlarmListRebuilt'

      responses:

        '204':

          description: >-

            Success case ("204 No Content").

            The notification is successfully delivered. The response message

            body is absent.

        default:

          description: Error case.

          content:

            application/json:

              schema:

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