Merge branch 'TS28312_v120_for_merge' into 'Integration_Rel17_SA5_143_YAML' (8138da8c) · Commits · Miguel Angel Reina Ortega / Management and Orchestration APIs

OpenAPI/intentNrm.yaml

+282 −20

Original line number	Diff line number	Diff line
		openapi: 3.0.2
		openapi: 3.0.1
		info:
		title: Intent NRM
		description: OAS 3.0.1 specification of the Intent NRM
		version: 17.0.0
		description: >-
		OAS 3.0.1 definition of the Intent NRM
		© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.312; Intent driven management services for mobile networks
		url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.312/
		paths: {}
		components:
		schemas:
		@@ -22,13 +28,15 @@ components:
		type: array
		items:
		$ref: "#/components/schemas/IntentContext"
		intentFulfilStatus:
		$ref: "#/components/schemas/IntentFulfilStatus"
		intentFulfilmentInfo:
		$ref: "#/components/schemas/FulfilmentInfo"
		IntentExpectation:
		type: object
		properties:
		expectationId:
		type: string
		expectationVerb:
		$ref: "#/components/schemas/ExpectationVerb"
		expectationObjects:
		type: array
		items:
		@@ -41,6 +49,8 @@ components:
		type: array
		items:
		$ref: "#/components/schemas/ExpectationContext"
		expectationfulfilmentInfo:
		$ref: "#/components/schemas/FulfilmentInfo"

		ExpectationObject:
		type: object
		@@ -48,7 +58,8 @@ components:
		objectType:
		type: string
		enum:
		- RAN_SubNetwrok #--value for Radio Network Expectation--#
		- RAN_SubNetwrok #value for Radio Network Expectation--#
		- Service_Support #value for Service Support Expectation--#
		- TBD #-This will be added based on defined scenario specfic intent expectation-#
		objectInstance:
		$ref: "comDefs.yaml#/components/schemas/Dn"
		@@ -67,7 +78,15 @@ components:
		- $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---------------#

		@@ -80,24 +99,25 @@ components:
		- $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 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:
		type: object
		properties:
		contextAttribute:
		type: string
		contextCondition:
		$ref: "#/components/schemas/Condition"
		contextValueRange:
		type: array
		items:
		type: number
		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:
		type: object
		@@ -118,11 +138,42 @@ components:
		- Is_greater_than
		- Is_within_the_range

		IntentFulfilStatus:
		FulfilStatus:
		type: string
		enum:
		- FULFILLED
		- NOT_FULFILLED

		NotFulfilledState:
		type: string
		enum:
		- ACKNOWLEDGED
		- COMPLIANT
		- DEGRADED
		- SUSPENDED
		- TERMINATED
		- FULFILMENTFAILED

		FulfilmentInfo:
		type: object
		properties:
		fulfilStatus:
		$ref: "#/components/schemas/FulfilStatus"
		notFullfilledState:
		description: ->
		An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo
		$ref: "#/components/schemas/NotFulfilledState"
		notFulfilledReasons:
		description: ->
		An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo
		type: string

		ExpectationVerb:
		type: string
		enum:
		- DELIVER
		- ENSURE

		#-------Definition of the concrete ExpectationTarget dataType----------#
		WeakRSRPRatioTarget:
		type: object
		@@ -141,6 +192,8 @@ components:
		maximum: 100
		targetContexts:
		$ref: "#/components/schemas/WeakRSRPContext"
		targetFulfilmentInfo:
		$ref: "#/components/schemas/FulfilmentInfo"

		WeakRSRPContext:
		type: object
		@@ -173,6 +226,8 @@ components:
		maximum: 100
		targetContexts:
		$ref: "#/components/schemas/LowSINRContext"
		targetFulfilmentInfo:
		$ref: "#/components/schemas/FulfilmentInfo"

		LowSINRContext:
		type: object
		@@ -201,6 +256,8 @@ components:
		- Is_greater_than
		targetValueRange:
		type: integer
		targetFulfilmentInfo:
		$ref: "#/components/schemas/FulfilmentInfo"

		AveDLRANUEThptTarget:
		type: object
		@@ -215,6 +272,8 @@ components:
		- Is_greater_than
		targetValueRange:
		type: integer
		targetFulfilmentInfo:
		$ref: "#/components/schemas/FulfilmentInfo"

		LowULRANUEThptRatioTarget:
		type: object
		@@ -233,6 +292,8 @@ components:
		maximum: 100
		targetContexts:
		$ref: "#/components/schemas/LowULRANUEThptContext"
		targetFulfilmentInfo:
		$ref: "#/components/schemas/FulfilmentInfo"

		LowULRANUEThptContext:
		type: object
		@@ -265,6 +326,8 @@ components:
		maximum: 100
		targetContexts:
		$ref: "#/components/schemas/LowDLRANUEThptContext"
		targetFulfilmentInfo:
		$ref: "#/components/schemas/FulfilmentInfo"

		LowDLRANUEThptContext:
		type: object
		@@ -279,6 +342,98 @@ components:
		- Is_less_than
		contextValueRange:
		type: number
		DLThptPerUETarget:
		type: object
		properties:
		targetName:
		type: string
		enum:
		- DlThptPerUE
		targetCondition:
		type: string
		enum:
		- Is_greater_than
		targetValueRange:
		$ref: "sliceNrm.yaml#/components/schemas/XLThpt"
		ULThptPerUETarget:
		type: object
		properties:
		targetName:
		type: string
		enum:
		- UlThptPerUE
		targetCondition:
		type: string
		enum:
		- Is_greater_than
		targetValueRange:
		$ref: "sliceNrm.yaml#/components/schemas/XLThpt"
		DLLatencyTarget:
		type: object
		properties:
		targetName:
		type: string
		enum:
		- DlLatency
		targetCondition:
		type: string
		enum:
		- Is_less_than
		targetValueRange:
		type: integer
		ULLatencyTarget:
		type: object
		properties:
		targetName:
		type: string
		enum:
		- UlLatency
		targetCondition:
		type: string
		enum:
		- Is_less_than
		targetValueRange:
		type: integer
		MaxNumberofUEsTarget:
		type: object
		properties:
		targetAttribute:
		type: string
		enum:
		- maxNumberofUEs
		targetCondition:
		type: string
		enum:
		- Is_less _than
		targetValueRange:
		type: integer
		ActivityFactorTarget:
		type: object
		properties:
		targetAttribute:
		type: string
		enum:
		- activityFactor
		targetCondition:
		type: string
		enum:
		- Is_equal _than
		targetValueRange:
		type: integer
		UESpeedTarget:
		type: object
		properties:
		targetAttribute:
		type: string
		enum:
		- uESpeed
		targetCondition:
		type: string
		enum:
		- Is_less _than
		targetValueRange:
		type: integer

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

		#-------Definition of the concrete ObjectTarget dataType----------------#
		@@ -366,7 +521,114 @@ components:
		- UTRAN
		- EUTRAN
		- NR
		EdgeIdenfiticationIdContext:
		type: object
		properties:
		contextAttribute:
		type: string
		enum:
		- edgeIdentificationId
		contextCondition:
		type: string
		enum:
		- Is_equal_than
		contextValueRange:
		type: array
		items:
		type: string
		EdgeIdenfiticationLocContext:
		type: object
		properties:
		contextAttribute:
		type: string
		enum:
		- edgeIdentificationTarget
		contextCondition:
		type: string
		enum:
		- Is_equal_than
		contextValueRange:
		type: array
		items:
		type: string
		CoverageAreaTAContext:
		type: object
		properties:
		contextAttribute:
		type: string
		enum:
		- coverageAreaTA
		contextCondition:
		type: string
		enum:
		- Is_within_the_range
		contextValueRange:
		type: array
		items:
		$ref: "#/components/schemas/CoverageAreaTAList"
		CoverageAreaTAList:
		type: integer

		#-------Definition of the concrete ObjectTarget dataType----------------#
		#-------Definition of the concrete ExpectionContext dataType----------------#
		ServiceStartTimeContext:
		type: object
		properties:
		contextAttribute:
		type: string
		enum:
		- ServiceStartTime
		contextCondition:
		type: string
		enum:
		- Is_equal_than
		contextValueRange:
		type: string
		ServiceEndTimeContext:
		type: object
		properties:
		contextAttribute:
		type: string
		enum:
		- ServiceEndTime
		contextCondition:
		type: string
		enum:
		- Is_equal_than
		contextValueRange:
		type: string
		UEMobilityLevelContext:
		type: object
		properties:
		contextAttribute:
		type: string
		enum:
		- UEMobilityLevel
		contextCondition:
		type: string
		enum:
		- Is_within_the_range
		contextValueRange:
		type: array
		items:
		$ref: "sliceNrm.yaml#/components/schemas/MobilityLevel"
		ResourceSharingLevelContext:
		type: object
		properties:
		contextAttribute:
		type: string
		enum:
		- ResourceSharingLevel
		contextCondition:
		type: string
		enum:
		- Is_within_the_range
		contextValueRange:
		type: array
		items:
		$ref: "sliceNrm.yaml#/components/schemas/SharingLevel"
		#-------Definition of the concrete ExpectionContext dataType----------------#


		#------Definition of JSON arrays for name-contained IOCs ---------------#

		@@ -374,7 +636,7 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/Intent-Single'
		#------Definition of JSON arrays for name-contained IOCs --------------#
		#------Definition of JSON arrays for name-contained IOCs ---------------#

		#----- Definitions in TS 28.312 for TS 28.532 --------------------------#
		resources-intentNrm: