Replace TS28312_IntentNrm.yaml (13885cb1) · Commits · SA5 – Management & Orchestration and Charging / Management and Orchestration APIs

OpenAPI/TS28312_IntentNrm.yaml

+56 −17

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: Intent NRM
		version: 19.4.0
		version: 19.5.0
		description: >-
		OAS 3.0.1 definition of the Intent NRM
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 2026, 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
		@@ -73,9 +73,11 @@ components:
		type: integer
		minimum: 1
		maximum: 100
		default: 1
		description: It expresses the priority of the stated intent within a MnS consumer.
		intentPreemptionCapability:
		type: boolean
		default: false
		intentReportControl:
		type: array
		uniqueItems: true
		@@ -87,7 +89,13 @@ components:
		intentReportReference:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'
		intentUtilityFormulaRef:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		required:
		- userLabel
		- intentExpectations
		- intentMgmtPurpose
		- intentReportControl
		- intentReportReference
		IntentReport-Single:
		description: It represents intent report information from MnS producer to MnS consumer.
		allOf:
		@@ -116,6 +124,9 @@ components:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo'
		intentReference:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'
		required:
		- lastUpdatedTime
		- intentReference
		IntentHandlingFunction-Single:
		description: >-
		It represents the intent handling capabilities can be supported by a specific intent
		@@ -161,6 +172,9 @@ components:
		utilityOffset:
		type: number
		default: 0
		required:
		- utilityFunctionId
		- utilityParameterList
		#-------Definition of generic IOCs ----------#

		#-------Definition of the generic IntentExpectation dataType ----------#
		@@ -248,6 +262,7 @@ components:
		- ALL_OF
		- ONE_OF
		- ANY_OF
		default: ALL_OF
		IntentMgmtPurpose:
		description: >-
		It describes the MnS consumer requirements for the management purpose (required procedures)
		@@ -298,6 +313,8 @@ components:
		type: string
		readOnly: true
		description: An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo
		required:
		- fulfilmentStatus
		ExpectationVerb:
		type: string
		enum:
		@@ -385,6 +402,10 @@ components:
		minimum: 0
		maximum: 10
		description: It represents the preference information of the Consumer on expectationTargets.
		required:
		- targetName
		- targetCondition
		- targetValueRange

		#-------Definition of the generic ExpectationTarget dataType----------#

		@@ -406,6 +427,10 @@ components:
		items:
		$ref: "#/components/schemas/ValueRangeType"
		- $ref: "#/components/schemas/ValueRangeType"
		required:
		- contextAttribute
		- contextCondition
		- contextValueRange
		#-------Definition of the generic Context dataType----------------#

		#-------Definition of the generic IntentReportControl dataType----------------#
		@@ -416,7 +441,8 @@ components:
		properties:
		reportRecipientAddress:
		description: >-
		It indicates the address of report recipient for MnS consumer
		It indicates the address of report recipient for MnS consumer.
		It shall be supported when the implicit intent report subscription mechanism is supported.
		type: string
		observationPeriod:
		description: >-
		@@ -445,7 +471,6 @@ components:
		items:
		type: string
		required:
		- reportRecipientAddress
		- observationPeriod
		ExpectedReportType:
		type: string
		@@ -480,6 +505,10 @@ components:
		items:
		$ref: '#/components/schemas/ValueRangeType'
		- $ref: '#/components/schemas/ValueRangeType'
		required:
		- targetName
		- targetCondition
		- targetValueRange
		#-------Definition of the concrete IntentReportControl dataType----------------#


		@@ -499,7 +528,15 @@ components:
		items:
		$ref: '#/components/schemas/ExpectationFulfilmentResult'
		additionalFulfilmentInfo:
		description: >-
		It describes the additional information of intent intent fulfilment.The content and format is vendor specific.
		Examples of additional fulfilment information could be:Types for the list of managed objects (e.g. NE, NF, Cell)
		which are updated during intent fulfilment, or, Instance information for the list of managed objects (e.g. NE, NF,
		Cell) and corresponding attributes which are updated during intent fulfilment.
		type: string
		readOnly: true
		required:
		- intentFulfilmentInfo
		#-------Definition of the concrete IntentFulfilmentReport dataType----------------#

		#-------Definition of the generic ExpectationFulfilmentResult dataType----------------#
		@@ -561,23 +598,25 @@ components:
		readOnly: true
		conflictType:
		type: string
		readOnly: true
		enum:
		- INTENT_CONFLICT
		- EXPECTATION_CONFLICT
		- TARGET_CONFLICT
		readOnly: true
		conflictingIntent:
		description: >-
		This will be present if the value of conflictType is INTENT_CONFLICT. It describes the DN of the conflicting intent
		This will be present if the MnS producer supports reporting on INTENT_CONFLICT or EXPECTATION_CONFLICT
		or TARGET_CONFLICT.
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'
		conflictingExpectation:
		description: >-
		This will be present if the value of conflictType is EXPECTATION_CONFLICT. It describes the expectationId of the conflicting IntentExpectation with an Intent
		This will be present if the MnS producer supports reporting on conflicts of type EXPECTATION_CONFLICT or
		TARGET_CONFLICT.
		type: string
		readOnly: true
		conflictingTarget:
		description: >-
		This will be present if the value of conflictType is TARGET_CONFLICT. It describes the targetName of the conflicting ExpectationTarget with an IntentExpectation
		This will be present if the MnS producer supports reporting on conflicts of type TARGET_CONFLICT.
		type: string
		readOnly: true
		recommendedSolutions: