Commit 70d12b41 authored by ruiyue's avatar ruiyue
Browse files

Merge branch... 

Merge branch 'TS38.317_Rel18_pCR_Add_stage3_definition_for_MnS_component_type_B' into 'Integration_Rel18_SA5_152_YAML'

TS28.317_Rel-18_PCRS5-237445_CR0299_Add_stage3_definition_for_MnS_component_type_B

See merge request !839
parents 8e1fbf36 54f81e0b

OpenAPI/README.md

+4 −0
Original line number Diff line number Diff line
@@ -51,6 +51,10 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f 
([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))



* 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)



* Provisioning MnS (TS 28.532)

OpenAPI/TS28317_RanScNrm.yaml

0 → 100644
+176 −0
Original line number Diff line number Diff line 
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: '#/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 ----------#  

    NEType:

      type: integer

      description: It defines 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:

      description: >-

        It defines the NE Type or the NE instance for which this

        ScMgmtProfile instance is valid.

      oneOf:

        - $ref: '#/components/schemas/NEType'

        - $ref: '#/components/schemas/NEIdentification'      

    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-RanScNrm:

      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 --------------------------#

OpenAPI/TS28532_ProvMnS.yaml

+1 −0
Original line number Diff line number Diff line
@@ -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: