diff --git a/OpenAPI/TS28312_IntentExpectations.yaml b/OpenAPI/TS28312_IntentExpectations.yaml index b48f7afaf39b787dbd54b2709da94e896b47a0fa..b8c44996d60e77b24fb715444f65aa11316bf9c7 100644 --- a/OpenAPI/TS28312_IntentExpectations.yaml +++ b/OpenAPI/TS28312_IntentExpectations.yaml @@ -243,7 +243,10 @@ components: #-------Definition of the Scenario specific ExpectationTarget dataType----------# WeakRSRPRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for WeakRSRPRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for WeakRSRPRatioTarget. It describes + the downlink weak coverage ratio target for the RAN SubNetwork that the intent expectation is applied. + The numerator is the number of the cells with downlink weak RSRP, and the denominator is the total number + of cells of the RAN Subnetwork in the specified area. type: object properties: targetName: @@ -262,7 +265,9 @@ components: $ref: '#/components/schemas/WeakRSRPContext' WeakRSRPContext: description: >- - This data type is the "TargetContext" data type with specialisations for WeakRSRPContext + This data type is the "TargetContext" data type with specialisations for WeakRSRPContext. It describes the threshold + for downlink weak RSRP of the cells (see RSRP measurements in TS 28.552 [6]) of the RAN SubNetwork that the intent + expectation is applied. type: object properties: contextAttribute: @@ -277,7 +282,9 @@ components: type: number LowSINRRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for LowSINRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for LowSINRatioTarget.It describes the low SINR + ratio target for the RAN SubNetwork that the intent expectation is applied. The numerator is the number of the cells with + low SINR, and the denominator is the total number of cells of the RAN Subnetwork in the specified area. type: object properties: targetName: @@ -296,7 +303,8 @@ components: $ref: '#/components/schemas/LowSINRContext' LowSINRContext: description: >- - This data type is the "TargetContext" data type with specialisations for LowSINRContext + This data type is the "TargetContext" data type with specialisations for LowSINRContext.It describes the threshold for + low SINR of the cells (see SINR measurements in TS 28.552 [6]) of the RAN SubNetwork that the intent expectation is applied. type: object properties: contextAttribute: @@ -311,7 +319,9 @@ components: type: integer AveULRANUEThptTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for AveULRANUEThptTarget + This data type is the "ExpectationTarget" data type with specialisations for AveULRANUEThptTarget.It describes the average + UL RAN UE throughput target for RAN SubNetwork (see UL RAN UE throughput for a sub-network in TS 28.554[11]) that the intent + expectation is applied. type: object properties: targetName: @@ -326,7 +336,9 @@ components: type: integer AveDLRANUEThptTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for AveDLRANUEThptTarget + This data type is the "ExpectationTarget" data type with specialisations for AveDLRANUEThptTarget.It describes the average + DL RAN UE throughput target for RAN SubNetwork (see DL RAN UE throughput for a sub-network in TS 28.554[11]) that the intent + expectation is applied. type: object properties: targetName: @@ -341,7 +353,10 @@ components: type: integer LowULRANUEThptRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for LowULRANUEThptRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for LowULRANUEThptRatioTarget.It describes the low + UL RAN UE throughput ratio target for the RAN SubNetwork that the intent expectation is applied. The numerator is the number + of the cells with low UL RAN UE throughput, and the denominator is the total number of cells of the RAN Subnetwork in the + specified area. type: object properties: targetName: @@ -360,7 +375,9 @@ components: $ref: '#/components/schemas/LowULRANUEThptContext' LowULRANUEThptContext: description: >- - This data type is the "TargetContext" data type with specialisations for LowULRANUEThptContext + This data type is the "TargetContext" data type with specialisations for LowULRANUEThptContext.It describes the threshold + for the low UL RAN UE throughput cells (see average UL RAN UE throughput in gNB and distribution of UL UE throughput in gNB + in TS 28.552[6]) of the RAN SubNetwork that the intent expectation is applied. type: object properties: contextAttribute: @@ -375,7 +392,10 @@ components: type: number LowDLRANUEThptRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for LowDLRANUEThptRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for LowDLRANUEThptRatioTarget. It describes + the low DL RAN UE throughput ratio target for the RAN SubNetwork that the intent expectation is applied.The numerator + is the number of the cells with low DL RAN UE throughput, and the denominator is the total number of cells of the + RAN Subnetwork in the specified area. type: object properties: targetName: @@ -394,7 +414,9 @@ components: $ref: '#/components/schemas/LowDLRANUEThptContext' LowDLRANUEThptContext: description: >- - This data type is the "TargetContext" data type with specialisations for LowDLRANUEThptContext + This data type is the "TargetContext" data type with specialisations for LowDLRANUEThptContext.It describes the threshold + for the low DL RAN UE throughput cells ((see average DL RAN UE throughput in gNB and distribution of DL UE throughput in gNB + in TS 28.552[6]) ) of the RAN SubNetwork that the intent expectation is applied. type: object properties: contextAttribute: @@ -409,7 +431,9 @@ components: type: number HighULPrbLoadRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for HighULPrbLoadRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for HighULPrbLoadRatioTarget. It describes the high UL + PRB load ratio target (as percentage) for the RAN SubNetwork that the intent expectation is applied. The numerator is the number + of the cells with high UL PRB load, and the denominator is the total number of cells of the RAN Subnetwork in the specified area. type: object properties: targetName: @@ -428,7 +452,9 @@ components: $ref: '#/components/schemas/HighULPrbLoadContext' HighULPrbLoadContext: description: >- - This data type is the "TargetContext" data type with specialisations for HighULPrbLoadContext + This data type is the "TargetContext" data type with specialisations for HighULPrbLoadContext.It describes the threshold for high + uplink PRB load (i.e. UL Total PRB Usage in TS 28.552 [12] to represent the percentage of UL PRBs used) of the cells of the RAN + SubNetwork in the specified area that the intent expectation is applied. type: object properties: contextAttribute: @@ -445,7 +471,9 @@ components: maximum: 100 HighDLPrbLoadRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for HighDLPrbLoadRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for HighDLPrbLoadRatioTarget.It describes the high DL PRB + load ratio target (as percentage) for the RAN SubNetwork that the intent expectation is applied. The numerator is the number of the + cells with high DL PRB load, and the denominator is the total number of cells of the RAN Subnetwork in the specified area. type: object properties: targetName: @@ -464,7 +492,9 @@ components: $ref: '#/components/schemas/HighDLPrbLoadContext' HighDLPrbLoadContext: description: >- - This data type is the "TargetContext" data type with specialisations for HighDLPrbLoadContext + This data type is the "TargetContext" data type with specialisations for HighDLPrbLoadContext.It describes the threshold for high downlink + PRB load (i.e. DL Total PRB Usage in TS 28.552 [12] to represent the percentage of DL PRBs used) of the cells of the RAN SubNetwork in the + specified area that the intent expectation is applied. type: object properties: contextAttribute: @@ -481,7 +511,9 @@ components: maximum: 100 AveULPrbLoadTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for AveULPrbLoadTarget + This data type is the "ExpectationTarget" data type with specialisations for AveULPrbLoadTarget.It describes the average uplink PRB load target + (i.e. UL Total PRB Usage in TS 28.552 [12] to represent the percentage of UL PRBs used) of the cells of the RAN SubNetwork that the intent + expectation is applied. type: object properties: targetName: @@ -498,7 +530,9 @@ components: maximum: 100 AveDLPrbLoadTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for AveDLPrbLoadTarget + This data type is the "ExpectationTarget" data type with specialisations for AveDLPrbLoadTarget.It describes the average dowlink PRB load + (i.e. DL Total PRB Usage in TS 28.552 [12] to represent the percentage of DL PRBs used) target for RAN SubNetwork that the intent expectation + is applied. type: object properties: targetName: @@ -515,7 +549,9 @@ components: maximum: 100 RANEnergyConsumptionTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for RANEnergyConsumptionTarget + This data type is the "ExpectationTarget" data type with specialisations for RANEnergyConsumptionTarget.It describes the RAN energy consumption + target for RAN SubNetwork that the intent expectation is applied. The definition for RAN energy consumption see ECNG-RAN in clause 6.7.3.4.1 in + TS 28.554 [11]. type: object properties: targetName: @@ -530,7 +566,9 @@ components: type: integer RANEnergyEfficiencyTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for RANEnergyEfficiencyTarget + This data type is the "ExpectationTarget" data type with specialisations for RANEnergyEfficiencyTarget.It describes the RAN energy efficiency target + for RAN SubNetwork that the intent expectation is applied. The unit of this target is bit/J. The definition for RAN energy efficiency target for RAN + SubNetwork see EEMN,DV in clause 6.7.1.1 in TS 28.554 [11]. type: object properties: targetName: @@ -545,7 +583,8 @@ components: type: integer DLThptPerUETarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for DLThptPerUETarget + This data type is the "ExpectationTarget" data type with specialisations for DLThptPerUETarget. It describes the DL throughput target by the per UE for the + edge service supporting or radio servicde that the intent expectation is applied. For details see dlThptPerUE defined in clause 6.3.1 of TS 28.541 [5]. type: object properties: targetName: @@ -560,7 +599,8 @@ components: $ref: 'TS28541_SliceNrm.yaml#/components/schemas/XLThpt' ULThptPerUETarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for ULThptPerUETarget + This data type is the "ExpectationTarget" data type with specialisations for ULThptPerUETarget.It describes the UL throughput target by the per UE for the edge + service supporting or radio service that the intent expectation is applied. For details see ulThptPerUE defined in clause 6.3.1 of TS 28.541 [5]. type: object properties: targetName: @@ -572,10 +612,11 @@ components: enum: - IS_GREATER_THAN targetValueRange: - $ref: 'TS28541_SliceNrm.yaml#/components/schemas/XLThpt' + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/XLThpt' DLLatencyTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for DLLatencyTarget + This data type is the "ExpectationTarget" data type with specialisations for DLLatencyTarget.It describes the DL latency target for the edge service supporting or radio service + that the intent expectation is applied type: object properties: targetName: @@ -590,7 +631,8 @@ components: type: integer ULLatencyTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for ULLatencyTarget + This data type is the "ExpectationTarget" data type with specialisations for ULLatencyTarget. It describes the UL latency target for the edge service supporting or radioService + that the intent expectation is applied. For details see attribute ulLatency defined in clause 6.3.1 of TS 28.541 [5] type: object properties: targetName: @@ -605,7 +647,8 @@ components: type: integer MaxNumberofUEsTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofUEsTarget + This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofUEsTarget.It describes the the number of UEs for edge service supporting + that the intent expectation is applied. For details see attribute maxNumberofUE defined in clause 6.3.1 of of TS 28.541 [5] type: object properties: targetName: @@ -620,7 +663,9 @@ components: type: integer ActivityFactorTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for ActivityFactorTarget + This data type is the "ExpectationTarget" data type with specialisations for ActivityFactorTarget.It describes the percentage value of the amount of simultaneous + active UEs to the total number of UEs where active means the UEs are exchanging data with the edge service supporting that the intent expectation is applied. + For details see activityFactor in clause 6.3.1 in TS 28.541 [5]. type: object properties: targetName: @@ -635,7 +680,8 @@ components: type: integer UESpeedTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for UESpeedTarget + This data type is the "ExpectationTarget" data type with specialisations for UESpeedTarget.It describes the speed (in km/hour) supported for edge service supporting + that the intent expectation is applied. For details see uESpeed in clause 6.3.1 in TS 28.541[5]. type: object properties: targetName: @@ -650,7 +696,8 @@ components: type: integer MaxNumberofPDUsessionsTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofPDUsessionsTarget + This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofPDUsessionsTarget.It describes the maximum number of PDU sessions for 5GC + SubNetwork supporting that the intent expectation is applied. For details, see maxNumberofPDUsessions in clause 5.3.1.2 in TS 28.552 [12]. type: object properties: targetName: @@ -667,7 +714,8 @@ components: $ref: '#/components/schemas/5GSessionContext' 5GSessionContext: description: >- - This data type is the "TargetContext" data type with specialisations for 5GSessionContext + This data type is the "TargetContext" data type with specialisations for 5GSessionContext.It describes the maximum supported 5G PDU session of the 5GC SubNetwork + related to the intent expectation. type: object properties: contextAttribute: @@ -682,7 +730,8 @@ components: type: integer MaxNumberofRegisteredsubscribersTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofRegisteredsubscribersTarget + This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofRegisteredsubscribersTarget.It describes the maximum number of Registered + subscribers for 5GC SubNetwork supporting that the intent expectation is applied. For details, see maxNumberofRegisteredsubscribers in clause 5.6.2 in TS 28.552 [12]. type: object properties: targetName: @@ -697,7 +746,8 @@ components: type: integer IncomingDataTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for IncomingDataTarget + This data type is the "ExpectationTarget" data type with specialisations for IncomingDataTarget.It describes the maximum incoming data packets for 5GC SubNetwork + related to the intent expectation. For details, see N6 incoming link usage measurement in clause 5.4.2.1 in TS 28.552 [12]. type: object properties: targetName: @@ -712,7 +762,8 @@ components: type: integer OutgoingDataTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for OutgoingDataTarget + This data type is the "ExpectationTarget" data type with specialisations for OutgoingDataTarget.It describes the maximum outgoing data packets for 5GC SubNetwork + related to the intent expectation. For details, see N6 outgoing link usage measurement in clause 5.4.2.2 in TS 28.552 [12]. type: object properties: targetName: @@ -731,7 +782,8 @@ components: #-------Definition of the concrete ObjectTarget dataType----------------# CoverageAreaPolygonContext: description: >- - This data type is the "ObjectContext" data type with specialisations for CoverageAreaPolygonContext + This data type is the "ObjectContext" data type with specialisations for CoverageAreaPolygonContext.It describes the coverage areas for the RAN SubNetwork that the + intent expectation is applied in the form of polygon. type: object properties: contextAttribute: @@ -746,7 +798,8 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea' CoverageTACContext: description: >- - This data type is the "ObjectContext" data type with specialisations for CoverageTACContext + This data type is the "ObjectContext" data type with specialisations for CoverageTACContext.It describes the coverage areas for the RAN SubNetwork that the intent + expectation is applied in the form of TAC. type: object properties: contextAttribute: @@ -780,9 +833,8 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' DlFrequencyContext: description: >- - 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. + 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: @@ -799,9 +851,8 @@ components: $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Frequency' UlFrequencyContext: description: >- - This data type is the "Context" data type with specialisations for Object context "ULFrequencyContext". - 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. + This data type is the "Context" data type with specialisations for Object context "ULFrequencyContext".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: @@ -818,7 +869,8 @@ components: $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Frequency' RATContext: description: >- - This data type is the "ObjectContext" data type with specialisations for RATContext + This data type is the "ObjectContext" data type with specialisations for RATContext.It describes the RAT supported by the RAN SubNetwork that the intent expectation + is applied. type: object properties: contextAttribute: @@ -992,7 +1044,8 @@ components: TargetAssuranceTimeContext: description: >- - This data type is the "Expectation Context" data type with specialisations for TargetAssuranceTimeContext + This data type is the "Expectation Context" data type with specialisations for TargetAssuranceTimeContext.It describes the timeWindows + (including startTime, endTime) when the targets in the Intent Expectation need to be assured. type: object properties: contextAttribute: @@ -1068,7 +1121,8 @@ components: $ref: "TS28541_SliceNrm.yaml#/components/schemas/SharingLevel" ServiceTypeContext: description: >- - This data type is the "ExpectationContext" data type with specialisations for ServiceTypeContext + This data type is the "ExpectationContext" data type with specialisations for ServiceTypeContext.It describes + the service type for the Radio Service that the intent expectation is applied. For details see sST in clause 6.4.1 in TS 28.541 [5] type: object properties: contextAttribute: diff --git a/OpenAPI/TS28312_IntentNrm.yaml b/OpenAPI/TS28312_IntentNrm.yaml index 130494e0230e7c9588ba2cf28d8f1a4d245e379e..5c5e2a3027c2474cbe2131f4f7ca9c57d1e829a1 100644 --- a/OpenAPI/TS28312_IntentNrm.yaml +++ b/OpenAPI/TS28312_IntentNrm.yaml @@ -150,13 +150,12 @@ components: objectType: type: string enum: - - RAN_SubNetwork #value for Radio Network Expectation--# - - Edge_Service_Support #value for Edge Service Support Expectation--# - - 5GC_SubNetwork #value for 5GC Network Expectation--# + - RAN_SUBNETWORK #value for Radio Network Expectation--# + - EDGE_SERVICE_SUPPORT #value for Edge Service Support Expectation--# + - 5GC_SUBNETWORK #value for 5GC Network Expectation--# + - Radio_Service #value for Radio Service Expectation--# objectInstance: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - contextSelectivity: - $ref: "#/components/schemas/Selectivity" objectContexts: type: array items: @@ -227,7 +226,7 @@ components: enum: - DELIVER - ENSURE - description: It describes the characteristic of the intentExpectation and is the property that describes the types of intentExpectations. + description: It describes the characteristic of the intentExpectation and is the property that describes the types of intentExpectations. Vendor extensions are allowed Frequency: description: >- It desribes the RF reference frequency (i.e. Absolute Radio Frequency Channel Number) @@ -360,6 +359,9 @@ components: $ref: '#/components/schemas/FulfilmentInfo' targetAchievedValue: type: number + description: >- + It describes the value that has been achieved for the expectation target at the time at which + the report is generated. #-------Definition of the concrete TargetFulfilmentResult dataType----------------# #-------Definition of the generic IntentConflictReport dataType----------------# @@ -429,6 +431,7 @@ components: - RAN_SUBNETWORK - EDGE_SERVICE_SUPPORT - 5GC_SUBNETWORK + - Radio_Service description: It describes the expectation object type which can be supported by a specific intent handling function of MnS producer. supportedExpectationTargetNames: type: array