From a71430510927200772d5332161bd076f35746ca8 Mon Sep 17 00:00:00 2001 From: gautamd Date: Fri, 8 Aug 2025 09:45:40 +0000 Subject: [PATCH 1/5] Add new file --- OpenAPI/CCLNrm | 137 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 137 insertions(+) create mode 100644 OpenAPI/CCLNrm diff --git a/OpenAPI/CCLNrm b/OpenAPI/CCLNrm new file mode 100644 index 000000000..2c1d5feda --- /dev/null +++ b/OpenAPI/CCLNrm @@ -0,0 +1,137 @@ +openapi: 3.0.1 +info: + title: CCL NRM + version: 19.3.0 + description: >- + OAS 3.0.1 definition of the CCL NRM + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.567; management aspect of closed control loops + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.567/ +paths: {} +components: + schemas: + + #-------- Definition of types for name-containments ------ + SubNetwork-ncO-CCLNrm: + type: object + properties: + ClosedControlLoop: + $ref: '#/components/schemas/ClosedControlLoop-Multiple' + + #-------Definition of generic IOCs ----------# + + ClosedControlLoop-Single: + description: >- + This IOC represents the properties of an CCL management information between MnS consumer and MnS producer. + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + cCLComponentsInfo: + type: array + items: + $ref: '#/components/schemas/CCLComponentsInfo' + description: >- + It indicates information on the constituent components of a CCL. + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + cCLPriority: + type: integer + minimum: 1 + maximum: 10 + description: This provides the priority of the CCL. This will be the numerical value between 1 to 10, with 1 being the least priority. + cCLComponentList: + type: array + items: + $ref: '#/components/schemas/CCLComponent' + description: >- + It indicates the list of components ating as steps of the CCL. + cCLType: + type: string + enum: + - ENERGYOPTIMIZATION + - SLICEASSURANCE + cCLActionTrigger: + type: array + items: + $ref: '#/components/schemas/CCLTrigger' + description: >- + This defines the criteria/conditions under which the CCL is allowed to take actions.. + desiredBehavior: + type: string + enum: + - DECISION_ACTIVATION + - NOTIFY_RCOMMENDATION + - DO_NOTHING + cCLPurposeRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + CCLScope-Single: + description: It indicates a scope of a CCL. + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + cCLPurposeRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + CCLReport-Single: + description: This class represents the reported outcomes on a CCL instance. + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + scopeType: + type: string + enum: + - CCL_MEASUREMENT_SCOPE + - CCL_TARGET_SCOPE + - CCL_CONTROL_SCOPE + - CCL_IMPACT_SCOPE + ConflictManagementAndCoordinationEntity-Single: + description: This defines the conflict management functionality. + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + coordinationCapability: + type: array + items: + $ref: '#/components/schemas/CoordinationCapability' + description: >- + It indicates a capability of a coordination entity to coordinate CCL conflicts. + coordinatedCCLsScopes + type: string + cCLActionConflictsHandling: + $ref: '#/components/schemas/CCLActionConflictsHandling' + FaultManagement: + description: This IOC represents the Fault Management CCL purpose. + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + FaultManagementAlarmIdList: + type: string + FaultManagementBackUpObjectRequirement + type: boolean + FaultManagementIsolateObjectRequirement + type: boolean + FaultManagementTimeWindow: + $ref: '#/components/schemas/TimeWindow' + clearUserId: + type: string + + #-------Definition of the generic dataType --------------# + + + #-------Definition of the generic dataType --------------# + + #------Definition of JSON arrays for name-contained IOCs ---------------# + + resources-CCLNrm: + oneOf: + - $ref: '#/components/schemas/ClosedControlLoop-Single' + - $ref: '#/components/schemas/CCLScope-Single' + - $ref: '#/components/schemas/CCLReport-Single' \ No newline at end of file -- GitLab From b4c1b4cfee88e67afb6a0a6aa48e4027eb5fc895 Mon Sep 17 00:00:00 2001 From: gautamd Date: Fri, 8 Aug 2025 09:50:13 +0000 Subject: [PATCH 2/5] Edit CCLNrm --- OpenAPI/CCLNrm | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/OpenAPI/CCLNrm b/OpenAPI/CCLNrm index 2c1d5feda..79729b565 100644 --- a/OpenAPI/CCLNrm +++ b/OpenAPI/CCLNrm @@ -52,21 +52,21 @@ components: It indicates the list of components ating as steps of the CCL. cCLType: type: string - enum: - - ENERGYOPTIMIZATION - - SLICEASSURANCE + enum: + - ENERGYOPTIMIZATION + - SLICEASSURANCE cCLActionTrigger: type: array items: $ref: '#/components/schemas/CCLTrigger' description: >- - This defines the criteria/conditions under which the CCL is allowed to take actions.. - desiredBehavior: + This defines the criteria/conditions for CCL + desiredBehavior: type: string - enum: - - DECISION_ACTIVATION - - NOTIFY_RCOMMENDATION - - DO_NOTHING + enum: + - DECISION_ACTIVATION + - NOTIFY_RCOMMENDATION + - DO_NOTHING cCLPurposeRefList: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' CCLScope-Single: @@ -102,11 +102,11 @@ components: $ref: '#/components/schemas/CoordinationCapability' description: >- It indicates a capability of a coordination entity to coordinate CCL conflicts. - coordinatedCCLsScopes + coordinatedCCLsScopes: type: string cCLActionConflictsHandling: $ref: '#/components/schemas/CCLActionConflictsHandling' - FaultManagement: + FaultManagement: description: This IOC represents the Fault Management CCL purpose. allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -114,9 +114,9 @@ components: properties: FaultManagementAlarmIdList: type: string - FaultManagementBackUpObjectRequirement + FaultManagementBackUpObjectRequirement: type: boolean - FaultManagementIsolateObjectRequirement + FaultManagementIsolateObjectRequirement: type: boolean FaultManagementTimeWindow: $ref: '#/components/schemas/TimeWindow' -- GitLab From 78337781cf57470ab7fb61093d609ddb95e7e570 Mon Sep 17 00:00:00 2001 From: gautamd Date: Fri, 8 Aug 2025 10:45:13 +0000 Subject: [PATCH 3/5] Edit CCLNrm --- OpenAPI/CCLNrm | 120 +++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 107 insertions(+), 13 deletions(-) diff --git a/OpenAPI/CCLNrm b/OpenAPI/CCLNrm index 79729b565..5a553205d 100644 --- a/OpenAPI/CCLNrm +++ b/OpenAPI/CCLNrm @@ -56,11 +56,7 @@ components: - ENERGYOPTIMIZATION - SLICEASSURANCE cCLActionTrigger: - type: array - items: - $ref: '#/components/schemas/CCLTrigger' - description: >- - This defines the criteria/conditions for CCL + type: string desiredBehavior: type: string enum: @@ -97,9 +93,7 @@ components: - type: object properties: coordinationCapability: - type: array - items: - $ref: '#/components/schemas/CoordinationCapability' + type: string description: >- It indicates a capability of a coordination entity to coordinate CCL conflicts. coordinatedCCLsScopes: @@ -119,19 +113,119 @@ components: FaultManagementIsolateObjectRequirement: type: boolean FaultManagementTimeWindow: - $ref: '#/components/schemas/TimeWindow' + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/TimeWindow' clearUserId: type: string - #-------Definition of the generic dataType --------------# - +#-------Definition of the generic dataType --------------# + CCLComponentsInfo: + type: object + properties: + cCLComponentId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + cCLSteps: + type: string + enum: + - DATA_COLLECTION + - ANALYSIS + - DECISION + - EXECUTION + CCLComponent: + type: object + properties: + cCLComponentIdentification: + type: string + cCLComponentRole: + type: string + enum: + - MONITOR + - ANALYSIS + - DECISION + - EXECUTION + - OTHER + FaultManagementCCLReport: + type: object + properties: + GeneratedAlarmResultList: + type: array + items: + type: string + FaultManagementCCLReportTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + + GeneratedAlarmResult: + type: object + properties: + alarmId: + type: string + alarmClearedStatus: + type: boolean + identifiedRootCauseInformation: + type: string + enhancedCorrelationInformation: + type: array + items: + type: string + + CCLScopeCoordinationCapability: + type: object + properties: + cCLCoordinationCapabilityID: + type: string + + CCLActionConflictsHandling: + type: object + properties: + conflictInformation: + $ref: '#/components/schemas/ConflictInformation' + conflictResolution: + $ref: '#/components/schemas/ConflictResolution' + targetCCL: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + ConflictInformation: + type: object + properties: + conflictingCCLId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + conflictingActions: + type: string + + ConflictResolution: + type: object + properties: + conflictingCCLId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + cCLGoalBreachPercentage: + type: integer + #-------Definition of the generic dataType --------------# - #-------Definition of the generic dataType --------------# #------Definition of JSON arrays for name-contained IOCs ---------------# + ClosedControlLoop-Multiple: + type: array + items: + $ref: '#/components/schemas/ClosedControlLoop-Single' + + CCLScope-Multiple: + type: array + items: + $ref: '#/components/schemas/CCLScope-Single' + + CCLReport-Multiple: + type: array + items: + $ref: '#/components/schemas/CCLReport-Single' + + ConflictManagementAndCoordinationEntity-Multiple: + type: array + items: + $ref: '#/components/schemas/ConflictManagementAndCoordinationEntity-Single' + resources-CCLNrm: oneOf: - $ref: '#/components/schemas/ClosedControlLoop-Single' - $ref: '#/components/schemas/CCLScope-Single' - - $ref: '#/components/schemas/CCLReport-Single' \ No newline at end of file + - $ref: '#/components/schemas/CCLReport-Single' + - $ref: '#/components/schemas/ConflictManagementAndCoordinationEntity-Single' \ No newline at end of file -- GitLab From d425a1dda111f63cde5604b50a5d6516e09898bd Mon Sep 17 00:00:00 2001 From: ruiyue Date: Thu, 4 Sep 2025 13:29:14 +0000 Subject: [PATCH 4/5] Code Moderator udpate the file format and file name --- OpenAPI/{CCLNrm => TS28567_CclNrm.yaml} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename OpenAPI/{CCLNrm => TS28567_CclNrm.yaml} (95%) diff --git a/OpenAPI/CCLNrm b/OpenAPI/TS28567_CclNrm.yaml similarity index 95% rename from OpenAPI/CCLNrm rename to OpenAPI/TS28567_CclNrm.yaml index 5a553205d..5c995eaf0 100644 --- a/OpenAPI/CCLNrm +++ b/OpenAPI/TS28567_CclNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: CCL NRM - version: 19.3.0 + version: 19.0.0 description: >- OAS 3.0.1 definition of the CCL NRM - © 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. externalDocs: description: 3GPP TS 28.567; management aspect of closed control loops -- GitLab From 7ce64a153fe08a33988da669f223b075ea05fef8 Mon Sep 17 00:00:00 2001 From: ruiyue Date: Thu, 4 Sep 2025 13:33:26 +0000 Subject: [PATCH 5/5] Update file TS28567_CclNrm.yaml --- OpenAPI/TS28567_CclNrm.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/OpenAPI/TS28567_CclNrm.yaml b/OpenAPI/TS28567_CclNrm.yaml index 5c995eaf0..1cd88fcd3 100644 --- a/OpenAPI/TS28567_CclNrm.yaml +++ b/OpenAPI/TS28567_CclNrm.yaml @@ -113,7 +113,7 @@ components: FaultManagementIsolateObjectRequirement: type: boolean FaultManagementTimeWindow: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/TimeWindow' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' clearUserId: type: string -- GitLab