diff --git a/OpenAPI/TS28312_IntentExpectations.yaml b/OpenAPI/TS28312_IntentExpectations.yaml index 8db5343f9515a80e7e408d3670858a8f8abc9221..e10f7bd52c0eefd4250d0506ad2f1458a61ff4e4 100644 --- a/OpenAPI/TS28312_IntentExpectations.yaml +++ b/OpenAPI/TS28312_IntentExpectations.yaml @@ -22,11 +22,11 @@ components: expectationId: type: string expectationVerb: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationVerb" + $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationVerb' expectationObjects: type: array items: - $ref: "#/components/schemas/RadioNetworkExpectationObject" + $ref: '#/components/schemas/RadioNetworkExpectationObject' expectationTargets: type: array items: @@ -45,9 +45,7 @@ components: expectationContexts: type: array items: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationContext" - expectationfulfilmentInfo: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/FulfilmentInfo" + $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationContext' required: - expectationId ServiceSupportExpectation: @@ -58,36 +56,34 @@ components: expectationId: type: string expectationVerb: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationVerb" + $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationVerb' expectationObjects: type: array items: - $ref: "#/components/schemas/ServiceSupportExpectationObject" + $ref: '#/components/schemas/ServiceSupportExpectationObject' expectationTargets: type: array items: type: object oneOf: - - $ref: "#/components/schemas/DLThptPerUETarget" - - $ref: "#/components/schemas/ULThptPerUETarget" - - $ref: "#/components/schemas/DLLatencyTarget" - - $ref: "#/components/schemas/ULLatencyTarget" - - $ref: "#/components/schemas/MaxNumberofUEsTarget" - - $ref: "#/components/schemas/ActivityFactorTarget" - - $ref: "#/components/schemas/UESpeedTarget" - - $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationTarget" + - $ref: '#/components/schemas/DLThptPerUETarget' + - $ref: '#/components/schemas/ULThptPerUETarget' + - $ref: '#/components/schemas/DLLatencyTarget' + - $ref: '#/components/schemas/ULLatencyTarget' + - $ref: '#/components/schemas/MaxNumberofUEsTarget' + - $ref: '#/components/schemas/ActivityFactorTarget' + - $ref: '#/components/schemas/UESpeedTarget' + - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationTarget' expectationContexts: type: array items: type: object oneOf: - - $ref: "#/components/schemas/ServiceStartTimeContext" - - $ref: "#/components/schemas/ServiceEndTimeContext" - - $ref: "#/components/schemas/UEMobilityLevelContext" - - $ref: "#/components/schemas/ResourceSharingLevelContext" - - $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationContext" - expectationfulfilmentInfo: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/FulfilmentInfo" + - $ref: '#/components/schemas/ServiceStartTimeContext' + - $ref: '#/components/schemas/ServiceEndTimeContext' + - $ref: '#/components/schemas/UEMobilityLevelContext' + - $ref: '#/components/schemas/ResourceSharingLevelContext' + - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationContext' required: - expectationId #-------Definition of the IntentExpectation dataType ----------# @@ -103,18 +99,18 @@ components: enum: - RAN_SubNetwork #value for Radio Network Expectation--# objectInstance: - $ref: "TS28623_ComDefs.yaml#/components/schemas/Dn" + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' objectContexts: type: array items: type: object oneOf: - - $ref: "#/components/schemas/CoverageAreaPolygonContext" - - $ref: "#/components/schemas/CoverageTACContext" - - $ref: "#/components/schemas/PLMNContext" - - $ref: "#/components/schemas/NRFqBandContext" - - $ref: "#/components/schemas/RATContext" - - $ref: "#/components/schemas/ObjectContext" + - $ref: '#/components/schemas/CoverageAreaPolygonContext' + - $ref: '#/components/schemas/CoverageTACContext' + - $ref: '#/components/schemas/PLMNContext' + - $ref: '#/components/schemas/NRFqBandContext' + - $ref: '#/components/schemas/RATContext' + - $ref: '#/components/schemas/ObjectContext' ServiceSupportExpectationObject: description: >- This data type is the "ExpectationObject" data type with specialisations for ServiceSupportExpectation @@ -125,16 +121,16 @@ components: enum: - Service_Support #value for Service Support Expectation--# objectInstance: - $ref: "TS28623_ComDefs.yaml#/components/schemas/Dn" + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' objectContexts: type: array items: type: object oneOf: - - $ref: "#/components/schemas/EdgeIdentificationIdContext" - - $ref: "#/components/schemas/EdgeIdentificationLocContext" - - $ref: "#/components/schemas/CoverageAreaTAContext" - - $ref: "#/components/schemas/ObjectContext" + - $ref: '#/components/schemas/EdgeIdentificationIdContext' + - $ref: '#/components/schemas/EdgeIdentificationLocContext' + - $ref: '#/components/schemas/CoverageAreaTAContext' + - $ref: '#/components/schemas/ObjectContext' #-------Definition of the ExpectationObject dataType ----------# @@ -157,9 +153,7 @@ components: minimum: 0 maximum: 100 targetContexts: - $ref: "#/components/schemas/WeakRSRPContext" - targetFulfilmentInfo: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/FulfilmentInfo" + $ref: '#/components/schemas/WeakRSRPContext' WeakRSRPContext: description: >- This data type is the "TargetContext" data type with specialisations for WeakRSRPContext @@ -193,9 +187,7 @@ components: minimum: 0 maximum: 100 targetContexts: - $ref: "#/components/schemas/LowSINRContext" - targetFulfilmentInfo: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/FulfilmentInfo" + $ref: '#/components/schemas/LowSINRContext' LowSINRContext: description: >- This data type is the "TargetContext" data type with specialisations for LowSINRContext @@ -226,8 +218,6 @@ components: - IS_GREATER_THAN targetValueRange: type: integer - targetFulfilmentInfo: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/FulfilmentInfo" AveDLRANUEThptTarget: description: >- This data type is the "ExpectationTarget" data type with specialisations for AveDLRANUEThptTarget @@ -243,8 +233,6 @@ components: - IS_GREATER_THAN targetValueRange: type: integer - targetFulfilmentInfo: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/FulfilmentInfo" LowULRANUEThptRatioTarget: description: >- This data type is the "ExpectationTarget" data type with specialisations for LowULRANUEThptRatioTarget @@ -263,9 +251,7 @@ components: minimum: 0 maximum: 100 targetContexts: - $ref: "#/components/schemas/LowULRANUEThptContext" - targetFulfilmentInfo: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/FulfilmentInfo" + $ref: '#/components/schemas/LowULRANUEThptContext' LowULRANUEThptContext: description: >- This data type is the "TargetContext" data type with specialisations for LowULRANUEThptContext @@ -299,9 +285,7 @@ components: minimum: 0 maximum: 100 targetContexts: - $ref: "#/components/schemas/LowDLRANUEThptContext" - targetFulfilmentInfo: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/FulfilmentInfo" + $ref: '#/components/schemas/LowDLRANUEThptContext' LowDLRANUEThptContext: description: >- This data type is the "TargetContext" data type with specialisations for LowDLRANUEThptContext @@ -437,7 +421,7 @@ components: enum: - IS_GREATER_THAN targetValueRange: - $ref: "TS28541_SliceNrm.yaml#/components/schemas/XLThpt" + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/XLThpt' ULThptPerUETarget: description: >- This data type is the "ExpectationTarget" data type with specialisations for ULThptPerUETarget @@ -452,7 +436,7 @@ 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 @@ -539,7 +523,7 @@ components: contextAttribute: type: string contextCondition: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/Condition" + $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Condition' contextValueRange: type: array items: @@ -560,7 +544,7 @@ components: contextValueRange: type: array items: - $ref: "#/components/schemas/CoverageArea" + $ref: '#/components/schemas/CoverageArea' CoverageArea: type: string CoverageTACContext: @@ -579,7 +563,7 @@ components: contextValueRange: type: array items: - $ref: "TS28541_NrNrm.yaml#/components/schemas/NrTac" + $ref: 'TS28541_NrNrm.yaml#/components/schemas/NrTac' PLMNContext: description: >- This data type is the "ObjectContext" data type with specialisations for PLMNContext @@ -596,7 +580,7 @@ components: contextValueRange: type: array items: - $ref: "TS28623_ComDefs.yaml#/components/schemas/PlmnId" + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' NRFqBandContext: description: >- This data type is the "ObjectContext" data type with specialisations for NRFqBandContext @@ -685,7 +669,7 @@ components: contextValueRange: type: array items: - $ref: "#/components/schemas/CoverageAreaTAList" + $ref: '#/components/schemas/CoverageAreaTAList' CoverageAreaTAList: type: integer #-------Definition of the scenario specific ObjectTarget dataType----------------# @@ -737,7 +721,7 @@ components: contextValueRange: type: array items: - $ref: "TS28541_SliceNrm.yaml#/components/schemas/MobilityLevel" + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/MobilityLevel' ResourceSharingLevelContext: description: >- This data type is the "ExpectationContext" data type with specialisations for ResourceSharingLevelContext @@ -754,5 +738,5 @@ components: contextValueRange: type: array items: - $ref: "TS28541_SliceNrm.yaml#/components/schemas/SharingLevel" - #-------Definition of the concrete ExpectationContext dataType----------------# + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/SharingLevel' + #-------Definition of the concrete ExpectionContext dataType----------------# diff --git a/OpenAPI/TS28312_IntentNrm.yaml b/OpenAPI/TS28312_IntentNrm.yaml index ad5776abab39cb7ed1af1789bf292a61d733203a..e66f20dd0dad610fc4096d396acf438a3b11838d 100644 --- a/OpenAPI/TS28312_IntentNrm.yaml +++ b/OpenAPI/TS28312_IntentNrm.yaml @@ -27,8 +27,8 @@ components: properties: SubNetwork: $ref: '#/components/schemas/SubNetwork-Multiple' - Intent: - $ref: '#/components/schemas/Intent-Multiple' + IntentHandlingFunction: + $ref: '#/components/schemas/IntentHandlingFunction-Multiple' Intent-Single: allOf: @@ -42,15 +42,52 @@ components: items: type: object oneOf: - - $ref: "#/components/schemas/IntentExpectation" - - $ref: "TS28312_IntentExpectations.yaml#/components/schemas/RadioNetworkExpectation" - - $ref: "TS28312_IntentExpectations.yaml#/components/schemas/ServiceSupportExpectation" + - $ref: '#/components/schemas/IntentExpectation' + - $ref: 'TS28312_IntentExpectations.yaml#/components/schemas/RadioNetworkExpectation' + - $ref: 'TS28312_IntentExpectations.yaml#/components/schemas/ServiceSupportExpectation' intentContexts: type: array items: - $ref: "#/components/schemas/IntentContext" - intentFulfilmentInfo: - $ref: "#/components/schemas/FulfilmentInfo" + $ref: '#/components/schemas/IntentContext' + observationPeriod: + type: integer + intentReportReference: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + IntentReport-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + intentFulfilmentReport: + type: array + items: + $ref: '#/components/schemas/IntentFulfilmentReport' + intentConflictReports: + type: array + items: + $ref: '#/components/schemas/IntentConflictReport' + intentFeasibilityCheckReport: + type: array + items: + $ref: '#/components/schemas/IntentFeasibilityCheckReport' + intentReference: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + IntentHandlingFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + intentHandlingCapabilityList: + type: array + items: + $ref: '#/components/schemas/IntentHandlingCapability' + Intent: + $ref: '#/components/schemas/Intent-Multiple' + IntentReport: + $ref: '#/components/schemas/IntentReport-Multiple' + #-------Definition of generic IOCs ----------# #-------Definition of the generic IntentExpectation dataType ----------# @@ -62,21 +99,19 @@ components: expectationId: type: string expectationVerb: - $ref: "#/components/schemas/ExpectationVerb" + $ref: '#/components/schemas/ExpectationVerb' expectationObjects: type: array items: - $ref: "#/components/schemas/ExpectationObject" + $ref: '#/components/schemas/ExpectationObject' expectationTargets: type: array items: - $ref: "#/components/schemas/ExpectationTarget" + $ref: '#/components/schemas/ExpectationTarget' expectationContexts: type: array items: - $ref: "#/components/schemas/ExpectationContext" - expectationfulfilmentInfo: - $ref: "#/components/schemas/FulfilmentInfo" + $ref: '#/components/schemas/ExpectationContext' required: - expectationId #-------Definition of the generic IntentExpectation dataType ----------# @@ -94,11 +129,11 @@ components: - Service_Support #value for Service Support Expectation--# - TBD #-This will be added based on defined scenario specific intent expectation-# objectInstance: - $ref: "TS28623_ComDefs.yaml#/components/schemas/Dn" + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' objectContexts: type: array items: - $ref: "#/components/schemas/ObjectContext" + $ref: '#/components/schemas/ObjectContext' #-------Definition of the generic ExpectationObject dataType ----------# @@ -136,7 +171,7 @@ components: type: object properties: fulfilStatus: - $ref: "#/components/schemas/FulfilStatus" + $ref: '#/components/schemas/FulfilStatus' notFullfilledState: description: -> An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo @@ -162,7 +197,7 @@ components: contextAttribute: type: string contextCondition: - $ref: "#/components/schemas/Condition" + $ref: '#/components/schemas/Condition' contextValueRange: type: array items: @@ -178,13 +213,13 @@ components: targetName: type: string targetCondition: - $ref: "#/components/schemas/Condition" + $ref: '#/components/schemas/Condition' targetValueRange: type: number targetContexts: type: array items: - $ref: "#/components/schemas/TargetContext" + $ref: '#/components/schemas/TargetContext' TargetContext: description: >- This data type is the "TargetContext" data type without specialisations @@ -193,7 +228,7 @@ components: contextAttribute: type: string contextCondition: - $ref: "#/components/schemas/Condition" + $ref: '#/components/schemas/Condition' contextValueRange: type: number #-------Definition of the generic ExpectationTarget dataType----------# @@ -207,7 +242,7 @@ components: contextAttribute: type: string contextCondition: - $ref: "#/components/schemas/Condition" + $ref: '#/components/schemas/Condition' contextValueRange: type: array items: @@ -223,13 +258,106 @@ components: contextAttribute: type: string contextCondition: - $ref: "#/components/schemas/Condition" + $ref: '#/components/schemas/Condition' contextValueRange: type: array items: type: number - #-------Definition of the concrete ExpectationContext dataType----------------# - + #-------Definition of the concrete ExpectionContext dataType----------------# + #-------Definition of the generic IntentFulfilmentReport dataType----------------# + IntentFulfilmentReport: + description: >- + This data type is the "IntentFulfilmentReport" data type without specialisations + type: object + properties: + intentFulfilmentInfo: + $ref: '#/components/schemas/FulfilmentInfo' + expectationFulfilmentResult: + type: array + items: + $ref: '#/components/schemas/ExpectationFulfilmentResult' + #-------Definition of the concrete IntentFulfilmentReport dataType----------------# + + #-------Definition of the generic ExpectationFulfilmentResult dataType----------------# + ExpectationFulfilmentResult: + description: >- + This data type is the "ExpectationFulfilmentResult" data type without specialisations + type: object + properties: + expectaitonId: + type: string + expectationFulfilmentInfo: + $ref: '#/components/schemas/FulfilmentInfo' + targetFulfilmentResult: + type: array + items: + $ref: '#/components/schemas/TargetFulfilmentResult' + #-------Definition of the concrete ExpectationFulfilmentResult dataType----------------# + + #-------Definition of the generic TargetFulfilmentResult dataType----------------# + TargetFulfilmentResult: + description: >- + This data type is the "TargetFulfilmentResult" data type without specialisations + type: object + properties: + targetName: + type: string + targetFulfilmentInfo: + $ref: '#/components/schemas/FulfilmentInfo' + targetAchievedValue: + type: number + #-------Definition of the concrete TargetFulfilmentResult dataType----------------# + + #-------Definition of the generic IntentConflictReport dataType----------------# + IntentConflictReport: + description: >- + This data type is the "IntentConflictReport" data type without specialisations + type: object + properties: + conflictType: + type: string + enum: + - INTENT_CONFLICT + - EXPECTATION_CONFLICT + - TARGET_CONFLICT + conflictField: + type: string + #-------Definition of the concrete IntentConflictReport dataType----------------# + + #-------Definition of the generic IntentFeasibilityCheckReport dataType----------------# + IntentFeasibilityCheckReport: + description: >- + This data type is the "IntentFeasibilityCheckReport" data type without specialisations + type: object + properties: + feasibilityCheckResult: + type: string + enum: + - FEASIBLE + - INFEASIBLE + infeasibilityReason: + description: -> + An attribute which is used when feasibilityCheckResult is INFEASIBLE + type: string + #-------Definition of the concrete IntentFeasibilityCheckReport dataType----------------# + + #-------Definition of the generic IntentHandlingCapability dataType----------------# + IntentHandlingCapability: + type: object + properties: + intentHandlingCapabilityId: + type: string + supportedExpectationObjectType: + type: string + enum: + - RAN_SUBNETWORK + - EDGE_SERVICE_SUPPORT + supportedExpectationTargetType: + type: array + items: + $ref: "#/components/schemas/ExpectationTarget" + #-------Definition of the concrete IntentHandlingCapability dataType----------------# + #------Definition of JSON arrays for name-contained IOCs ---------------# SubNetwork-Multiple: @@ -240,7 +368,19 @@ components: Intent-Multiple: type: array items: - $ref: '#/components/schemas/Intent-Single' + $ref: '#/components/schemas/Intent-Single' + + IntentReport-Multiple: + type: array + items: + $ref: '#/components/schemas/IntentReport-Single' + + IntentHandlingFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/IntentHandlingFunction-Single' + + #------Definition of JSON arrays for name-contained IOCs ---------------# #----- Definitions in TS 28.312 for TS 28.532 --------------------------#