Commit 3a27fbcc authored by ruiyue's avatar ruiyue
Browse files

Update readme file to add Overview of management capabilities and corresponding openAPI definitions

parent 490b435a

OpenAPI/README.md

+41 −2
Original line number Diff line number Diff line 
# 3GPP SA5 models and MnS OpenAPI definitions



(c) 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.

(c) 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.



The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML file of each API:



<!-- APIs -->

## Network Resource Models (NRM)



## Overview of management capabilities and corresponding openAPI definitions



| Management Feature | Management Capability | MnS definition | OpenAPI definition |

|:------|:------|:------|:------|

| Network and network slicing management | NR Provisioning|CRUD operations/notifications (3GPP TS 28.532) + NR NRM fragment (3GPP TS 28.541) | [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28541_NrNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28541_NrNrm.yaml)|

| | 5GC Provisioning|CRUD operations/notifications (TS 28.532) + 5GC NRM fragment (3GPP TS 28.541) | [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28541_5GcNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28541_5GcNrm.yaml)|

| | Network Slicing Provisioning |CRUD operations/notifications (TS 28.532) + 5GC NRM fragment (3GPP TS 28.541) | [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28541_SliceNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28541_SliceNrm.yaml)|

| | |Network slice provisioning service (3GPP TS 28.531) + Network slice subnet provisioning service (3GPP TS 28.531)| [TS28531_NSProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28531_NSProvMnS.yaml) <br> [TS28531_NSSProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28531_NSSProvMnS.yaml)|

|Edge Computing Management|Edge Computing Management|CRUD operations/notifications (3GPP TS 28.532) + Edge NRM fragment (3GPP TS 28.538)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28538_EdgeNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28538_EdgeNrm.yaml)|

|Performance Assurance |Performance Metric Collection Control|CRUD operations/notifications (3GPP TS 28.532) + PM control NRM fragment (3GPP TS 28.622)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28623_PmControlNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_PmControlNrm.yaml)|

| | |CRUD operations/notifications (3GPP TS 28.532) + PM control NRM fragment (3GPP TS 28.622)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28623_ManagementDataCollectionNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_ManagementDataCollectionNrm.yaml)|

| |Performance Metric Data Report|Streaming data reporting service (3GPP TS 28.532) + Performance data stream units (3GPP TS 28.550)| [TS28532_StreamingDataMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_StreamingDataMnS.yaml)|

| |Performance Metric Threshold Monitor Control|CRUD operations/notifications (3GPP TS 28.532) + Threshold monitoring control NRM fragment (3GPP TS 28.622)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28623_ThresholdMonitorNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_ThresholdMonitorNrm.yaml)|

| |Performance Metric Threshold Notification|notifyThresholdCrossing notification (3GPP TS 28.532)| [TS28532_PerfMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_PerfMnS.yaml)|

|Fault Management |Fault control |CRUD operations/notifications (3GPP TS 28.532) + FM control NRM fragment (3GPP TS 28.111)|[TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28111_FaultNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28111_FaultNrm.yaml)|

| |Fault Notification |CRUD operations/notifications (3GPP TS 28.532) + FM control NRM fragment (3GPP TS 28.111)|[TS28111_FaultNotifications.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28111_FaultNotifications.yaml)|

|Trace and MDT management |Trace/MDT data collection control|CRUD operations/notifications (3GPP TS 28.532) + Trace control NRM fragment (3GPP TS 28.622)|[TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28623_TraceControlNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_TraceControlNrm.yaml)|

| |Trace/MDT data report |Streaming data reporting service (3GPP TS 28.532 + Trace/MDT stream date schema definition (3GPP TS 32.423)|[TS28532_StreamingDataMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_StreamingDataMnS.yaml)|

| | |File data reporting service (3GPP TS 28.532) + Trace/MDT file date format definition (TS 32.423)|[TS28532_FileDataReportingMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_FileDataReportingMnS.yaml)|

|QoE management |QoE data collection control|CRUD operations/notifications (3GPP TS 28.532) + QoE Measurement Collection control NRM fragment (3GPP TS 28.622)|[TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28623_QoEMeasurementCollectionNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_QoEMeasurementCollectionNrm.yaml)|

| |QoE data report|File data reporting service (3GPP TS 28.532) + QoE data file format (3GPP TS 26.247)|[TS28532_FileDataReportingMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_FileDataReportingMnS.yaml)|

|Plan management|Configuration plan management|Information model for configuration plan management (3GPP TS 28.572)|[TS28572_PlanManagement.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_FileDataReportingMnS.yaml)|

|Notification subscription and Heartbeat notification control |Subscription Control|CRUD operations/notifications (3GPP TS 28.532) + Notification subscription and heartbeat notification control NRM fragment (3GPP TS 28.622)|[TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28623_SubscriptionControlNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_SubscriptionControlNrm.yaml)|

| |Heartbeat Control|CRUD operations/notifications (3GPP TS 28.532) + Heartbeat notification control NRM fragment (3GPP TS 28.622)|[TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28623_SubscriptionControlNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_SubscriptionControlNrm.yaml)|

| |Heartbeat Notification |notifyHeartbeat notification (3GPP TS 28.532])|[TS28532_HeartbeatNtf.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_HeartbeatNtf.yaml)|

|MDA|Management Data Analytic|CRUD operations/notifications (3GPP TS 28.532) + NRM fragment for MDA request and MDA report (3GPP TS 28.104)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28104_MdaNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28104_MdaNrm.yaml) <br> [TS28104_MdaReport.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28104_MdaReport.yaml)|

|SON|RANSC Management|CRUD operations/notifications (3GPP TS 28.532) + RANSC NRM Fragment 3GPP TS 28.317)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28317_RanScNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28317_RanScNrm.yaml) |

||SON policy|CRUD operations/notifications (3GPP TS 28.532) + NRM Fragment for DANR/DES/DRACH/DMRO/DPCI/CES/CPCI/DLMO/CCO Management (3GPP TS 28.541 )| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28541_NrNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28541_NrNrm.yaml) |

|Closed-loop |Communication Service Assurance Control|CRUD operations/notifications (3GPP TS 28.532) + Assurance management NRM fragment (3GPP TS 28.536)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28536_CoslaNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28536_CoslaNrm.yaml) |

| |Closed control loop management|CRUD operations/notifications (3GPP TS 28.532) + NRM fragment for CCL management (3GPP TS 28.567)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28567_CclNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28567_CclNrm.yaml) |

|Intent driven management|Intent Driven Management|CRUD operations/notifications (3GPP TS 28.532) + NRM fragment for intent driven management (3GPP TS 28.312)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28312_IntentNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_IntentNrm.yaml) <br> [TS28312_RadioNetworkExpectation.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_RadioNetworkExpectation.yaml) <br> [TS28312_RadioServiceExpectation.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_RadioServiceExpectation.yaml) <br> [TS28312_NetworkMaintenanceExpectation.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_NetworkMaintenanceExpectation.yaml) <br> [TS28312_5GCNetworkExpectation.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_5GCNetworkExpectation.yaml)<br> [TS28312_EdgeServiceSupportExpectation.yamll](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_EdgeServiceSupportExpectation.yaml)|

|AI/ML management|ML model Management|CRUD operations/notifications (3GPP TS 28.532) + NRM fragment for ML model training/testing/ inference emulation control/ ML model loading / inference (3GPP TS 28.105)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28105_AiMlNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28105_AiMlNrm.yaml) |

|NDT management|NDT Lifecycle Management|CRUD operations/notifications (3GPP TS 28.532) + NRM fragment for NDT management (3GPP TS 28.561)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28561_NdtNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28561_NdtNrm.yaml) |

|MnS Registry and Discovery|MnS Registry and Discovery|CRUD operations/notifications (3GPP TS 28.532) + MnS Registry NRM fragment (TS 28.622)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28623_MnSRegistryNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_MnSRegistryNrm.yaml) |

| |MgmtData Registry and Discovery|CRUD operations/notifications (3GPP TS 28.532) + MnS Registry NRM fragment (TS 28.622)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28623_MnSRegistryNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_MnSRegistryNrm.yaml) |

|MSAC|MnS Access Control|CRUD operations/notifications (3GPP TS 28.532 ) + Information model for role based access control (3GPP TS 28.319)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28319_MsacNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28319_MsacNrm.yaml) |

|NSOEU|DSO Rapid Recovery and Threshold Monitoring|CRUD operations/notifications (3GPP TS 28.532)+ DSO Rapid Recovery NRM fragment (3GPP TS 28.318) + DSO Rapid Recovery NRM fragment(3GPP TS 28.318)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28318_DsoNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28318_DsoNrm.yaml) |

|External Data Management|External Data Discovery and Request|CRUD operations/notifications (3GPP TS 28.532) + External data type NRM fragment (TS 28.622)| [TS28532_ProvMnS.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml) <br> [TS28623_ExternalDataMgmtNrm.yaml](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_ExternalDataMgmtNrm.yaml) |



## Network Resource Models (NRM)

* Generic NRM (TS 28.623)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_GenericNrm.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_GenericNrm.yaml))