Merge branch... (5a107a36) · Commits · SA5 – Management & Orchestration and Charging / Management and Orchestration APIs

OpenAPI/TS28312_IntentNrm.yaml

+61 −22

Original line number	Diff line number	Diff line
		@@ -31,6 +31,8 @@ components:
		$ref: '#/components/schemas/IntentHandlingFunction-Multiple'

		Intent-Single:
		description: >-
		This IOC represents the properties of an Intent driven management information between MnS consumer and MnS producer.
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		@@ -53,11 +55,17 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/IntentContext'
		description: >-
		It describes the list of IntentContext(s) which represents the constraints and conditions that should apply
		for the entire intent even if there may be specific contexts defined for specific parts of the intent
		intentAdminState:
		type: string
		enum:
		- ACTIVATED
		- DEACTIVATED
		description: >-
		It describes the intent administrative state.
		This attribute is used when MnS consumer-suspension mechanism is supported
		intentPriority:
		type: integer
		minimum: 1
		@@ -65,9 +73,13 @@ components:
		description: It expresses the priority of the stated intent within a MnS consumer.
		observationPeriod:
		type: integer
		description: >-
		It represents the observation period of the fulfilmentInfo for corresponding
		ExpectationTargets, IntentExpectations and Intent.
		intentReportReference:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		IntentReport-Single:
		description: It represents intent report information from MnS producer to MnS consumer.
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		@@ -80,11 +92,14 @@ components:
		$ref: '#/components/schemas/IntentConflictReport'
		intentFeasibilityCheckReport:
		$ref: '#/components/schemas/IntentFeasibilityCheckReport'
		lastUpdated:
		lastUpdatedTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		intentReference:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		IntentHandlingFunction-Single:
		description: >-
		It represents the intent handling capabilities can be supported by a specific intent
		handling function of MnS producer.
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		@@ -104,10 +119,12 @@ components:
		IntentExpectation:
		description: >-
		This data type is the "IntentExpectation" data type without specialisations
		It represents MnS consumer's requirements, goals and contexts given to a 3GPP system
		type: object
		properties:
		expectationId:
		type: string
		description: A unique identifier of the intentExpectation within the intent.
		expectationVerb:
		$ref: "#/components/schemas/ExpectationVerb"
		expectationObject:
		@@ -129,6 +146,7 @@ components:
		#-------Definition of the generic ExpectationObject dataType ----------#
		ExpectationObject:
		description: >-
		It represents the Object to which the IntentExpectation should apply.
		This data type is the "ExpectationObject" data type without specialisations
		type: object
		properties:
		@@ -146,6 +164,9 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/ObjectContext'
		description: >-
		It describes the list of ObjectContext(s) which represents the constraints and conditions to be
		used as filter information to identify the object(s) to which a given intentExpectation should apply.

		#-------Definition of the generic ExpectationObject dataType ----------#

		@@ -169,12 +190,13 @@ components:
		- ALL_OF
		- ONE_OF
		- ANY_OF
		FulfilStatus:
		FulfilmentStatus:
		type: string
		readOnly: true
		enum:
		- FULFILLED
		- NOT_FULFILLED
		description: It describes the current status of the intent fulfilment result.
		NotFulfilledState:
		type: string
		readOnly: true
		@@ -185,25 +207,31 @@ components:
		- SUSPENDED
		- TERMINATED
		- FULFILMENTFAILED
		description: It describes the current progress of or the reason for not achieving fulfilment
		for the intent, intentExpectation or expectationTarget.
		An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo
		FulfilmentInfo:
		description: >-
		This dataType represents the properties of a specific fulfilment information for an aspect of
		the intent (i.e. either an expectation, a target or the whole intent).
		type: object
		properties:
		fulfilStatus:
		$ref: '#/components/schemas/FulfilStatus'
		fulfilmentStatus:
		$ref: '#/components/schemas/FulfilmentStatus'
		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: array
		items:
		type: string
		readOnly: true
		description: An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo
		ExpectationVerb:
		type: string
		enum:
		- DELIVER
		- ENSURE
		description: It describes the characteristic of the intentExpectation and is the property that describes the types of intentExpectations.
		Frequency:
		description: >-
		It desribes the RF reference frequency (i.e. Absolute Radio Frequency Channel Number)
		@@ -270,6 +298,7 @@ components:
		#-------Definition of the generic ExpectationTarget dataType----------#
		ExpectationTarget:
		description: >-
		This data type represents the target of the IntentExpectation that are required to be achieved.
		This data type is the "ExpectationTarget" data type without specialisations
		type: object
		properties:
		@@ -289,6 +318,7 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/TargetContext'
		description: It describes the list of constraints and conditions that should apply for a specific expectationTarget.
		TargetContext:
		description: >-
		This data type is the "TargetContext" data type without specialisations
		@@ -344,7 +374,8 @@ components:
		#-------Definition of the generic IntentFulfilmentReport dataType----------------#
		IntentFulfilmentReport:
		description: >-
		This data type is the "IntentFulfilmentReport" data type without specialisations
		It includes the intentFulfilmentInfo and expectationFulfilmetResult.
		This attribute shall be supported when intent fulfilment information is supported by IntentReport
		type: object
		properties:
		intentFulfilmentInfo:
		@@ -358,7 +389,7 @@ components:
		#-------Definition of the generic ExpectationFulfilmentResult dataType----------------#
		ExpectationFulfilmentResult:
		description: >-
		This data type is the "ExpectationFulfilmentResult" data type without specialisations
		It includes the expectationFulfilmentInfo and targetFulfilmetResults for each IntentExpectation.
		type: object
		properties:
		expectaitonId:
		@@ -374,7 +405,7 @@ components:
		#-------Definition of the generic TargetFulfilmentResult dataType----------------#
		TargetFulfilmentResult:
		description: >-
		This data type is the "TargetFulfilmentResult" data type without specialisations
		This data type includes targetFulfilmentInfo and targetAchievedValue for each ExpectationTarget.
		type: object
		properties:
		targetName:
		@@ -388,7 +419,8 @@ components:
		#-------Definition of the generic IntentConflictReport dataType----------------#
		IntentConflictReport:
		description: >-
		This data type is the "IntentConflictReport" data type without specialisations
		It represents the conflict information for the detected conflict
		This attribute shall be supported when intent conflict information is supported by IntentReport
		type: object
		properties:
		conflictId:
		@@ -416,7 +448,8 @@ components:
		#-------Definition of the generic IntentFeasibilityCheckReport dataType----------------#
		IntentFeasibilityCheckReport:
		description: >-
		This data type is the "IntentFeasibilityCheckReport" data type without specialisations
		It represents the intent feasibility check information
		This attribute shall be supported when intent feasibility check information information is supported by IntentReport
		type: object
		properties:
		feasibilityCheckResult:
		@@ -425,13 +458,15 @@ components:
		- FEASIBLE
		- INFEASIBLE
		infeasibilityReason:
		description: ->
		An attribute which is used when feasibilityCheckResult is INFEASIBLE
		type: string
		description: An attribute which is used when feasibilityCheckResult is INFEASIBLE
		#-------Definition of the concrete IntentFeasibilityCheckReport dataType----------------#

		#-------Definition of the generic IntentHandlingCapability dataType----------------#
		IntentHandlingCapability:
		description: >-
		It represents expectation object information and expectation target information
		which can be supported by a specific intent handling function of MnS producer.
		type: object
		properties:
		intentHandlingCapabilityId:
		@@ -442,8 +477,12 @@ components:
		- RAN_SUBNETWORK
		- EDGE_SERVICE_SUPPORT
		- 5GC_SUBNETWORK
		supportedExpectationTargetType:
		description: It describes the expectation object type which can be supported by a specific intent handling function of MnS producer.
		supportedExpectationTargetNames:
		type: array
		items:
		type: string
		description: It describes the supported expectation targets for the supported expectation object type.
		#-------Definition of the concrete IntentHandlingCapability dataType----------------#

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