Commit 56071027 authored by Mirko Cano Soveri's avatar Mirko Cano Soveri
Browse files

Merge branch 'SA89e_YAML_Rel-16_content_extracted_from_MS_Word_specs' into 'Rel-16' 

Extracted OpenAPI definitions from Rel-16 TSs published after SA89 in September 2020

See merge request sa5/MnS!50
parents f8f09749 963e7263

OpenAPI/5gcNrm.yaml

+193 −5
Original line number Diff line number Diff line 
openapi: 3.0.1

info:

  title: 3GPP 5GC NRM

  version: 16.5.0

  version: 16.6.0

  description: >-

    OAS 3.0.1 specification of the 5GC NRM

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

    All rights reserved.

externalDocs:

  description: 3GPP TS 28.541 V16.4.0; 5G NRM, 5GC NRM

  description: 3GPP TS 28.541 V16.6.0; 5G NRM, 5GC NRM

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

paths: {}

components:
@@ -298,6 +298,143 @@ components: 
        thresholdRtt:

          type: integer



    QosData:

      type: object

      properties:

        qosId:

          type: string

        fiveQIValue:

          type: integer

        maxbrUl:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/BitRateRm'

        maxbrDl:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/BitRateRm'

        gbrUl:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/BitRateRm'

        gbrDl:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/BitRateRm'

        arp:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/Arp'

        qosNotificationControl:

          type: boolean

        reflectiveQos:

          type: boolean

        sharingKeyDl:

          type: string

        sharingKeyUl:

          type: string

        maxPacketLossRateDl:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm'

        maxPacketLossRateUl:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm'

        extMaxDataBurstVol:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm'



    QosDataList:

      type: array

      items:

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



    SteeringMode:

      type: object

      properties:

        steerModeValue:

          $ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteerModeValue'

        active:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/AccessType'

        standby:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/AccessTypeRm'

        threeGLoad:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/Uinteger'

        prioAcc:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/AccessType'



    TrafficControlData:

      type: object

      properties:

        tcId:

          type: string

        flowStatus:

          $ref: '/rep/all/5G_APIs/raw/master/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus'

        redirectInfo:

          $ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation'

        addRedirectInfo:

          type: array

          items:

            $ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation'

          minItems: 1

        muteNotif:

          type: boolean

        trafficSteeringPolIdDl:

          type: string

          nullable: true

        trafficSteeringPolIdUl:

          type: string

          nullable: true

        routeToLocs:

          type: array

          items:

            $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/RouteToLocation'

        traffCorreInd:

          type: boolean

        upPathChgEvent:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/UpPathChgEvent'

        steerFun:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/SteeringFunctionality'

        steerModeDl:

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

        steerModeUl:

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

        mulAccCtrl:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/MulticastAccessControl'



    TrafficControlDataList:

      type: array

      items:

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



    PccRule:

      type: object

      properties:

        pccRuleId:

          type: string

          description: Univocally identifies the PCC rule within a PDU session.

        flowInfoList:

          type: array

          items:

            $ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation'

        applicationId:

          type: string

        appDescriptor:

          $ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ApplicationDescriptor'

        contentVersion:

          $ref: '/rep/all/5G_APIs/raw/master/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion'

        precedence:

          $ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/Uinteger'

        afSigProtocol:

          $ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol'

        isAppRelocatable:

          type: boolean

        isUeAddrPreserved:

          type: boolean

        qosData:

          type: array

          items:

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

        altQosParams:

          type: array

          items:

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

        trafficControlData:

          type: array

          items:

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

        conditionData:

            $ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl#/components/schemas/ConditionData'

        tscaiInputDl:

          $ref: '/rep/all/5G_APIs/raw/master/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'

        tscaiInputUl:

          $ref: '/rep/all/5G_APIs/raw/master/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'



#-------- Definition of concrete IOCs --------------------------------------------
@@ -328,6 +465,8 @@ components: 
              $ref: '#/components/schemas/AmfRegion-Multiple'

            Configurable5QISet:

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

            Dynamic5QISet:

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



    ManagedElement-Single:

      allOf:
@@ -378,6 +517,8 @@ components: 
              $ref: '#/components/schemas/NefFunction-Multiple'

            Configurable5QISet:

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

            Dynamic5QISet:

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



    AmfFunction-Single:

      allOf:
@@ -490,7 +631,9 @@ components: 
                      $ref: '#/components/schemas/ManagedNFProfile'

                    commModelList:

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

                    Configurable5QISetRef:

                    configurable5QISetRef:

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

                    dynamic5QISetRef:

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



        - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO'
@@ -514,6 +657,8 @@ components: 
              $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single'

            QFQoSMonitoringControl:

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

            PredefinedPccRuleSet:

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



    UpfFunction-Single:

      allOf:
@@ -589,6 +734,10 @@ components: 
                      $ref: '#/components/schemas/ManagedNFProfile'

                    commModelList:

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

                    configurable5QISetRef:

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

                    dynamic5QISetRef:

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

        - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO'

        - type: object

          properties:
@@ -602,6 +751,9 @@ components: 
              $ref: '#/components/schemas/EP_N16-Multiple'

            EP_Rx:

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

            PredefinedPccRuleSet:

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



    AusfFunction-Single:

      allOf:

        - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
@@ -987,6 +1139,8 @@ components: 
                      $ref: 'nrNrm.yaml#/components/schemas/LocalAddress'

                    remoteAddress:

                      $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress'

                    epTransportRefs:

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

    EP_N4-Single:

      allOf:

        - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
@@ -1407,6 +1561,21 @@ components: 
                      type: array

                      items:

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



    Dynamic5QISet-Single:

      allOf:

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

        - type: object

          properties:

            attributes:

              allOf:

                - type: object

                  properties:

                    dynamic5QIs:

                      type: array

                      items:

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



    GtpUPathQoSMonitoringControl-Single:

      allOf:

        - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
@@ -1481,6 +1650,19 @@ components: 
                    qFMeasurementPeriod:

                      type: integer



    PredefinedPccRuleSet-Single:

      allOf:

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

        - type: object

          properties:

            attributes:

              allOf:

                - type: object

                  properties:

                    predefinedPccRules:

                      type: array

                      items:

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



#-------- Definition of JSON arrays for name-contained IOCs ----------------------
@@ -1715,6 +1897,10 @@ components: 
      type: array

      items:

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

    Dynamic5QISet-Multiple:

      type: array

      items:

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





#------------ Definitions in TS 28.541 for TS 28.532 -----------------------------
@@ -1787,3 +1973,5 @@ components: 
        - $ref: '#/components/schemas/EP_NLG-Single'

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

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

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

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

OpenAPI/PerDataFileReportMnS.yaml→OpenAPI/FileDataReportingMnS.yaml

+20 −11
Original line number Diff line number Diff line 
openapi: 3.0.1

info:

  title: TS 28.532 Performance data file reporting Service

  version: 16.4.0

  title: TS 28.532 File data reporting Service

  version: 16.5.0

  description: >-

    OAS 3.0.1 specification of the Performance data file reporting Management Service © 2020,

    OAS 3.0.1 specification of the File data reporting Management Service © 2020,

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

    rights reserved.

externalDocs:

  description: 3GPP TS 28.532 V16.4.0; Generic management services

  description: 3GPP TS 28.532 V16.5.0; Generic management services

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

servers:

  - url: '{MnSRoot}/PerfDataFileReportMnS/v1640'

  - url: '{MnSRoot}/FileDataReportingMnS/{MnSversion}'

    variables:

      MnSRoot:

        description: See subclause 4.4 of TS 32.158

        default: http://example.com/3GPPManagement 

      version:

        description: Indicates the current version of the specification

        default: 16.5.0

paths:

  /Files:

    get:

      summary: Read resources of information of available files

      description: 'With HTTP GET, resources of information of available files are read. The resources to be read are identified with the path component (base resource) and the query component (managementDataType, beginTime and endTime) of the URI. The fields query component allows to select the resource properties to be returned.'

      description: With HTTP GET, resources of information of available files are read. The resources to be read are identified with the path component (base resource) and the query component (managementDataType, beginTime and endTime) of the URI. The fields query component allows to select the resource properties to be returned.

      parameters:

        - name: managementDataType

          in: query

          description: This parameter identifies the type of management data that the file contains to select the resources from the collection resources identified with the path component of the URI.

          required: true

          schema:

            $ref: '#/components/schemas/managementDataType-Type'

        - name: beginTime

          in: query

          description: This parameter identifies the time stamp no later than which the file became available to select the resources from the collection resources identified with the path component of the URI.

          required: true

          schema:

            $ref: '#/components/schemas/dateTime-Type'

        - name: endTime

          in: query

          description: This parameter identifies the time stamp no earlier than which the file became available to select the resources from the collection resources identified with the path component of the URI.

          required: true

          schema:

            $ref: '#/components/schemas/dateTime-Type'

      responses:

        '200':
@@ -195,7 +201,10 @@ components: 
    managementDataType-Type:

      type: string

      enum:

        - PM

        - PERFORMANCE

        - TRACE

        - ANALYTICS

        - PROPRIETARY

    header-Type:

      description: Header used in notifications as notification header

      type: object

OpenAPI/PerfDataStreamingMnS.yaml

deleted100644 → 0
+0 −363

File deleted.

Preview size limit exceeded, changes collapsed.

OpenAPI/README.md

+4 −4
Original line number Diff line number Diff line
@@ -45,10 +45,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/PerMeasJobCtlMnS.yaml))

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



* Performance Data File Reporting MnS (TS 28.532)

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

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



* Performance Threshold Monitoring MnS (TS 28.532)

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

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerThresMonMnS.yaml))
@@ -61,6 +57,10 @@ 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/streamingDataMnS.yaml))

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



* File Data Reporting MnS (TS 28.532)

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

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



## Tools



* [Frontend](https://forge.3gpp.org/swagger/tools/GitlabOpenAPIFrontend.htm) to invoke the Swagger Editor, Swagger UI, or to parse OpenAPI files with APIDevTools Swagger Parser/Validator, or to search for APIs referencing a data structure

OpenAPI/comDefs.yaml

+54 −8
Original line number Diff line number Diff line 
openapi: 3.0.1

info:

  title: Common Type Definitions

  version: 16.3.0

  version: 16.5.0

  description: >-

    OAS 3.0.1 specification of common type definitions in the Generic NRM

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

    All rights reserved.

externalDocs:

  description: 3GPP TS 28.623 V16.3.0; Generic NRM, Common Type Definitions

  description: 3GPP TS 28.623 V16.5.0; Generic NRM, Common Type Definitions

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

paths: {}

components:

  schemas:

    Long:

      type: string

      type: number

      format: long

    Float:

      type: string

      type: number

      format: float

    DateTime:

      type: string

      format: date-Time

    Dn:

      type: string

    DnList:

      type: array

      items:

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

    Mcc:

      type: string

      pattern: '^[0-9]{3}$'

    Mnc:

      type: string

      pattern: '^[0-9]{2,3}$'

    Fqdn:

      type: string

    Uri:

      type: string

    Ipv4Addr:

      type: string

      pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$'

      example: '198.51.100.1'

    Ipv6Addr:

      type: string

      allOf:

        - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$'

        - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$'

      example: '2001:db8:85a3::8a2e:370:7334'

    Ipv6Prefix:

      type: string

      allOf:

        - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$'

        - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$'

      example: '2001:db8:abcd:12::0/64'

    AdministrativeState:

      type: string

      enum:

        - LOCKED

        - UNLOCKED

    OperationalState:

      type: string

      enum:

        - ENABLED

        - DISABLED

    UsageState:

      type: string

      enum:

        - IDEL

        - ACTIVE

        - BUSY

    AttributeNameValuePairSet:

      type: object

      minProperties: 1
@@ -47,6 +91,11 @@ components: 
      type: string

    NotificationId:

      type: integer

    NotificationType:

      oneOf:

        - $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationType'

        - $ref: 'provMnS.yaml#/components/schemas/CmNotificationType'

        # more to be added

    NotificationHeader:

      description: >-

        Header used for all notifications types
@@ -63,10 +112,7 @@ components: 
        notificationId:

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

        notificationType:

          oneOf:

            - $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes'

            #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes'

            # more to be added

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

        eventTime:

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

        systemDN: