Merge branch 'Integration_Rel19_SA5_161_YAML' into 'Rel-19' (8ce9d1f3) · Commits · SA5 – Management & Orchestration and Charging / Management and Orchestration APIs

OpenAPI/README.md

+3 −0

Original line number	Diff line number	Diff line
		@@ -103,6 +103,9 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28318_DsoNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28318_DsoNrm.yaml))

		* Energy Information NRM (TS 28.310)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28310_EnergyInformationNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28310_EnergyInformationNrm.yaml))

		## Management Services (MnS)

OpenAPI/TS28104_MdaNrm.yaml

+25 −17

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: MDA NRM
		version: 19.1.0
		version: 19.2.0
		description: >-
		OAS 3.0.1 specification of the MDA NRM
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -17,22 +17,30 @@ components:
		MDAType:
		type: string
		enum:
		- COVERAGEANALYTICS_COVERAGEPROBLEMANALYSIS
		- COVERAGEANALYTICS_PAGINGOPTIMIZATION
		- SLSANALYSIS_SERVICEEXPERIENCEANALYSIS
		- SLSANALYSIS_NETWORKSLICETHROUGHPUTANALYSIS
		- SLSANALYSIS_NETWORKSLICETRAFFICANALYSIS
		- SLSANALYSIS_E2ELATENCYANALYSIS
		- SLSANALYSIS_NETWORKSLICELOADANALYSIS
		- MDAASSISTEDFAULTMANAGEMENT_FAILUREPREDICTION
		- MDAASSISTEDENERGYSAVING_ENERGYSAVINGANALYSIS
		- MOBILITYMANAGEMENTANALYTICS_MOBILITYPERFORMANCEANALYSIS
		- MOBILITYMANAGEMENTANALYTICS_HANDOVEROPTIMIZATION
		- MAINTENANCE_MAINTENANCEANALYTICS
		- RESOURCEANALYTICS_VIRTUALIZEDRESOURCEUTILIZATIONANALYSISNF
		- RESOURCEANALYTICS_PHYISCALRESOURCEUTILIZATIONANALYSISNF
		- RESOURCEANALYTICS_5GCCONTROLPLANECONGESTIONANALYSIS
		- PREDICTIONS_PMDATA
		- COVERAGE_ANALYTICS_COVERAGE_PROBLEM_ANALYSIS
		- COVERAGE_ANALYTICS_PAGING_OPTIMIZATION
		- SLS_ANALYSIS_SERVICE_EXPERIENCE_ANALYSIS
		- SLS_ANALYSIS_NETWORK_SLICE_THROUGHPUT_ANALYSIS
		- SLS_ANALYSIS_NETWORK_SLICE_TRAFFIC_ANALYSIS
		- SLS_ANALYSIS_E2E_LATENCY_ANALYSIS
		- SLS_ANALYSIS_NETWORK_SLICE_LOAD_ANALYSIS
		- SLS_ANALYSIS_EDGE_APPLICATION_DEPLOYMENT_LOCATION_ANALYSIS
		- SLS_ANALYSIS_EDGE_COMPUTING_PERFORMANCE_ANALYSIS
		- SLS_ANALYSIS_TRAFFIC_CONGESTION_PREDICTION_ANALYSIS
		- MDA_ASSISTED_FAULT_MANAGEMENT_FAILURE_PREDICTION
		- MDA_ASSISTED_ENERGY_SAVING_ENERGY_SAVING_ANALYSIS
		- MOBILITY_MANAGEMENT_ANALYTICS_MOBILITY_PERFORMANCE_ANALYSIS
		- MOBILITY_MANAGEMENT_ANALYTICS_HANDOVER_OPTIMIZATION
		- MAINTENANCE_MAINTENANCE_ANALYTICS
		- MAINTENANCE_SOFTWARE_UPGRADE_VALIDATION_ANALYTICS
		- RESOURCE_ANALYTICS_VIRTUALIZED_RESOURCE_UTILIZATION_ANALYSIS_NF
		- RESOURCE_ANALYTICS_PHYSICAL_RESOURCE_UTILIZATION_ANALYSIS_NF
		- RESOURCE_ANALYTICS_5GC_CONTROL_PLANE_CONGESTION_ANALYSIS
		- PREDICTIONS_PM_DATA
		- UE_THROUGHPUT_ANALYSIS_TRAFFIC_CONGESTION_PROBLEM_ANALYSIS
		- CORRELATION_ANALYTICS_TRAINING_DATA_ANALYSIS
		- CORRELATION_ANALYTICS_NF_SCALING_DIMENSIONING_DATA_ANALYSIS


		MDATypes:
		type: array

