From a30717260a50e7f4ff95592db65c41f976b8fe5d Mon Sep 17 00:00:00 2001 From: ruiyue Date: Mon, 30 Oct 2023 12:10:25 +0000 Subject: [PATCH 1/8] Add new file --- OpenAPI/TS28317_RanScNrm.yaml | 160 ++++++++++++++++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 OpenAPI/TS28317_RanScNrm.yaml diff --git a/OpenAPI/TS28317_RanScNrm.yaml b/OpenAPI/TS28317_RanScNrm.yaml new file mode 100644 index 000000000..5592ce6f3 --- /dev/null +++ b/OpenAPI/TS28317_RanScNrm.yaml @@ -0,0 +1,160 @@ +openapi: 3.0.1 +info: + title: RANSC NRM + version: 18.0.0 + description: >- + OAS 3.0.1 definition of the RANSC NRM + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.317; Self-configuration of Radio Access Network Entities (RAN NEs) + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.317/ +paths: {} +components: + schemas: + +#-------Definition of IOCs ----------# + SubNetwork-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ScMgmtProfile: + $ref: '#/components/schemas/ScMgmtProfile-Multiple' + Sc_Process: + $ref: '#/components/schemas/Sc_Process-Multiple' + + ScMgmtProfile-Single: + description: >- + The ScMgmtProfile represents MnS Consumer’s requirements for self-configuration management + for a set of RAN NEs or RAN NE types. + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + nEInformation: + type: array + items: + $ref: '#/components/schemas/NEInfomration' + description: >- + This attribute defines the NE Type(s) or the NE instance(s) for which this + ScMgmtProfile instance is valid. + configDataFileLocation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + + Sc_Process-Single: + description: >- + This IOC represents the self-configuration process for a RAN NE, which allows the MnS + Consumer to be informed about the current situation of the Self Configuration process. + When the automated management process for an RAN NE starts, an instance of the Sc_Process + is created automatically by the MnS Producer and informed to MnS consumer. + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + nEIdentification: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/NEIdentification' + scProcessMonitor: + $ref: '#/components/schemas/ScProcessMonitor' + cancelScProcess: + type: string + enum: + - TRUE + - FALSE + description: >- + Setting this attribute to "TRUE" cancels the self configuration process. + scMgmtProfileRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' +#-------Definition of IOCs ----------# + + +#-------Definition of Data types ----------# + NEInfomration: + type: object + oneOf: + - type: string + - $ref: '#/components/schemas/NEIdentification' + NEIdentification: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/GnbId' + + ScProcessMonitor: + description: >- + This data type is the "ProcessMonitor" data type with specialisations + for usage in the RANSC management for monitoring for the self configuration process. + type: object + properties: + jobId: + type: string + status: + type: string + enum: + - NOT_STARTED + - RUNNING + - FINSHED + - FAILED + - CANCELLING + - CANCELLED + progressPercentage: + type: integer + minimum: 0 + maximum: 100 + progressStateInfo: + type: string + enum: + - NE_HEALTH_CHECK + - SW_DOWNLOAD + - SW_INSTALLATION + - SW_ACTIVATION + - PREPARE_BASIC_CONFIGURATION_AND_OAMLINK + - RETRIEVE_CONFIGURATION_DATA + - SETUP_PRECONFIGURED_SIGNALLING_LINKS + - TSET_FINAL_STATE_OF_NE + resultStateInfo: + oneOf: + - type: string + enum: + - UNKNOWN + - INCORRECT_CONFIGURATION + - NE_HARDWARE_ERROR_DELECTED + - DISCONNECTION_BETWEEN_NE_AND_OAM + - OTHER + - type: string + startTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + +#-------Definition of Data types ----------# + +#------Definition of JSON arrays for name-contained IOCs ---------------# + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + ScMgmtProfile-Multiple: + type: array + items: + $ref: '#/components/schemas/ScMgmtProfile-Single' + Sc_Process-Multiple: + type: array + items: + $ref: '#/components/schemas/Sc_Process-Single' +#------Definition of JSON arrays for name-contained IOCs ---------------# + + +#----- Definitions in TS 28.317 for TS 28.532 --------------------------# + resources-intentNrm: + oneOf: + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ScMgmtProfile-Single' + - $ref: '#/components/schemas/Sc_Process-Single' + +#----- Definitions in TS 28.317 for TS 28.532 --------------------------# + -- GitLab From e0d9d6e7df5798565b475eda0628d6feadfa1efb Mon Sep 17 00:00:00 2001 From: ruiyue Date: Mon, 30 Oct 2023 12:14:05 +0000 Subject: [PATCH 2/8] Update file TS28317_RanScNrm.yaml --- OpenAPI/TS28317_RanScNrm.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/OpenAPI/TS28317_RanScNrm.yaml b/OpenAPI/TS28317_RanScNrm.yaml index 5592ce6f3..9b74fe522 100644 --- a/OpenAPI/TS28317_RanScNrm.yaml +++ b/OpenAPI/TS28317_RanScNrm.yaml @@ -60,7 +60,7 @@ components: - type: object properties: nEIdentification: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/NEIdentification' + $ref: '#/components/schemas/NEIdentification' scProcessMonitor: $ref: '#/components/schemas/ScProcessMonitor' cancelScProcess: -- GitLab From 6e0756800ad3bd793a22c9dac332b2c601bfe59f Mon Sep 17 00:00:00 2001 From: ruiyue Date: Mon, 30 Oct 2023 12:17:05 +0000 Subject: [PATCH 3/8] Update file TS28317_RanScNrm.yaml --- OpenAPI/TS28317_RanScNrm.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/OpenAPI/TS28317_RanScNrm.yaml b/OpenAPI/TS28317_RanScNrm.yaml index 9b74fe522..d9700d1e9 100644 --- a/OpenAPI/TS28317_RanScNrm.yaml +++ b/OpenAPI/TS28317_RanScNrm.yaml @@ -150,7 +150,7 @@ components: #----- Definitions in TS 28.317 for TS 28.532 --------------------------# - resources-intentNrm: + resources-RanScNrm: oneOf: - $ref: '#/components/schemas/SubNetwork-Single' - $ref: '#/components/schemas/ScMgmtProfile-Single' -- GitLab From 3f378b6d0fe07d5b5eee92957c99864d6168aeab Mon Sep 17 00:00:00 2001 From: ruiyue Date: Mon, 30 Oct 2023 12:21:25 +0000 Subject: [PATCH 4/8] Update file TS28532_ProvMnS.yaml --- OpenAPI/TS28532_ProvMnS.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/OpenAPI/TS28532_ProvMnS.yaml b/OpenAPI/TS28532_ProvMnS.yaml index 7b734bc79..306f6f0bf 100755 --- a/OpenAPI/TS28532_ProvMnS.yaml +++ b/OpenAPI/TS28532_ProvMnS.yaml @@ -397,6 +397,7 @@ components: - $ref: 'TS28104_MdaNrm.yaml#/components/schemas/resources-mdaNrm' - $ref: 'TS28105_AiMlNrm.yaml#/components/schemas/resources-AiMlNrm' - $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/resources-edgeNrm' + - $ref: 'TS28317_RanScNrm.yaml#/components/schemas/resources-RanScNRM' Scope: type: object properties: -- GitLab From 728f9d6cd020a32f57476ff58c98b2d8e4c8263b Mon Sep 17 00:00:00 2001 From: ruiyue Date: Mon, 30 Oct 2023 12:24:22 +0000 Subject: [PATCH 5/8] Update 2 files - /OpenAPI/README.md - /OpenAPI/TS28532_ProvMnS.yaml --- OpenAPI/README.md | 6 +++++- OpenAPI/TS28532_ProvMnS.yaml | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/OpenAPI/README.md b/OpenAPI/README.md index 5a86008c5..e94fc4dcc 100644 --- a/OpenAPI/README.md +++ b/OpenAPI/README.md @@ -49,7 +49,11 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f * AI/ML NRM (TS 28.105) ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28105_AiMlNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28105_AiMlNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28105_AiMlNrm.yaml))4 + +* RANSC NRM (TS 28.105) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28317_RanScNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28317_RanScNrm.yaml)) ## Management Services (MnS) diff --git a/OpenAPI/TS28532_ProvMnS.yaml b/OpenAPI/TS28532_ProvMnS.yaml index 306f6f0bf..d0eac63c2 100755 --- a/OpenAPI/TS28532_ProvMnS.yaml +++ b/OpenAPI/TS28532_ProvMnS.yaml @@ -397,7 +397,7 @@ components: - $ref: 'TS28104_MdaNrm.yaml#/components/schemas/resources-mdaNrm' - $ref: 'TS28105_AiMlNrm.yaml#/components/schemas/resources-AiMlNrm' - $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/resources-edgeNrm' - - $ref: 'TS28317_RanScNrm.yaml#/components/schemas/resources-RanScNRM' + - $ref: 'TS28317_RanScNrm.yaml#/components/schemas/resources-RanScNrm' Scope: type: object properties: -- GitLab From 804c743f7152cdac873eaa7ab8399176ce220ae9 Mon Sep 17 00:00:00 2001 From: ruiyue Date: Mon, 30 Oct 2023 12:29:05 +0000 Subject: [PATCH 6/8] Update file README.md --- OpenAPI/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/OpenAPI/README.md b/OpenAPI/README.md index e94fc4dcc..f33f1c3c7 100644 --- a/OpenAPI/README.md +++ b/OpenAPI/README.md @@ -49,7 +49,7 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f * AI/ML NRM (TS 28.105) ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28105_AiMlNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28105_AiMlNrm.yaml))4 +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28105_AiMlNrm.yaml)) * RANSC NRM (TS 28.105) ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28317_RanScNrm.yaml)) -- GitLab From 4cd47d45403c2d2539dd7ede98d7007efbd8099c Mon Sep 17 00:00:00 2001 From: ruiyue Date: Tue, 31 Oct 2023 01:33:04 +0000 Subject: [PATCH 7/8] Update file TS28317_RanScNrm.yaml --- OpenAPI/TS28317_RanScNrm.yaml | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/OpenAPI/TS28317_RanScNrm.yaml b/OpenAPI/TS28317_RanScNrm.yaml index d9700d1e9..0b6ebff71 100644 --- a/OpenAPI/TS28317_RanScNrm.yaml +++ b/OpenAPI/TS28317_RanScNrm.yaml @@ -76,14 +76,30 @@ components: #-------Definition of Data types ----------# + NEType: + type: integer + description: It defines the the type of RAN NE + GnbId: + type: integer + minimum: 0 + maximum: 4294967295 + description: It is the identity of gNB + EnbId: + type: string + minimum: 0 + maximum: 268435455 + description: It is the identity of ng-eNB + NEIdentification: + oneOf: + - $ref: '#/components/schemas/EnbId' + - $ref: '#/components/schemas/GnbId' NEInfomration: - type: object + description: >- + It defines the NE Type or the NE instance for which this + ScMgmtProfile instance is valid. oneOf: - - type: string + - $ref: '#/components/schemas/NEType' - $ref: '#/components/schemas/NEIdentification' - NEIdentification: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/GnbId' - ScProcessMonitor: description: >- This data type is the "ProcessMonitor" data type with specialisations -- GitLab From 54f81e0bb2e712f9a8b3b4b53089592a240ce9cf Mon Sep 17 00:00:00 2001 From: ruiyue Date: Wed, 1 Nov 2023 00:38:29 +0000 Subject: [PATCH 8/8] Update file TS28317_RanScNrm.yaml --- OpenAPI/TS28317_RanScNrm.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/OpenAPI/TS28317_RanScNrm.yaml b/OpenAPI/TS28317_RanScNrm.yaml index 0b6ebff71..ed6566f23 100644 --- a/OpenAPI/TS28317_RanScNrm.yaml +++ b/OpenAPI/TS28317_RanScNrm.yaml @@ -33,7 +33,7 @@ components: ScMgmtProfile-Single: description: >- - The ScMgmtProfile represents MnS Consumer’s requirements for self-configuration management + The ScMgmtProfile represents MnS Consumer's requirements for self-configuration management for a set of RAN NEs or RAN NE types. allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -78,7 +78,7 @@ components: #-------Definition of Data types ----------# NEType: type: integer - description: It defines the the type of RAN NE + description: It defines the type of RAN NE GnbId: type: integer minimum: 0 -- GitLab