From 975407402d30fba4a049510534522ac28c6fd216 Mon Sep 17 00:00:00 2001 From: ruiyue Date: Thu, 4 Aug 2022 13:44:29 +0000 Subject: [PATCH] Update TS28312_IntentNrm.yaml to distinguish the generic intent expectation part and scenario specific intent part --- OpenAPI/TS28312_IntentNrm.yaml | 338 +++++++++++++++++++++++++-------- 1 file changed, 255 insertions(+), 83 deletions(-) diff --git a/OpenAPI/TS28312_IntentNrm.yaml b/OpenAPI/TS28312_IntentNrm.yaml index 54a5bc028..cb4d86c57 100644 --- a/OpenAPI/TS28312_IntentNrm.yaml +++ b/OpenAPI/TS28312_IntentNrm.yaml @@ -12,7 +12,6 @@ externalDocs: paths: {} components: schemas: - Intent-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -23,14 +22,22 @@ components: intentExpectations: type: array items: - $ref: "#/components/schemas/IntentExpectation" + type: object + oneOf: + - $ref: "#/components/schemas/IntentExpectation" + - $ref: "#/components/schemas/RadioNetworkExpectation" + - $ref: "#/components/schemas/ServiceSupportExpectation" intentContexts: type: array items: $ref: "#/components/schemas/IntentContext" intentFulfilmentInfo: $ref: "#/components/schemas/FulfilmentInfo" + + #-------Definition of the IntentExpectation dataType ----------# IntentExpectation: + description: >- + This data type is the "IntentExpectation" data type without specialisations type: object properties: expectationId: @@ -50,9 +57,82 @@ components: items: $ref: "#/components/schemas/ExpectationContext" expectationfulfilmentInfo: - $ref: "#/components/schemas/FulfilmentInfo" - + $ref: "#/components/schemas/FulfilmentInfo" + RadioNetworkExpectation: + description: >- + This data type is the "IntentExpectation" data type with specialisations to represent MnS consumer's expectations for radio network delivering and performance assurance + type: object + properties: + expectationId: + type: string + expectationVerb: + $ref: "#/components/schemas/ExpectationVerb" + expectationObjects: + type: array + items: + $ref: "#/components/schemas/RadioNetworkExpectationObject" + expectationTargets: + type: array + items: + type: object + oneOf: + - $ref: "#/components/schemas/WeakRSRPRatioTarget" + - $ref: "#/components/schemas/LowSINRRatioTarget" + - $ref: "#/components/schemas/AveULRANUEThptTarget" + - $ref: "#/components/schemas/AveDLRANUEThptTarget" + - $ref: "#/components/schemas/LowULRANUEThptRatioTarget" + - $ref: "#/components/schemas/LowDLRANUEThptRatioTarget" + - $ref: "#/components/schemas/ExpectationTarget" + expectationContexts: + type: array + items: + $ref: "#/components/schemas/ExpectationContext" + expectationfulfilmentInfo: + $ref: "#/components/schemas/FulfilmentInfo" + ServiceSupportExpectation: + description: >- + This data type is the "IntentExpectation" data type with specialisations to represent MnS consumer's expectations for service deployment + type: object + properties: + expectationId: + type: string + expectationVerb: + $ref: "#/components/schemas/ExpectationVerb" + expectationObjects: + type: array + items: + $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: "#/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: "#/components/schemas/ExpectationContext" + expectationfulfilmentInfo: + $ref: "#/components/schemas/FulfilmentInfo" + #-------Definition of the IntentExpectation dataType ----------# + + #-------Definition of the ExpectationObject dataType ----------# ExpectationObject: + description: >- + This data type is the "ExpectationObject" data type without specialisations type: object properties: objectType: @@ -66,70 +146,52 @@ components: objectContexts: type: array items: - $ref: "#/components/schemas/ObjectContext" - - ExpectationTarget: - oneOf: - #--ExpectationTargets defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)- # - - $ref: "#/components/schemas/WeakRSRPRatioTarget" - - $ref: "#/components/schemas/LowSINRRatioTarget" - - $ref: "#/components/schemas/AveULRANUEThptTarget" - - $ref: "#/components/schemas/AveDLRANUEThptTarget" - - $ref: "#/components/schemas/LowULRANUEThptRatioTarget" - - $ref: "#/components/schemas/LowDLRANUEThptRatioTarget" - #--ExpectationTargets defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)- # - #--ExpectationTargets defind for Service Support Expectation (ObjectType is ServiceSupport)- # - - $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" - #--ExpectationTargets defind for Service Support Expectation (ObjectType is ServiceSupport)- # - #--ExpectationTargets defind for other Scenario specific Expectation-----TBD---------------# - #--ExpectationTargets defind for other Scenario specific Expectation-----TBD---------------# - - - ObjectContext: - oneOf: - #--ObjectContext defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)-------# - - $ref: "#/components/schemas/CoverageAreaPolygonContext" - - $ref: "#/components/schemas/CoverageTACContext" - - $ref: "#/components/schemas/PLMNContext" - - $ref: "#/components/schemas/NRFqBandContext" - - $ref: "#/components/schemas/RATContext" - #--ObjectContext defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)-------# - #--ObjectContext defind for Service Support Expectation (ObjectType is ServiceSupport)-------# - - $ref: "#/components/schemas/EdgeIdenfiticationIdContext" - - $ref: "#/components/schemas/EdgeIdenfiticationLocContext" - - $ref: "#/components/schemas/CoverageAreaTAContext" - #--ObjectContext defind for Service Support Expectation (ObjectType is ServiceSupport)-------# - - #--ObjectContext defind for other Scenario specific Expectation -----------TBD------------# - #--ObjectContext defind for other Scenario specific Expectation -----------TBD------------# - - - ExpectationContext: - oneOf: - #--ExpectationContext defind for Service Support Expectation (ObjectType is Service_Support)- # - - $ref: "#/components/schemas/ServiceStartTimeContext" - - $ref: "#/components/schemas/ServiceEndTimeContext" - - $ref: "#/components/schemas/UEMobilityLevelContext" - - $ref: "#/components/schemas/ResourceSharingLevelContext" - #--ExpectationContext defind for Service Support Expectation (ObjectType is Service_Support)- # - - IntentContext: + $ref: "#/components/schemas/ObjectContext" + RadioNetworkExpectationObject: + description: >- + This data type is the "ExpectationObject" data type with specialisations for RadioNetworkExpectation type: object properties: - contextAttribute: + objectType: type: string - contextCondition: - $ref: "#/components/schemas/Condition" - contextValueRange: + enum: + - RAN_SubNetwrok #value for Radio Network Expectation--# + objectInstance: + $ref: "TS28623_ComDefs.yaml#/components/schemas/Dn" + objectContexts: type: array items: - type: number + 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" + ServiceSupportExpectationObject: + description: >- + This data type is the "ExpectationObject" data type with specialisations for ServiceSupportExpectation + type: object + properties: + objectType: + type: string + enum: + - Service_Support #value for Radio Network Expectation--# + objectInstance: + $ref: "TS28623_ComDefs.yaml#/components/schemas/Dn" + objectContexts: + type: array + items: + type: object + oneOf: + - $ref: "#/components/schemas/EdgeIdenfiticationIdContext" + - $ref: "#/components/schemas/EdgeIdenfiticationLocContext" + - $ref: "#/components/schemas/CoverageAreaTAContext" + - $ref: "#/components/schemas/ObjectContext" + #-------Definition of the ExpectationObject dataType ----------# + + #-------Definition of the generic dataType --------------# Condition: type: string enum: @@ -137,13 +199,11 @@ components: - Is_less_than - Is_greater_than - Is_within_the_range - FulfilStatus: type: string enum: - FULFILLED - NOT_FULFILLED - NotFulfilledState: type: string enum: @@ -153,7 +213,6 @@ components: - SUSPENDED - TERMINATED - FULFILMENTFAILED - FulfilmentInfo: type: object properties: @@ -167,15 +226,59 @@ components: description: -> An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo type: string - ExpectationVerb: type: string enum: - DELIVER - ENSURE + #-------Definition of the generic dataType --------------# - #-------Definition of the concrete ExpectationTarget dataType----------# + #-------Definition of the IntentContext dataType --------------# + IntentContext: + description: >- + This data type is the "IntentContext" data type without specialisations + type: object + properties: + contextAttribute: + type: string + contextCondition: + $ref: "#/components/schemas/Condition" + contextValueRange: + type: array + items: + type: number + #-------Definition of the IntentContext dataType --------------# + + #-------Definition of the ExpectationTarget dataType----------# + ExpectationTarget: + description: >- + This data type is the "ExpectationTarget" data type without specialisations + type: object + properties: + targetName: + type: string + targetCondition: + $ref: "#/components/schemas/Condition" + targetValueRange: + type: number + targetContexts: + type: array + items: + $ref: "#/components/schemas/TargetContext" + TargetContext: + description: >- + This data type is the "TargetContext" data type without specialisations + type: object + properties: + contextAttribute: + type: string + contextCondition: + $ref: "#/components/schemas/Condition" + contextValueRange: + type: number WeakRSRPRatioTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for WeakRSRPRatioTarget type: object properties: targetName: @@ -194,8 +297,9 @@ components: $ref: "#/components/schemas/WeakRSRPContext" targetFulfilmentInfo: $ref: "#/components/schemas/FulfilmentInfo" - WeakRSRPContext: + description: >- + This data type is the "TargetContext" data type with specialisations for WeakRSRPContext type: object properties: contextAttribute: @@ -208,8 +312,9 @@ components: - Is_less_than contextValueRange: type: number - LowSINRRatioTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for LowSINRatioTarget type: object properties: targetName: @@ -228,8 +333,9 @@ components: $ref: "#/components/schemas/LowSINRContext" targetFulfilmentInfo: $ref: "#/components/schemas/FulfilmentInfo" - LowSINRContext: + description: >- + This data type is the "TargetContext" data type with specialisations for LowSINRContext type: object properties: contextAttribute: @@ -242,8 +348,9 @@ components: - Is_less_than contextValueRange: type: integer - AveULRANUEThptTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for AveULRANUEThptTarget type: object properties: targetName: @@ -258,8 +365,9 @@ components: type: integer targetFulfilmentInfo: $ref: "#/components/schemas/FulfilmentInfo" - AveDLRANUEThptTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for AveDLRANUEThptTarget type: object properties: targetName: @@ -274,8 +382,9 @@ components: type: integer targetFulfilmentInfo: $ref: "#/components/schemas/FulfilmentInfo" - LowULRANUEThptRatioTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for LowULRANUEThptRatioTarget type: object properties: targetName: @@ -294,8 +403,9 @@ components: $ref: "#/components/schemas/LowULRANUEThptContext" targetFulfilmentInfo: $ref: "#/components/schemas/FulfilmentInfo" - LowULRANUEThptContext: + description: >- + This data type is the "TargetContext" data type with specialisations for LowULRANUEThptContext type: object properties: contextAttribute: @@ -308,8 +418,9 @@ components: - Is_less_than contextValueRange: type: number - LowDLRANUEThptRatioTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for LowDLRANUEThptRatioTarget type: object properties: targetName: @@ -328,8 +439,9 @@ components: $ref: "#/components/schemas/LowDLRANUEThptContext" targetFulfilmentInfo: $ref: "#/components/schemas/FulfilmentInfo" - LowDLRANUEThptContext: + description: >- + This data type is the "TargetContext" data type with specialisations for LowDLRANUEThptContext type: object properties: contextAttribute: @@ -343,6 +455,8 @@ components: contextValueRange: type: number DLThptPerUETarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for DLThptPerUETarget type: object properties: targetName: @@ -356,6 +470,8 @@ components: targetValueRange: $ref: "TS28541_SliceNrm.yaml#/components/schemas/XLThpt" ULThptPerUETarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for ULThptPerUETarget type: object properties: targetName: @@ -369,6 +485,8 @@ components: targetValueRange: $ref: "TS28541_SliceNrm.yaml#/components/schemas/XLThpt" DLLatencyTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for DLLatencyTarget type: object properties: targetName: @@ -382,6 +500,8 @@ components: targetValueRange: type: integer ULLatencyTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for ULLatencyTarget type: object properties: targetName: @@ -395,6 +515,8 @@ components: targetValueRange: type: integer MaxNumberofUEsTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofUEsTarget type: object properties: targetAttribute: @@ -408,6 +530,8 @@ components: targetValueRange: type: integer ActivityFactorTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for ActivityFactorTarget type: object properties: targetAttribute: @@ -421,6 +545,8 @@ components: targetValueRange: type: integer UESpeedTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for UESpeedTarget type: object properties: targetAttribute: @@ -433,11 +559,25 @@ components: - Is_less _than targetValueRange: type: integer - #-------Definition of the concrete ExpectationTarget dataType----------# - #-------Definition of the concrete ObjectTarget dataType----------------# + #-------Definition of the concrete ObjectTarget dataType----------------# + ObjectContext: + description: >- + This data type is the "ObjectContext" data type without specialisations + type: object + properties: + contextAttribute: + type: string + contextCondition: + $ref: "#/components/schemas/Condition" + contextValueRange: + type: array + items: + type: number CoverageAreaPolygonContext: + description: >- + This data type is the "ObjectContext" data type with specialisations for CoverageAreaPolygonContext type: object properties: contextAttribute: @@ -455,6 +595,8 @@ components: CoverageArea: type: string CoverageTACContext: + description: >- + This data type is the "ObjectContext" data type with specialisations for CoverageTACContext type: object properties: contextAttribute: @@ -469,8 +611,9 @@ components: type: array items: $ref: "TS28541_NrNrm.yaml#/components/schemas/NrTac" - PLMNContext: + description: >- + This data type is the "ObjectContext" data type with specialisations for PLMNContext type: object properties: contextAttribute: @@ -485,8 +628,9 @@ components: type: array items: $ref: "TS28541_NrNrm.yaml#/components/schemas/PlmnId" - NRFqBandContext: + description: >- + This data type is the "ObjectContext" data type with specialisations for NRFqBandContext type: object properties: contextAttribute: @@ -501,8 +645,9 @@ components: type: array items: type: string - RATContext: + description: >- + This data type is the "ObjectContext" data type with specialisations for RATContext type: object properties: contextAttribute: @@ -522,6 +667,8 @@ components: - EUTRAN - NR EdgeIdenfiticationIdContext: + description: >- + This data type is the "ObjectContext" data type with specialisations for EdgeIdenfiticationIdContext type: object properties: contextAttribute: @@ -537,6 +684,8 @@ components: items: type: string EdgeIdenfiticationLocContext: + description: >- + This data type is the "ObjectContext" data type with specialisations for EdgeIdenfiticationLocContext type: object properties: contextAttribute: @@ -552,6 +701,8 @@ components: items: type: string CoverageAreaTAContext: + description: >- + This data type is the "ObjectContext" data type with specialisations for CoverageAreaTAContext type: object properties: contextAttribute: @@ -568,10 +719,25 @@ components: $ref: "#/components/schemas/CoverageAreaTAList" CoverageAreaTAList: type: integer - #-------Definition of the concrete ObjectTarget dataType----------------# + #-------Definition of the concrete ExpectionContext dataType----------------# + ExpectationContext: + description: >- + This data type is the "ExpectationContext" data type without specialisations + type: object + properties: + contextAttribute: + type: string + contextCondition: + $ref: "#/components/schemas/Condition" + contextValueRange: + type: array + items: + type: number ServiceStartTimeContext: + description: >- + This data type is the "ExpectationContext" data type with specialisations for ServiceStartTimeContext type: object properties: contextAttribute: @@ -585,6 +751,8 @@ components: contextValueRange: type: string ServiceEndTimeContext: + description: >- + This data type is the "ExpectationContext" data type with specialisations for ServiceEndTimeContext type: object properties: contextAttribute: @@ -598,6 +766,8 @@ components: contextValueRange: type: string UEMobilityLevelContext: + description: >- + This data type is the "ExpectationContext" data type with specialisations for UEMobilityLevelContext type: object properties: contextAttribute: @@ -613,6 +783,8 @@ components: items: $ref: "TS28541_SliceNrm.yaml#/components/schemas/MobilityLevel" ResourceSharingLevelContext: + description: >- + This data type is the "ExpectationContext" data type with specialisations for ResourceSharingLevelContext type: object properties: contextAttribute: -- GitLab