OpenAPI/TS28104_MdaReport.yaml

+340 −5

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: MDA Report
		version: 19.1.0
		version: 19.2.0
		description: >-
		OAS 3.0.1 specification of the MDA Report
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -14,6 +14,30 @@ components:
		schemas:

		#-------- Definition of types-----------------------------------------------------
		ProjectionDuration:
		type: object
		properties:
		fromTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		toTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		PagingOptimizationAnalysisOutput:
		type: object
		properties:
		oOCDuration:
		$ref: '#/components/schemas/ProjectionDuration'
		oOCLocation:
		type: array
		uniqueItems: true
		items:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoCoordinate'
		minItems: 1
		oOCMap:
		type: array
		uniqueItems: true
		items:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea'
		minItems: 1

		MDAOutputs:
		type: object
		@@ -21,7 +45,15 @@ components:
		mDAType:
		$ref: 'TS28104_MdaNrm.yaml#/components/schemas/MDAType'
		mDAOutputList:
		type: array
		oneOf:
		- $ref: '#/components/schemas/CoverageProblemAnalysisoutput'
		- $ref: '#/components/schemas/MobilityPerformanceAnalysisoutput'
		- $ref: '#/components/schemas/TrainingDataAnalysisOutput'
		- $ref: '#/components/schemas/NFScalingDimensioningDataAnalysisOutput'
		- $ref: '#/components/schemas/PMDataOutput'
		- $ref: '#/components/schemas/FailurePredictionOutput'
		- $ref: '#/components/schemas/PagingOptimizationAnalysisOutput'
		- type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/MDAOutputEntry'
		@@ -60,3 +92,306 @@ components:
		$ref: '#/components/schemas/MDAOutputs'
		mDARequestRef:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'

		#-------- Definition of recommended action --------------------------------------------
		Recommended3GPPAction:
		type: object
		properties:
		mOInstance:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		path:
		type: string
		op:
		type: string
		enum:
		- ADD
		- REMOVE
		- REPLACE
		value:
		type: array
		uniqueItems: true
		items:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet'
		additionalText:
		type: array
		items:
		type: string

		RecommendedAction:
		type: object
		properties:
		recommended3GPPActions:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/Recommended3GPPAction'
		recommendedNon3GPPActions:
		type: array
		uniqueItems: true
		items:
		type: string
		recommendedHumanReadableActions:
		type: array
		uniqueItems: true
		items:
		type: string
		actionInterval:
		type: integer
		timeWindow:
		type: array
		uniqueItems: false
		items:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'



		#-------- Definition of specific MobilityPerformanceAnalysis MDAoutput -----------------------------
		MobilityPerformanceAnalysisoutput:
		type: object
		properties:
		mobilityPerformanceIssueIdentifier:
		type: integer
		mobilityPerformanceIssueRootCause:
		type: string
		enum:
		- TooLongMobilityInterruptionTime
		- PoorCoverageOfTheCelledge
		- InappropriateHandoverParameters
		- Other
		mobilityPerformanceIssueLocation:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea'

		#-------- Definition of specific CoverageProblemAnalysis MDAoutput -----------------------------
		CoverageProblemAnalysisoutput:
		type: object
		properties:
		coverageProblemId:
		type: string
		coverageProblemType:
		type: string
		enum:
		- WEAK_COVERAGE
		- COVERAGE_HOLE
		- PILOT_POLLUTION
		- OVERSHOOT_COVERAGE
		- DL_ULCHANNEL_COVERAGE_MISMATCH
		- Other
		coverageProblemAreas:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea'
		problematicCells:
		type: integer
		recommendedActions:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/RecommendedAction'
		radioEnvironmentMap:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/RadioEnvironmentMap'
		cellConfigurations:
		description: A map (list of key-value pairs)
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet'

		RadioEnvironmentMap:
		type: object
		properties:
		geoCoordinate:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea'
		coverageCharacterization:
		$ref: '#/components/schemas/CoverageCharacterization'

		CoverageCharacterization:
		type: object
		properties:
		rsrp:
		type: number
		format: float
		sinr:
		type: number
		format: float

		#-------- Definition of specific TrainingDataAnalysis MDAoutput -----------------------------

		TrainingDataAnalysisOutput:
		type: object
		properties:
		measurementDataCorrelationRecommendation:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/MeasurementDataCorrelationRecommendation'

		MeasurementDataCorrelationRecommendation:
		type: object
		properties:
		recommendedMeasurementDataToCollect:
		type: array
		uniqueItems: true
		items:
		type: string
		recommendedMeasurementDataNotToCollect:
		type: array
		uniqueItems: true
		items:
		type: string
		modelPerformanceImpact:
		type: integer
		minimum: 0
		maximum: 100




		#-------- Definition of specific NFScalingDimensioningDataAnalysis MDAoutput -----------------------------

		NFScalingDimensioningDataAnalysisOutput:
		type: object
		properties:
		recommendedActions:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/RecommendedAction'





		#-------- Definition of specific PMData MDAoutput -----------------------------
		PMDataOutput:
		type: object
		properties:
		pmPredictions:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/PmPrediction'
		minItems: 1
		thresholdAssessment:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/ThresholdAssessment'
		thresholdAdjustmentRecommendations:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/RecommendedAction'

		PmPrediction:
		type: object
		properties:
		pmName:
		type: string
		pmPredictedValue:
		description: >-
		This specifies the predicted value of the PM specified by “pmName”
		attribute.
		oneOf:
		- type: integer
		- type: number
		format: float

		thresholdAssessment:
		$ref: '#/components/schemas/ThresholdAssessment'

		ThresholdAssessment:
		type: object
		properties:
		performanceMetrics:
		description: >-
		It indicates list of performance metrics with threshold
		configuration issue.
		Performance metrics include measurements defined in TS 28.552
		and KPIs defined in TS 28.554.
		For non-3GPP specified measurements the name is defined elsewhere.
		type: array
		uniqueItems: true
		items:
		type: string
		timeWindow:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'
		confidenceScore:
		type: number
		format: float


		#-------- Definition of specific FailurePrediction MDAoutput -----------------------------

		FailurePredictionOutput:
		type: object
		properties:
		failurePredictionObject:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
		potentialFailureType:
		type: string
		potentialFailureCause:
		oneOf:
		- type: integer
		- type: string
		eventTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		issueID:
		type: string
		issueDomain:
		type: string
		enum:
		- RAN_ISSUE
		- CN_ISSUE
		- UNKNOWN
		perceivedSeverity:
		type: string
		enum:
		- CRITICAL
		- MAJOR
		- MINOR
		- WARNING
		- INTERMEDIATE
		- CLEARED
		trendIndication:
		type: string
		enum:
		- MORE_SEVERE
		- NO_CHANGE
		- LESS_SEVERE
		predictedFailureEndTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		statisticsInfoList:
		type: array
		items:
		type: integer
		managementDataCollectionRecommendations:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/ManagementDataCollectionInfo'
		recommendedActions:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/RecommendedAction'

		ManagementDataCollectionInfo:
		type: object
		properties:
		managementDataType:
		type: string
		enum:
		- MEASUREMENT
		- KPI
		- TRACE_MDT
		- QOE
		managementData:
		$ref: 'TS28623_ManagementDataCollectionNrm.yaml#/components/schemas/ManagementData'
		targetEntities:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
		collectionDuration:
		type: array
		items:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'

