Replace TS28312_IntentNrm.yaml after SA5#167 (3178f3d7) · Commits · All Groups / 5G APIs

TS28312_IntentNrm.yaml

+401 −26

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: Intent NRM
		version: 19.5.0
		version: 20.0.0
		description: >-
		OAS 3.0.1 definition of the Intent NRM
		© 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -39,11 +39,11 @@ components:
		type: object
		oneOf:
		- $ref: '#/components/schemas/IntentExpectation'
		- $ref: 'TS28312_IntentExpectations.yaml#/components/schemas/RadioNetworkExpectation'
		- $ref: 'TS28312_IntentExpectations.yaml#/components/schemas/EdgeServiceSupportExpectation'
		- $ref: 'TS28312_IntentExpectations.yaml#/components/schemas/5GCNetworkExpectation'
		- $ref: 'TS28312_IntentExpectations.yaml#/components/schemas/RadioServiceExpectation'
		- $ref: 'TS28312_IntentExpectations.yaml#/components/schemas/NetworkMaintenanceExpectation'
		- $ref: 'TS28312_RadioNetworkExpectation.yaml#/components/schemas/RadioNetworkExpectation'
		- $ref: 'TS28312_EdgeServiceSupportExpectation.yaml#/components/schemas/EdgeServiceSupportExpectation'
		- $ref: 'TS28312_5GCNetworkExpectation.yaml#/components/schemas/5GCNetworkExpectation'
		- $ref: 'TS28312_RadioServiceExpectation.yaml#/components/schemas/RadioServiceExpectation'
		- $ref: 'TS28312_NetworkMaintenanceExpectation.yaml#/components/schemas/NetworkMaintenanceExpectation'
		intentMgmtPurpose:
		$ref: '#/components/schemas/IntentMgmtPurpose'
		contextSelectivity:
		@@ -86,6 +86,17 @@ components:
		implicitIntentIndex:
		type: boolean
		default: false
		guaranteePeriods:
		type: array
		uniqueItems: true
		items:
		type: object
		oneOf:
		- $ref: '#/components/schemas/SchedulingTimeContext'
		intentHandlingInfo:
		$ref: '#/components/schemas/IntentHandlingInfo'
		intentInterpretationAssistanceInfo:
		$ref: '#/components/schemas/IntentInterpretationAssistanceInfo'
		intentReportReference:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'
		intentUtilityFormulaRef:
		@@ -120,6 +131,8 @@ components:
		$ref: '#/components/schemas/IntentUtilityReport'
		intentFulfilmentNegotiationReport:
		$ref: '#/components/schemas/IntentFulfilmentNegotiationReport'
		intentDecompositionReport:
		$ref: '#/components/schemas/IntentDecompositionReport'
		lastUpdatedTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo'
		intentReference:
		@@ -135,6 +148,17 @@ components:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		intentHandlingScope:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/IntentHandlingScope'
		supportedNegotiationFunctionalities:
		type: array
		uniqueItems: true
		minimum: 1
		items:
		$ref: '#/components/schemas/NegotiationFunctionality'
		intentHandlingCapabilityList:
		type: array
		uniqueItems: true
		@@ -209,6 +233,13 @@ components:
		minimum: 0
		maximum: 10
		description: It represents the preference information of the Consumer on expectations.
		guaranteePeriods:
		type: array
		uniqueItems: true
		items:
		type: object
		oneOf:
		- $ref: '#/components/schemas/SchedulingTimeContext'
		required:
		- expectationId
		- expectationObject
		@@ -270,6 +301,7 @@ components:
		type: string
		enum:
		- FEASIBILITYCHECK
		- FEASIBILITYCHECK_WITH_RECOMMENDATIONS
		- FULFILMENT_WITHOUT_NEGOTIATION
		- EXPLORATION
		- FULFILMENT_WITH_NEGOTIATION
		@@ -286,13 +318,11 @@ components:
		type: string
		readOnly: true
		enum:
		- ACKNOWLEDGED
		- COMPLIANT
		- RECEIVED
		- DEGRADED
		- SUSPENDED
		- TERMINATED
		- FULFILMENTFAILED
		default: ACKNOWLEDGED
		default: RECEIVED
		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
		@@ -315,6 +345,29 @@ components:
		description: An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo
		required:
		- fulfilmentStatus

		FulfilmentStatisticsInfo:
		type: object
		properties:
		expectationObjectFulfilmentInfo:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/Distribution'
		expectationTemporalFulfilmentInfo:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/Distribution'

		Distribution:
		type: object
		properties:
		couter:
		type: integer
		bin:
		type: string

		ExpectationVerb:
		type: string
		enum:
		@@ -353,21 +406,159 @@ components:
		- $ref: '#/components/schemas/UEGroup'
		- $ref: '#/components/schemas/Frequency'
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SchedulingTime'
		- $ref: '#/components/schemas/CivicArea'
		UEGroup:
		description: >-
		It describes the UE Group,
		which is represented by specific 5QI, specific S-NSSAI, specific PLMNId or
		a specific combination of S-NSSAI, 5QI and PLMNId.
		which is represented by specific QoSId, specific S-NSSAI, specific PLMNId or
		a specific combination of S-NSSAI, QoSId and PLMNId.
		type: object
		properties:
		pLMNId:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId'
		qOSId:
		$ref: '#/components/schemas/QoSId'
		sNssai:
		$ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai'
		uEType:
		description: It describes the information of a UE Type defined in TS 38.331
		type: string
		enum:
		- REDCAP_UE
		- EREDCAP_UE
		QoSId:
		oneOf:
		- type: object
		properties:
		qCI:
		description: >-
		It describes QCI for EUTRAN network.
		type: integer
		minimum: 0
		maximum: 255
		- type: object
		properties:
		fiveQI:
		description: >-
		It describes 5QI for NR network.
		type: integer
		minimum: 0
		maximum: 255
		sNssai:
		$ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai'
		IntentHandlingScope:
		type: string
		enum:
		- RAN
		- CN
		NegotiationFunctionality:
		type: string
		enum:
		- FEASIBILITY_CHECK
		- EXPLORATION
		- FULFILMENT_WITH_NEGOTIATION
		CivicArea:
		description: >-
		It describes civic area, which is represented by civic address (e.g. streets, districts, seats, etc.) or
		location label (e.g. hotel name, school name).
		oneOf:
		- type: object
		properties:
		civicAddress:
		$ref: '#/components/schemas/CivicAddress'
		- type: object
		properties:
		locationLabel:
		description: >-
		It describes a location label (e.g. hotel name, school name).
		type: string
		CivicAddress:
		description: Indicates a Civic address.
		type: object
		properties:
		country:
		type: string
		A1:
		type: string
		A2:
		type: string
		A3:
		type: string
		A4:
		type: string
		A5:
		type: string
		A6:
		type: string
		PRD:
		type: string
		POD:
		type: string
		STS:
		type: string
		HNO:
		type: string
		HNS:
		type: string
		LMK:
		type: string
		LOC:
		type: string
		NAM:
		type: string
		PC:
		type: string
		BLD:
		type: string
		UNIT:
		type: string
		FLR:
		type: string
		ROOM:
		type: string
		PLC:
		type: string
		PCN:
		type: string
		POBOX:
		type: string
		ADDCODE:
		type: string
		SEAT:
		type: string
		RD:
		type: string
		RDSEC:
		type: string
		RDBR:
		type: string
		RDSUBBR:
		type: string
		PRM:
		type: string
		POM:
		type: string
		usageRules:
		type: string
		method:
		type: string
		providedBy:
		type: string
		IntentHandlingInfo:
		description: >-
		It contains includeTraceInfo, which is an attribute to control whether traceability
		information may be propagated upon intent decomposition.
		It also contains an ordered list of IntentTraceabilityInfo entries, each recording the
		identity of an intent handling function that has processed the intent and the identity
		of the corresponding derived intent.
		type: object
		properties:
		includeTraceInfo:
		type: boolean
		default: true
		intentTraceabilityInfoList:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/IntentTraceabilityInfo'

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

		#-------Definition of the generic ExpectationTarget dataType----------#
		@@ -427,6 +618,9 @@ components:
		items:
		$ref: "#/components/schemas/ValueRangeType"
		- $ref: "#/components/schemas/ValueRangeType"
		contextInvariant:
		type: boolean
		default: false
		required:
		- contextAttribute
		- contextCondition
		@@ -446,9 +640,8 @@ components:
		type: string
		observationPeriod:
		description: >-
		It indicates the time period for which the fulfilment process is observed
		and at the end of which the fulfilmentInfo for corresponding
		ExpectationTargets, IntentExpectations and Intent is updated.
		It indicates the time period for which the fulfilment process or exploration process is observed
		and at the end of which which the IntentFulfilmentReport or IntentExplorationReport is updated and reported.
		type: integer
		expectedReportTypes:
		description: >-
		@@ -481,6 +674,7 @@ components:
		- INTENT_EXPLORATION_REPORT
		- INTENT_FULFILMENT_NEGOTIATION_REPORT
		- INTENT_UTILITY_REPORT
		- INTENT_DECOMPOSITION_REPORT
		ReportingCondition:
		description: >-
		It describes the specified conditions for intent reporting.
		@@ -535,6 +729,14 @@ components:
		Cell) and corresponding attributes which are updated during intent fulfilment.
		type: string
		readOnly: true
		guaranteeConfidenceLevel:
		description: >-
		It indicate the guarantee confidence level calculated by the MnS Producer. This should be reported if the
		corresponding intent is set for guarantee, i.e., when the guarantee period is set for the whole intent.
		type: integer
		minimum: 0
		maximum: 100
		readOnly: true
		required:
		- intentFulfilmentInfo
		#-------Definition of the concrete IntentFulfilmentReport dataType----------------#
		@@ -550,11 +752,22 @@ components:
		readOnly: true
		expectationFulfilmentInfo:
		$ref: '#/components/schemas/FulfilmentInfo'
		expectationFulfilmentStatisticsInfo:
		$ref: '#/components/schemas/FulfilmentStatisticsInfo'
		targetFulfilmentResults:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/TargetFulfilmentResult'
		guaranteeConfidenceLevel:
		description: >-
		It indicate the guarantee confidence level calculated by the MnS Producer. This should be reported
		if the corresponding intent expectation is set for guarantee, i.e., when the guarantee period is
		set for the specific intent expectations.
		type: integer
		minimum: 0
		maximum: 100
		readOnly: true
		required:
		- expectaitonId
		- expectationFulfilmentInfo
		@@ -671,6 +884,12 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/InFeasibleExpectationInfo'
		additionalPreEvaluationInfo:
		description: >-
		It describes the additional provide additional pre-evaluation information for feasibility
		check process. The content and format is vendor specific.
		type: string
		readOnly: true
		required:
		- feasibilityCheckResult
		- infeasibilityReasons
		@@ -687,12 +906,23 @@ components:
		type: array
		uniqueItems: true
		items:
		type: string
		$ref: '#/components/schemas/InFeasibleTargetInfo'
		readOnly: true
		description: It describes the list of TargetNames for the InFeasibleTargets
		description: It describes the list of inFeasibleTargetInfo for the InFeasibleTargets
		required:
		- expectationId
		- inFeasibleTargets
		InFeasibleTargetInfo:
		description: >-
		It describes each infeasible target, including the targetName and recommendedValue for the InFeasibleTargets.
		type: object
		properties:
		targetName:
		type: string
		readOnly: true
		recommendedValue:
		type: number
		readOnly: true
		#-------Definition of the concrete IntentFeasibilityCheckReport dataType----------------#


		@@ -709,6 +939,21 @@ components:
		$ref: '#/components/schemas/ExpectationExplorationResult'
		uniqueItems: true
		minItems: 1
		additionalPreEvaluationInfo:
		description: >-
		It describes the additional provide additional pre-evaluation information for intent exploration
		process. The content and format is vendor specific.
		type: string
		readOnly: true
		expectationExplorationStatus:
		description: ->
		It describes the status of intent exploration process.
		type: string
		enum:
		- NOT_STARTED
		- RUNNING
		- FINISHED
		- FAILED
		ExpectationExplorationResult:
		description: >-
		It represents the expectation exploration result for a specific intent expectation
		@@ -720,7 +965,7 @@ components:
		targetExplorationResults:
		type: array
		items:
		$ref: '#/components/schemas/ExpectationTarget'
		$ref: '#/components/schemas/TargetExplorationResult'
		uniqueItems: true
		minItems: 1
		contextExplorationResults:
		@@ -732,6 +977,23 @@ components:
		required:
		- expectationId
		- targetExplorationResults
		TargetExplorationResult:
		type: object
		description: >-
		It represents exploration results (i.e. recommended best values) for the expectation targets.
		properties:
		targetName:
		type: string
		targetCondition:
		$ref: '#/components/schemas/Condition'
		targetValueRange:
		$ref: '#/components/schemas/ValueRangeType'
		cellContext:
		$ref: 'TS28312_RadioNetworkExpectation.yaml#/components/schemas/CellContext'
		coverageAreaPolygonContext:
		$ref: 'TS28312_RadioNetworkExpectation.yaml#/components/schemas/CoverageAreaPolygonContext'


		#-------Definition of the generic IntentExplorationReport dataType----------------#


		@@ -832,6 +1094,7 @@ components:
		type: string
		readOnly: true
		supportedExpectationObjectType:
		description: It describes the expectation object type which can be supported by a specific intent handling function of MnS producer.
		type: string
		enum:
		- RAN_SUBNETWORK
		@@ -839,13 +1102,24 @@ components:
		- 5GC_SUBNETWORK
		- RADIO_SERVICE
		readOnly: true
		description: It describes the expectation object type which can be supported by a specific intent handling function of MnS producer.
		supportedObjectContextInfoList:
		type: array
		items:
		$ref: '#/components/schemas/SupportedContextInfo'
		uniqueItems: true
		minItems: 1
		supportedExpectationTargetInfoList:
		type: array
		items:
		$ref: '#/components/schemas/SupportedExpectationTargetInfo'
		uniqueItems: true
		minItems: 1
		supportedExpectationContextInfoList:
		type: array
		items:
		$ref: '#/components/schemas/SupportedContextInfo'
		uniqueItems: true
		minItems: 1
		required:
		- intentHandlingCapabilityId
		- supportedExpectationObjectType
		@@ -870,6 +1144,23 @@ components:
		- $ref: '#/components/schemas/ValueRangeType'
		required:
		- supportedTargetName

		SupportedContextInfo:
		type: object
		properties:
		supportedContextAttribute:
		type: string
		supportedContextCondition:
		$ref: '#/components/schemas/Condition'
		supportedContextValueRange:
		oneOf:
		- type: array
		uniqueItems: true
		minItems: 1
		items:
		$ref: '#/components/schemas/ValueRangeType'
		- $ref: '#/components/schemas/ValueRangeType'

		#-------Definition of the concrete IntentHandlingCapability dataType----------------#


		@@ -918,6 +1209,36 @@ components:
		uniqueItems: true
		#-------Definition of the concrete UtilityDefinition dataType----------------#

		#-------Definition of the generic IntentDecompositionReport dataType----------------#
		IntentDecompositionReport:
		description: >-
		It includes the intentDecompositionResults. This attribute shall be supported when intent decomposition result information is supported by intent Report
		type: object
		properties:
		intentDecompositionResults:
		type: array
		items:
		$ref: '#/components/schemas/IntentTraceabilityInfo'
		#-------Definition of the generic IntentDecompositionReport dataType----------------#

		#-------Definition of the generic IntentDecompositionResult dataType----------------#
		IntentTraceabilityInfo:
		description: >-
		It describes traceability record associated with the handling of an intent
		by a particular intent handling function
		type: object
		properties:
		intentHandlingFunctionID:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		readOnly: true
		intentID:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		readOnly: true
		decomposedExpectationID:
		type: string
		readOnly: true
		#-------Definition of the generic IntentDecompositionResult dataType----------------#

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

		Intent-Multiple:
		@@ -942,6 +1263,60 @@ components:

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

		#-------Definition of the generic IntentInterpretationAssistanceInformation dataType----------------#
		IntentInterpretationAssistanceInfo:
		description: >-
		It represents the additional information needed for intent interpretation.
		type: object
		properties:
		dateTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		conditions:
		type: string
		prevProducerMessage:
		type: string
		prevConsumerMessage:
		type: string
		#-------Definition of the concrete IntentInterpretationAssistanceInformation dataType----------------#

		#-------Definition of the common scenario specific IntentExpectation dataType----------------#
		DecompositionAssistingContext:
		description: >-
		This data type is the "ExpectationContext" data type with specialisations for DecompositionAssistingContext. It describes the list of DNs of authorized intent handling functions to which intent decomposition is not recommended
		type: object
		properties:
		contextAttribute:
		type: string
		enum:
		- DecompositionAssisting
		contextCondition:
		type: string
		enum:
		- IS_ALL_OF
		contextValueRange:
		type: array
		items:
		type: string
		SchedulingTimeContext:
		description: >-
		This data type is the "ExpectationContext" data type with specialisations for SchedulingTimeContext.It describes
		the scheduled times (including one-time interval, daily periodicity, weekly periodicity or monthly periodicity)
		for the IntentObject that the intent expectation is applied.
		type: object
		properties:
		contextAttribute:
		type: string
		enum:
		- schedulingTime
		contextCondition:
		type: string
		enum:
		- IS_ALL_OF
		contextValueRange:
		$ref: "TS28623_GenericNrm.yaml#/components/schemas/SchedulingTime"
		#-------Definition of the common scenario specific IntentExpectation dataType----------------#


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