Skip to content
openapi: 3.0.0
info:
title: M5_NetworkAssistance
version: 3.0.2
version: 3.0.3
description: |
5GMS AF M5 Network Assistance API (deprecated)
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: '5G Media Streaming: Media Session Handling (M5) APIs: Network Assistance (deprecated)'
externalDocs:
description: 'TS 26.512 V18.5.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.6.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
paths: {}
......
openapi: 3.0.0
info:
title: Maf_Provisioning (5G Media Streaming)
version: 1.0.0
version: 1.0.1
description: |
5GMS AF Provisioning API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
......@@ -12,7 +12,7 @@ tags:
description: '5G Media Streaming: AF Provisioning APIs'
externalDocs:
description: 'TS 26.512 V18.2.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.6.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
servers:
......
openapi: 3.0.0
info:
title: Maf_SessionHandling (5G Media Streaming)
version: 1.0.0
version: 1.0.1
description: |
5GMS AF Provisioning API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
......@@ -12,7 +12,7 @@ tags:
description: '5G Media Streaming: Media Session Handling APIs'
externalDocs:
description: 'TS 26.512 V18.2.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.6.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
servers:
......
openapi: 3.0.0
info:
title: Mas_Configuration (5G Media Streaming)
version: 1.0.0
version: 1.0.1
description: |
5GMS AS Configuration API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
......@@ -12,7 +12,7 @@ tags:
description: '5G Media Streaming: Application Server Configuration (M3) APIs'
externalDocs:
description: 'TS 26.512 V18.2.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.6.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
servers:
......
openapi: 3.0.0
info:
title: Mas_Configuration_ContentHosting
version: 1.0.1
version: 1.0.2
description: |
5GMS AS Configuration API: Content Hosting
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
......@@ -12,7 +12,7 @@ tags:
description: '5G Media Streaming: Application Server Configuration (M3) APIs: Content Hosting'
externalDocs:
description: 'TS 26.512 V18.4.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.6.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
servers:
......
openapi: 3.0.0
info:
title: Mas_Configuration_ContentPreparationTemplates
version: 1.0.0
version: 1.0.1
description: |
5GMS AS Configuration API: Content Preparation Templates
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
......@@ -12,7 +12,7 @@ tags:
description: '5G Media Streaming: Application Server Configuration (M3) APIs: Content Preparation Templates'
externalDocs:
description: 'TS 26.512 V18.2.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.6.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
servers:
......
openapi: 3.0.0
info:
title: Mas_Configuration_ContentPublishing
version: 1.0.1
version: 1.0.2
description: |
5GMS AS Configuration API: Content Publishing
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
......@@ -12,7 +12,7 @@ tags:
description: '5G Media Streaming: Application Server Configuration (M3) APIs: Content Publishing'
externalDocs:
description: 'TS 26.512 V18.4.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.6.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
servers:
......
openapi: 3.0.0
info:
title: Mas_Configuration_ServerCertificates
version: 1.0.0
version: 1.0.1
description: |
5GMS AS Configuration API: Server Certificates
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
......@@ -12,7 +12,7 @@ tags:
description: '5G Media Streaming: Application Server Configuration (M3) APIs: Server Certificates'
externalDocs:
description: 'TS 26.512 V18.2.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.6.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
servers:
......
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: 5GMS Data Reporting data types
version: 1.0.1
version: 1.0.2
description: |
5GMS Data Reporting data types
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -13,7 +13,7 @@ tags:
description: '5G Media Streaming: Data Reporting data types'
externalDocs:
description: 'TS 26.512 V18.2.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.6.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
paths: {}
......
......@@ -2,10 +2,10 @@ openapi: 3.0.0
info:
title: 5GMS R4 Data Reporting data types
version: 2.0.1
version: 2.0.2
description: |
5GMS R4 Data Reporting data types
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
......@@ -13,7 +13,7 @@ tags:
description: '5G Media Streaming: R4 Data Reporting data types'
externalDocs:
description: 'TS 26.512 V18.2.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.6.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
paths: {}
......
openapi: 3.0.0
info:
title: Data Collection and Reporting Common Data Types
version: 2.1.0
version: 2.1.1
description: |
Data Collection and Reporting Common Data Types
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
- name: Data Collection and Reporting Common Data Types
description: 'Data Collection and Reporting: Common Data Types'
externalDocs:
description: 'TS 26.532 V18.3.0; Data Collection and Reporting; Protocols and Formats'
description: 'TS 26.532 V18.5.0; Data Collection and Reporting; Protocols and Formats'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.532/'
paths: {}
components:
......
openapi: 3.0.0
info:
title: Ndcaf_DataReporting
version: 2.1.1
version: 2.1.2
description: |
Data Collection AF: Data Collection and Reporting Configuration API and Data Reporting API
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: 'Data Collection and Reporting: Client Configuration and Data Reporting (R2/R3/R4) APIs'
externalDocs:
description: 'TS 26.532 V18.4.0; Data Collection and Reporting; Protocols and Formats'
description: 'TS 26.532 V18.5.0; Data Collection and Reporting; Protocols and Formats'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.532/'
servers:
......
openapi: 3.0.0
info:
title: Ndcaf_DataReportingProvisioning
version: 2.0.0
version: 2.0.1
description: |
Data Collection AF: Provisioning Sessions API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
......@@ -12,7 +12,7 @@ tags:
description: 'Data Collection and Reporting: Application Service Provider Provisioning (R1) APIs'
externalDocs:
description: 'TS 26.532 V18.2.0; Data Collection and Reporting; Protocols and Formats'
description: 'TS 26.532 V18.5.0; Data Collection and Reporting; Protocols and Formats'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.532/'
servers:
......
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: 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: 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: 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'
openapi: 3.0.1
info:
title: Scenario specific Intent Expectations
version: 19.1.0
version: 19.2.0
description: >-
OAS 3.0.1 definition of scenario specific Intent Expectations
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -44,6 +44,8 @@ components:
- $ref: "#/components/schemas/RANEnergyConsumptionTarget"
- $ref: "#/components/schemas/RANEnergyEfficiencyTarget"
- $ref: "#/components/schemas/ActiveUEsNumTarget"
- $ref: '#/components/schemas/PRBsTarget'
- $ref: '#/components/schemas/InterRAThandoverTarget'
- $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationTarget'
expectationContexts:
type: array
......@@ -163,6 +165,54 @@ components:
- $ref: "TS28312_IntentNrm.yaml#/components/schemas/Context"
required:
- expectationId
NetworkMaintenanceExpectation:
description: >-
This data type is the "IntentExpectation" data type with specialisations to represent MnS consumer's expectations for Network Maintenance
type: object
properties:
expectationId:
type: string
expectationVerb:
$ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationVerb"
expectationObjects:
type: array
uniqueItems: true
items:
$ref: "#/components/schemas/NetworkMaintenanceExpectationObject"
expectationTargets:
type: array
uniqueItems: true
items:
type: object
oneOf:
- $ref: '#/components/schemas/MaintenanceVersionTarget'
- $ref: '#/components/schemas/WeakRSRPRatioTarget'
- $ref: '#/components/schemas/LowSINRRatioTarget'
- $ref: '#/components/schemas/AveULRANUEThptTarget'
- $ref: '#/components/schemas/AveDLRANUEThptTarget'
- $ref: '#/components/schemas/LowULRANUEThptRatioTarget'
- $ref: '#/components/schemas/LowDLRANUEThptRatioTarget'
- $ref: '#/components/schemas/HighULPrbLoadRatioTarget'
- $ref: '#/components/schemas/HighDLPrbLoadRatioTarget'
- $ref: '#/components/schemas/AveULPrbLoadTarget'
- $ref: '#/components/schemas/AveDLPrbLoadTarget'
- $ref: "#/components/schemas/RANEnergyConsumptionTarget"
- $ref: "#/components/schemas/RANEnergyEfficiencyTarget"
- $ref: "#/components/schemas/MaxNumberofPDUsessionsTarget"
- $ref: "#/components/schemas/MaxNumberofRegisteredsubscribersTarget"
- $ref: "#/components/schemas/IncomingDataTarget"
- $ref: "#/components/schemas/OutgoingDataTarget"
- $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationTarget"
expectationContexts:
type: array
uniqueItems: true
items:
type: object
oneOf:
- $ref: '#/components/schemas/MaintenanceTimeContext'
- $ref: "TS28312_IntentNrm.yaml#/components/schemas/Context"
required:
- expectationId
#-------Definition of the IntentExpectation dataType ----------#
#-------Definition of the scenario specific ExpectationObject dataType ----------#
......@@ -174,7 +224,7 @@ components:
objectType:
type: string
enum:
- RAN_SubNetwork
- RAN_SUBNETWORK
objectInstance:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
objectContexts:
......@@ -185,6 +235,7 @@ components:
oneOf:
- $ref: '#/components/schemas/CoverageAreaPolygonContext'
- $ref: '#/components/schemas/CoverageTACContext'
- $ref: '#/components/schemas/TimeBasedAreaContext'
- $ref: '#/components/schemas/CellContext'
- $ref: '#/components/schemas/PLMNContext'
- $ref: '#/components/schemas/DlFrequencyContext'
......@@ -200,7 +251,7 @@ components:
objectType:
type: string
enum:
- Radio_Service
- RADIO_SERVICE
objectInstance:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
objectContexts:
......@@ -210,8 +261,12 @@ components:
type: object
oneOf:
- $ref: '#/components/schemas/CoverageAreaPolygonContext'
- $ref: '#/components/schemas/DlFrequencyContext'
- $ref: '#/components/schemas/UlFrequencyContext'
- $ref: '#/components/schemas/CellContext'
- $ref: '#/components/schemas/ServiceTypeContext'
- $ref: '#/components/schemas/PlmnInfoContext'
- $ref: '#/components/schemas/UEGroupContext'
- $ref: '#/components/schemas/GeoCoordinateContext'
- $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context'
EdgeServiceSupportExpectationObject:
description: >-
......@@ -221,7 +276,7 @@ components:
objectType:
type: string
enum:
- EdgeService_Support #value for Edge Service Support Expectation--#
- EDGE_SERVICE_SUPPORT #value for Edge Service Support Expectation--#
objectInstance:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
objectContexts:
......@@ -242,7 +297,27 @@ components:
objectType:
type: string
enum:
- 5GC_SubNetwork #value for 5GC Network Expectation--#
- 5GC_SUBNETWORK #value for 5GC Network Expectation--#
objectInstance:
$ref: "TS28623_ComDefs.yaml#/components/schemas/Dn"
objectContexts:
type: array
uniqueItems: true
items:
type: object
oneOf:
- $ref: "#/components/schemas/NfTypeContext"
- $ref: "#/components/schemas/NfInstanceLocationContext"
- $ref: "#/components/schemas/PLMNContext"
- $ref: "#/components/schemas/TaiContext"
- $ref: "#/components/schemas/ServingScopeContext"
- $ref: "#/components/schemas/DnnContext"
- $ref: "TS28312_IntentNrm.yaml#/components/schemas/Context"
NetworkMaintenanceExpectationObject:
description: >-
This data type is the "ExpectationObject" data type with specialisations for NetworkMaintenanceExpectation
type: object
properties:
objectInstance:
$ref: "TS28623_ComDefs.yaml#/components/schemas/Dn"
objectContexts:
......@@ -251,12 +326,21 @@ components:
items:
type: object
oneOf:
- $ref: "#/components/schemas/MaintenanceVersionContext"
- $ref: "#/components/schemas/MaintenanceOrderContext"
- $ref: "#/components/schemas/MaintenanceTypeContext"
- $ref: "#/components/schemas/NfTypeContext"
- $ref: "#/components/schemas/NfInstanceLocationContext"
- $ref: "#/components/schemas/PLMNContext"
- $ref: "#/components/schemas/TaiContext"
- $ref: "#/components/schemas/ServingScopeContext"
- $ref: "#/components/schemas/DnnContext"
- $ref: '#/components/schemas/CoverageAreaPolygonContext'
- $ref: '#/components/schemas/CoverageTACContext'
- $ref: '#/components/schemas/PLMNContext'
- $ref: '#/components/schemas/DlFrequencyContext'
- $ref: '#/components/schemas/UlFrequencyContext'
- $ref: '#/components/schemas/RATContext'
- $ref: "TS28312_IntentNrm.yaml#/components/schemas/Context"
#-------Definition of the ExpectationObject dataType ----------#
......@@ -640,6 +724,40 @@ components:
type: integer
minItems: 1
maxItems: 2
PRBsTarget:
description: >-
This data type is the "ExpectationTarget" data type with specialisations for PRBsTarget.
It describes total available number of physical resource blocks (PRBs). This target is equal to the difference between the DL total available PRB plus UL total available PRB of operator A and the DL total available PRB plus UL total available PRB of operator B. DL total available PRB and UL total available PRB defined in clause 5.1.1.2.6 and 5.1.1.2.8 of TS 28.552 [12].
type: object
properties:
targetName:
type: string
enum:
- PRBS
targetCondition:
type: string
enum:
- IS_EQUAL_TO
targetValueRange:
type: integer
InterRAThandoverTarget:
description: >-
This data type is the "ExpectationTarget" data type with specialisations for PRBsTarget.
it shows how often a handover from 5GS to EPS is successful. The InterRAThandover target is equal to the difference between 5GS to EPS handover success rate of operator A and 5GS to EPS handover success rate of operator B. For details see attribute 5GS to EPS handover success rate defined in clause 6.6.4 of TS 28.554 [11].
type: object
properties:
targetName:
type: string
enum:
- INTERRATHANDOVER
targetCondition:
type: string
enum:
- IS_LESS_THAN
targetValueRange:
type: integer
minimum: 0
maximum: 100
NumberofUEsTarget:
description: >-
This data type is the "ExpectationTarget" data type with specialisations for NumberofUEsTarget.It describes
......@@ -671,7 +789,7 @@ components:
enum:
- IS_GREATER_THAN
targetValueRange:
$ref: 'TS28541_SliceNrm.yaml#/components/schemas/XLThpt'
$ref: 'TS28623_ComDefs.yaml#/components/schemas/Float'
ULThptPerUETarget:
description: >-
This data type is the "ExpectationTarget" data type with specialisations for ULThptPerUETarget.It describes the UL throughput target by the per UE for the edge
......@@ -687,7 +805,7 @@ components:
enum:
- IS_GREATER_THAN
targetValueRange:
$ref: 'TS28541_SliceNrm.yaml#/components/schemas/XLThpt'
$ref: 'TS28623_ComDefs.yaml#/components/schemas/Float'
DLLatencyTarget:
description: >-
This data type is the "ExpectationTarget" data type with specialisations for DLLatencyTarget.It describes the DL latency target for the edge service supporting or radio service
......@@ -851,6 +969,21 @@ components:
- IS_LESS_THAN
targetValueRange:
type: integer
MaintenanceVersionTarget:
description: >-
This data type is the "ExpectationTarget" data type with specialisations for Maintenance Version Target. It describes the maintenance version target for the network maintenance, such as target version of the maintenance object after maintenance.
type: object
properties:
targetName:
type: string
enum:
- MaintenanceVersion
targetCondition:
type: string
enum:
- IS_EQUAL_TO
targetValueRange:
type: string
#-------Definition of the concrete ExpectationTarget dataType----------#
......@@ -893,7 +1026,7 @@ components:
CellContext:
description: >-
This data type is the "ObjectContext" data type with specialisations for CellContext.
It describes the coverage areas for the RAN SubNetwork that the intent expectation is applied
It describes the coverage areas for the RAN SubNetwork or Radio Service that the intent expectation is applied
in the form of a list of cells (including E-UTRAN cells identified by E-UTRAN-CGI and NR cells
identified by NG-RAN CGI).
type: object
......@@ -914,6 +1047,32 @@ components:
oneOf:
- $ref: 'TS28623_ComDefs.yaml#/components/schemas/EutraCellId'
- $ref: 'TS28623_ComDefs.yaml#/components/schemas/NrCellId'
TimeBasedAreaContext:
description: >-
This data type is the "ObjectContext" data type with specialisations for TimeBasedAreaContext.
It describes the areas for specific times for the RAN SubNetwork that the intent expectation is
applied in the form of a <GeoArea, TimeWindow> list.
type: object
properties:
contextAttribute:
type: string
enum:
- TimeBasedArea
contextCondition:
type: string
enum:
- IS_ALL_OF
contextValueRange:
type: array
items:
$ref: "#/components/schemas/TimeBasedArea"
TimeBasedArea:
type: object
properties:
geoArea:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea'
timeWindow:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'
PLMNContext:
description: >-
This data type is the "ObjectContext" data type with specialisations for PLMNContext
......@@ -932,10 +1091,26 @@ components:
uniqueItems: true
items:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId'
GeoCoordinateContext:
description: >-
This data type is the "ObjectContext" data type with specialisations for GeoCoordinateContext.
It describes the location (i.e. geocoordinate) that radio service intent is applied.
type: object
properties:
contextAttribute:
type: string
enum:
- GeoCoordinate
contextCondition:
type: string
enum:
- IS_EQUAL_TO
contextValueRange:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoCoordinate'
DlFrequencyContext:
description: >-
This data type is the "Context" data type with specialisations for Object context "DLFrequencyContext". It describes the downlink frequency information (RF reference
frequencies and/ or the frequency operating band) supported by the RAN SubNetwork that the intent expectation is applied.
frequencies and/ or the frequency operating band) supported by the RAN SubNetwork or Radio Service that the intent expectation is applied.
type: object
properties:
contextAttribute:
......@@ -954,7 +1129,7 @@ components:
UlFrequencyContext:
description: >-
This data type is the "Context" data type with specialisations for Object context "ULFrequencyContext".It describes the uplink frequency information (RF reference
frequencies and/ or the frequency operating band) supported by the RAN SubNetwork that the intent expectation is applied.
frequencies and/ or the frequency operating band) supported by the RAN SubNetwork or Radio Service that the intent expectation is applied.
type: object
properties:
contextAttribute:
......@@ -995,7 +1170,7 @@ components:
- NR
UEGroupContext:
description: >-
This data type is the "ObjectContext" data type with specialisations for UEGroup([5QI, SNSSAI])
This data type is the "ObjectContext" data type with specialisations for UEGroup([5QI, SNSSAI, pLMNId])
type: object
properties:
contextAttribute:
......@@ -1149,6 +1324,61 @@ components:
uniqueItems: true
items:
type: string
MaintenanceVersionContext:
description: >-
This data type is the "ObjectContext" data type with specialisations for MaintenanceVersionContext. It describes the scope of the maintenance objects based on software version.
type: object
properties:
contextAttribute:
type: string
enum:
- swVersion
contextCondition:
type: string
enum:
- IS_ALL_OF
contextValueRange:
type: array
items:
type: string
MaintenanceOrderContext:
description: >-
This data type is the "ObjectContext" data type with specialisations for MaintenanceOrderContext. It describes describes the list of DNs for NFs/NEs based on their order for maintenance.
type: object
properties:
contextAttribute:
type: string
enum:
- maintenanceOrder
contextCondition:
type: string
enum:
- IS_ALL_OF
contextValueRange:
type: array
items:
type: string
MaintenanceTypeContext:
description: >-
This data type is the "ObjectContext" data type with specialisations for MaintenanceTypeContext. It describes the type of maintenance expected for the maintenance object.
type: object
properties:
contextAttribute:
type: string
enum:
- maintenanceType
contextCondition:
type: string
enum:
- IS_EQUAL_TO
contextValueRange:
type: array
uniqueItems: true
items:
type: string
enum:
- UPGRADE
- DOWNGRADE
#-------Definition of the scenario specific ObjectTarget dataType----------------#
#-------Definition of the concrete ExpectationContext dataType----------------#
......@@ -1246,23 +1476,6 @@ components:
- IS_EQUAL_TO
contextValueRange:
$ref: "TS28541_NrNrm.yaml#/components/schemas/Sst"
PlmnInfoContext:
description: >-
This data type is the "ExpectationContext" data type with specialisations for PlmnInfoContext.It describes
the PLMN supported by the Radio Service that the intent expectation is applied. In case of network slicing
feature is supported, this also represents the S-NSSAI in the PLMN supported by the Radio Service.
type: object
properties:
contextAttribute:
type: string
enum:
- PlmnInfo
contextCondition:
type: string
enum:
- IS_ALL_OF
contextValueRange:
$ref: "TS28541_NrNrm.yaml#/components/schemas/PlmnInfo"
SchedulingTimeContext:
description: >-
This data type is the "ExpectationContext" data type with specialisations for SchedulingTimeContext.It describes
......@@ -1295,4 +1508,19 @@ components:
- IS_EQUAL_TO
contextValueRange:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
MaintenanceTimeContext:
description: >-
This data type is the "ExpectationContext" data type with specialisations for MaintenanceTimeContext
type: object
properties:
contextAttribute:
type: string
enum:
- MaintenanceTime
contextCondition:
type: string
enum:
- IS_EQUAL_TO
contextValueRange:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'
#-------Definition of the concrete ExpectionContext dataType----------------#
openapi: 3.0.1
info:
title: Intent NRM
version: 19.1.0
version: 19.2.0
description: >-
OAS 3.0.1 definition of the Intent NRM
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -43,10 +43,13 @@ components:
- $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"
intentMgmtPurpose:
$ref: "#/components/schemas/IntentMgmtPurpose"
contextSelectivity:
$ref: "#/components/schemas/Selectivity"
consumerSatisfactionIndexThreshold:
type: integer
expectationSelectivity:
$ref: "#/components/schemas/Selectivity"
intentContexts:
......@@ -76,6 +79,8 @@ components:
$ref: '#/components/schemas/IntentReportControl'
intentReportReference:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'
intentUtilityFormulaRef:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'
IntentReport-Single:
description: It represents intent report information from MnS producer to MnS consumer.
allOf:
......@@ -93,6 +98,10 @@ components:
$ref: '#/components/schemas/IntentFeasibilityCheckReport'
intentExplorationReport:
$ref: '#/components/schemas/IntentExplorationReport'
intentUtilityReport:
$ref: '#/components/schemas/IntentUtilityReport'
intentFulfilmentNegotiationReport:
$ref: '#/components/schemas/IntentFulfilmentNegotiationReport'
lastUpdatedTime:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo'
intentReference:
......@@ -121,7 +130,34 @@ components:
$ref: '#/components/schemas/Intent-Multiple'
IntentReport:
$ref: '#/components/schemas/IntentReport-Multiple'
supportedUtilityList:
type: array
items:
$ref: '#/components/schemas/UtilityDefinition'
uniqueItems: true
IntentUtilityFormula-Single:
description: >-
It represents an intent utility function instance.
allOf:
- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
- type: object
properties:
utilityFunctionId:
type: string
uniqueItems: true
minItems: 1
utilityParameterList:
type: array
items:
$ref: '#/components/schemas/UtilityParameter'
uniqueItems: true
minItems: 1
utilityScale:
type: number
minItems: 1
utilityOffset:
type: number
minItems: 1
#-------Definition of generic IOCs ----------#
#-------Definition of the generic IntentExpectation dataType ----------#
......@@ -173,7 +209,8 @@ components:
- RAN_SUBNETWORK #value for Radio Network Expectation--#
- EDGE_SERVICE_SUPPORT #value for Edge Service Support Expectation--#
- 5GC_SUBNETWORK #value for 5GC Network Expectation--#
- Radio_Service #value for Radio Service Expectation--#
- RADIO_SERVICE #value for Radio Service Expectation--#
- SUBNETWORK #value for Network Maintenance Expectation--#
objectInstance:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
objectContexts:
......@@ -213,9 +250,10 @@ components:
type: string
enum:
- FEASIBILITYCHECK
- FULFILMENT
- FULFILMENT_WITHOUT_NEGOTIATION
- EXPLORATION
default: FULFILMENT
- FULFILMENT_WITH_NEGOTIATION
default: FULFILMENT_WITHOUT_NEGOTIATION
FulfilmentStatus:
type: string
readOnly: true
......@@ -260,6 +298,7 @@ components:
enum:
- DELIVER
- ENSURE
- MAINTAIN
description: It describes the characteristic of the intentExpectation and is the property that describes the types of intentExpectations. Vendor extensions are allowed
Frequency:
description: >-
......@@ -292,14 +331,15 @@ components:
- $ref: '#/components/schemas/UEGroup'
- $ref: '#/components/schemas/Frequency'
- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SchedulingTime'
- $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfo'
UEGroup:
description: >-
It describes the UE Group, which is
represented by specific 5QI, specific S-NSSAI, or a specific combination
of S-NSSAI and 5QI
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.
type: object
properties:
pLMNId:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId'
fiveQI:
type: integer
minimum: 0
......@@ -387,6 +427,7 @@ components:
- INTENT_FULFILMENT_REPORT
- INTENT_CONFLICT_REPORT
- INTENT_FEASIBILITY_CHECK_REPORT
- INTENT_UTILITY_REPORT
reportingConditions:
description: >-
It indicates the specified conditions for intent reporting.
......@@ -475,11 +516,10 @@ components:
targetFulfilmentInfo:
$ref: '#/components/schemas/FulfilmentInfo'
targetAchievedValue:
type: number
description: >-
It describes the value that has been achieved for the expectation target at the time at which
the report is generated.
readOnly: true
$ref: "#/components/schemas/ValueRangeType"
targetContexts:
type: array
uniqueItems: true
......@@ -527,6 +567,20 @@ components:
#-------Definition of the concrete IntentConflictReport dataType----------------#
#-------Definition of the generic IntentUtilityReport dataType----------------#
IntentUtilityReport:
description: >-
It represents the utility function results.
type: object
properties:
utilityResultList:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/UtilityResult'
#-------Definition of the concrete IntentUtilityReport dataType----------------#
#-------Definition of the generic IntentFeasibilityCheckReport dataType----------------#
IntentFeasibilityCheckReport:
description: >-
......@@ -606,6 +660,90 @@ components:
minItems: 1
#-------Definition of the generic IntentExplorationReport dataType----------------#
#-------Definition of the generic IntentFulfilmentNegotiationReport dataType----------------#
IntentFulfilmentNegotiationReport:
description: >-
It represents the intent negotiation information during fulfilment phase
This attribute shall be supported when intent fulfilment negotiation information is supported by IntentReport
type: object
properties:
possibleIntentOutcomeList:
type: array
items:
$ref: '#/components/schemas/PossibleIntentOutcome'
uniqueItems: true
minItems: 1
intentFulfilmentNegotiationConsumerFeedback:
$ref: '#/components/schemas/IntentFulfilmentNegotiationFeedback'
implicitIntent:
$ref: '#/components/schemas/ImplicitIntent'
PossibleIntentOutcome:
description: >-
It represents a single outcome evaluated by the MnS producer
type: object
properties:
possibleIntentOutcomeId:
type: integer
readOnly: true
intentFulfilmentInfo:
$ref: '#/components/schemas/FulfilmentInfo'
expectationFulfilmentResults:
type: array
items:
$ref: '#/components/schemas/ExpectationFulfilmentResult'
uniqueItems: true
minItems: 1
possibleImpacts:
type: array
items:
$ref: '#/components/schemas/PossibleImpact'
uniqueItems: true
minItems: 1
PossibleImpact:
description: >-
It represents the possible impact of the possible outcome
type: object
properties:
impactedObjects:
type: array
items:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo'
minItems: 1
impactedAttributes:
type: array
items:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet'
minItems: 1
IntentFulfilmentNegotiationFeedback:
description: >-
It represents the feedback information that the MnS consumer provides to the
MnS producer as response during intent fulfilment Negotiation.
type: object
properties:
referredIntentOutcomeId:
type: integer
consumerSatisfactionIndex:
type: integer
ImplicitIntent:
description: >-
It represents the implicit intent which includes the information
that MnS consumers have not explicitly pointed out in its intent.
type: object
properties:
implicitIntentExpectations:
type: array
items:
$ref: '#/components/schemas/IntentExpectation'
implicitIntentContexts:
type: array
items:
$ref: '#/components/schemas/Context'
#-------Definition of the generic IntentFulfilmentNegotiationReport dataType----------------#
#-------Definition of the generic IntentHandlingCapability dataType----------------#
IntentHandlingCapability:
description: >-
......@@ -622,23 +760,21 @@ components:
- RAN_SUBNETWORK
- EDGE_SERVICE_SUPPORT
- 5GC_SUBNETWORK
- Radio_Service
- RADIO_SERVICE
readOnly: true
description: It describes the expectation object type which can be supported by a specific intent handling function of MnS producer.
supportedExpectationTargetNames:
supportedExpectationTargetInfoList:
type: array
items:
$ref: '#/components/schemas/SupportedExpectationTargetInfo'
uniqueItems: true
minItems: 1
items:
type: string
readOnly: true
description: It describes the supported expectation targets for the supported expectation object type.
SupportedExpectationTargetInfo:
description: >-
It indicates the detailed information about what the intent driven MnS producer supports for a given supportedExpectationObjectType.
type: object
properties:
supportedExpectationTargetName:
supportedTargetName:
type: string
readOnly: true
supportedTargetCondition:
......@@ -653,6 +789,51 @@ components:
- $ref: '#/components/schemas/ValueRangeType'
#-------Definition of the concrete IntentHandlingCapability dataType----------------#
#-------Definition of the generic UtilityParameter dataType----------------#
UtilityParameter:
description: >-
It represents the inputs for the specified Intent Utility Function.
type: object
properties:
parameterName:
type: string
parameterWeight:
type: number
#-------Definition of the concrete UtilityParameter dataType----------------#
#-------Definition of the generic UtilityResult dataType----------------#
UtilityResult:
description: >-
It represents the inputs for the specified Intent Utility Function.
type: object
properties:
utilityFunctionId:
type: string
utilityResult:
type: number
#-------Definition of the concrete UtilityResult dataType----------------#
#-------Definition of the generic UtilityDefinition dataType----------------#
UtilityDefinition:
description: >-
It represents the inputs for the specified Intent Utility Function.
type: object
properties:
utilityDefinitionId:
type: string
utilityDescription:
type: string
utilityParameterList:
oneOf:
- type: array
uniqueItems: true
minItems: 1
items:
$ref: '#/components/schemas/UtilityParameter'
- $ref: '#/components/schemas/UtilityParameter'
#-------Definition of the concrete UtilityDefinition dataType----------------#
#------Definition of JSON arrays for name-contained IOCs ---------------#
Intent-Multiple:
......@@ -670,6 +851,10 @@ components:
items:
$ref: '#/components/schemas/IntentHandlingFunction-Single'
IntentUtilityFormula-Multiple:
type: array
items:
$ref: '#/components/schemas/IntentUtilityFormula-Single'
#------Definition of JSON arrays for name-contained IOCs ---------------#
......@@ -679,5 +864,6 @@ components:
- $ref: '#/components/schemas/IntentHandlingFunction-Single'
- $ref: '#/components/schemas/Intent-Single'
- $ref: '#/components/schemas/IntentReport-Single'
- $ref: '#/components/schemas/IntentUtilityFormula-Single'
#----- Definitions in TS 28.312 for TS 28.532 --------------------------#
openapi: 3.0.1
info:
title: 3GPP NRM
version: 19.0.0
version: 19.1.0
description: >-
OAS 3.0.1 specification of the OutageAndRecoveryInfo NRM
© 2024, 3GPP Organizational OutageAndRecoveryInfo Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational OutageAndRecoveryInfo Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 28.318; OutageAndRecoveryInfo NRM
......@@ -17,8 +17,8 @@ components:
EnergyServiceLocation:
type: object
properties:
CGI:
type: string
outageArea:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/AreaOfInterest'
energySupplyId:
type: string
......