Commit 0087d286 authored by mouqueta's avatar mouqueta
Browse files

Merge branch 'Integration_Rel18_SA5_152_YAML' into 'Rel-18' 

SA5#151 152 OpenAPI SS changes for Rel-18

See merge request !959
parents d6d31f3e e44f2ba0

OpenAPI/README.md

+13 −1
Original line number Diff line number Diff line
@@ -15,6 +15,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/TS28623_ComDefs.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_ComDefs.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))



* 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,6 +39,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/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))
@@ -51,6 +59,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/TS28105_AiMlNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28105_AiMlNrm.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))



## Management Services (MnS)



* Provisioning MnS (TS 28.532)
@@ -90,4 +102,4 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f 


## Other 3GPP API definitions



* [CT4](https://forge.3gpp.org/rep/3GPP/5G_APIs) specifications.
 
* [5G_APIs](https://forge.3gpp.org/rep/3GPP/5G_APIs) specifications.

OpenAPI/TS28104_MdaReport.yaml

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

info:

  title: MDA Report

  version: 18.0.0

  version: 18.2.0

  description: >-

    OAS 3.0.1 specification of the MDA Report

    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
@@ -20,7 +20,7 @@ components: 
      properties:

        mDAType:

          type: string

        mdaOutputList:

        mDAOutputList:

          type: array

          items:

            $ref: '#/components/schemas/MDAOutputEntry'
@@ -37,7 +37,7 @@ components: 
      properties:

        mDAOutputIEName:

          type: string

        mdaOutputIEValue: {}

        mDAOutputIEValue: {}





    TimeWindow:

OpenAPI/TS28105_AiMlNrm.yaml

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

info:

  title: AI/ML NRM

  version: 18.1.0

  version: 18.2.0

  description: >-

    OAS 3.0.1 specification of the AI/ML NRM

    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
@@ -201,6 +201,8 @@ components: 
                      $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

                    trainingReportRef:

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

                    mLEnityGeneratedRef:

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





    MLTrainingReport-Single:
@@ -220,7 +222,7 @@ components: 
                      type: array

                      items:

                        type: string

                    confidenceIndication:

                    modelConfidenceIndication:

                      type: integer

                    modelPerformanceTraining:

                      type: array

OpenAPI/TS28312_IntentExpectations.yaml

+225 −49
Original line number Diff line number Diff line 
openapi: 3.0.1

info:

  title: Scenario specific Intent Expectations

  version: 18.1.0

  version: 18.2.0

  description: >-

    OAS 3.0.1 definition of scenario specific Intent Expectations 

    © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
@@ -46,7 +46,37 @@ components: 
        expectationContexts:

          type: array

          items:

            $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationContext'

            type: object

            oneOf:

             - $ref: '#/components/schemas/TargetAssuranceTimeContext'

             - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context'

      required:

        - expectationId

    RadioServiceExpectation:

      description: >-

        This data type is the "IntentExpectation" data type with specialisations to represent MnS consumer's expectations for radio service delivering   

      type: object

      properties:

        expectationId:

          type: string

        expectationVerb:

           $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationVerb"

        expectationObject:

          $ref: "#/components/schemas/RadioServiceExpectationObject"

        expectationTargets:

          type: array

          items:

            type: object

            oneOf:

              - $ref: '#/components/schemas/DLLatencyTarget'

              - $ref: '#/components/schemas/ULLatencyTarget'

              - $ref: '#/components/schemas/DLThptPerUETarget'

              - $ref: '#/components/schemas/ULThptPerUETarget'

              - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationTarget'

        expectationContexts:

          type: array

          items:

            $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context'

      required:

        - expectationId                   

    EdgeServiceSupportExpectation:
@@ -82,7 +112,7 @@ components: 
              - $ref: '#/components/schemas/ServiceEndTimeContext'

              - $ref: '#/components/schemas/UEMobilityLevelContext'

              - $ref: '#/components/schemas/ResourceSharingLevelContext'

              - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationContext'

              - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context'

      required:

        - expectationId   

    5GCNetworkExpectation:
@@ -105,11 +135,17 @@ components: 
            oneOf:

              - $ref: "#/components/schemas/MaxNumberofPDUsessionsTarget"

              - $ref: "#/components/schemas/MaxNumberofRegisteredsubscribersTarget"

              - $ref: "#/components/schemas/IncomingDataTarget"

              - $ref: "#/components/schemas/OutgoingDataTarget"

              - $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationTarget"

        expectationContexts:

          type: array

          items:

            $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationContext"

            type: object

            oneOf:

              - $ref: '#/components/schemas/StartTimeContext'

              - $ref: '#/components/schemas/ResourceSharingLevelContext'

              - $ref: "TS28312_IntentNrm.yaml#/components/schemas/Context"

        expectationfulfilmentInfo:

            $ref: "TS28312_IntentNrm.yaml#/components/schemas/FulfilmentInfo" 

      required:
@@ -136,10 +172,30 @@ components: 
              - $ref: '#/components/schemas/CoverageAreaPolygonContext'

              - $ref: '#/components/schemas/CoverageTACContext'

              - $ref: '#/components/schemas/PLMNContext'

              - $ref: '#/components/schemas/NRFqBandContext'

              - $ref: '#/components/schemas/DlFrequencyContext'

              - $ref: '#/components/schemas/UlFrequencyContext'              

              - $ref: '#/components/schemas/RATContext'

              - $ref: "#/components/schemas/UEGroupContext"

              - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ObjectContext'                                

              - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context'                                

    RadioServiceExpectationObject:

      description: >-

        This data type is the "ExpectationObject" data type with specialisations for RadioServicekExpectation

      type: object

      properties:

        objectType:

          type: string

          enum:

            - Radio_Service

        objectInstance:

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

        objectContexts:

          type: array

          items:

            type: object

            oneOf:

              - $ref: '#/components/schemas/CoverageAreaPolygonContext'

              - $ref: '#/components/schemas/ServiceTypeContext'

              - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context'

    ServiceSupportExpectationObject: 

      description: >-

        This data type is the "ExpectationObject" data type with specialisations for EdgeServiceSupportExpectation
@@ -159,7 +215,7 @@ components: 
              - $ref: '#/components/schemas/EdgeIdenfiticationIdContext'

              - $ref: '#/components/schemas/EdgeIdentificationLocContext'

              - $ref: '#/components/schemas/CoverageAreaTAContext'   

              - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ObjectContext'   

              - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context'   

    5GCNetworkExpectationObject:

      description: >-

        This data type is the "ExpectationObject" data type with specialisations for 5GCNetworkExpectation
@@ -180,7 +236,9 @@ components: 
              - $ref: "#/components/schemas/NfInstanceLocationContext"

              - $ref: "#/components/schemas/PLMNContext"

              - $ref: "#/components/schemas/TaiContext"

              - $ref: "#/components/schemas/ObjectContext"            

              - $ref: "#/components/schemas/ServingScopeContext"

              - $ref: "#/components/schemas/DnnContext"

              - $ref: "TS28312_IntentNrm.yaml#/components/schemas/Context"

   #-------Definition of the ExpectationObject dataType ----------#
@@ -607,6 +665,23 @@ components: 
            - IS_LESS_THAN

        targetValueRange:

          type: integer

        targetContexts:

          $ref: '#/components/schemas/5GSessionContext'

    5GSessionContext:

      description: >-

        This data type is the "TargetContext" data type with specialisations for 5GSessionContext      

      type: object

      properties:

        contextAttribute:

          type: string

          enum:

            - 5GSession

        contextCondition:

          type: string

          enum:

            - IS_less_THAN

        contextValueRange:

          type: integer

    MaxNumberofRegisteredsubscribersTarget:

      description: >-

        This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofRegisteredsubscribersTarget
@@ -622,23 +697,40 @@ components: 
            - IS_LESS_THAN

        targetValueRange:

          type: integer



   #-------Definition of the concrete ExpectationTarget  dataType----------#  

   

   #-------Definition of the concrete ObjectTarget dataType----------------#

    ObjectContext:

    IncomingDataTarget:

      description: >-

        This data type is the "ObjectContext" data type without specialisations        

        This data type is the "ExpectationTarget" data type with specialisations for IncomingDataTarget     

      type: object

      properties:

        contextAttribute:

        targetName:

          type: string

        contextCondition:

          $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Condition'

        contextValueRange:

          type: array

          items:

            type: number 

          enum:

            - IncomingData

        targetCondition:

          type: string

          enum:

            - IS_LESS_THAN

        targetValueRange:

          type: integer

    OutgoingDataTarget:

      description: >-

        This data type is the "ExpectationTarget" data type with specialisations for OutgoingDataTarget     

      type: object

      properties:

        targetName:

          type: string

          enum:

            - OutgoingData

        targetCondition:

          type: string

          enum:

            - IS_LESS_THAN

        targetValueRange:

          type: integer



   #-------Definition of the concrete ExpectationTarget  dataType----------#  

   

   #-------Definition of the concrete ObjectTarget dataType----------------#

    CoverageAreaPolygonContext:

      description: >-

        This data type is the "ObjectContext" data type with specialisations for CoverageAreaPolygonContext
@@ -653,11 +745,7 @@ components: 
          enum:

            - IS_ALL_OF

        contextValueRange:

          type: array

          items:

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

    CoverageArea:

      type: string

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

    CoverageTACContext:

      description: >-

        This data type is the "ObjectContext" data type with specialisations for CoverageTACContext
@@ -674,7 +762,7 @@ components: 
        contextValueRange:

          type: array

          items:

            $ref: 'TS28541_NrNrm.yaml#/components/schemas/NrTac'

            $ref: "TS28623_ComDefs.yaml#/components/schemas/Tac"

    PLMNContext:

      description: >-

        This data type is the "ObjectContext" data type with specialisations for PLMNContext
@@ -692,15 +780,17 @@ components: 
          type: array

          items:

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

    NRFqBandContext:

    DlFrequencyContext:

      description: >-

        This data type is the "ObjectContext" data type with specialisations for NRFqBandContext       

        This data type is the "Context" data type with specialisations for Object context "DLFrequencyContext".

        It describes the downlink frequency information (RF reference frequencies and/ or the 

        frequency operating band) supported by the RAN SubNetwork that the intent expectation is applied.       

      type: object

      properties:

        contextAttribute:

          type: string

          enum:

            - NRFqBand

            - DlFrequency

        contextCondition:

          type: string

          enum:
@@ -708,7 +798,26 @@ components: 
        contextValueRange:

          type: array

          items:

            $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Frequency'

    UlFrequencyContext:

      description: >-

        This data type is the "Context" data type with specialisations for Object context "DLFrequencyContext".

        It describes the uplink frequency information (RF reference frequencies and/ or the frequency 

        operating band) supported by the RAN SubNetwork that the intent expectation is applied.       

      type: object

      properties:

        contextAttribute:

          type: string

          enum:

            - UlFrequency

        contextCondition:

          type: string

          enum:

            - IS_ALL_OF

        contextValueRange:

          type: array

          items:

            $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Frequency'            

    RATContext:

      description: >-

        This data type is the "ObjectContext" data type with specialisations for RATContext
@@ -746,14 +855,7 @@ components: 
        contextValueRange:

          type: array

          items:

            $ref: "#/components/schemas/UEGroup"            

    UEGroup:

      type: object

      properties:

        fiveQI:

          type: integer

        sNssai:

          $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai'  

            $ref: "TS28312_IntentNrm.yaml#/components/schemas/UEGroup"              

    EdgeIdenfiticationIdContext:

      description: >-

        This data type is the "ObjectContext" data type with specialisations for EdgeIdentificationIdContext
@@ -768,8 +870,6 @@ components: 
          enum:

            - IS_EQUAL_TO

        contextValueRange:

          type: array

          items:

          type: string

    EdgeIdentificationLocContext:

      description: >-
@@ -785,9 +885,7 @@ components: 
          enum:

            - IS_EQUAL_TO

        contextValueRange:

          type: array

          items:

            type: string

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

    CoverageAreaTAContext:

      description: >-

        This data type is the "ObjectContext" data type with specialisations for CoverageAreaTAContext
@@ -804,9 +902,7 @@ components: 
        contextValueRange:

          type: array

          items:

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

    CoverageAreaTAList:

          type: integer

            $ref: "TS28623_ComDefs.yaml#/components/schemas/Tac"

    NfTypeContext:          

      description: >-

        This data type is the "ObjectContext" data type with specialisations for NfTypeContext
@@ -858,10 +954,60 @@ components: 
          type: array

          items:

            $ref: "TS28623_GenericNrm.yaml#/components/schemas/Tai"



    ServingScopeContext:          

      description: >-

        This data type is the "ObjectContext" data type with specialisations for ServingScopeContext   

      type: object

      properties:

        contextAttribute:

          type: string

          enum:

            - ServingScope

        contextCondition:

          type: string

          enum:

            - IS_ALL_OF

        contextValueRange:

          type: array

          items:

            type: string

    DnnContext:          

      description: >-

        This data type is the "ObjectContext" data type with specialisations for DnnContext   

      type: object

      properties:

        contextAttribute:

          type: string

          enum:

            - Dnn

        contextCondition:

          type: string

          enum:

            - IS_ALL_OF

        contextValueRange:

          type: array

          items:

            type: string

   #-------Definition of the scenario specific  ObjectTarget dataType----------------#

   

   #-------Definition of the concrete ExpectationContext dataType----------------#



    TargetAssuranceTimeContext:

      description: >-

        This data type is the "Expectation Context" data type with specialisations for TargetAssuranceTimeContext       

      type: object

      properties:

        contextAttribute:

          type: string

          enum:

            - TargetAssuranceTime

        contextCondition:

          type: string

          enum:

            - IS_EQUAL_TO

        contextValueRange:

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



    ServiceStartTimeContext:

      description: >-

        This data type is the "ExpectationContext" data type with specialisations for ServiceStartTimeContext
@@ -922,4 +1068,34 @@ components: 
            - IS_EQUAL_TO

        contextValueRange:

          $ref: "TS28541_SliceNrm.yaml#/components/schemas/SharingLevel"

    ServiceTypeContext:

      description: >-

        This data type is the "ExpectationContext" data type with specialisations for ServiceTypeContext       

      type: object

      properties:

        contextAttribute:

          type: string

          enum:

            - ServiceType

        contextCondition:

          type: string

          enum:

            - IS_EQUAL_TO

        contextValueRange:

          $ref: "TS28541_NrNrm.yaml#/components/schemas/Sst"

    StartTimeContext:

      description: >-

        This data type is the "ExpectationContext" data type with specialisations for StartTimeContext       

      type: object

      properties:

        contextAttribute:

          type: string

          enum:

            - StartTime

        contextCondition:

          type: string

          enum:

            - IS_EQUAL_TO

        contextValueRange:

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

   #-------Definition of the concrete ExpectionContext dataType----------------#

OpenAPI/TS28312_IntentNrm.yaml

+150 −95

File changed.

Preview size limit exceeded, changes collapsed.