OpenAPI/TS28111_FaultNrm.yaml

+6 −5

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: Fault Management NRM
		version: 19.1.0
		version: 19.2.0
		description: >-
		OAS 3.0.1 definition of the Fault Supervision MnS
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -40,6 +40,7 @@ components:
		- PHYSICAL_VIOLATION
		- SECURITY_SERVICE_OR_MECHANISM_VIOLATION
		- TIME_DOMAIN_VIOLATION
		- OTHER
		readOnly: true
		ProbableCause:
		description: >-
		@@ -107,7 +108,7 @@ components:
		properties:
		down:
		$ref: '#/components/schemas/ThresholdHysteresis'
		ThresholdInfo:
		ThresholdCrossing:
		type: object
		properties:
		observedMeasurement:
		@@ -178,7 +179,7 @@ components:
		trendIndication:
		$ref: '#/components/schemas/TrendIndication'
		thresholdinfo:
		$ref: '#/components/schemas/ThresholdInfo'
		$ref: '#/components/schemas/ThresholdCrossing'
		correlatedNotifications:
		$ref: '#/components/schemas/CorrelatedNotifications'
		stateChangeDefinition:
		@@ -292,7 +293,7 @@ components:
		trendIndication:
		$ref: '#/components/schemas/TrendIndication'
		thresholdInfo:
		$ref: '#/components/schemas/ThresholdInfo'
		$ref: '#/components/schemas/ThresholdCrossing'
		correlatedNotifications:
		$ref: '#/components/schemas/CorrelatedNotifications'
		stateChangeDefinition:
		@@ -418,7 +419,7 @@ components:
		trendIndication:
		$ref: '#/components/schemas/TrendIndication'
		thresholdInfo:
		$ref: '#/components/schemas/ThresholdInfo'
		$ref: '#/components/schemas/ThresholdCrossing'
		stateChangeDefinition:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet'
		monitoredAttributes:

