From ce11847301ca53bbdf823aa34de519f9fa3caf63 Mon Sep 17 00:00:00 2001 From: zhaoxxian Date: Fri, 8 Aug 2025 04:08:19 +0000 Subject: [PATCH 1/7] initial NDT NRM stage 3 --- OpenAPI/TS28561_NdtNrm.yaml | 199 ++++++++++++++++++++++++++++++++++++ 1 file changed, 199 insertions(+) create mode 100644 OpenAPI/TS28561_NdtNrm.yaml diff --git a/OpenAPI/TS28561_NdtNrm.yaml b/OpenAPI/TS28561_NdtNrm.yaml new file mode 100644 index 000000000..a0be71c2d --- /dev/null +++ b/OpenAPI/TS28561_NdtNrm.yaml @@ -0,0 +1,199 @@ +openapi: 3.0.1 +info: + title: NDT NRM + version: 19.0.0 + description: >- + OAS 3.0.1 definition of the NDT NRM + © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.561; Management aspects of Network Digital Twins + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.561/ +paths: {} +components: + schemas: + + #-------- Definition of types for name-containments ------ + SubNetwork-ncO-NDTNrm: + type: object + properties: + NDTFunction: + $ref: '#/components/schemas/NDTFunction-Multiple' + + #-------Definition of generic IOCs ----------# + NDTFunction-Single: + description: >- + This IOC represents the properties of an NDT Function + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + supportedNDTCapabilities: + type: array + uniqueItems: true + items: + enum: + - RISKY-ACTIONS_PREDICTION + - EVENTS-IMPACTS_VERIFICATION + - FAULT_INJECTION + - NETWORK_EVENTS_VERIFICATION + - NETWORK_CONFIGURATIONS_VERIFICATION + - AUTOMATION_CONFIGURATION_VERIFICATION + - ML-TRAINING_DATA_GENERATION + - USER_EXPERIENCE_DATA_GENERATION + description: >- + It indicates the different types of NDT application use cases which the NDT is capable of undertaking.. + New values can be added to this list in future releases to support new use cases. + nDTFunctionScope: + $ref: "#/components/schemas/NDTFunctionScope" + + NDTJob-Single: + description: >- + This IOC represents the properties of an NDT job demand created by an MnS consumer. An NDT job represents the requirements for a network simulation/emulation task + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + nDTCapability: + type: string + enum: + - RISKY-ACTIONS_PREDICTION + - EVENTS-IMPACTS_VERIFICATION + - FAULT_INJECTION + - NETWORK_EVENTS_VERIFICATION + - NETWORK_CONFIGURATIONS_VERIFICATION + - AUTOMATION_CONFIGURATION_VERIFICATION + - ML-TRAINING_DATA_GENERATION + - USER_EXPERIENCE_DATA_GENERATION + description: >- + It indicates the type of application use cases that is desired to be executed. + New values can be added to this list in future releases to support new use cases. + nDTJobSynchScope: + $ref: "#/components/schemas/ScopeDefinition" + nDTJobScenario: + $ref: "#/components/schemas/NDTInputDescription" + nDTJobExecutionRequirements: + $ref: "#/components/schemas/NdtJobExecutionReqts" + collaboratingNDT: + description: >- + It indicates the related NDT Job contributing as a collaborator to the executed NDT Job. It describes the DN of the collaborated NDT Job + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + ndtReportRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + + NDTReport-Single: + description: >- + This IOC represents the properties of an NDT report corresponding to an NDT job + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + nDTJobOutputData: + type: array + uniqueItems: true + items: + $ref: "#/components/schemas/NDTOutputDataPoint" + description: It indicates the list of NDTOutput(s) that are provided by the NDT function as the output for any task executed in an instantiated NDT job. + ndtJobRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + ndtFunctionRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + + #-------Definition of the dataType ----------# + NDTFunctionScope: + type: object + properties: + nDTRANScope: + $ref: '#/components/schemas/ScopeDefinition' + nDTCNScope: + $ref: "#/components/schemas/ScopeDefinition" + NDTInputDescription: + type: object + properties: + nDTInputDescriptionId: + type: string + simulationData: + type: array + uniqueItems: true + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + networkEventInfo: + type: string + condition: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + NDTOutputDescription: + type: object + properties: + nDTOutputDescriptionId: + type: string + objectInstance: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + objectAttributeList: + type: array + uniqueItems: true + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + ScopeDefinition: + type: object + oneOf: + - required: [ managedEntitiesScope ] + - required: [ areaScope ] + properties: + managedEntitiesScope: + type: array + uniqueItems: true + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + areaScope: + type: array + uniqueItems: true + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea' + NdtJobExecutionReqts: + type: object + properties: + maxRuntime: + type: integer + NDTOutputDataPoint: + type: object + properties: + networkState: + type: array + uniqueItems: true + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NDTOutputDescription' + networkConfiguration: + type: array + uniqueItems: true + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NDTOutputDescription' + observations: + type: array + uniqueItems: true + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NDTOutputDescription' + + #------Definition of JSON arrays for name-contained IOCs ---------------# + + NDTJob-Multiple: + type: array + items: + $ref: '#/components/schemas/NDTJob-Single' + + NDTReport-Multiple: + type: array + items: + $ref: '#/components/schemas/NDTReport-Single' + + NDTFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NDTFunction-Single' + #------Definition of JSON arrays for name-contained IOCs ---------------# + + #----- Definitions in TS 28.561 for TS 28.532 --------------------------# + resources-intentNrm: + oneOf: + - $ref: '#/components/schemas/NDTFunction-Single' + - $ref: '#/components/schemas/NDTJob-Single' + - $ref: '#/components/schemas/NDTReport-Single' -- GitLab From ae7b02a42126a0e41c4d31f854eda35f3e3d21cd Mon Sep 17 00:00:00 2001 From: zhaoxxian Date: Fri, 8 Aug 2025 04:24:45 +0000 Subject: [PATCH 2/7] initial NDT NRM stage3 --- OpenAPI/TS28561_NdtNrm.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/OpenAPI/TS28561_NdtNrm.yaml b/OpenAPI/TS28561_NdtNrm.yaml index a0be71c2d..df890505e 100644 --- a/OpenAPI/TS28561_NdtNrm.yaml +++ b/OpenAPI/TS28561_NdtNrm.yaml @@ -161,17 +161,17 @@ components: type: array uniqueItems: true items: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NDTOutputDescription' + $ref: '#/components/schemas/NDTOutputDescription' networkConfiguration: type: array uniqueItems: true items: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NDTOutputDescription' + $ref: '#/components/schemas/NDTOutputDescription' observations: type: array uniqueItems: true items: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NDTOutputDescription' + $ref: '#/components/schemas/NDTOutputDescription' #------Definition of JSON arrays for name-contained IOCs ---------------# -- GitLab From 9c7a5746f3be9fe57108cbb4b03a06f210552e61 Mon Sep 17 00:00:00 2001 From: zhaoxxian Date: Fri, 8 Aug 2025 07:17:02 +0000 Subject: [PATCH 3/7] Edit TS28561_NdtNrm.yaml --- OpenAPI/TS28561_NdtNrm.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/OpenAPI/TS28561_NdtNrm.yaml b/OpenAPI/TS28561_NdtNrm.yaml index df890505e..eb6fd9c04 100644 --- a/OpenAPI/TS28561_NdtNrm.yaml +++ b/OpenAPI/TS28561_NdtNrm.yaml @@ -33,13 +33,13 @@ components: uniqueItems: true items: enum: - - RISKY-ACTIONS_PREDICTION - - EVENTS-IMPACTS_VERIFICATION + - RISKY_ACTIONS_PREDICTION + - EVENTS_IMPACTS_VERIFICATION - FAULT_INJECTION - NETWORK_EVENTS_VERIFICATION - NETWORK_CONFIGURATIONS_VERIFICATION - AUTOMATION_CONFIGURATION_VERIFICATION - - ML-TRAINING_DATA_GENERATION + - ML_TRAINING_DATA_GENERATION - USER_EXPERIENCE_DATA_GENERATION description: >- It indicates the different types of NDT application use cases which the NDT is capable of undertaking.. @@ -57,13 +57,13 @@ components: nDTCapability: type: string enum: - - RISKY-ACTIONS_PREDICTION - - EVENTS-IMPACTS_VERIFICATION + - RISKY_ACTIONS_PREDICTION + - EVENTS_IMPACTS_VERIFICATION - FAULT_INJECTION - NETWORK_EVENTS_VERIFICATION - NETWORK_CONFIGURATIONS_VERIFICATION - AUTOMATION_CONFIGURATION_VERIFICATION - - ML-TRAINING_DATA_GENERATION + - ML_TRAINING_DATA_GENERATION - USER_EXPERIENCE_DATA_GENERATION description: >- It indicates the type of application use cases that is desired to be executed. -- GitLab From f689aad39208123e4e3db94e31277d7285252edb Mon Sep 17 00:00:00 2001 From: ruiyue Date: Thu, 14 Aug 2025 06:32:24 +0000 Subject: [PATCH 4/7] Update 2 files - /OpenAPI/TS28623_FeatureNrm.yaml - /OpenAPI/TS28561_NdtNrm.yaml --- OpenAPI/TS28561_NdtNrm.yaml | 2 +- OpenAPI/TS28623_FeatureNrm.yaml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/OpenAPI/TS28561_NdtNrm.yaml b/OpenAPI/TS28561_NdtNrm.yaml index eb6fd9c04..f1ad5965a 100644 --- a/OpenAPI/TS28561_NdtNrm.yaml +++ b/OpenAPI/TS28561_NdtNrm.yaml @@ -192,7 +192,7 @@ components: #------Definition of JSON arrays for name-contained IOCs ---------------# #----- Definitions in TS 28.561 for TS 28.532 --------------------------# - resources-intentNrm: + resources-ndtNrm: oneOf: - $ref: '#/components/schemas/NDTFunction-Single' - $ref: '#/components/schemas/NDTJob-Single' diff --git a/OpenAPI/TS28623_FeatureNrm.yaml b/OpenAPI/TS28623_FeatureNrm.yaml index 7a37deb97..0991e09eb 100644 --- a/OpenAPI/TS28623_FeatureNrm.yaml +++ b/OpenAPI/TS28623_FeatureNrm.yaml @@ -27,6 +27,7 @@ components: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/resources-nrNrm' - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/resources-5gcNrm' - $ref: 'TS28541_SliceNrm.yaml#/components/schemas/resources-sliceNrm' + - $ref: 'TS28561_NdtNrm.yaml#/components/schemas/resources-ndtNrm:' - $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/resources-fileMgmtNrm' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/resources-genericNrm' - $ref: 'TS28623_ManagementDataCollectionNrm.yaml#/components/schemas/resources-mgmtDataCollectionNrm' -- GitLab From fd9905ea0b5e15975680d1b8579041d8e25e0e3e Mon Sep 17 00:00:00 2001 From: ruiyue Date: Thu, 14 Aug 2025 06:41:16 +0000 Subject: [PATCH 5/7] Update 2 files - /OpenAPI/TS28623_FeatureNrm.yaml - /OpenAPI/TS28561_NdtNrm.yaml --- OpenAPI/TS28561_NdtNrm.yaml | 46 ++++++++++++++------------------- OpenAPI/TS28623_FeatureNrm.yaml | 2 +- 2 files changed, 21 insertions(+), 27 deletions(-) diff --git a/OpenAPI/TS28561_NdtNrm.yaml b/OpenAPI/TS28561_NdtNrm.yaml index f1ad5965a..097fb1db5 100644 --- a/OpenAPI/TS28561_NdtNrm.yaml +++ b/OpenAPI/TS28561_NdtNrm.yaml @@ -25,27 +25,19 @@ components: description: >- This IOC represents the properties of an NDT Function allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: supportedNDTCapabilities: type: array uniqueItems: true items: - enum: - - RISKY_ACTIONS_PREDICTION - - EVENTS_IMPACTS_VERIFICATION - - FAULT_INJECTION - - NETWORK_EVENTS_VERIFICATION - - NETWORK_CONFIGURATIONS_VERIFICATION - - AUTOMATION_CONFIGURATION_VERIFICATION - - ML_TRAINING_DATA_GENERATION - - USER_EXPERIENCE_DATA_GENERATION + $ref: '#/components/schemas/NDTCapability' description: >- It indicates the different types of NDT application use cases which the NDT is capable of undertaking.. New values can be added to this list in future releases to support new use cases. nDTFunctionScope: - $ref: "#/components/schemas/NDTFunctionScope" + $ref: '#/components/schemas/NDTFunctionScope' NDTJob-Single: description: >- @@ -55,25 +47,16 @@ components: - type: object properties: nDTCapability: - type: string - enum: - - RISKY_ACTIONS_PREDICTION - - EVENTS_IMPACTS_VERIFICATION - - FAULT_INJECTION - - NETWORK_EVENTS_VERIFICATION - - NETWORK_CONFIGURATIONS_VERIFICATION - - AUTOMATION_CONFIGURATION_VERIFICATION - - ML_TRAINING_DATA_GENERATION - - USER_EXPERIENCE_DATA_GENERATION + $ref: '#/components/schemas/NDTCapability' description: >- It indicates the type of application use cases that is desired to be executed. New values can be added to this list in future releases to support new use cases. nDTJobSynchScope: - $ref: "#/components/schemas/ScopeDefinition" + $ref: '#/components/schemas/ScopeDefinition' nDTJobScenario: - $ref: "#/components/schemas/NDTInputDescription" + $ref: '#/components/schemas/NDTInputDescription' nDTJobExecutionRequirements: - $ref: "#/components/schemas/NdtJobExecutionReqts" + $ref: '#/components/schemas/NdtJobExecutionReqts' collaboratingNDT: description: >- It indicates the related NDT Job contributing as a collaborator to the executed NDT Job. It describes the DN of the collaborated NDT Job @@ -92,7 +75,7 @@ components: type: array uniqueItems: true items: - $ref: "#/components/schemas/NDTOutputDataPoint" + $ref: '#/components/schemas/NDTOutputDataPoint' description: It indicates the list of NDTOutput(s) that are provided by the NDT function as the output for any task executed in an instantiated NDT job. ndtJobRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' @@ -100,13 +83,24 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' #-------Definition of the dataType ----------# + NDTCapability: + type: string + enum: + - RISKY_ACTIONS_PREDICTION + - EVENTS_IMPACTS_VERIFICATION + - FAULT_INJECTION + - NETWORK_EVENTS_VERIFICATION + - NETWORK_CONFIGURATIONS_VERIFICATION + - AUTOMATION_CONFIGURATION_VERIFICATION + - ML_TRAINING_DATA_GENERATION + - USER_EXPERIENCE_DATA_GENERATION NDTFunctionScope: type: object properties: nDTRANScope: $ref: '#/components/schemas/ScopeDefinition' nDTCNScope: - $ref: "#/components/schemas/ScopeDefinition" + $ref: '#/components/schemas/ScopeDefinition' NDTInputDescription: type: object properties: diff --git a/OpenAPI/TS28623_FeatureNrm.yaml b/OpenAPI/TS28623_FeatureNrm.yaml index 0991e09eb..7bfc472d4 100644 --- a/OpenAPI/TS28623_FeatureNrm.yaml +++ b/OpenAPI/TS28623_FeatureNrm.yaml @@ -27,7 +27,7 @@ components: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/resources-nrNrm' - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/resources-5gcNrm' - $ref: 'TS28541_SliceNrm.yaml#/components/schemas/resources-sliceNrm' - - $ref: 'TS28561_NdtNrm.yaml#/components/schemas/resources-ndtNrm:' + - $ref: 'TS28561_NdtNrm.yaml#/components/schemas/resources-ndtNrm' - $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/resources-fileMgmtNrm' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/resources-genericNrm' - $ref: 'TS28623_ManagementDataCollectionNrm.yaml#/components/schemas/resources-mgmtDataCollectionNrm' -- GitLab From 530b912966251310101f345aa5a2995902921008 Mon Sep 17 00:00:00 2001 From: ruiyue Date: Thu, 14 Aug 2025 07:06:30 +0000 Subject: [PATCH 6/7] Update file TS28561_NdtNrm.yaml --- OpenAPI/TS28561_NdtNrm.yaml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/OpenAPI/TS28561_NdtNrm.yaml b/OpenAPI/TS28561_NdtNrm.yaml index 097fb1db5..270a819a8 100644 --- a/OpenAPI/TS28561_NdtNrm.yaml +++ b/OpenAPI/TS28561_NdtNrm.yaml @@ -23,7 +23,7 @@ components: #-------Definition of generic IOCs ----------# NDTFunction-Single: description: >- - This IOC represents the properties of an NDT Function + This IOC represents the properties of an NDT Function allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -49,7 +49,7 @@ components: nDTCapability: $ref: '#/components/schemas/NDTCapability' description: >- - It indicates the type of application use cases that is desired to be executed. + It indicates the type of application use cases that is desired to be executed. New values can be added to this list in future releases to support new use cases. nDTJobSynchScope: $ref: '#/components/schemas/ScopeDefinition' @@ -60,15 +60,15 @@ components: collaboratingNDT: description: >- It indicates the related NDT Job contributing as a collaborator to the executed NDT Job. It describes the DN of the collaborated NDT Job - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo' ndtReportRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo' NDTReport-Single: description: >- - This IOC represents the properties of an NDT report corresponding to an NDT job + This IOC represents the properties of an NDT report corresponding to an NDT job allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: nDTJobOutputData: @@ -172,7 +172,7 @@ components: NDTJob-Multiple: type: array items: - $ref: '#/components/schemas/NDTJob-Single' + $ref: '#/components/schemas/NDTJob-Single' NDTReport-Multiple: type: array @@ -188,6 +188,6 @@ components: #----- Definitions in TS 28.561 for TS 28.532 --------------------------# resources-ndtNrm: oneOf: - - $ref: '#/components/schemas/NDTFunction-Single' + - $ref: '#/components/schemas/NDTFunction-Single' - $ref: '#/components/schemas/NDTJob-Single' - - $ref: '#/components/schemas/NDTReport-Single' + - $ref: '#/components/schemas/NDTReport-Single' -- GitLab From 249279fafe89a48ee82d85d0447a5dc097a1b802 Mon Sep 17 00:00:00 2001 From: tianzzhu Date: Fri, 15 Aug 2025 07:35:24 +0000 Subject: [PATCH 7/7] Update file TS28561_NdtNrm.yaml --- OpenAPI/TS28561_NdtNrm.yaml | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/OpenAPI/TS28561_NdtNrm.yaml b/OpenAPI/TS28561_NdtNrm.yaml index 270a819a8..d44c809c0 100644 --- a/OpenAPI/TS28561_NdtNrm.yaml +++ b/OpenAPI/TS28561_NdtNrm.yaml @@ -112,7 +112,9 @@ components: items: $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' networkEventInfo: - type: string + type: array + items: + $ref: '#/components/schemas/NetworkEventInfo' condition: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' NDTOutputDescription: @@ -166,6 +168,23 @@ components: uniqueItems: true items: $ref: '#/components/schemas/NDTOutputDescription' + NetworkEventInfo: + type: object + properties: + eventDescription: + type: string + eventMetrics: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/EventMetric' + EventMetric: + type: object + properties: + performanceData: + type: string + scalingFactor: + type: integer #------Definition of JSON arrays for name-contained IOCs ---------------# -- GitLab