OpenAPI/TS28310_EnergyInformationNrm.yaml

0 → 100644

+95 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: Energy Information NRM
		version: 19.0.0
		description: >-
		OAS 3.0.1 specification of the Energy Information NRM
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.310; Energy Information NRM
		url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.310/
		paths: {}
		components:
		schemas:

		#-------- Definition of types-----------------------------------------------------
		EnergySourceInfo:
		type: object
		properties:
		energySourceType:
		type: string
		energySourceCef:
		type: number
		format: float
		minimum: 0
		renewableEnergy:
		type: boolean
		energyCompositionPercentage:
		type: number
		format: float
		default: 100
		minimum: 1
		maximum: 100
		EnergySupplyMode:
		type: string
		enum:
		- GRID_ELECTRICITY
		- BACKUP_ENERGY
		- LOCALLY_GENERATED_ENERGY

		#-------- Definition of concrete IOCs --------------------------------------------
		SubNetwork-ncO-EnergyInformationNrm:
		type: object
		properties:
		EnergySupplyInfo:
		$ref: '#/components/schemas/EnergySupplyInfo-Multiple'
		EnergyInfoGroup:
		$ref: '#/components/schemas/EnergyInfoGroup-Multiple'

		EnergySupplyInfo-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		type: object
		properties:
		energySupplyMode:
		$ref: '#/components/schemas/EnergySupplyMode'
		energySourceList:
		type: array
		uniqueItems: true
		minItems: 1
		items:
		$ref: '#/components/schemas/EnergySourceInfo'
		EnergyInfoGroup-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		type: object
		properties:
		energySupplyModeRefList:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
		memberDNList:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'

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

		EnergySupplyInfo-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EnergySupplyInfo-Single'
		EnergyInfoGroup-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EnergyInfoGroup-Single'

		#--------------------------------- Definition ------------------------------------

		resources-energyInformationNrm:
		oneOf:
		- $ref: '#/components/schemas/EnergySupplyInfo-Single'
		- $ref: '#/components/schemas/EnergyInfoGroup-Single'