From 9fd1c942ab7b6433037b3429cbfd447b666c6540 Mon Sep 17 00:00:00 2001 From: lengyelb Date: Sun, 2 Jan 2022 09:38:46 +0000 Subject: [PATCH 01/21] Update README.md Added 1 space to test pipeline --- yang-models/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yang-models/README.md b/yang-models/README.md index 4959d98c5..bcd5ec655 100755 --- a/yang-models/README.md +++ b/yang-models/README.md @@ -5,4 +5,4 @@ All commited YANG modules MUST pass the "pyang --strict -p external-yams _3gpp-*.yang" validation command without errors. - \ No newline at end of file + -- GitLab From 10200757060e8ea2d1a88b13f9b06d0e356f7be4 Mon Sep 17 00:00:00 2001 From: "U-ERICSSON\\ETHBLL" Date: Sun, 2 Jan 2022 11:01:29 +0100 Subject: [PATCH 02/21] CR-0138 S5-215572 --- yang-models/_3gpp-common-yang-types.yang | 37 ++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/yang-models/_3gpp-common-yang-types.yang b/yang-models/_3gpp-common-yang-types.yang index f71e5420b..d5371e347 100755 --- a/yang-models/_3gpp-common-yang-types.yang +++ b/yang-models/_3gpp-common-yang-types.yang @@ -13,6 +13,11 @@ module _3gpp-common-yang-types { network slicing."; reference "3GPP TS 28.541"; + revision 2021-09-30 { + description "Added Longitude, Latitude, TenthOfDegrees, OnOff."; + reference "CR-0138"; + } + revision 2020-11-06 { description "Removed incorrect S-NSSAI definitions."; reference "CR-0118"; @@ -37,6 +42,38 @@ module _3gpp-common-yang-types { reference "Initial version."; } + typedef TenthOfDegrees { + type uint16 { + range 0..3600; + } + units "0.1 degrees"; + description "A single integral value corresponding to an angle in degrees + between 0 and 360 with a resolution of 0.1 degrees."; + } + + typedef Latitude { + type decimal64 { + fraction-digits 4; + range "-90.0000..+90.0000"; + } + description "Latitude values"; + } + + typedef Longitude { + type decimal64 { + fraction-digits 4; + range "-180.0000..+180.0000"; + } + description "Longitude values"; + } + + typedef OnOff { + type enumeration { + enum ON; + enum OFF; + } + } + grouping ManagedNFProfile { description "Defines profile for managed NF"; reference "3GPP TS 23.501"; -- GitLab From 72689f2e863141a9919709edf509e758c7eb9d7e Mon Sep 17 00:00:00 2001 From: "U-ERICSSON\\ETHBLL" Date: Sun, 2 Jan 2022 11:05:25 +0100 Subject: [PATCH 03/21] S5-215533 CR-0140 --- yang-models/_3gpp-common-mnsregistry.yang | 59 +++++++++++++++-------- 1 file changed, 40 insertions(+), 19 deletions(-) mode change 100644 => 100755 yang-models/_3gpp-common-mnsregistry.yang diff --git a/yang-models/_3gpp-common-mnsregistry.yang b/yang-models/_3gpp-common-mnsregistry.yang old mode 100644 new mode 100755 index 2783fd385..52163902b --- a/yang-models/_3gpp-common-mnsregistry.yang +++ b/yang-models/_3gpp-common-mnsregistry.yang @@ -12,13 +12,12 @@ module _3gpp-common-mnsregistry { Class (IOC) that is part of the Generic Network Resource Model (NRM)."; reference "3GPP TS 28.623 Generic Network Resource Model (NRM)"; + revision 2021-10-18 { reference "S5-215263"; } revision 2021-08-29 { reference "Initial revision, S5-214388"; } - - grouping MNSRegistryGrp { - description "Represents the MNSRegistry IOC."; - reference "3GPP TS 28.541"; - uses top3gpp:Top_Grp; - + + grouping MNSInfoGrp { + description "Represents the MNSInfo IOC."; + reference "3GPP TS 28.622"; leaf mnsLabel { description "Human-readable name of management service."; mandatory true; @@ -28,9 +27,10 @@ module _3gpp-common-mnsregistry { leaf mnsType { description "Type of management service."; type enumeration { - enum PROVISIONING; - enum FAULT_SUPERVISION; - enum PERFORMANCE_ASSURANCE; + enum ProvMnS; + enum FaultSupervisionMnS; + enum StreamingDataReportingMnS; + enum FileDataReportingMnS; } } @@ -44,16 +44,37 @@ module _3gpp-common-mnsregistry { mandatory true; type string; } + } + + grouping MNSInfo { + description "Represents the MNSInfo IOC."; + reference "3GPP TS 28.622"; + uses top3gpp:Top_Grp; + container attributes { + uses MNSInfoGrp; } - - augment "/subnet3gpp:SubNetwork" { - list MNSRegistry { - description "Represents the MNSRegistry IOC."; - key id; - uses top3gpp:Top_Grp; - container attributes { - uses MNSRegistryGrp; - } + } + + grouping MNSRegistryGrp { + description "Represents the MNSRegistry IOC."; + reference "3GPP TS 28.622"; + uses top3gpp:Top_Grp; + } + + grouping MNSRegistry { + list mnsRegistry { + description "Represents the MNSRegistry IOC."; + reference "3GPP TS 28.622"; + uses top3gpp:Top_Grp; + key "mnsType mnsVersion mnsAddress"; + container attributes { + uses MNSInfoGrp; } - } + } + } + + augment "/subnet3gpp:SubNetwork" { + uses MNSRegistryGrp; + } + } \ No newline at end of file -- GitLab From 664adf684dd92d3a9a6f9cef9ad755ad529a556c Mon Sep 17 00:00:00 2001 From: "U-ERICSSON\\ETHBLL" Date: Sun, 2 Jan 2022 11:09:01 +0100 Subject: [PATCH 04/21] S5-215534 CR-0468 _3gpp-nr-nrm-operatordu.yang _3gpp-nr-nrm-nroperatorcelldu.yang --- .../_3gpp-nr-nrm-nroperatorcelldu.yang | 73 +++++++++++++++++++ yang-models/_3gpp-nr-nrm-operatordu.yang | 44 +++++++++++ 2 files changed, 117 insertions(+) create mode 100755 yang-models/_3gpp-nr-nrm-nroperatorcelldu.yang create mode 100755 yang-models/_3gpp-nr-nrm-operatordu.yang diff --git a/yang-models/_3gpp-nr-nrm-nroperatorcelldu.yang b/yang-models/_3gpp-nr-nrm-nroperatorcelldu.yang new file mode 100755 index 000000000..6f8ac2d06 --- /dev/null +++ b/yang-models/_3gpp-nr-nrm-nroperatorcelldu.yang @@ -0,0 +1,73 @@ +module _3gpp-nr-nrm-nroperatorcelldu { + yang-version 1.1; + namespace "urn:3gpp:sa5:_3gpp-nr-nrm-nroperatorcelldu"; + prefix "nropcelld3gpp"; + + import _3gpp-common-top { prefix top3gpp; } + import _3gpp-common-managed-element { prefix me3gpp; } + import _3gpp-nr-nrm-operatordu { prefix operdu3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } + import _3gpp-common-yang-types { prefix types3gpp; } + import _3gpp-nr-nrm-gnbdufunction { prefix gnbdu3gpp; } + + organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines the YANG mapping of the OperatorDU Information Object + Class (IOC) that is part of the NR Network Resource Model (NRM)."; + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + + revision 2021-10-01 { reference "Initial revision"; } + + grouping NROperatorCellDUGrp { + description "Represents the NROperatorCellDU IOC."; + reference "3GPP TS 28.541"; + uses operdu3gpp:OperatorDUGrp; + + leaf cellLocalId { + description "Identifies an NR cell of a gNB. Together with the + corresponding gNB identifier in forms the NR Cell Identity (NCI)."; + reference "NCI in 3GPP TS 38.300"; + type int32 { range "0..16383"; } + } + + list pLMNInfoList { + description "The PLMNInfoList is a list of PLMNInfo data type. It + defines which PLMNs that can be served by the NR cell, and which + S-NSSAIs that can be supported by the NR cell for corresponding PLMN + in case of network slicing feature is supported. The plMNId of the + first entry of the list is the PLMNId used to construct the nCGI for + the NR cell."; + key "mcc mnc sd sst"; + min-elements 1; + ordered-by user; + uses types5g3gpp:PLMNInfo; + } + + leaf nRTAC { + description "The common 5GS Tracking Area Code for the PLMNs."; + reference "3GPP TS 23.003, 3GPP TS 38.473"; + type types3gpp:Tac; + } + + leaf-list nRCellDURef { + description "Reference to corresponding NRCellDU instance."; + type types3gpp:DistinguishedName; + } + + } + + augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction/operdu3gpp:OperatorDU" + { + + list NROperatorCellDU { + description "Contains attributes to support 5G MOCN network sharing."; + reference "3GPP TS 28.541"; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses NROperatorCellDUGrp; + } + uses gnbdu3gpp:GNBDUFunctionGrp; + } + } +} diff --git a/yang-models/_3gpp-nr-nrm-operatordu.yang b/yang-models/_3gpp-nr-nrm-operatordu.yang new file mode 100755 index 000000000..f0536c43b --- /dev/null +++ b/yang-models/_3gpp-nr-nrm-operatordu.yang @@ -0,0 +1,44 @@ +module _3gpp-nr-nrm-operatordu { + yang-version 1.1; + namespace "urn:3gpp:sa5:_3gpp-nr-nrm-operatordu"; + prefix "operdu3gpp"; + + import _3gpp-common-top { prefix top3gpp; } + import _3gpp-common-managed-element { prefix me3gpp; } + import _3gpp-nr-nrm-gnbdufunction {prefix gnbdu3gpp; } + + organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines the YANG mapping of the OperatorDU Information Object + Class (IOC) that is part of the NR Network Resource Model (NRM)."; + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + + revision 2021-10-01 { reference "Initial revision"; } + + grouping OperatorDUGrp { + description "Represents the OperatorDU IOC."; + reference "3GPP TS 28.541"; + uses gnbdu3gpp:GNBDUFunctionGrp { + refine gNBId { + mandatory true; + } + refine gNBIdLength { + mandatory true; + } + } + } + + augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction" { + + list OperatorDU { + description "Contains attributes to support the 5G MOCN network sharing."; + reference "3GPP TS 28.541"; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses OperatorDUGrp; + } + uses gnbdu3gpp:GNBDUFunctionGrp; + } + } +} -- GitLab From 73e27070fdbaa572842cb2bac063cccad577f999 Mon Sep 17 00:00:00 2001 From: Joey Chou Date: Thu, 21 Oct 2021 21:31:37 +0200 Subject: [PATCH 05/21] Add new file --- yang-models/3gpp-nr-nrm-dlbofunction.yang | 77 +++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 yang-models/3gpp-nr-nrm-dlbofunction.yang diff --git a/yang-models/3gpp-nr-nrm-dlbofunction.yang b/yang-models/3gpp-nr-nrm-dlbofunction.yang new file mode 100644 index 000000000..4f3a94468 --- /dev/null +++ b/yang-models/3gpp-nr-nrm-dlbofunction.yang @@ -0,0 +1,77 @@ + +module _3gpp-nr-nrm-dlbofunction { + yang-version 1.1; + namespace "urn:3gpp:sa5:_3gpp-nr-nrm-dlbofunction"; + prefix "dlbof3gpp"; + + import _3gpp-common-subnetwork { prefix subnet3gpp; } + import _3gpp-common-top { prefix top3gpp; } + import _3gpp-nr-nrm-gnbcucpfunction { prefix gnbcucp3gpp; } + import _3gpp-common-managed-element { prefix me3gpp; } + import _3gpp-nr-nrm-nrcellcu { prefix nrcellcu3gpp; } + + organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines the YANG mapping of the DLBOFunction + Information Object Class (IOC) that is part of the NR Network Resource + Model (NRM)."; + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + + grouping DLBOFunctionGrp { + description "Represents the DLBOFunction IOC."; + + leaf dlboControl { + description "This attribute determines whether the LBO function is + enabled or disabled."; + type boolean; + } + + leaf maximumDeviationHoTrigger { + description "This parameter defines the maximum allowed absolute deviation of the Handover Trigger, from the default point of operation."; + type int32 { range "-20..20"; } + units "0.5"; + } + + leaf minimumTimeBetweenHoTriggerChange { + description "This parameter defines the minimum allowed time interval between two Handover Trigger change performed by MRO. This is used to control the stability and convergence of the algorithm."; + type int32 { range "0..604800"; } + units "1"; + } + + } + + grouping DLBOFunctionSubtree { + list DLBOFunction { + description "This IOC contains attributes to support the D-SON function + of LBO. + + In the case where multiple DLBO MOIs exist at different levels of the + containment tree, the DLBO MOI at the lower level overrides the DLBO + MOIs at higher level(s) of the same containment tree."; + reference "clause 7.1.2 in TS 28.313"; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses DLBOFunctionGrp; + } + } + } + + augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/"+ + "nrcellcu3gpp:NRCellCU" { + if-feature nrcellcu3gpp:DLBOFunction; + uses DLBOFunctionSubtree; + } + augment /me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction { + if-feature gnbcucp3gpp:DLBOFunction; + uses DLBOFunctionSubtree; + } + augment /me3gpp:ManagedElement { + if-feature me3gpp:DLBOFunction; + uses DLBOFunctionSubtree; + } + augment /subnet3gpp:SubNetwork { + if-feature subnet3gpp:DLBOFunction; + uses DLBOFunctionSubtree; + } +} -- GitLab From b5c1d7d497c1a2a2ebec1e17a3cabd44adbd42c3 Mon Sep 17 00:00:00 2001 From: "U-ERICSSON\\ETHBLL" Date: Fri, 22 Oct 2021 14:03:55 +0200 Subject: [PATCH 06/21] Renamed file dlbofunc adding the lead underscore and corrected features for containment. --- ...on.yang => _3gpp-nr-nrm-dlbofunction.yang} | 37 +++++++++++++------ 1 file changed, 26 insertions(+), 11 deletions(-) rename yang-models/{3gpp-nr-nrm-dlbofunction.yang => _3gpp-nr-nrm-dlbofunction.yang} (68%) diff --git a/yang-models/3gpp-nr-nrm-dlbofunction.yang b/yang-models/_3gpp-nr-nrm-dlbofunction.yang similarity index 68% rename from yang-models/3gpp-nr-nrm-dlbofunction.yang rename to yang-models/_3gpp-nr-nrm-dlbofunction.yang index 4f3a94468..e3146a24b 100644 --- a/yang-models/3gpp-nr-nrm-dlbofunction.yang +++ b/yang-models/_3gpp-nr-nrm-dlbofunction.yang @@ -1,4 +1,3 @@ - module _3gpp-nr-nrm-dlbofunction { yang-version 1.1; namespace "urn:3gpp:sa5:_3gpp-nr-nrm-dlbofunction"; @@ -17,6 +16,22 @@ module _3gpp-nr-nrm-dlbofunction { Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-10-22 { reference "CR-0577"; } + + feature DLBOUnderGNBCUCPFunction { + description "The DLBOFunction shall be available under + GNBCUCPFunction"; + } + + feature DLBOUnderManagedElement { + description "The DLBOFunction shall be available under + ManagedElement"; + } + + feature DLBOUnderSubNetwork { + description "The DLBOFunction shall be available under + SubNetwork"; + } grouping DLBOFunctionGrp { description "Represents the DLBOFunction IOC."; @@ -27,13 +42,17 @@ module _3gpp-nr-nrm-dlbofunction { } leaf maximumDeviationHoTrigger { - description "This parameter defines the maximum allowed absolute deviation of the Handover Trigger, from the default point of operation."; + description "This parameter defines the maximum allowed absolute + deviation of the Handover Trigger, from the default point of + operation."; type int32 { range "-20..20"; } units "0.5"; } leaf minimumTimeBetweenHoTriggerChange { - description "This parameter defines the minimum allowed time interval between two Handover Trigger change performed by MRO. This is used to control the stability and convergence of the algorithm."; + description "This parameter defines the minimum allowed time interval + between two Handover Trigger change performed by MRO. This is used + to control the stability and convergence of the algorithm."; type int32 { range "0..604800"; } units "1"; } @@ -59,19 +78,15 @@ module _3gpp-nr-nrm-dlbofunction { augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/"+ "nrcellcu3gpp:NRCellCU" { - if-feature nrcellcu3gpp:DLBOFunction; - uses DLBOFunctionSubtree; - } - augment /me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction { - if-feature gnbcucp3gpp:DLBOFunction; + if-feature DLBOUnderGNBCUCPFunction; uses DLBOFunctionSubtree; } augment /me3gpp:ManagedElement { - if-feature me3gpp:DLBOFunction; + if-feature DLBOUnderManagedElement; uses DLBOFunctionSubtree; } augment /subnet3gpp:SubNetwork { - if-feature subnet3gpp:DLBOFunction; + if-feature DLBOUnderSubNetwork; uses DLBOFunctionSubtree; } -} +} \ No newline at end of file -- GitLab From defc7c0f3d4cd6ef28dba4d928800f3e3ae11be3 Mon Sep 17 00:00:00 2001 From: "U-ERICSSON\\ETHBLL" Date: Sun, 2 Jan 2022 18:49:20 +0100 Subject: [PATCH 07/21] delete all yaml --- OpenAPI/5gcNrm.yaml | 2185 ----------------------------- OpenAPI/PerDataFileReportMnS.yaml | 13 - OpenAPI/PerMeasJobCtlMnS.yaml | 280 ---- OpenAPI/PerThresMonMnS.yaml | 102 -- OpenAPI/PerfDataStreamingMnS.yaml | 363 ----- OpenAPI/comDefs.yaml | 84 -- OpenAPI/coslaNrm.yaml | 168 --- OpenAPI/faultMnS.yaml | 1144 --------------- OpenAPI/genericNrm.yaml | 1606 --------------------- OpenAPI/heartbeatNtf.yaml | 23 - OpenAPI/nrNrm.yaml | 1905 ------------------------- OpenAPI/provMnS.yaml | 579 -------- OpenAPI/sliceNrm.yaml | 632 --------- OpenAPI/streamingDataMnS.yaml | 453 ------ 14 files changed, 9537 deletions(-) delete mode 100644 OpenAPI/5gcNrm.yaml delete mode 100644 OpenAPI/PerDataFileReportMnS.yaml delete mode 100644 OpenAPI/PerMeasJobCtlMnS.yaml delete mode 100644 OpenAPI/PerThresMonMnS.yaml delete mode 100644 OpenAPI/PerfDataStreamingMnS.yaml delete mode 100644 OpenAPI/comDefs.yaml delete mode 100644 OpenAPI/coslaNrm.yaml delete mode 100644 OpenAPI/faultMnS.yaml delete mode 100644 OpenAPI/genericNrm.yaml delete mode 100644 OpenAPI/heartbeatNtf.yaml delete mode 100644 OpenAPI/nrNrm.yaml delete mode 100644 OpenAPI/provMnS.yaml delete mode 100644 OpenAPI/sliceNrm.yaml delete mode 100644 OpenAPI/streamingDataMnS.yaml diff --git a/OpenAPI/5gcNrm.yaml b/OpenAPI/5gcNrm.yaml deleted file mode 100644 index e4c4b2619..000000000 --- a/OpenAPI/5gcNrm.yaml +++ /dev/null @@ -1,2185 +0,0 @@ -openapi: 3.0.1 -info: - title: 3GPP 5GC NRM - version: 17.4.0 - description: >- - OAS 3.0.1 specification of the 5GC NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.541; 5G NRM, 5GC NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ -paths: {} -components: - schemas: - -#-------- Definition of types----------------------------------------------------- - - AmfIdentifier: - type: object - description: 'AmfIdentifier comprise of amfRegionId, amfSetId and amfPointer' - properties: - amfRegionId: - $ref: '#/components/schemas/AmfRegionId' - amfSetId: - $ref: '#/components/schemas/AmfSetId' - amfPointer: - $ref: '#/components/schemas/AmfPointer' - AmfRegionId: - type: integer - description: AmfRegionId is defined in TS 23.003 - maximum: 255 - AmfSetId: - type: string - description: AmfSetId is defined in TS 23.003 - maximum: 1023 - AmfPointer: - type: integer - description: AmfPointer is defined in TS 23.003 - maximum: 63 - IpEndPoint: - type: object - properties: - ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' - ipv6Prefix: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Prefix' - transport: - $ref: 'genericNrm.yaml#/components/schemas/TransportProtocol' - port: - type: integer - NFProfileList: - type: array - description: List of NF profile - items: - $ref: '#/components/schemas/NFProfile' - NFProfile: - type: object - description: 'NF profile stored in NRF, defined in TS 29.510' - properties: - nFInstanceId: - type: string - description: uuid of NF instance - nFType: - $ref: 'genericNrm.yaml#/components/schemas/NFType' - nFStatus: - $ref: '#/components/schemas/NFStatus' - plmn: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - sNssais: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - interPlmnFqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - nfServices: - type: array - items: - $ref: '#/components/schemas/NFService' - NFService: - type: object - description: NF Service is defined in TS 29.510 - properties: - serviceInstanceId: - type: string - serviceName: - type: string - version: - type: string - schema: - type: string - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - interPlmnFqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - ipEndPoints: - type: array - items: - $ref: '#/components/schemas/IpEndPoint' - apiPrfix: - type: string - allowedPlmns: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - allowedNfTypes: - type: array - items: - $ref: 'genericNrm.yaml#/components/schemas/NFType' - allowedNssais: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - NFStatus: - type: string - description: any of enumrated value - enum: - - REGISTERED - - SUSPENDED - CNSIIdList: - type: array - items: - $ref: '#/components/schemas/CNSIId' - CNSIId: - type: string - description: CNSI Id is defined in TS 29.531, only for Core Network - TACList: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/NrTac' - WeightFactor: - type: integer - UdmInfo: - type: object - properties: - nFSrvGroupId: - type: string - AusfInfo: - type: object - properties: - nFSrvGroupId: - type: string - UpfInfo: - type: object - properties: - smfServingAreas: - type: string - AmfInfo: - type: object - properties: - priority: - type: integer - SupportedDataSetId: - type: string - description: any of enumrated value - enum: - - SUBSCRIPTION - - POLICY - - EXPOSURE - - APPLICATION - Udrinfo: - type: object - properties: - supportedDataSetIds: - type: array - items: - $ref: '#/components/schemas/SupportedDataSetId' - nFSrvGroupId: - type: string - NFInfo: - oneOf: - - $ref: '#/components/schemas/UdmInfo' - - $ref: '#/components/schemas/AusfInfo' - - $ref: '#/components/schemas/UpfInfo' - - $ref: '#/components/schemas/AmfInfo' - - $ref: '#/components/schemas/Udrinfo' - ManagedNFProfile: - type: object - properties: - nfInstanceID: - type: string - nfType: - $ref: 'genericNrm.yaml#/components/schemas/NFType' - authzInfo: - type: string - hostAddr: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' - locality: - type: string - nFInfo: - $ref: '#/components/schemas/NFInfo' - capacity: - type: integer - SEPPType: - type: string - description: any of enumrated value - enum: - - CSEPP - - PSEPP - SupportedFunc: - type: object - properties: - function: - type: string - policy: - type: string - SupportedFuncList: - type: array - items: - $ref: '#/components/schemas/SupportedFunc' - CommModelType: - type: string - description: any of enumrated value - enum: - - DIRECT_COMMUNICATION_WO_NRF - - DIRECT_COMMUNICATION_WITH_NRF - - INDIRECT_COMMUNICATION_WO_DEDICATED_DISCOVERY - - INDIRECT_COMMUNICATION_WITH_DEDICATED_DISCOVERY - CommModel: - type: object - properties: - groupId: - type: integer - commModelType: - $ref: '#/components/schemas/CommModelType' - targetNFServiceList: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - commModelConfiguration: - type: string - CommModelList: - type: array - items: - $ref: '#/components/schemas/CommModel' - CapabilityList: - type: array - items: - type: string - FiveQiDscpMapping: - type: object - properties: - fiveQIValues: - type: array - items: - type: integer - dscp: - type: integer - NetworkSliceInfo: - type: object - properties: - sNSSAI: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - cNSIId: - $ref: '#/components/schemas/CNSIId' - networkSliceRef: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - NetworkSliceInfoList: - type: array - items: - $ref: '#/components/schemas/NetworkSliceInfo' - - - PacketErrorRate: - type: object - properties: - scalar: - type: integer - exponent: - type: integer - - - - GtpUPathDelayThresholdsType: - type: object - properties: - n3AveragePacketDelayThreshold: - type: integer - n3MinPacketDelayThreshold: - type: integer - n3MaxPacketDelayThreshold: - type: integer - n9AveragePacketDelayThreshold: - type: integer - n9MinPacketDelayThreshold: - type: integer - n9MaxPacketDelayThreshold: - type: integer - QFPacketDelayThresholdsType: - type: object - properties: - thresholdDl: - type: integer - thresholdUl: - type: integer - thresholdRtt: - type: integer - - QosData: - type: object - properties: - qosId: - type: string - fiveQIValue: - type: integer - maxbrUl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' - maxbrDl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' - gbrUl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' - gbrDl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' - arp: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Arp' - qosNotificationControl: - type: boolean - reflectiveQos: - type: boolean - sharingKeyDl: - type: string - sharingKeyUl: - type: string - maxPacketLossRateDl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' - maxPacketLossRateUl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' - extMaxDataBurstVol: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' - - QosDataList: - type: array - items: - $ref: '#/components/schemas/QosData' - - SteeringMode: - type: object - properties: - steerModeValue: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteerModeValue' - active: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessType' - standby: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessTypeRm' - threeGLoad: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Uinteger' - prioAcc: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessType' - - TrafficControlData: - type: object - properties: - tcId: - type: string - flowStatus: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus' - redirectInfo: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' - addRedirectInfo: - type: array - items: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' - minItems: 1 - muteNotif: - type: boolean - trafficSteeringPolIdDl: - type: string - nullable: true - trafficSteeringPolIdUl: - type: string - nullable: true - routeToLocs: - type: array - items: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/RouteToLocation' - traffCorreInd: - type: boolean - upPathChgEvent: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' - steerFun: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringFunctionality' - steerModeDl: - $ref: '#/components/schemas/SteeringMode' - steerModeUl: - $ref: '#/components/schemas/SteeringMode' - mulAccCtrl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/MulticastAccessControl' - - TrafficControlDataList: - type: array - items: - $ref: '#/components/schemas/TrafficControlData' - - PccRule: - type: object - properties: - pccRuleId: - type: string - description: Univocally identifies the PCC rule within a PDU session. - flowInfoList: - type: array - items: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' - applicationId: - type: string - appDescriptor: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ApplicationDescriptor' - contentVersion: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' - precedence: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Uinteger' - afSigProtocol: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' - isAppRelocatable: - type: boolean - isUeAddrPreserved: - type: boolean - qosData: - type: array - items: - $ref: '#/components/schemas/QosDataList' - altQosParams: - type: array - items: - $ref: '#/components/schemas/QosDataList' - trafficControlData: - type: array - items: - $ref: '#/components/schemas/TrafficControlDataList' - conditionData: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ConditionData' - tscaiInputDl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' - tscaiInputUl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' - - SnssaiInfo: - type: object - properties: - plmnInfo: - $ref: 'nrNrm.yaml#/components/schemas/PlmnInfo' - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - - NsacfInfoSnssai: - type: object - properties: - SnssaiInfo: - $ref: '#/components/schemas/SnssaiInfo' - isSubjectToNsac: - type: boolean - maxNumberofUEs: - type: integer - eACMode: - type: string - enum: - - INACTIVE - - ACTIVE - activeEacThreshhold: - type: integer - deactiveEacThreshhold: - type: integer - numberofUEs: - type: integer - uEIdList: - type: array - items: - type: string - - -#-------- Definition of concrete IOCs -------------------------------------------- - - SubNetwork-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - ExternalAmfFunction: - $ref: '#/components/schemas/ExternalAmfFunction-Multiple' - ExternalNrfFunction: - $ref: '#/components/schemas/ExternalNrfFunction-Multiple' - ExternalNssfFunction: - $ref: '#/components/schemas/ExternalNssfFunction-Multiple' - AmfSet: - $ref: '#/components/schemas/AmfSet-Multiple' - AmfRegion: - $ref: '#/components/schemas/AmfRegion-Multiple' - Configurable5QISet: - $ref: '#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: '#/components/schemas/Dynamic5QISet-Multiple' - - ManagedElement-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' - - type: object - properties: - AmfFunction: - $ref: '#/components/schemas/AmfFunction-Multiple' - SmfFunction: - $ref: '#/components/schemas/SmfFunction-Multiple' - UpfFunction: - $ref: '#/components/schemas/UpfFunction-Multiple' - N3iwfFunction: - $ref: '#/components/schemas/N3iwfFunction-Multiple' - PcfFunction: - $ref: '#/components/schemas/PcfFunction-Multiple' - AusfFunction: - $ref: '#/components/schemas/AusfFunction-Multiple' - UdmFunction: - $ref: '#/components/schemas/UdmFunction-Multiple' - UdrFunction: - $ref: '#/components/schemas/UdrFunction-Multiple' - UdsfFunction: - $ref: '#/components/schemas/UdsfFunction-Multiple' - NrfFunction: - $ref: '#/components/schemas/NrfFunction-Multiple' - NssfFunction: - $ref: '#/components/schemas/NssfFunction-Multiple' - SmsfFunction: - $ref: '#/components/schemas/SmsfFunction-Multiple' - LmfFunction: - $ref: '#/components/schemas/LmfFunction-Multiple' - NgeirFunction: - $ref: '#/components/schemas/NgeirFunction-Multiple' - SeppFunction: - $ref: '#/components/schemas/SeppFunction-Multiple' - NwdafFunction: - $ref: '#/components/schemas/NwdafFunction-Multiple' - ScpFunction: - $ref: '#/components/schemas/ScpFunction-Multiple' - NefFunction: - $ref: '#/components/schemas/NefFunction-Multiple' - Configurable5QISet: - $ref: '#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: '#/components/schemas/Dynamic5QISet-Multiple' - - AmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - amfIdentifier: - $ref: '#/components/schemas/AmfIdentifier' - sBIFqdn: - type: string - weightFactor: - $ref: '#/components/schemas/WeightFactor' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - amfSet: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N2: - $ref: '#/components/schemas/EP_N2-Multiple' - EP_N8: - $ref: '#/components/schemas/EP_N8-Multiple' - EP_N11: - $ref: '#/components/schemas/EP_N11-Multiple' - EP_N12: - $ref: '#/components/schemas/EP_N12-Multiple' - EP_N14: - $ref: '#/components/schemas/EP_N14-Multiple' - EP_N15: - $ref: '#/components/schemas/EP_N15-Multiple' - EP_N17: - $ref: '#/components/schemas/EP_N17-Multiple' - EP_N20: - $ref: '#/components/schemas/EP_N20-Multiple' - EP_N22: - $ref: '#/components/schemas/EP_N22-Multiple' - EP_N26: - $ref: '#/components/schemas/EP_N26-Multiple' - EP_NLS: - $ref: '#/components/schemas/EP_NLS-Multiple' - EP_NLG: - $ref: '#/components/schemas/EP_NLG-Multiple' - AmfSet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - amfSetId: - $ref: '#/components/schemas/AmfSetId' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - AmfRegion-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - amfRegionId: - $ref: '#/components/schemas/AmfRegionId' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - SmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - configurable5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - dynamic5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N4: - $ref: '#/components/schemas/EP_N4-Multiple' - EP_N7: - $ref: '#/components/schemas/EP_N7-Multiple' - EP_N10: - $ref: '#/components/schemas/EP_N10-Multiple' - EP_N11: - $ref: '#/components/schemas/EP_N11-Multiple' - EP_N16: - $ref: '#/components/schemas/EP_N16-Multiple' - EP_S5C: - $ref: '#/components/schemas/EP_S5C-Multiple' - FiveQiDscpMappingSet: - $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' - GtpUPathQoSMonitoringControl: - $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' - QFQoSMonitoringControl: - $ref: '#/components/schemas/QFQoSMonitoringControl-Single' - PredefinedPccRuleSet: - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' - - UpfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N3: - $ref: '#/components/schemas/EP_N3-Multiple' - EP_N4: - $ref: '#/components/schemas/EP_N4-Multiple' - EP_N6: - $ref: '#/components/schemas/EP_N6-Multiple' - EP_N9: - $ref: '#/components/schemas/EP_N9-Multiple' - EP_S5U: - $ref: '#/components/schemas/EP_S5U-Multiple' - N3iwfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N3: - $ref: '#/components/schemas/EP_N3-Multiple' - EP_N4: - $ref: '#/components/schemas/EP_N4-Multiple' - PcfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - configurable5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - dynamic5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N5: - $ref: '#/components/schemas/EP_N5-Multiple' - EP_N7: - $ref: '#/components/schemas/EP_N7-Multiple' - EP_N15: - $ref: '#/components/schemas/EP_N15-Multiple' - EP_N16: - $ref: '#/components/schemas/EP_N16-Multiple' - EP_Rx: - $ref: '#/components/schemas/EP_Rx-Multiple' - PredefinedPccRuleSet: - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' - - AusfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N12: - $ref: '#/components/schemas/EP_N12-Multiple' - EP_N13: - $ref: '#/components/schemas/EP_N13-Multiple' - UdmFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N8: - $ref: '#/components/schemas/EP_N8-Multiple' - EP_N10: - $ref: '#/components/schemas/EP_N10-Multiple' - EP_N13: - $ref: '#/components/schemas/EP_N13-Multiple' - UdrFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - UdsfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - NrfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - cNSIIdList: - $ref: '#/components/schemas/CNSIIdList' - nFProfileList: - $ref: '#/components/schemas/NFProfileList' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N27: - $ref: '#/components/schemas/EP_N27-Multiple' - NssfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - cNSIIdList: - $ref: '#/components/schemas/CNSIIdList' - nFProfileList: - $ref: '#/components/schemas/NFProfileList' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N22: - $ref: '#/components/schemas/EP_N22-Multiple' - EP_N31: - $ref: '#/components/schemas/EP_N31-Multiple' - SmsfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N20: - $ref: '#/components/schemas/EP_N20-Multiple' - EP_N21: - $ref: '#/components/schemas/EP_N21-Multiple' - EP_MAP_SMSC: - $ref: '#/components/schemas/EP_MAP_SMSC-Multiple' - LmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_NLS: - $ref: '#/components/schemas/EP_NLS-Multiple' - NgeirFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N17: - $ref: '#/components/schemas/EP_N17-Multiple' - SeppFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnId: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - sEPPType: - $ref: '#/components/schemas/SEPPType' - sEPPId: - type: integer - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N32: - $ref: '#/components/schemas/EP_N32-Multiple' - NwdafFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - networkSliceInfoList: - $ref: '#/components/schemas/NetworkSliceInfoList' - - ScpFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - supportedFuncList: - $ref: '#/components/schemas/SupportedFuncList' - address: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - NefFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - capabilityList: - $ref: '#/components/schemas/CapabilityList' - isCAPIFSup: - type: boolean - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N33: - $ref: '#/components/schemas/EP_N33-Multiple' - NsacfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - nsacfInfoSnssai: - type: array - items: - $ref: '#/components/schemas/NsacfInfoSnssai' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N60: - $ref: '#/components/schemas/EP_N60-Multiple' - - DDNMFFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnId: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - sBIFqdn: - type: string - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N64: - $ref: '#/components/schemas/EP_N64-Multiple' - EP_N65: - $ref: '#/components/schemas/EP_N65-Multiple' - EP_N66: - $ref: '#/components/schemas/EP_N66-Multiple' - - ExternalAmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - amfIdentifier: - $ref: '#/components/schemas/AmfIdentifier' - ExternalNrfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - ExternalNssfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - ExternalSeppFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnId: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - sEPPId: - type: integer - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - - - EP_N2-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N3-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - epTransportRefs: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - EP_N4-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N5-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N6-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N7-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N8-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N9-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N10-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N11-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N12-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N13-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N14-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N15-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N16-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N17-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - EP_N20-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - EP_N21-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N22-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - EP_N26-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N27-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - - EP_N31-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N32-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - remotePlmnId: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - remoteSeppAddress: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' - remoteSeppId: - type: integer - n32cParas: - type: string - n32fPolicy: - type: string - withIPX: - type: boolean - EP_N33-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_S5C-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_S5U-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_Rx-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_MAP_SMSC-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_NLS-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_NLG-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - EP_N60-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N64-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N65-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N66-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - FiveQiDscpMappingSet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - FiveQiDscpMappingList: - type: array - items: - $ref: '#/components/schemas/FiveQiDscpMapping' - - FiveQICharacteristics-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - fiveQIValue: - type: integer - resourceType: - type: string - enum: - - GBR - - NonGBR - priorityLevel: - type: integer - packetDelayBudget: - type: integer - packetErrorRate: - $ref: '#/components/schemas/PacketErrorRate' - averagingWindow: - type: integer - maximumDataBurstVolume: - type: integer - FiveQICharacteristics-Multiple: - type: array - items: - $ref: '#/components/schemas/FiveQICharacteristics-Single' - Configurable5QISet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - configurable5QIs: - type: array - items: - $ref: '#/components/schemas/FiveQICharacteristics-Multiple' - - Dynamic5QISet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - dynamic5QIs: - type: array - items: - $ref: '#/components/schemas/FiveQICharacteristics-Multiple' - - GtpUPathQoSMonitoringControl-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - gtpUPathQoSMonitoringState: - type: string - enum: - - ENABLED - - DISABLED - gtpUPathMonitoredSNSSAIs: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - monitoredDSCPs: - type: array - items: - type: integer - minimum: 0 - maximum: 255 - isEventTriggeredGtpUPathMonitoringSupported: - type: boolean - isPeriodicGtpUMonitoringSupported: - type: boolean - isImmediateGtpUMonitoringSupported: - type: boolean - gtpUPathDelayThresholds: - $ref: '#/components/schemas/GtpUPathDelayThresholdsType' - gtpUPathMinimumWaitTime: - type: integer - gtpUPathMeasurementPeriod: - type: integer - - QFQoSMonitoringControl-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - qFQoSMonitoringState: - type: string - enum: - - ENABLED - - DISABLED - qFMonitoredSNSSAIs: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - qFMonitored5QIs: - type: array - items: - type: integer - minimum: 0 - maximum: 255 - isEventTriggeredQFMonitoringSupported: - type: boolean - isPeriodicQFMonitoringSupported: - type: boolean - isSessionReleasedQFMonitoringSupported: - type: boolean - qFPacketDelayThresholds: - $ref: '#/components/schemas/QFPacketDelayThresholdsType' - qFMinimumWaitTime: - type: integer - qFMeasurementPeriod: - type: integer - - PredefinedPccRuleSet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - predefinedPccRules: - type: array - items: - $ref: '#/components/schemas/PccRule' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - ManagedElement-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedElement-Single' - AmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/AmfFunction-Single' - SmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/SmfFunction-Single' - UpfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UpfFunction-Single' - N3iwfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/N3iwfFunction-Single' - PcfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/PcfFunction-Single' - AusfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/AusfFunction-Single' - UdmFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UdmFunction-Single' - UdrFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UdrFunction-Single' - UdsfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UdsfFunction-Single' - NrfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NrfFunction-Single' - NssfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NssfFunction-Single' - SmsfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/SmsfFunction-Single' - LmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/LmfFunction-Single' - NgeirFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NgeirFunction-Single' - SeppFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/SeppFunction-Single' - NwdafFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NwdafFunction-Single' - ScpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ScpFunction-Single' - NefFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NefFunction-Single' - - NsacfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NsacfFunction-Single' - - ExternalAmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalAmfFunction-Single' - ExternalNrfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalNrfFunction-Single' - ExternalNssfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalNssfFunction-Single' - ExternalSeppFunction-Nultiple: - type: array - items: - $ref: '#/components/schemas/ExternalSeppFunction-Single' - - AmfSet-Multiple: - type: array - items: - $ref: '#/components/schemas/AmfSet-Single' - AmfRegion-Multiple: - type: array - items: - $ref: '#/components/schemas/AmfRegion-Single' - - EP_N2-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N2-Single' - EP_N3-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N3-Single' - EP_N4-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N4-Single' - EP_N5-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N5-Single' - EP_N6-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N6-Single' - EP_N7-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N7-Single' - EP_N8-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N8-Single' - EP_N9-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N9-Single' - EP_N10-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N10-Single' - EP_N11-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N11-Single' - EP_N12-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N12-Single' - EP_N13-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N13-Single' - EP_N14-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N14-Single' - EP_N15-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N15-Single' - EP_N16-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N16-Single' - EP_N17-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N17-Single' - - EP_N20-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N20-Single' - EP_N21-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N21-Single' - EP_N22-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N22-Single' - - EP_N26-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N26-Single' - EP_N27-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N27-Single' - - EP_N31-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N31-Single' - EP_N32-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N32-Single' - EP_N33-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N33-Single' - EP_S5C-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_S5C-Single' - EP_S5U-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_S5U-Single' - EP_Rx-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_Rx-Single' - EP_MAP_SMSC-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_MAP_SMSC-Single' - EP_NLS-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_NLS-Single' - EP_NLG-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_NLG-Single' - EP_N60-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N60-Single' - EP_N64-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N64-Single' - EP_N65-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N65-Single' - EP_N66-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N66-Single' - Configurable5QISet-Multiple: - type: array - items: - $ref: '#/components/schemas/Configurable5QISet-Single' - Dynamic5QISet-Multiple: - type: array - items: - $ref: '#/components/schemas/Dynamic5QISet-Single' - - - -#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- - - resources-5gcNrm: - oneOf: - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' - - $ref: '#/components/schemas/AmfFunction-Single' - - $ref: '#/components/schemas/SmfFunction-Single' - - $ref: '#/components/schemas/UpfFunction-Single' - - $ref: '#/components/schemas/N3iwfFunction-Single' - - $ref: '#/components/schemas/PcfFunction-Single' - - $ref: '#/components/schemas/AusfFunction-Single' - - $ref: '#/components/schemas/UdmFunction-Single' - - $ref: '#/components/schemas/UdrFunction-Single' - - $ref: '#/components/schemas/UdsfFunction-Single' - - $ref: '#/components/schemas/NrfFunction-Single' - - $ref: '#/components/schemas/NssfFunction-Single' - - $ref: '#/components/schemas/SmsfFunction-Single' - - $ref: '#/components/schemas/LmfFunction-Single' - - $ref: '#/components/schemas/NgeirFunction-Single' - - $ref: '#/components/schemas/SeppFunction-Single' - - $ref: '#/components/schemas/NwdafFunction-Single' - - $ref: '#/components/schemas/ScpFunction-Single' - - $ref: '#/components/schemas/NefFunction-Single' - - $ref: '#/components/schemas/NsacfFunction-Single' - - - $ref: '#/components/schemas/ExternalAmfFunction-Single' - - $ref: '#/components/schemas/ExternalNrfFunction-Single' - - $ref: '#/components/schemas/ExternalNssfFunction-Single' - - $ref: '#/components/schemas/ExternalSeppFunction-Single' - - - $ref: '#/components/schemas/AmfSet-Single' - - $ref: '#/components/schemas/AmfRegion-Single' - - $ref: '#/components/schemas/QFQoSMonitoringControl-Single' - - $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' - - - $ref: '#/components/schemas/EP_N2-Single' - - $ref: '#/components/schemas/EP_N3-Single' - - $ref: '#/components/schemas/EP_N4-Single' - - $ref: '#/components/schemas/EP_N5-Single' - - $ref: '#/components/schemas/EP_N6-Single' - - $ref: '#/components/schemas/EP_N7-Single' - - $ref: '#/components/schemas/EP_N8-Single' - - $ref: '#/components/schemas/EP_N9-Single' - - $ref: '#/components/schemas/EP_N10-Single' - - $ref: '#/components/schemas/EP_N11-Single' - - $ref: '#/components/schemas/EP_N12-Single' - - $ref: '#/components/schemas/EP_N13-Single' - - $ref: '#/components/schemas/EP_N14-Single' - - $ref: '#/components/schemas/EP_N15-Single' - - $ref: '#/components/schemas/EP_N16-Single' - - $ref: '#/components/schemas/EP_N17-Single' - - - $ref: '#/components/schemas/EP_N20-Single' - - $ref: '#/components/schemas/EP_N21-Single' - - $ref: '#/components/schemas/EP_N22-Single' - - - $ref: '#/components/schemas/EP_N26-Single' - - $ref: '#/components/schemas/EP_N27-Single' - - - $ref: '#/components/schemas/EP_N31-Single' - - $ref: '#/components/schemas/EP_N32-Single' - - $ref: '#/components/schemas/EP_N33-Single' - - $ref: '#/components/schemas/EP_N60-Single' - - - $ref: '#/components/schemas/EP_S5C-Single' - - $ref: '#/components/schemas/EP_S5U-Single' - - $ref: '#/components/schemas/EP_Rx-Single' - - $ref: '#/components/schemas/EP_MAP_SMSC-Single' - - $ref: '#/components/schemas/EP_NLS-Single' - - $ref: '#/components/schemas/EP_NLG-Single' - - $ref: '#/components/schemas/Configurable5QISet-Single' - - $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' - - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' - - $ref: '#/components/schemas/Dynamic5QISet-Single' diff --git a/OpenAPI/PerDataFileReportMnS.yaml b/OpenAPI/PerDataFileReportMnS.yaml deleted file mode 100644 index 83fd77acb..000000000 --- a/OpenAPI/PerDataFileReportMnS.yaml +++ /dev/null @@ -1,13 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.532 File data reporting Service - version: 16.6.0 - description: >- - OAS 3.0.1 specification of the File data reporting Management Service © 2020, - 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All - rights reserved. -externalDocs: - description: 3GPP TS 28.532 V16.5.0; Generic management services - url: 'http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/' -paths: {} - diff --git a/OpenAPI/PerMeasJobCtlMnS.yaml b/OpenAPI/PerMeasJobCtlMnS.yaml deleted file mode 100644 index b6abe58b2..000000000 --- a/OpenAPI/PerMeasJobCtlMnS.yaml +++ /dev/null @@ -1,280 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.550 Performance Measurement Job Control Service - version: 16.5.0 - description: >- - OAS 3.0.1 specification of the Performance Measurement Job Control Service - @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.550 V16.5.0; Performance assurance - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.550/ -servers: - - url: 'http://{URI-DN-prefix}/{root}/PerfMeasJobCtrlMnS/v1650/{LDN-first-part}' - variables: - URI-DN-prefix: - description: See subclause 4.4 of TS 32.158 - default: example.com - root: - description: See subclause 4.4 of TS 32.158 - default: 3GPPManagement - LDN-first-part: - description: See subclause 4.4 of TS 32.158 - default: '' -paths: - /measJobs: - post: - summary: Create a measurement job - description: To create a measurement job the representation of the measurement job is POSTed on the /measJobs collection resource. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/measJobCreation-RequestType' - responses: - '201': - description: Success case ("201 Created"). The representation of the newly created measurement job resource shall be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/measJobCreation-ResponseType' - '202': - description: Partial success case ("202 Partically created"). The representation of the newly created measurement job resource with unsupported list shall be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/measJobCreation-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - get: - summary: Read resources of measurement jobs - description: 'With HTTP GET, resources of measurement jobs are read. The resources to be read are identified with the path component (base resource) and the query component (jobIdList) of the URI. The fields query component allows to select the resource properties to be returned.' - parameters: - - name: jobIdList - in: query - description: This parameter identifies the list of jobId to select the resources from the collection resources identified with the path component of the URI. - required: true - schema: - type: array - items: - type: string - responses: - '200': - description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.' - content: - application/json: - schema: - $ref: '#/components/schemas/measJobsRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - '/measJobs/{jobId}': - get: - summary: Read resource of a single measurement job - description: 'With HTTP GET, resource of a measurement job is read. The resource to be read is identified with the path component of the URI.' - parameters: - - name: jobId - in: path - description: Identifies the measurement job to be read. - required: true - schema: - $ref: '#/components/schemas/uri-Type' - responses: - '200': - description: 'Success case ("200 OK"). The resource identified in the path for retrieval is returned in the response message body. ' - content: - application/json: - schema: - $ref: '#/components/schemas/measJobsRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: Delete a single measurement job - description: The measurement job is deleted by deleting the corresponding measurement job resource. The resource to be deleted is identified with the path component of the URI. - parameters: - - name: jobId - in: path - description: Identifies the measurement job to be deleted. - required: true - schema: - $ref: '#/components/schemas/uri-Type' - responses: - '204': - description: Success case ("204 No Content"). The measurement job resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - dateTime-Type: - type: string - format: date-Time - uri-Type: - type: string - measJobCreation-RequestType: - type: object - properties: - iOCName: - type: string - iOCInstanceList: - type: array - items: - $ref: '#/components/schemas/uri-Type' - measurementCategoryList: - type: array - items: - type: string - reportingMethod: - $ref: '#/components/schemas/reportingMethod-Type' - granularityPeriod: - type: integer - reportingPeriod: - type: integer - startTime: - $ref: '#/components/schemas/dateTime-Type' - stopTime: - $ref: '#/components/schemas/dateTime-Type' - schedule: - $ref: '#/components/schemas/schedule-Type' - streamTarget: - type: string - priority: - $ref: '#/components/schemas/priority-Type' - reliability: - type: string - measJobCreation-ResponseType: - type: object - properties: - unsupportedList: - type: array - items: - $ref: '#/components/schemas/unsupportedMeas-Type' - measJobsRetrieval-ResponseType: - type: object - properties: - jobInfoList: - type: array - items: - $ref: '#/components/schemas/measJobInfo-ResourceType' - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - measJobInfo-ResourceType: - type: object - properties: - href: - $ref: '#/components/schemas/uri-Type' - iOCName: - type: string - iOCInstanceList: - type: array - items: - $ref: '#/components/schemas/uri-Type' - measurementCategoryList: - type: array - items: - type: string - reportingMethod: - $ref: '#/components/schemas/reportingMethod-Type' - granularityPeriod: - type: integer - reportingPeriod: - type: integer - startTime: - $ref: '#/components/schemas/dateTime-Type' - stopTime: - $ref: '#/components/schemas/dateTime-Type' - schedule: - $ref: '#/components/schemas/schedule-Type' - streamTarget: - type: string - priority: - $ref: '#/components/schemas/priority-Type' - reliability: - type: string - schedule-Type: - type: object - properties: - scheduleOption: - $ref: '#/components/schemas/scheduleOption-Type' - dailySchedule: - type: array - items: - $ref: '#/components/schemas/timeInterval-Type' - weeklySchedule: - type: array - items: - $ref: '#/components/schemas/scheduleOfDay-Type' - timeInterval-Type: - type: object - properties: - intervalStart: - type: string - format: Time - intervalEnd: - type: string - format: Time - scheduleOfDay-Type: - type: object - properties: - dayOfWeek: - $ref: '#/components/schemas/dayOfWeek-Type' - intervalsOfDay: - type: array - items: - $ref: '#/components/schemas/timeInterval-Type' - unsupportedMeas-Type: - type: object - properties: - iOCInstance: - $ref: '#/components/schemas/uri-Type' - measurementTypeName: - type: string - reason: - type: string - reportingMethod-Type: - type: string - enum: - - file - - streaming - priority-Type: - type: string - enum: - - low - - medium - - high - scheduleOption-Type: - type: string - enum: - - daily - - weekly - dayOfWeek-Type: - type: string - enum: - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday diff --git a/OpenAPI/PerThresMonMnS.yaml b/OpenAPI/PerThresMonMnS.yaml deleted file mode 100644 index 923640a11..000000000 --- a/OpenAPI/PerThresMonMnS.yaml +++ /dev/null @@ -1,102 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.532 Performance Threshold Monitoring Service - version: 16.4.0 - description: OAS 3.0.1 specification of the Performance Threshold Monitoring Service -servers: - - url: 'http://{monitoringNotifTarget}' - variables: - monitoringNotifTarget: - description: >- - The open API server of the performance threshold monitoring service is - located in the consumer side, see monitoringNotifTarget attribute of - the IOC ThresholdMonitor defined in 3GPP TS 28.622 [11]. - default: example.com -paths: - /notificationSink: - post: - summary: Send notifications about performance threshold crossing - description: To send a notifyThresholdCrossing notification - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyThresholdCrossing-NotifType' - responses: - '204': - description: >- - Success case ("204 No Content"). The notification is successfully - delivered. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - dateTime-Type: - type: string - format: date-Time - uri-Type: - type: string - long-Type: - type: string - format: long - thresholdLevel-Type: - type: integer - measurementTypeName-Type: - type: string - measurementValue-Type: - type: string - additionalText-Type: - type: string - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - header-Type: - description: Header used in notifications as notification header - type: object - properties: - uri: - $ref: '#/components/schemas/uri-Type' - notificationId: - $ref: '#/components/schemas/notificationId-Type' - notificationType: - $ref: '#/components/schemas/notificationType-Type' - eventTime: - $ref: '#/components/schemas/dateTime-Type' - notificationId-Type: - $ref: '#/components/schemas/long-Type' - notificationType-Type: - type: string - enum: - - notifyThresholdCrossing - notifyThresholdCrossing-NotifType: - type: object - properties: - header: - $ref: '#/components/schemas/header-Type' - body: - type: object - properties: - startOfMonitoringGP: - $ref: '#/components/schemas/dateTime-Type' - endOfMonitoringGP: - $ref: '#/components/schemas/dateTime-Type' - monitoredObjectInstance: - $ref: '#/components/schemas/uri-Type' - thresholdLevel: - $ref: '#/components/schemas/thresholdLevel-Type' - measurementTypeName: - $ref: '#/components/schemas/measurementTypeName-Type' - measurementValue: - $ref: '#/components/schemas/measurementValue-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' diff --git a/OpenAPI/PerfDataStreamingMnS.yaml b/OpenAPI/PerfDataStreamingMnS.yaml deleted file mode 100644 index e040e14c8..000000000 --- a/OpenAPI/PerfDataStreamingMnS.yaml +++ /dev/null @@ -1,363 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.550 Performance Data Streaming Service - version: 16.3.0 - description: OAS 3.0.1 specification of the Performance Data Streaming Service -servers: - - url: 'http://{streamTarget}/PerfDataStreamMnS/v1630' - description: This URL is used for posting the set of information about streams supported on the connection between the producer and the consumer. - variables: - streamTarget: - description: 'The open API server of the performance data streaming service is located in the consumer side,and the “streamTarget” part corresponds to the streamTarget parameter provided in the createMeasurementJob operation (see clause 6.1.1.2) or the streamTarget attribute of the MOI of MeasurementControlor MeasurementReader, see 3GPP TS 28.622 [5]).' - default: example.com - - url: 'wss://{streamTarget}/PerfDataStreamMnS/v1630/streamingConnection' - description: This URL is used for establishing the WebSocket connection for the performance data streaming service. - variables: - streamTarget: - description: 'The open API server of the performance data streaming service is located in the consumer side,and the “streamTarget” part corresponds to the streamTarget parameter provided in the createMeasurementJob operation (see clause 6.1.1.2) or the streamTarget attribute of the MOI of MeasurementControlor MeasurementReader, see 3GPP TS 28.622 [5]).' - default: example.com -paths: - /streamInfoList: - post: - summary: The set of information about the streams sent from the producer to the consumer - description: To send the streamInfoList from the producer to the consumer - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoListPost-RequestType' - responses: - '201': - description: Success case ("201 Posted"). The streamInfoList is successfully posted. - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoListPost-ResponseType' - '202': - description: Partial success case ("202 Partially posted"). The representation of the posted resource on stream information. - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoListPost-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - get: - summary: Read resources of stream information from the streaming consumer - description: 'With HTTP GET, resources of stream information are read. The resources to be read are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be returned.' - parameters: - - name: streamIdList - in: query - description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. - required: true - schema: - type: array - items: - type: integer - responses: - '200': - description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.' - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' - '202': - description: Partial success case ("202 Partially retrieved"). The representation of the retrieved resources on stream information. - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - patch: - summary: Update resources of stream information to the streaming consumer - description: 'With HTTP PATCH, resources of stream information are to be updated. The resources to be updated are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be updated.' - parameters: - - name: streamIdList - in: query - description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. - required: true - schema: - type: array - items: - type: integer - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoToUpdate-RequestType' - responses: - '200': - description: Success case ("200 OK"). The resources selected by the query parameter are updated and returned in the response message body. - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoUpdate-ResponseType' - '202': - description: Partial success case ("202 Partially updated"). The representation of the updated resources on stream information - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoUpdate-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: The information of streams to be deleted by the producer to the consumer - description: 'With HTTP DELETE, resources of stream information are to be deleted. The resources to be deleted are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be deleted.' - parameters: - - name: streamIdList - in: query - description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. - required: true - schema: - type: array - items: - type: integer - responses: - '204': - description: Success case ("204 No Content"). The stream information resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - '/streamInfoList/{streamId}': - get: - summary: Read resource of the stream information from the streaming consumer - description: 'With HTTP GET, resource of stream information is read. The resource to be read is identified with the path component the URI.' - parameters: - - name: streamId - in: path - description: Identifies the stream for which the information is to be retrieved. - required: true - schema: - $ref: '#/components/schemas/uri-Type' - responses: - '200': - description: Success case ("200 OK"). The resource identified in the request for retrieval is returned in the response message body. - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - patch: - summary: Update the resource of stream information to the streaming consumer - description: 'With HTTP PATCH, resource of stream information is to be updated. The resource to be updated is identified by the path component of the URI. ' - parameters: - - name: streamId - in: path - description: Identifies the stream for which the information is to be updated. - required: true - schema: - $ref: '#/components/schemas/uri-Type' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoToUpdate-RequestType' - responses: - '200': - description: Success case ("200 OK"). The resources identified by the path of the URI is updated and returned in the response message body. - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoUpdate-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: The stream information to be deleted by the producer to the consumer - description: 'With HTTP DELETE, resource of stream information identified by the path component of the URI is to be deleted.' - parameters: - - name: streamId - in: path - description: Identifies the stream for which the information is to be deleted - required: true - schema: - $ref: '#/components/schemas/uri-Type' - responses: - '204': - description: Success case ("204 No Content"). The stream information resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - /streamConnection: - get: - summary: The connection for streaming from the producer to the consumer - description: To establish the WebSocket connection between the producer and the consumer. The HTTP version of this operation shall not be earlier than HTTP/1.1 - parameters: - - in: header - name: Upgrade - required: true - schema: - $ref: '#/components/schemas/Upgrade-HeaderType' - - in: header - name: Connection - required: true - schema: - $ref: '#/components/schemas/Connection-HeaderType' - - in: header - name: Sec-WebSocket-Key - required: true - schema: - $ref: '#/components/schemas/Sec-WebSocket-Key-HeaderType' - - in: header - name: Sec-WebSocket-Version - required: true - schema: - $ref: '#/components/schemas/Sec-WebSocket-Version-HeaderType' - responses: - '101': - description: Success case ("101 Switching Protocols "). The connection has been successfully switched to WebSocket. The response message body is absent. - headers: - Upgrade: - schema: - $ref: '#/components/schemas/Upgrade-HeaderType' - Connection: - schema: - $ref: '#/components/schemas/Connection-HeaderType' - Sec-WebSocket-Accept-HeaderType: - schema: - $ref: '#/components/schemas/Sec-WebSocket-Accept-HeaderType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - uri-Type: - type: string - streamInfoIn-Type: - type: object - properties: - streamId: - type: integer - iOCInstance: - $ref: '#/components/schemas/uri-Type' - measTypes: - type: array - items: - type: string - streamInfoOut-Type: - type: object - properties: - streamId: - $ref: '#/components/schemas/uri-Type' - iOCInstance: - $ref: '#/components/schemas/uri-Type' - measTypes: - type: array - items: - type: string - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - streamInfoListPost-RequestType: - type: object - properties: - streamInfoList: - type: array - items: - $ref: '#/components/schemas/streamInfoIn-Type' - streamInfoListPost-ResponseType: - type: object - properties: - streamInfoListPosted: - type: array - items: - $ref: '#/components/schemas/streamInfoOut-Type' - streamInfoRetrieval-ResponseType: - type: object - properties: - streamInfoOut: - $ref: '#/components/schemas/streamInfoOut-Type' - listOfStreamInfoRetrieval-ResponseType: - type: object - properties: - listOfStreamInfoOut: - type: array - items: - $ref: '#/components/schemas/streamInfoOut-Type' - streamInfoToUpdatePropertyType: - type: object - properties: - iOCInstance: - description: 'The updated measured object instance, empty value means no update.' - allOf: - - $ref: '#/components/schemas/uri-Type' - measTypes: - description: 'The updated list of measurement type, empty value means no update.' - type: array - items: - type: string - streamInfoToUpdate-RequestType: - type: object - properties: - streamInfoToUpdate: - $ref: '#/components/schemas/streamInfoToUpdatePropertyType' - listOfStreamInfoToUpdate-RequestType: - type: object - properties: - listOfStreamInfoToUpdate: - type: array - items: - $ref: '#/components/schemas/streamInfoToUpdatePropertyType' - streamInfoUpdate-ResponseType: - type: object - properties: - streamInfoUpdated: - $ref: '#/components/schemas/streamInfoOut-Type' - listOfStreamInfoUpdate-ResponseType: - type: object - properties: - listOfStreamInfoUpdated: - type: array - items: - $ref: '#/components/schemas/streamInfoOut-Type' - Upgrade-HeaderType: - type: string - enum: - - websocket - Connection-HeaderType: - type: string - enum: - - Upgrade - Sec-WebSocket-Key-HeaderType: - type: string - Sec-WebSocket-Version-HeaderType: - type: string - Sec-WebSocket-Accept-HeaderType: - type: string diff --git a/OpenAPI/comDefs.yaml b/OpenAPI/comDefs.yaml deleted file mode 100644 index 04ab65161..000000000 --- a/OpenAPI/comDefs.yaml +++ /dev/null @@ -1,84 +0,0 @@ -openapi: 3.0.1 -info: - title: Common Type Definitions - version: 16.3.0 - description: >- - OAS 3.0.1 specification of common type definitions in the Generic NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.623 V16.3.0; Generic NRM, Common Type Definitions - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ -paths: {} -components: - schemas: - Long: - type: string - format: long - Float: - type: string - format: float - DateTime: - type: string - format: date-Time - Dn: - type: string - Uri: - type: string - AttributeNameValuePairSet: - type: object - minProperties: 1 - AttributeValueChangeSet: - description: >- - The key in this map is the attribute name. The value of each key is an array. - When only one item is present in the array, it carries the new attribute - value. If two items are present, then the first item carries the old value - and the second item the new value. The items can be of any type including null. - type: object - additionalProperties: - type: array - minItems: 1 - maxItems: 2 - items: - nullable: true - Filter: - type: string - SystemDN: - type: string - NotificationId: - type: integer - NotificationHeader: - description: >- - Header used for all notifications types - type: object - required: - - uri - - notificationId - - notificationType - - eventTime - - systemDn - properties: - uri: - $ref: '#/components/schemas/Uri' - notificationId: - $ref: '#/components/schemas/NotificationId' - notificationType: - oneOf: - - $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes' - #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes' - # more to be added - eventTime: - $ref: '#/components/schemas/DateTime' - systemDN: - $ref: '#/components/schemas/SystemDN' - ErrorResponse: - description: >- - Default schema for the response message body in case the request - is not successful. - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string diff --git a/OpenAPI/coslaNrm.yaml b/OpenAPI/coslaNrm.yaml deleted file mode 100644 index e6a0ef13a..000000000 --- a/OpenAPI/coslaNrm.yaml +++ /dev/null @@ -1,168 +0,0 @@ -openapi: 3.0.2 - -info: - title: coslaNrm - version: 16.4.0 - description: - OAS 3.0.1 specification of the Cosla NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. - -externalDocs: - description: 3GPP TS 28.536 V16.4.0; Cosla NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.536/ - -paths: {} - -components: - - schemas: - -#------------ Type definitions --------------------------------------------------- - - ControlLoopLifeCyclePhase: - type: string - enum: - - PREPARATION - - COMMISSIONING - - OPERATION - - DECOMMISSIONING - - ObservationTime: - type: integer - - AssuranceGoalStatusObserved: - type: string - enum: - - FULFILLED - - NOT_FULFILLED - - AssuranceGoalStatusPredicted: - type: string - enum: - - FULFILLED - - NOT_FULFILLED - - AssuranceTargetStatusObserved: - type: string - enum: - - FULFILLED - - NOT_FULFILLED - - AssuranceTargetStatusPredicted: - type: string - enum: - - FULFILLED - - NOT_FULFILLED - - AssuranceTarget: - type: object - properties: - assuranceTargetName: - type: string - assuranceTargetValue: - type: string - assuranceTargetStatusObserved: - $ref: '#/components/schemas/AssuranceTargetStatusObserved' - assuranceTargetStatusPredicted: - $ref: '#/components/schemas/AssuranceTargetStatusPredicted' - - AssuranceTargetList: - type: array - items: - $ref: '#/components/schemas/AssuranceTarget' - - -#-------- Definition of concrete IOCs -------------------------------------------- - - SubNetwork-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - AssuranceClosedControlLoop: - $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' - - ManagedElement-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' - - type: object - properties: - AssuranceClosedControlLoop: - $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' - - AssuranceClosedControlLoop-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - operationalState: - $ref: 'genericNrm.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - controlLoopLifeCyclePhase: - $ref: '#/components/schemas/ControlLoopLifeCyclePhase' - AssuranceGoal: - $ref: '#/components/schemas/AssuranceGoal-Multiple' - - AssuranceGoal-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - observationTime: - $ref: '#/components/schemas/ObservationTime' - assuranceTargetList: - $ref: '#/components/schemas/AssuranceTargetList' - assuranceGoalStatusObserved: - $ref: '#/components/schemas/AssuranceGoalStatusObserved' - assuranceGoalStatusPredicted: - $ref: '#/components/schemas/AssuranceGoalStatusPredicted' - serviceProfileId: - type: string - sliceProfileId: - type: string - networkSliceRef: - $ref: 'comDefs.yaml#/components/schemas/Dn' - networkSliceSubnetRef: - $ref: 'comDefs.yaml#/components/schemas/Dn' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - AssuranceClosedControlLoop-Multiple: - type: array - items: - $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' - - AssuranceGoal-Multiple: - type: array - items: - $ref: '#/components/schemas/AssuranceGoal-Single' - -#------------ Definitions in TS 28.536 for TS 28.623 ----------------------------- - - resources-coslaNrm: - oneOf: - - $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' - - $ref: '#/components/schemas/AssuranceGoal-Single' - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' \ No newline at end of file diff --git a/OpenAPI/faultMnS.yaml b/OpenAPI/faultMnS.yaml deleted file mode 100644 index 499123b90..000000000 --- a/OpenAPI/faultMnS.yaml +++ /dev/null @@ -1,1144 +0,0 @@ -openapi: 3.0.1 -info: - title: Fault Supervision MnS - version: 16.4.0 - description: >- - OAS 3.0.1 definition of the Fault Supervision MnS - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.532 V16.4.0; Generic management services - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ -servers: - - url: '{MnSRoot}/FaultSupervisionMnS/{version}' - variables: - MnSRoot: - description: See subclause 4.4.3 of TS 32.158 - default: http://example.com/3GPPManagement - version: - description: Versi on number of the OpenAPI definition - default: XXX -paths: - /alarms: - get: - summary: Retrieve multiple alarms - description: >- - Retrieves the alarms identified by alarmAckState, baseObjectInstance - and filter. - parameters: - - name: alarmAckState - in: query - required: false - schema: - $ref: '#/components/schemas/AlarmAckState' - - name: baseObjectInstance - in: query - required: false - schema: - $ref: '#/components/schemas/Dn' - - name: filter - in: query - required: false - schema: - $ref: '#/components/schemas/Filter' - responses: - '200': - description: >- - Success case ("200 OK"). - Returns the alarms identified in the request. The alarmId is the key - of the map. - content: - application/json: - schema: - type: object - additionalProperties: - type: object - allOf: - - type: object - properties: - lastNotificationHeader: - $ref: '#/components/schemas/NotificationHeader' - - $ref: '#/components/schemas/AlarmRecord' - - type: object - properties: - comments: - $ref: '#/components/schemas/Comments' - default: - description: Response in case of error. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - patch: - summary: 'Clear, acknowledge or unacknowledge multiple alarms' - description: >- - Clears, acknowledges or unacknowledges multiple alarms using patch. Depending - on which action is to be performed, different merge patch documents need - to be used. - requestBody: - description: >- - Patch documents for acknowledging and unacknowledging, or clearing multiple - alarms. The keys in the map are the alarmIds to be patched. - content: - application/merge-patch+json: - schema: - oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/MergePatchAcknowledgeAlarm' - - type: object - additionalProperties: - $ref: '#/components/schemas/MergePatchClearAlarm' - responses: - '204': - description: >- - Success case ("204 No content"). - The response message body is empty. - default: - description: Response in case of error. - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/FailedAlarm' - /alarms/alarmCount: - get: - summary: Get the alarm count per perceived severity - parameters: - - name: alarmAckState - in: query - required: false - schema: - $ref: '#/components/schemas/AlarmAckState' - - name: filter - in: query - required: false - schema: - type: string - responses: - '200': - description: >- - Success case ("200 OK"). - The alarm count per perceived severity is returned. - content: - application/json: - schema: - $ref: '#/components/schemas/AlarmCount' - default: - description: Response in case of error. The error case needs rework. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - /alarms/{alarmId}: - patch: - summary: 'Clear, acknowledge or unacknowledge a single alarm' - description: >- - Clears, acknowledges or uncknowldeges a single alarm by patching the alarm - information. A conditional acknowledge request based on the perceived - severity is not supported. - parameters: - - name: alarmId - in: path - description: Identifies the alarm to be patched. - required: true - schema: - type: string - requestBody: - required: true - content: - application/merge-patch+json: - schema: - oneOf: - - $ref: '#/components/schemas/MergePatchAcknowledgeAlarm' - - $ref: '#/components/schemas/MergePatchClearAlarm' - responses: - '204': - description: >- - Success case (204 No content). - The response message body is absent. - default: - description: Response in case of error. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - /alarms/{alarmId}/comments: - post: - summary: Add a comment to a single alarm - description: >- - Adds a comment to an alarm identified by alarmId. The id of the new comment - is allocated by the producer. - parameters: - - name: alarmId - in: path - description: Identifies the alarm to which the comment shall be added. - required: true - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Comment' - responses: - '201': - description: >- - Success case (201 Created). - The representation of the newly created comment resource shall be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/Comment' - headers: - Location: - description: URI of the newly created comment resource. - required: true - schema: - type: string - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - - /subscriptions: - post: - summary: Create a subscription - description: >- - To create a subscription the representation of the subscription is - POSTed on the /subscriptions collection resource. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Subscription' - responses: - '201': - description: >- - Success case ("201 Created"). - The representation of the newly created subscription resource shall - be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/Subscription' - headers: - Location: - description: URI of the newly created subscription resource - required: true - schema: - type: string - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - callbacks: - notifyNewAlarm: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/NotifyNewAlarm' - - $ref: '#/components/schemas/NotifyNewSecAlarm' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyClearedAlarm: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyClearedAlarm' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyChangedAlarm: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyChangedAlarm' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyChangedAlarmGeneral: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/NotifyChangedAlarmGeneral' - - $ref: '#/components/schemas/NotifyChangedSecAlarmGeneral' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyCorrelatedNotificationChanged: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyCorrelatedNotificationChanged' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyAckStateChanged: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyAckStateChanged' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyComments: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyComments' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyPotentialFaultyAlarmList: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyPotentialFaultyAlarmList' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyAlarmListRebuilt: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyAlarmListRebuilt' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}: - delete: - summary: Delete a subscription - description: >- - The subscription is deleted by deleting the corresponding subscription - resource. The resource to be deleted is identified with the path - component of the URI. - parameters: - - name: subscriptionId - in: path - description: Identifies the subscription to be deleted. - required: true - schema: - type: string - responses: - '204': - description: >- - Success case ("204 No Content"). - The subscription resource has been deleted. The response message body - is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - -components: - schemas: - - #---- Definitions to be moved to comDefs.yaml --------------------------------------# - - Long: - type: string - format: long - Float: - type: string - format: float - DateTime: - type: string - format: date-Time - - Dn: - type: string - Uri: - type: string - - AttributeNameValuePairSet: - type: object - minProperties: 1 - AttributeValueChangeSet: - description: >- - The key in this map is the attribute name. The value of each key is an array. - When only one item is present in the array, it carries the new attribute - value. If two items are present, then the first item carries the old value - and the second item the new value. The items can be of any type including null. - type: object - additionalProperties: - type: array - minItems: 1 - maxItems: 2 - items: - nullable: true - - Filter: - type: string - SystemDN: - type: string - - NotificationId: - type: integer - NotificationHeader: - description: >- - Header used for all notification types - type: object - required: - - href - - notificationId - - notificationType - - eventTime - - systemDN - properties: - uri: - $ref: '#/components/schemas/Uri' - notificationId: - $ref: '#/components/schemas/NotificationId' - notificationType: - oneOf: - - $ref: '#/components/schemas/AlarmNotificationTypes' - #- $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes' - #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes' - # more to be added - eventTime: - $ref: '#/components/schemas/DateTime' - systemDN: - $ref: '#/components/schemas/SystemDN' - - ErrorResponse: - description: >- - Default schema for the response message body in case the request is not - successful. - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - - #---- End of definitions to be moved to comDefs.yaml -------------------------------# - - #---- Definition of AlarmRecord ----------------------------------------------------# - - AlarmId: - type: string - AlarmType: - type: string - enum: - - COMMUNICATIONS_ALARM - - QUALITY_OF_SERVICE_ALARM - - PROCESSING_ERROR_ALARM - - EQUIPMENT_ALARM - - ENVIRONMENTAL_ALARM - - INTEGRITY_VIOLATION - - OPERATIONAL_VIOLATION - - PHYSICAL_VIOLATION - - SECURITY_SERVICE_OR_MECHANISM_VIOLATION - - TIME_DOMAIN_VIOLATION - ProbableCause: - description: >- - The value of the probable cause may be a specific standardized string, or any - vendor provided string. Probable cause strings are not standardized in the - present document. They may be added in a future version. Up to then the - mapping of the generic probable cause strings "PROBABLE_CAUSE_001" to - "PROBABLE_CAUSE_005" is vendor specific. - The value of the probable cause may also be an integer. The mapping of integer - values to probable causes is vendor specific. - oneOf: - - anyOf: - - type: string - enum: - - PROBABLE_CAUSE_001 - - PROBABLE_CAUSE_002 - - PROBABLE_CAUSE_003 - - PROBABLE_CAUSE_004 - - PROBABLE_CAUSE_005 - - type: string - - type: integer - SpecificProblem: - oneOf: - - type: string - - type: integer - PerceivedSeverity: - type: string - enum: - - INDETERMINATE - - CRITICAL - - MAJOR - - MINOR - - WARNING - - CLEARED - TrendIndication: - type: string - enum: - - MORE_SEVERE - - NO_CHANGE - - LESS_SEVERE - ThresholdHysteresis: - type: object - required: - - high - properties: - high: - oneOf: - - type: integer - - $ref: '#/components/schemas/Float' - low: - $ref: '#/components/schemas/Float' - ThresholdLevelInd: - type: object - required: - - up - properties: - up: - $ref: '#/components/schemas/ThresholdHysteresis' - low: - $ref: '#/components/schemas/ThresholdHysteresis' - ThresholdInfo: - type: object - required: - - observedMeasurement - - observedValue - properties: - observedMeasurement: - type: string - observedValue: - oneOf: - - type: integer - - $ref: '#/components/schemas/Float' - thresholdLevelInd: - $ref: '#/components/schemas/ThresholdLevelInd' - armTime: - $ref: '#/components/schemas/DateTime' - CorrelatedNotification: - type: object - required: - - source - - notificationId - properties: - sourceObjectInstance: - $ref: '#/components/schemas/Dn' - notificationIds: - type: array - items: - $ref: '#/components/schemas/NotificationId' - CorrelatedNotifications: - type: array - items: - $ref: '#/components/schemas/CorrelatedNotification' - AckState: - type: string - enum: - - ACKNOWLEDGED - - UNACKNOWLEDGED - - AlarmRecord: - description: >- - The alarmId is not a property of an alarm record. It is used as key - in the map of alarm records instead. - type: object - properties: - # alarmId: - # $ref: '#/components/schemas/AlarmId' - objectInstance: - $ref: '#/components/schemas/Dn' - notificationId: - $ref: '#/components/schemas/NotificationId' - alarmRaisedTime: - $ref: '#/components/schemas/DateTime' - alarmChangedTime: - $ref: '#/components/schemas/DateTime' - alarmClearedTime: - $ref: '#/components/schemas/DateTime' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - specificProblem: - $ref: '#/components/schemas/SpecificProblem' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - backedUpStatus: - type: boolean - backUpObject: - $ref: '#/components/schemas/Dn' - trendIndication: - $ref: '#/components/schemas/TrendIndication' - thresholdinfo: - $ref: '#/components/schemas/ThresholdInfo' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - stateChangeDefinition: - $ref: '#/components/schemas/AttributeValueChangeSet' - monitoredAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' - proposedRepairActions: - type: string - additionalText: - type: string - additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' - - rootCauseIndicator: - type: boolean - - ackTime: - $ref: '#/components/schemas/DateTime' - ackUserId: - type: string - ackSystemId: - type: string - ackState: - $ref: '#/components/schemas/AckState' - - clearUserId: - type: string - clearSystemId: - type: string - serviceUser: - type: string - serviceProvider: - type: string - securityAlarmDetector: - type: string - - #---- Definition of alarm notifications --------------------------------------------# - - AlarmNotificationTypes: - type: string - enum: - - notifyNewAlarm - - notifyChangedAlarm - - notifyChangedAlarmGeneral - - notifyAckStateChanged - - notifyCorrelatedNotificationChanged - - notifyComments - - notifyClearedAlarm - - notifyAlarmListRebuiltAlarm - - notifyPotentialFaultyAlarmList - AlarmListAlignmentRequirement: - type: string - enum: - - ALIGNMENT_REQUIRED - - ALIGNMENT_NOT_REQUIRED - - NotifyNewAlarm: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - specificProblem: - $ref: '#/components/schemas/SpecificProblem' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - backedUpStatus: - type: boolean - backUpObject: - $ref: '#/components/schemas/Dn' - trendIndication: - $ref: '#/components/schemas/TrendIndication' - thresholdInfo: - $ref: '#/components/schemas/ThresholdInfo' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - stateChangeDefinition: - $ref: '#/components/schemas/AttributeValueChangeSet' - monitoredAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' - proposedRepairActions: - type: string - additionalText: - type: string - additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - NotifyNewSecAlarm: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - serviceUser - - serviceProvider - - securityAlarmDetector - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - additionalText: - type: string - additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - serviceUser: - type: string - serviceProvider: - type: string - securityAlarmDetector: - type: string - NotifyClearedAlarm: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - clearUserId: - type: string - clearSystemId: - type: string - NotifyChangedAlarm: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - NotifyChangedAlarmGeneral: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - changedAlarmAttributes - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - specificProblem: - $ref: '#/components/schemas/SpecificProblem' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - backedUpStatus: - type: boolean - backUpObject: - $ref: '#/components/schemas/Dn' - trendIndication: - $ref: '#/components/schemas/TrendIndication' - thresholdInfo: - $ref: '#/components/schemas/ThresholdInfo' - stateChangeDefinition: - $ref: '#/components/schemas/AttributeValueChangeSet' - monitoredAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' - proposedRepairActions: - type: string - additionalText: - type: string - additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - changedAlarmAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' - NotifyChangedSecAlarmGeneral: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - serviceUser - - serviceProvider - - securityAlarmDetector - - changedAlarmAttributes - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - additionalText: - type: string - additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - serviceUser: - type: string - serviceProvider: - type: string - securityAlarmDetector: - type: string - changedAlarmAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' - NotifyCorrelatedNotificationChanged: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - correlatedNotifications - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - rootCauseIndicator: - type: boolean - NotifyAckStateChanged: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - ackState - - ackUserId - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - ackState: - $ref: '#/components/schemas/AckState' - ackUserId: - type: string - ackSystemId: - type: string - NotifyComments: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - comments - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - comments: - $ref: '#/components/schemas/Comments' - NotifyPotentialFaultyAlarmList: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - reason - properties: - reason: - type: string - NotifyAlarmListRebuilt: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - reason - properties: - reason: - type: string - alarmListAlignmentRequirement: - $ref: '#/components/schemas/AlarmListAlignmentRequirement' - - #---- Definition of query parameters -----------------------------------------------# - - AlarmAckState: - type: string - enum: - - ALL_ALARMS - - ALL_ACTIVE_ALARMS - - ALL_ACTIVE_AND_ACKNOWLEDGED_ALARMS - - ALL_ACTIVE_AND_UNACKNOWLEDGED_ALARMS - - ALL_CLEARED_AND_UNACKNOWLEDGED_ALARMS - - ALL_UNACKNOWLEDGED_ALARMS - - #---- Definition of patch documents ------------------------------------------------# - - MergePatchAcknowledgeAlarm: - description: >- - Patch document acknowledging or unacknowledging a single alarm. For - acknowleding an alarm the value of ackState is ACKNOWLEDGED, for unacknowleding - an alarm the value of ackState is UNACKNOWLEDGED. - type: object - required: - - ackUserId - - ackState - properties: - ackUserId: - type: string - ackSystemId: - type: string - ackState: - $ref: '#/components/schemas/AckState' - MergePatchClearAlarm: - description: Patch document for clearing a single alarm - type: object - required: - - clearUserId - - perceivedSeverity - properties: - clearUserId: - type: string - clearSystemId: - type: string - perceivedSeverity: - type: string - enum: - - CLEARED - - #---- Definition of method responses -----------------------------------------------# - - FailedAlarm: - type: object - required: - - alarmId - - failureReason - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - failureReason: - type: string - - #---- Definition of resources ------------------------------------------------------# - - AlarmCount: - type: object - required: - - criticalCount - - majorCount - - minorCount - - warningCount - - indeterminateCount - - clearedCount - properties: - criticalCount: - type: integer - majorCount: - type: integer - minorCount: - type: integer - warningCount: - type: integer - indeterminateCount: - type: integer - clearedCount: - type: integer - Comment: - type: object - properties: - commentTime: - $ref: '#/components/schemas/DateTime' - commentUserId: - type: string - commentSystemId: - type: string - commentText: - type: string - Comments: - description: >- - Collection of comments. The comment identifiers are allocated by the - MnS producer and used as key in the map. - type: object - additionalProperties: - $ref: '#/components/schemas/Comment' - Subscription: - type: object - properties: - consumerReference: - $ref: '#/components/schemas/Uri' - timeTick: - $ref: '#/components/schemas/Long' - filter: - $ref: '#/components/schemas/Filter' diff --git a/OpenAPI/genericNrm.yaml b/OpenAPI/genericNrm.yaml deleted file mode 100644 index 0911920a2..000000000 --- a/OpenAPI/genericNrm.yaml +++ /dev/null @@ -1,1606 +0,0 @@ -openapi: 3.0.1 -info: - title: Generic NRM - version: 16.4.0 - description: >- - OAS 3.0.1 specification of the Generic NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.623 V16.4.0; Generic NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ -paths: {} -components: - schemas: - -#-------- Definition of types----------------------------------------------------- - - DateTime: - type: string - format: date-time - Dn: - type: string - maxLength: 400 - DnList: - type: array - items: - $ref: '#/components/schemas/Dn' - Mcc: - type: string - pattern: '^[0-9]{3}$' - Mnc: - type: string - pattern: '^[0-9]{2,3}$' - AdministrativeState: - type: string - enum: - - LOCKED - - UNLOCKED - OperationalState: - type: string - enum: - - ENABLED - - DISABLED - UsageState: - type: string - enum: - - IDEL - - ACTIVE - - BUSY - RegistrationState: - type: string - enum: - - REGISTERED - - DEREGISTERED - SetOfMcc: - type: array - items: - $ref: '#/components/schemas/Mcc' - ManagedElementType: - type: string - ManagedElementTypeList: - type: array - items: - $ref: '#/components/schemas/ManagedElementType' - VnfParameter: - type: object - properties: - vnfInstanceId: - type: string - vnfdId: - type: string - flavourId: - type: string - autoScalable: - type: boolean - VnfParametersList: - type: array - items: - $ref: '#/components/schemas/VnfParameter' - SiteLatitude: - type: number - format: float - minimum: -90 - maximum: 90 - SiteLongitude: - type: number - format: float - minimum: -180 - maximum: 180 - PeeParameter: - type: object - properties: - siteIdentification: - type: string - siteDescription: - type: string - siteLatitude: - $ref: '#/components/schemas/SiteLatitude' - siteLongitude: - $ref: '#/components/schemas/SiteLongitude' - equipmentType: - type: string - environmentType: - type: string - powerInterface: - type: string - PeeParametersList: - type: array - items: - $ref: '#/components/schemas/PeeParameter' - MonitoringGPList: - type: array - items: - type: integer - ThresholdInfoList: - type: array - items: - $ref: '#/components/schemas/ThresholdInfo' - ThresholdInfo: - type: object - properties: - measurementType: - type: string - direction: - $ref: '#/components/schemas/Direction' - thresholdPack: - $ref: '#/components/schemas/ThresholdPack' - Direction: - enum: - - Increasing - - Decreasing - ThresholdPack: - type: array - items: - $ref: '#/components/schemas/ThresholdPackElement' - ThresholdPackElement: - type: object - properties: - thresholdLevel: - type: integer - thresholdValue: - type: number - hysteresis: - type: number - Operation: - type: object - properties: - name: - type: string - allowedNFTypes: - $ref: '#/components/schemas/NFType' - operationSemantics: - $ref: '#/components/schemas/OperationSemantics' - OperationList: - type: array - items: - $ref: '#/components/schemas/Operation' - NFType: - type: string - description: ' NF name defined in TS 23.501' - enum: - - NRF - - UDM - - AMF - - SMF - - AUSF - - NEF - - PCF - - SMSF - - NSSF - - UDR - - LMF - - GMLC - - 5G_EIR - - SEPP - - UPF - - N3IWF - - AF - - UDSF - - DN - Fqdn: - type: string - OperationSemantics: - type: string - enum: - - REQUEST_RESPONSE - - SUBSCRIBE_NOTIFY - SAP: - type: object - properties: - host: - $ref: '#/components/schemas/HostAddr' - port: - type: integer - NFServiceType: - type: string - enum: - - Namf_Communication - - Namf_EventExposure - - Namf_MT - - Namf_Location - - Nsmf_PDUSession - - Nsmf_EventExposure - - Others - HostAddr: - oneOf: - - $ref: '#/components/schemas/Ipv4Addr' - - $ref: '#/components/schemas/Ipv6Addr' - - $ref: '#/components/schemas/Fqdn' - Ipv4Addr: - type: string - pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$' - example: '198.51.100.1' - Ipv4AddrRm: - type: string - pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$' - example: '198.51.100.1' - nullable: true - Ipv6Addr: - type: string - allOf: - - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$' - - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' - example: '2001:db8:85a3::8a2e:370:7334' - Ipv6AddrRm: - type: string - allOf: - - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$' - - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' - example: '2001:db8:85a3::8a2e:370:7334' - nullable: true - Ipv6Prefix: - type: string - allOf: - - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$' - - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$' - example: '2001:db8:abcd:12::0/64' - Uri: - type: string - TransportProtocol: - anyOf: - - type: string - enum: - - TCP - - type: string - SupportedPerfMetricGroup: - type: object - properties: - performanceMetrics: - type: array - items: - type: string - granularityPeriods: - type: array - items: - type: integer - minimum: 1 - reportingMethods: - type: array - items: - type: string - enum: - - FILE_BASED_LOC_SET_BY_PRODUCER - - FILE_BASED_LOC_SET_BY_CONSUMER - - STREAM_BASED - ReportingCtrl: - oneOf: - - type: object - properties: - fileReportingPeriod: - type: integer - - type: object - properties: - fileReportingPeriod: - type: integer - fileLocation: - $ref: '#/components/schemas/Uri' - - type: object - properties: - streamTarget: - $ref: '#/components/schemas/Uri' - Scope: - type: object - properties: - scopeType: - type: string - enum: - - BASE_ONLY - - BASE_ALL - - BASE_NTH_LEVEL - - BASE_SUBTREE - scopeLevel: - type: integer - NotificationType: - type: string - enum: - - notifyMOICreation - - notifyMOIDeletion - - notifyMOIAttributeValueChanges - - notifyEvent - - notifyNewAlarm - - notifyChangedAlarm - - notifyAckStateChanged - - notifyComments - - notifyCorrelatedNotificationChanged - - notifyChangedAlarmGeneral - - notifyAlarmListRebuilt - - notifyPotentialFaultyAlarmList - - notifyFileReady - - notifyFilePreparationError - - notifyThresholdCrossing - NotificationTypes: - type: array - items: - $ref: '#/components/schemas/NotificationType' - -#-------- Definition of types used in Trace control NRM fragment------------------ - - tjJobType-Type: - type: string - description: Specifies whether the TraceJob represents only MDT, Logged MBSFN MDT, Trace or a combined Trace and MDT job. Applicable for Trace, MDT, RCEF and RLF reporting. See 3GPP TS 32.422 clause 5.9a for additional details. - enum: - - IMMEDIATE_MDT_ONLY - - LOGGED_MDT_ONLY - - TRACE_ONLY - - IMMEDIATE_MDT AND TRACE - - RLF_REPORT_ONLY - - RCEF_REPORT_ONLY - - LOGGED_MBSFN_MDT - - tjListOfInterfaces-Type: - description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details. - type: object - properties: - MSCServerInterfaces: - type: array - items: - type: string - enum: - - A - - Iu-CS - - Mc - - MAP-G - - MAP-B - - MAP-E - - MAP-F - - MAP-D - - MAP-C - - CAP - MGWInterfaces: - type: array - items: - type: string - enum: - - Mc - - Nb-UP - - Iu-UP - RNCInterfaces: - type: array - items: - type: string - enum: - - Iu-CS - - Iu-PS - - Iur - - Iub - - Uu - SGSNInterfaces: - type: array - items: - type: string - enum: - - Gb - - Iu-PS - - Gn - - MAP-Gr - - MAP-Gd - - MAP-Gf - - Ge - - Gs - - S6d - - S4 - - S3 - - S13 - GGSNInterfaces: - type: array - items: - type: string - enum: - - Gn - - Gi - - Gmb - S-CSCFInterfaces: - type: array - items: - type: string - enum: - - Mw - - Mg - - Mr - - Mi - P-CSCFInterfaces: - type: array - items: - type: string - enum: - - Gm - - Mw - I-CSCFInterfaces: - type: array - items: - type: string - enum: - - Cx - - Dx - - Mg - - Mw - MRFCInterfaces: - type: array - items: - type: string - enum: - - Mp - - Mr - MGCFInterfaces: - type: array - items: - type: string - enum: - - Mg - - Mj - - Mn - IBCFInterfaces: - type: array - items: - type: string - enum: - - Ix - - Mx - E-CSCFInterfaces: - type: array - items: - type: string - enum: - - Mw - - Ml - - Mm - - Mi/Mg - BGCFInterfaces: - type: array - items: - type: string - enum: - - Mi - - Mj - - Mk - ASInterfaces: - type: array - items: - type: string - enum: - - Dh - - Sh - - ISC - - Ut - HSSInterfaces: - type: array - items: - type: string - enum: - - MAP-C - - MAP-D - - Gc - - Gr - - Cx - - S6d - - S6a - - Sh - EIRInterfaces: - type: array - items: - type: string - enum: - - MAP-F - - S13 - - MAP-Gf - BM-SCInterfaces: - type: array - items: - type: string - enum: - - Gmb - MMEInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - S3 - - S6a - - S10 - - S11 - - S13 - SGWInterfaces: - type: array - items: - type: string - enum: - - S4 - - S5 - - S8 - - S11 - - Gxc - PDN_GWInterfaces: - type: array - items: - type: string - enum: - - S2a - - S2b - - S2c - - S5 - - S6b - - Gx - - S8 - - SGi - eNBInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - X2 - en-gNBInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - X2 - - Uu - - F1-C - - E1 - AMFInterfaces: - type: array - items: - type: string - enum: - - N1 - - N2 - - N8 - - N11 - - N12 - - N14 - - N15 - - N20 - - N22 - - N26 - AUSFInterfaces: - type: array - items: - type: string - enum: - - N12 - - N13 - NEFInterfaces: - type: array - items: - type: string - enum: - - N29 - - N30 - - N33 - NRFInterfaces: - type: array - items: - type: string - enum: - - N27 - NSSFInterfaces: - type: array - items: - type: string - enum: - - N22 - - N31 - PCFInterfaces: - type: array - items: - type: string - enum: - - N5 - - N7 - - N15 - SMFInterfaces: - type: array - items: - type: string - enum: - - N4 - - N7 - - N10 - - N11 - - S5-C - SMSFInterfaces: - type: array - items: - type: string - enum: - - N20 - - N21 - UDMInterfaces: - type: array - items: - type: string - enum: - - N8 - - N10 - - N13 - - N21 - UPFInterfaces: - type: array - items: - type: string - enum: - - N4 - ng-eNBInterfaces: - type: array - items: - type: string - enum: - - NG-C - - Xn-C - - Uu - gNB-CU-CPInterfaces: - type: array - items: - type: string - enum: - - NG-C - - Xn-C - - Uu - - F1-C - - E1 - - X2-C - gNB-CU-UPInterfaces: - type: array - items: - type: string - enum: - - E1 - gNB-DUInterfaces: - type: array - items: - type: string - enum: - - F1-C - - tjListOfNeTypes-Type: - description: The Network Element types where Trace Session activation is needed. See 3GPP TS 32.422 clause 5.4 for additional details. - type: array - items: - type: string - enum: - - MSC_SERVER - - SGSN - - MGW - - GGSN - - RNC - - BM_SC - - MME - - SGW - - PGW - - ENB - - EN_GNB - - GNB_CU_CP - - GNB_CU_UP - - GNB_DU - - tjPLMNTaget-Type: - type: object - description: The PLMN for which sessions shall be selected in the Trace Session in case of management based activation when several PLMNs are supported in the RAN (this means that shared cells and not shared cells are allowed for the specified PLMN. Note that the PLMN Target might differ from the PLMN specified in the Trace Reference, as that specifies the PLMN that is containing the management system requesting the Trace Session from the NE. See 3GPP TS 32.422 clause 5.9b for additional details. - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - required: - - mcc - - mnc - - tjStreamingTraceConsumerURI-Type: - type: string - description: The URI of the Trace Reporting MnS consumer (see 3GPP TS 28.532) to which the Trace records shall be sent. See 3GPP TS 32.422 clause 5.9 for additional details. - format: uri - - tjTraceCollectionEntityAddress-Type: - description: The IP address to which the Trace records shall be transferred. See 3GPP TS 32.422 clause 5.9 for additional details. - oneOf: - - $ref: '#/components/schemas/Ipv4Addr' - - $ref: '#/components/schemas/Ipv6Addr' - - tjTraceDepth-Type: - description: Specifies how detailed information should be recorded in the Network Element. The Trace Depth is a paremeter for Trace Session level, i.e., the Trace Depth is the same for all of the NEs to be traced in the same Trace Session. See 3GPP TS 32.422 clause 5.3 for additional details. - type: string - enum: - - MINIMUM - - MEDIUM - - MAXIMUM - - VENDORMINIMUM - - VENDORMEDIUM - - VENDORMAXIMUM - - tjTraceReference-Type: - type: object - description: The Trace Reference parameter shall be globally unique, therefore the Trace Reference shall compose as follows - MCC+MNC+Trace ID, where the MCC and MNC are coming with the Trace activation request from the management system to identify one PLMN containing the management system, and Trace ID is a 3 byte Octet String. See 3GPP TS 32.422 clause 5.6 for additional details. - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - traceId: - type: integer - required: - - mcc - - mnc - - traceId - - tjTraceReportingFormat-Type: - type: string - description: Specifies whether file-based or streaming reporting shall be used for this Trace Session. See 3GPP TS 32.422 clause 5.11 for additional details. - enum: - - FILE-BASED - - STREAMING - - tjTraceTarget-Type: - type: string - description: Type of trace target. For additional details see 3GPP TS 32.422. - enum: - - IMSI - - IMEI - - IMEISV - - PUBLIC_ID - - UTRAN_CELL - - E-UTRAN_CELL - - NG-RAN_CELL - - eNB - - RNC - - gNB - - tjTriggeringEvent-Type: - type: object - description: Specifies when to start a Trace Recording Session and which message shall be recorded first, when to stop a Trace Recording Session and which message shall be recorded last respectively. See 3GPP TS 32.422 clause 5.1 for additional detials. - properties: - NetworkElement: - type: string - enum: - - MSC_SERVER - - SGSN - - MGW - - GGSN - - BM_SC - - MME - - SGW - - PGW - - AMF - - SMF - - PCF - - UPF - EventBitmap: - type: integer - required: - - NetworkElement - - EventBitmap - - tjMDTAnonymizationOfData-Type: - description: Specifies level of MDT anonymization. For additional details see 3GPP TS 32.422 clause 5.10.12. - type: string - enum: - - NO_IDENTITY - - TAC_OF_IMEI - - tjMDTAreaConfigurationForNeighCell-Type: - description: Used for logged NR MDT and defines the area for which UE is requested to perform measurement logging for neighbour cells which have list of frequencies. For additional details see 3GPP TS 32.422 clause 5.10.26. - type: array - items: - type: object - properties: - frequency: - type: string - cell: - type: string - - tjMDTAreaScope-Type: - description: defines the area in terms or Cells or Tracking Area/Routing Area/Location Area where the MDT data collection shall take place. For additional details see 3GPP TS 32.422 clause 5.10.2. - allOf: - - $ref: '#/components/schemas/DnList' - - tjMDTCollectionPeriodRrmLte-Type: - description: See details in 3GPP TS 32.422 clause 5.10.20. - type: string - enum: - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - - tjMDTCollectionPeriodRrmUmts-Type: - description: See details in 3GPP TS 32.422 clause 5.10.21. - type: string - enum: - - 1024ms - - 1280ms - - 2048ms - - 2560ms - - 5120ms - - 10240ms - - 1min - - tjMDTEventListForTriggeredMeasurement-Type: - description: See details in 3GPP TS 32.422 clause 5.10.28. - type: string - enum: - - OUT_OF_COVERAGE - - A2_EVENT - - tjMDTEventThreshold-Type: - description: See details in 3GPP TS 32.422 clause 5.10.7, 5.10.7a, 5.10.13 and 5.10.14. - type: object - properties: - EventThresholdRSRP: - type: integer - minimum: 0 - maximum: 97 - EventThresholdRSRQ: - type: integer - minimum: 0 - maximum: 34 - EventThreshold1F: - type: object - properties: - CPICH_RSCP: - type: integer - minimum: -120 - maximum: 25 - CPICH_EcNo: - type: integer - minimum: -24 - maximum: 0 - PathLoss: - type: integer - minimum: 30 - maximum: 165 - EventThreshold1I: - type: integer - minimum: -120 - maximum: 25 - - tjMDTListOfMeasurements-Type: - description: See details in 3GPP TS 32.422 clause 5.10.3 for details. - type: object - properties: - UMTS: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M6_DL - - M6_UL - - M7_DL - - M7_UL - LTE: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M1_EVENT_TRIGGERED - - M6 - - M7 - - M8 - - M9 - NR: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M6 - - M7 - - M8 - - M9 - - tjMDTLoggingDuration-Type: - description: See details in 3GPP TS 32.422 clause 5.10.9. - type: string - enum: - - 600s - - 1200s - - 2400s - - 3600s - - 5400s - - 7200s - - tjMDTLoggingInterval-Type: - description: See details in 3GPP TS 32.422 clause 5.10.8. - type: string - enum: - - 1.28s - - 2.56s - - 5.12s - - 10.24s - - 20.48s - - 30.72s - - 40.96s - - 61.44s - - tjMDTMBSFNAreaList-Type: - description: See details in 3GPP TS 32.422 clause 5.10.25. - type: array - items: - type: object - properties: - mbsfnAreaId: - type: integer - minimum: 1 - earfcn: - type: integer - minimum: 1 - required: - - mbsfnAreaId - - earfcn - - tjMDTMeasurementPeriodLTE-Type: - description: See details in 3GPP TS 32.422 clause 5.10.23. - type: string - enum: - - 1024ms - - 1280ms - - 2048ms - - 2560ms - - 5120ms - - 10240ms - - 1min - - tjMDTMeasurementPeriodUMTS-Type: - description: See details in 3GPP TS 32.422 clause 5.10.22. - type: string - enum: - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - - tjMDTMeasurementQuantity-Type: - description: See details in 3GPP TS 32.422 clause 5.10.15. - type: string - enum: - - CPICH_EcNo - - CPICH_RSCP - - PathLoss - - tjMDTPLMList-Type: - description: See details in 3GPP TS 32.422 clause 5.10.24. - type: array - items: - type: object - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - required: - - mcc - - mnc - maxItems: 16 - - tjMDTPositioningMethod-Type: - description: See details in 3GPP TS 32.422 clause 5.10.19. - type: string - enum: - - GNSS - - E-CELL_ID - - tjMDTReportAmount-Type: - description: See details in 3GPP TS 32.422 clause 5.10.6. - type: string - enum: - - 1 - - 2 - - 4 - - 8 - - 16 - - 32 - - 64 - - INFINITY - - tjMDTReportingTrigger-Type: - description: See details in 3GPP TS 32.422 clause 5.10.4. - type: array - items: - type: string - enum: - - PERIODICAL - - A2_FOR_LTE - - 1F_FOR_UMTS - - 1I_FOR_UMTS_MCPS_TDD - - A2_TRIGGERED_PERIODIC_FOR_LTE - - ALL_CONFIGURED_RRM_FOR_LTE - - ALL_CONFIGURED_RRM_FOR_UMTS - - tjMDTReportInterval-Type: - description: See details in 3GPP TS 32.422 clause 5.10.5. - type: string - enum: - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - - 120ms - - 240ms - - 480ms - - 640ms - - 1024ms - - 2048ms - - 5120ms - - 10240ms - - 60000ms - - 360000ms - - 720000ms - - 1800000ms - - 3600000ms - - tjMDTReportType-Type: - description: Report type for logged NR MDT. See details in 3GPP TS 32.422 clause 5.10.27. - type: string - enum: - - PERIODICAL - - EVENT_TRIGGERED - - tjMDTSensorInformation-Type: - description: See details in 3GPP TS 32.422 clause 5.10.29. - type: array - items: - type: string - enum: - - BAROMETRIC_PRESSURE - - UE_SPEED - - UE_ORIENTATION - - tjMDTTraceCollectionEntityID-Type: - description: See details in 3GPP TS 32.422 clause 5.10.11. Only tceID value may be sent over the air to the UE being configured for Logged MDT. - type: object - properties: - tceID: - type: integer - tcePLMN: - type: object - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - required: - - mcc - - mnc - tceAddress: - oneOf: - - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' - - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' - required: - - tceID - - tcePLMN - - tceAddress - - -#-------- end of Definition of types used in Trace control NRM fragment ---------- - - -#-------- Definition of abstract IOC Top ----------------------------------------- - - Top-Attr: - # This definition will be deprecated, when all occurances of Top-Attr - # are replaced by Top. - type: object - properties: - id: - type: string - VsDataContainer: - $ref: '#/components/schemas/VsDataContainer-Multiple' - Top: - type: object - properties: - id: - type: string - VsDataContainer: - $ref: '#/components/schemas/VsDataContainer-Multiple' - -#-------- Definition of IOCs with new name-containments defined in other TS ------ - - SubNetwork-Attr: - type: object - properties: - dnPrefix: - type: string - userLabel: - type: string - userDefinedNetworkType: - type: string - setOfMcc: - $ref: '#/components/schemas/SetOfMcc' - priorityLabel: - type: integer - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - ManagedElement-Attr: - type: object - properties: - dnPrefix: - type: string - managedElementTypeList: - $ref: '#/components/schemas/ManagedElementTypeList' - userLabel: - type: string - locationName: - type: string - managedBy: - $ref: '#/components/schemas/DnList' - vendorName: - type: string - userDefinedState: - type: string - swVersion: - type: string - priorityLabel: - type: integer - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - - SubNetwork-ncO: - type: object - properties: - ManagementNode: - $ref: '#/components/schemas/ManagementNode-Multiple' - MeContext: - $ref: '#/components/schemas/MeContext-Multiple' - PerfMetricJob: - $ref: '#/components/schemas/PerfMetricJob-Multiple' - ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' - ThresholdMonitoringCapability: - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - NtfSubscriptionControl: - $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' - TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' - AlarmList: - $ref: '#/components/schemas/AlarmList-Single' - MnsRegistry: - type: array - items: - $ref: '#/components/schemas/MnsRegistry' - ManagedElement-ncO: - type: object - properties: - PerfMetricJob: - $ref: '#/components/schemas/PerfMetricJob-Multiple' - ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' - ThresholdMonitoringCapability: - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - NtfSubscriptionControl: - $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' - TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' - AlarmList: - $ref: '#/components/schemas/AlarmList-Single' - -#-------- Definition of abstract IOCs -------------------------------------------- - - ManagedFunction-Attr: - type: object - properties: - userLabel: - type: string - vnfParametersList: - $ref: '#/components/schemas/VnfParametersList' - peeParametersList: - $ref: '#/components/schemas/PeeParametersList' - priorityLabel: - type: integer - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - EP_RP-Attr: - type: object - properties: - userLabel: - type: string - farEndEntity: - type: string - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - - TraceJob-Attr: - type: object - description: abstract class used as a container of all TraceJob attributes - properties: - tjJobType: - $ref: '#/components/schemas/tjJobType-Type' - tjListOfInterfaces: - $ref: '#/components/schemas/tjListOfInterfaces-Type' - tjListOfNeTypes: - $ref: '#/components/schemas/tjListOfNeTypes-Type' - tjPLMNTarget: - $ref: '#/components/schemas/tjPLMNTaget-Type' - tjTraceConsumer: - oneOf: - - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' - - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' - tjTraceDepth: - $ref: '#/components/schemas/tjTraceDepth-Type' - tjTraceReference: - $ref: '#/components/schemas/tjTraceReference-Type' - tjTraceReportingFormat: - $ref: '#/components/schemas/tjTraceReportingFormat-Type' - tjTraceTarget: - $ref: '#/components/schemas/tjTraceTarget-Type' - tjTriggeringEvent: - $ref: '#/components/schemas/tjTriggeringEvent-Type' - tjMDTAnonymizationOfData: - $ref: '#/components/schemas/tjMDTAnonymizationOfData-Type' - tjMDTAreaConfigurationForNeighCell: - $ref: '#/components/schemas/tjMDTAreaConfigurationForNeighCell-Type' - tjMDTAreaScope: - $ref: '#/components/schemas/tjMDTAreaScope-Type' - tjMDTCollectionPeriodRrmLte: - $ref: '#/components/schemas/tjMDTCollectionPeriodRrmLte-Type' - tjMDTCollectionPeriodRrmUmts: - $ref: '#/components/schemas/tjMDTCollectionPeriodRrmUmts-Type' - tjMDTEventListForTriggeredMeasurement: - $ref: '#/components/schemas/tjMDTEventListForTriggeredMeasurement-Type' - tjMDTEventThreshold: - $ref: '#/components/schemas/tjMDTEventThreshold-Type' - tjMDTListOfMeasurements: - $ref: '#/components/schemas/tjMDTListOfMeasurements-Type' - tjMDTLoggingDuration: - $ref: '#/components/schemas/tjMDTLoggingDuration-Type' - tjMDTLoggingInterval: - $ref: '#/components/schemas/tjMDTLoggingInterval-Type' - tjMDTMBSFNAreaList: - $ref: '#/components/schemas/tjMDTMBSFNAreaList-Type' - tjMDTMeasurementPeriodLTE: - $ref: '#/components/schemas/tjMDTMeasurementPeriodLTE-Type' - tjMDTMeasurementPeriodUMTS: - $ref: '#/components/schemas/tjMDTMeasurementPeriodUMTS-Type' - tjMDTMeasurementQuantity: - $ref: '#/components/schemas/tjMDTMeasurementQuantity-Type' - tjMDTPLMList: - $ref: '#/components/schemas/tjMDTPLMList-Type' - tjMDTPositioningMethod: - $ref: '#/components/schemas/tjMDTPositioningMethod-Type' - tjMDTReportAmount: - $ref: '#/components/schemas/tjMDTReportAmount-Type' - tjMDTReportingTrigger: - $ref: '#/components/schemas/tjMDTReportingTrigger-Type' - tjMDTReportInterval: - $ref: '#/components/schemas/tjMDTReportInterval-Type' - tjMDTReportType: - $ref: '#/components/schemas/tjMDTReportType-Type' - tjMDTSensorInformation: - $ref: '#/components/schemas/tjMDTSensorInformation-Type' - tjMDTTraceCollectionEntityID: - $ref: '#/components/schemas/tjMDTTraceCollectionEntityID-Type' - required: - - tjJobType - - tjTraceReference - - tjTraceConsumer - - tjTraceReportingFormat - - tjTraceTarget - - ManagedFunction-ncO: - type: object - properties: - PerfMetricJob: - $ref: '#/components/schemas/PerfMetricJob-Multiple' - ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' - ThresholdMonitoringCapability: - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - ManagedNFService: - $ref: '#/components/schemas/ManagedNFService-Multiple' - TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' - - MnsRegistry: - type: object - properties: - mnsLabel: - type: string - mnsType: - type: string - mnsVersion: - type: string - mnsAddress: - type: string - -#-------- Definition of concrete IOCs -------------------------------------------- - - VsDataContainer-Single: - type: object - properties: - id: - type: string - attributes: - type: object - properties: - vsDataType: - type: string - vsDataFormatVersion: - type: string - vsData: - nullable: true - VsDataContainer: - $ref: '#/components/schemas/VsDataContainer-Multiple' - ManagedNFService-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - userLabel: - type: string - nFServiceType: - $ref: '#/components/schemas/NFServiceType' - sAP: - $ref: '#/components/schemas/SAP' - operations: - $ref: '#/components/schemas/OperationList' - administrativeState: - $ref: '#/components/schemas/AdministrativeState' - operationalState: - $ref: '#/components/schemas/OperationalState' - usageState: - $ref: '#/components/schemas/UsageState' - registrationState: - $ref: '#/components/schemas/RegistrationState' - ManagementNode-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - userLabel: - type: string - managedElements: - $ref: '#/components/schemas/DnList' - vendorName: - type: string - userDefinedState: - type: string - locationName: - type: string - swVersion: - type: string - MeContext-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - dnPrefix: - type: string - PerfMetricJob-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - administrativeState: - $ref: '#/components/schemas/AdministrativeState' - operationalState: - $ref: '#/components/schemas/OperationalState' - perfMetricJobGroupId: - type: string - performanceMetrics: - type: array - items: - type: string - granularityPeriod: - type: integer - minimum: 1 - objectInstances: - $ref: '#/components/schemas/DnList' - rootObjectInstances: - $ref: '#/components/schemas/DnList' - reportingCtrl: - $ref: '#/components/schemas/ReportingCtrl' - ThresholdMonitoringCapability-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - supportedMonitoringGPs: - $ref: '#/components/schemas/MonitoringGPList' - ThresholdMonitor-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - thresholdInfoList: - $ref: '#/components/schemas/ThresholdInfoList' - monitoringGP: - type: integer - monitoringNotifTarget: - type: string - monitoredIOCName: - type: string - monitoredObjectDNs: - $ref: '#/components/schemas/DnList' - NtfSubscriptionControl-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - notificationRecipientAddress: - $ref: '#/components/schemas/Uri' - notificationTypes: - $ref: '#/components/schemas/NotificationTypes' - scope: - $ref: '#/components/schemas/Scope' - notificationFilter: - type: string - HeartbeatControl: - $ref: '#/components/schemas/HeartbeatControl-Single' - HeartbeatControl-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - heartbeatNtfPeriod: - type: integer - triggerHeartbeatNtf: - type: boolean - TraceJob-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - $ref: '#/components/schemas/TraceJob-Attr' - - AlarmList-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - administrativeState: - $ref: '#/components/schemas/AdministrativeState' - operationalState: - $ref: '#/components/schemas/OperationalState' - numOfAlarmRecords: - type: integer - lastModification: - $ref: '#/components/schemas/DateTime' - alarmRecords: - description: >- - This resource represents a map of alarm records. - The alarmIds are used as keys in the map. - type: object - additionalProperties: - $ref: 'faultMnS.yaml#/components/schemas/AlarmRecord' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - VsDataContainer-Multiple: - type: array - items: - $ref: '#/components/schemas/VsDataContainer-Single' - ManagedNFService-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedNFService-Single' - ManagementNode-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagementNode-Single' - MeContext-Multiple: - type: array - items: - $ref: '#/components/schemas/MeContext-Single' - PerfMetricJob-Multiple: - type: array - items: - $ref: '#/components/schemas/PerfMetricJob-Single' - ThresholdMonitor-Multiple: - type: array - items: - $ref: '#/components/schemas/ThresholdMonitor-Single' - NtfSubscriptionControl-Multiple: - type: array - items: - $ref: '#/components/schemas/NtfSubscriptionControl-Single' - TraceJob-Multiple: - type: array - items: - $ref: '#/components/schemas/TraceJob-Single' - -#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- - - resources-genericNrm: - oneOf: - - - $ref: '#/components/schemas/VsDataContainer-Single' - - - $ref: '#/components/schemas/ManagementNode-Single' - - $ref: '#/components/schemas/MeContext-Single' - - - $ref: '#/components/schemas/ManagedNFService-Single' - - - $ref: '#/components/schemas/PerfMetricJob-Single' - - - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - - $ref: '#/components/schemas/ThresholdMonitor-Single' - - - $ref: '#/components/schemas/NtfSubscriptionControl-Single' - - $ref: '#/components/schemas/HeartbeatControl-Single' - - $ref: '#/components/schemas/TraceJob-Single' - - - $ref: '#/components/schemas/AlarmList-Single' diff --git a/OpenAPI/heartbeatNtf.yaml b/OpenAPI/heartbeatNtf.yaml deleted file mode 100644 index afde5066d..000000000 --- a/OpenAPI/heartbeatNtf.yaml +++ /dev/null @@ -1,23 +0,0 @@ -openapi: 3.0.1 -info: - title: Heartbeat notification - version: 16.3.0 - description: >- - OAS 3.0.1 specification of the heartbeat notification - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.532 V16.3.0; Heartbeat notification - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.6532/ -paths: {} -components: - schemas: - hearbeatNtfPeriod-Type: - type: integer - notifyHeartbeat-NotifType: - allOf: - - $ref: 'provMnS.yaml#/components/schemas/header-Type' - - type: object - properties: - heartbeatNtfPeriod: - $ref: '#/components/schemas/hearbeatNtfPeriod-Type' diff --git a/OpenAPI/nrNrm.yaml b/OpenAPI/nrNrm.yaml deleted file mode 100644 index 850106631..000000000 --- a/OpenAPI/nrNrm.yaml +++ /dev/null @@ -1,1905 +0,0 @@ -openapi: 3.0.1 -info: - title: NR NRM - version: 17.4.0 - description: >- - OAS 3.0.1 specification of the NR NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.541; 5G NRM, NR NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ -paths: {} -components: - schemas: - -#-------- Definition of types----------------------------------------------------- - - GnbId: - type: string - GnbIdLength: - type: integer - minimum: 22 - maximum: 32 - GnbName: - type: string - maxLength: 150 - GnbDuId: - type: number - minimum: 0 - maximum: 68719476735 - GnbCuUpId: - type: number - minimum: 0 - maximum: 68719476735 - - Sst: - type: integer - maximum: 255 - Snssai: - type: object - properties: - sst: - $ref: '#/components/schemas/Sst' - sd: - type: string - SnssaiList: - type: array - items: - $ref: '#/components/schemas/Snssai' - - Mnc: - type: string - pattern: '[0-9]{3}|[0-9]{2}' - PlmnId: - type: object - properties: - mcc: - $ref: 'genericNrm.yaml#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - PlmnIdList: - type: array - items: - $ref: '#/components/schemas/PlmnId' - PlmnInfo: - type: object - properties: - plmnId": - $ref: '#/components/schemas/PlmnId' - snssai: - $ref: '#/components/schemas/Snssai' - PlmnInfoList: - type: array - items: - $ref: '#/components/schemas/PlmnInfo' - cagId: - type: string - nid: - type: string - NpnIdentity: - type: object - properties: - plmnId": - $ref: '#/components/schemas/PlmnId' - cagidList: - $ref: '#/components/schemas/cagId' - nidList: - $ref: '#/components/schemas/nid' - NpnIdentityList: - type: array - items: - $ref: '#/components/schemas/NpnIdentity' - GGnbId: - type: string - pattern: '^[0-9]{3}[0-9]{2,3}-(22|23|24|25|26|27|28|29|30|31|32)-[0-9]{1,10}' - GEnbId: - type: string - pattern: '^[0-9]{3}[0-9]{2,3}-(18|20|21|22)-[0-9]{1,7}' - - GGnbIdList: - type: array - items: - $ref: '#/components/schemas/GGnbId' - - GEnbIdList: - type: array - items: - $ref: '#/components/schemas/GEnbId' - - NrPci: - type: integer - maximum: 503 - NrTac: - type: integer - maximum: 16777215 - Tai: - type: object - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - nrTac: - $ref: '#/components/schemas/NrTac' - - BackhaulAddress: - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - tai: - $ref: "#/components/schemas/Tai" - MappingSetIDBackhaulAddress: - type: object - properties: - setID: - type: integer - backhaulAddress: - $ref: '#/components/schemas/BackhaulAddress' - IntraRatEsActivationOriginalCellLoadParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - IntraRatEsActivationCandidateCellsLoadParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - IntraRatEsDeactivationCandidateCellsLoadParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - EsNotAllowedTimePeriod: - type: object - properties: - startTimeandendTime: - type: string - periodOfDay: - type: string - daysOfWeekList: - type: string - listoftimeperiods: - type: string - InterRatEsActivationOriginalCellParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - InterRatEsActivationCandidateCellParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - InterRatEsDeactivationCandidateCellParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - - UeAccProbilityDist: - type: object - properties: - targetProbability: - type: integer - numberofpreamblessent: - type: integer - - UeAccDelayProbilityDist: - type: object - properties: - targetProbability: - type: integer - accessdelay: - type: integer - - NRPciList: - type: object - properties: - NRPci: - type: integer - - CSonPciList: - type: object - properties: - NRPci: - type: integer - - MaximumDeviationHoTrigger: - type: integer - minimum: -20 - maximum: 20 - - MinimumTimeBetweenHoTriggerChange: - type: integer - minimum: 0 - maximum: 604800 - - TstoreUEcntxt: - type: integer - minimum: 0 - maximum: 1023 - - CellState: - type: string - enum: - - IDLE - - INACTIVE - - ACTIVE - CyclicPrefix: - type: string - enum: - - '15' - - '30' - - '60' - - '120' - TxDirection: - type: string - enum: - - DL - - UL - - DL and UL - BwpContext: - type: string - enum: - - DL - - UL - - SUL - IsInitialBwp: - type: string - enum: - - INITIAL - - OTHER - - SUL - QuotaType: - type: string - enum: - - STRICT - - FLOAT - IsESCoveredBy: - type: string - enum: - - NO - - PARTIAL - - FULL - RrmPolicyMember: - type: object - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - snssai: - $ref: '#/components/schemas/Snssai' - RrmPolicyMemberList: - type: array - items: - $ref: '#/components/schemas/RrmPolicyMember' - AddressWithVlan: - type: object - properties: - ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' - vlanId: - type: integer - minimum: 0 - maximum: 4096 - LocalAddress: - type: object - properties: - addressWithVlan: - $ref: '#/components/schemas/AddressWithVlan' - port: - type: integer - minimum: 0 - maximum: 65535 - RemoteAddress: - type: object - properties: - ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' - - CellIndividualOffset: - type: object - properties: - rsrpOffsetSSB: - type: integer - rsrqOffsetSSB: - type: integer - sinrOffsetSSB: - type: integer - rsrpOffsetCSI-RS: - type: integer - rsrqOffsetCSI-RS: - type: integer - sinrOffsetCSI-RS: - type: integer - QOffsetRange: - type: integer - enum: - - -24 - - -22 - - -20 - - -18 - - -16 - - -14 - - -12 - - -10 - - -8 - - -6 - - -5 - - -4 - - -3 - - -2 - - -1 - - 0 - - 24 - - 22 - - 20 - - 18 - - 16 - - 14 - - 12 - - 10 - - 8 - - 6 - - 5 - - 4 - - 3 - - 2 - - 1 - QOffsetRangeList: - type: object - properties: - rsrpOffsetSSB: - $ref: '#/components/schemas/QOffsetRange' - rsrqOffsetSSB: - $ref: '#/components/schemas/QOffsetRange' - sinrOffsetSSB: - $ref: '#/components/schemas/QOffsetRange' - rsrpOffsetCSI-RS: - $ref: '#/components/schemas/QOffsetRange' - rsrqOffsetCSI-RS: - $ref: '#/components/schemas/QOffsetRange' - sinrOffsetCSI-RS: - $ref: '#/components/schemas/QOffsetRange' - QOffsetFreq: - type: number - TReselectionNRSf: - type: integer - enum: - - 25 - - 50 - - 75 - - 100 - SsbPeriodicity: - type: integer - enum: - - 5 - - 10 - - 20 - - 40 - - 80 - - 160 - SsbDuration: - type: integer - enum: - - 1 - - 2 - - 3 - - 4 - - 5 - SsbSubCarrierSpacing: - type: integer - enum: - - 15 - - 30 - - 120 - - 240 - CoverageShape: - type: integer - maximum: 65535 - DigitalTilt: - type: integer - minimum: -900 - maximum: 900 - DigitalAzimuth: - type: integer - minimum: -1800 - maximum: 1800 - - RSSetId: - type: integer - maximum: 4194303 - - RSSetType: - type: string - enum: - - RS1 - - RS2 - - FrequencyDomainPara: - type: object - properties: - rimRSSubcarrierSpacing: - type: integer - rIMRSBandwidth: - type: integer - nrofGlobalRIMRSFrequencyCandidates: - type: integer - rimRSCommonCarrierReferencePoint: - type: integer - rimRSStartingFrequencyOffsetIdList: - type: array - items: - type: integer - - SequenceDomainPara: - type: object - properties: - nrofRIMRSSequenceCandidatesofRS1: - type: integer - rimRSScrambleIdListofRS1: - type: array - items: - type: integer - nrofRIMRSSequenceCandidatesofRS2: - type: integer - rimRSScrambleIdListofRS2: - type: array - items: - type: integer - enableEnoughNotEnoughIndication: - type: string - enum: - - ENABLE - - DISABLE - RIMRSScrambleTimerMultiplier: - type: integer - RIMRSScrambleTimerOffset: - type: integer - - TimeDomainPara: - type: object - properties: - dlULSwitchingPeriod1: - type: string - enum: - - MS0P5 - - MS0P625 - - MS1 - - MS1P25 - - MS2 - - MS2P5 - - MS3 - - MS4 - - MS5 - - MS10 - - MS20 - symbolOffsetOfReferencePoint1: - type: integer - dlULSwitchingPeriod2: - type: string - enum: - - MS0P5 - - MS0P625 - - MS1 - - MS1P25 - - MS2 - - MS2P5 - - MS3 - - MS4 - - MS5 - - MS10 - - MS20 - symbolOffsetOfReferencePoint2: - type: integer - totalnrofSetIdofRS1: - type: integer - totalnrofSetIdofRS2: - type: integer - nrofConsecutiveRIMRS1: - type: integer - nrofConsecutiveRIMRS2: - type: integer - consecutiveRIMRS1List: - type: array - items: - type: integer - consecutiveRIMRS2List: - type: array - items: - type: integer - enablenearfarIndicationRS1: - type: string - enum: - - ENABLE - - DISABLE - enablenearfarIndicationRS2: - type: string - enum: - - ENABLE - - DISABLE - - RimRSReportInfo: - type: object - properties: - detectedSetID: - type: integer - propagationDelay: - type: integer - functionalityOfRIMRS: - type: string - enum: - - RS1 - - RS2 - - RS1forEnoughMitigation - - RS1forNotEnoughMitigation - - RimRSReportConf: - type: object - properties: - reportIndicator: - type: string - enum: - - ENABLE - - DISABLE - reportInterval: - type: integer - nrofRIMRSReportInfo: - type: integer - maxPropagationDelay: - type: integer - rimRSReportInfoList: - type: array - items: - $ref: '#/components/schemas/RimRSReportInfo' - TceMappingInfo: - type: object - properties: - TceIPAddress: - oneOf: - - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' - TceID: - type: integer - PlmnTarget: - $ref: '#/components/schemas/PlmnId' - TceMappingInfoList: - type: array - items: - $ref: '#/components/schemas/TceMappingInfo' - - -#-------- Definition of abstract IOCs -------------------------------------------- - - RrmPolicy_-Attr: - type: object - properties: - resourceType: - type: string - rRMPolicyMemberList: - $ref: '#/components/schemas/RrmPolicyMemberList' - - -#-------- Definition of concrete IOCs -------------------------------------------- - - SubNetwork-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - NRFrequency: - $ref: '#/components/schemas/NRFrequency-Multiple' - ExternalGnbCuCpFunction: - $ref: '#/components/schemas/ExternalGnbCuCpFunction-Multiple' - ExternalENBFunction: - $ref: '#/components/schemas/ExternalENBFunction-Multiple' - EUtranFrequency: - $ref: '#/components/schemas/EUtranFrequency-Multiple' - DESManagementFunction: - $ref: '#/components/schemas/DESManagementFunction-Single' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - DMROFunction: - $ref: '#/components/schemas/DMROFunction-Single' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - CPCIConfigurationFunction: - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - CESManagementFunction: - $ref: '#/components/schemas/CESManagementFunction-Single' - Configurable5QISet: - $ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' - RimRSGlobal: - $ref: '#/components/schemas/RimRSGlobal-Single' - Dynamic5QISet: - $ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' - - ManagedElement-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' - - type: object - properties: - GnbDuFunction: - $ref: '#/components/schemas/GnbDuFunction-Multiple' - GnbCuUpFunction: - $ref: '#/components/schemas/GnbCuUpFunction-Multiple' - GnbCuCpFunction: - $ref: '#/components/schemas/GnbCuCpFunction-Multiple' - DESManagementFunction: - $ref: '#/components/schemas/DESManagementFunction-Single' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - DMROFunction: - $ref: '#/components/schemas/DMROFunction-Single' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - CPCIConfigurationFunction: - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - CESManagementFunction: - $ref: '#/components/schemas/CESManagementFunction-Single' - Configurable5QISet: - $ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' - - GnbDuFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbDuId: - $ref: '#/components/schemas/GnbDuId' - gnbDuName: - $ref: '#/components/schemas/GnbName' - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - rimRSReportConf: - $ref: '#/components/schemas/RimRSReportConf' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - RRMPolicyRatio: - $ref: '#/components/schemas/RRMPolicyRatio-Multiple' - NrCellDu: - $ref: '#/components/schemas/NrCellDu-Multiple' - Bwp-Multiple: - $ref: '#/components/schemas/Bwp-Multiple' - NrSectorCarrier-Multiple: - $ref: '#/components/schemas/NrSectorCarrier-Multiple' - EP_F1C: - $ref: '#/components/schemas/EP_F1C-Single' - EP_F1U: - $ref: '#/components/schemas/EP_F1U-Multiple' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - GnbCuUpFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - gnbCuUpId: - $ref: '#/components/schemas/GnbCuUpId' - plmnInfoList: - $ref: '#/components/schemas/PlmnInfoList' - configurable5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - dynamic5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - RRMPolicyRatio: - $ref: '#/components/schemas/RRMPolicyRatio-Multiple' - EP_E1: - $ref: '#/components/schemas/EP_E1-Single' - EP_XnU: - $ref: '#/components/schemas/EP_XnU-Multiple' - EP_F1U: - $ref: '#/components/schemas/EP_F1U-Multiple' - EP_NgU: - $ref: '#/components/schemas/EP_NgU-Multiple' - EP_X2U: - $ref: '#/components/schemas/EP_X2U-Multiple' - EP_S1U: - $ref: '#/components/schemas/EP_S1U-Multiple' - GnbCuCpFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - gnbCuName: - $ref: '#/components/schemas/GnbName' - plmnId: - $ref: '#/components/schemas/PlmnId' - x2BlackList: - $ref: '#/components/schemas/GGnbIdList' - xnBlackList: - $ref: '#/components/schemas/GGnbIdList' - x2WhiteList: - $ref: '#/components/schemas/GGnbIdList' - xnWhiteList: - $ref: '#/components/schemas/GGnbIdList' - x2XnHOBlackList: - $ref: '#/components/schemas/GEnbIdList' - mappingSetIDBackhaulAddress: - $ref: '#/components/schemas/MappingSetIDBackhaulAddress' - tceMappingInfoList: - $ref: '#/components/schemas/TceMappingInfoList' - configurable5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - dynamic5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - RRMPolicyRatio: - $ref: '#/components/schemas/RRMPolicyRatio-Multiple' - NrCellCu: - $ref: '#/components/schemas/NrCellCu-Multiple' - EP_XnC: - $ref: '#/components/schemas/EP_XnC-Multiple' - EP_E1: - $ref: '#/components/schemas/EP_E1-Multiple' - EP_F1C: - $ref: '#/components/schemas/EP_F1C-Multiple' - EP_NgC: - $ref: '#/components/schemas/EP_NgC-Multiple' - EP_X2C: - $ref: '#/components/schemas/EP_X2C-Multiple' - DANRManagementFunction: - $ref: '#/components/schemas/DANRManagementFunction-Single' - DESManagementFunction: - $ref: '#/components/schemas/DESManagementFunction-Single' - DMROFunction: - $ref: '#/components/schemas/DMROFunction-Single' - - NrCellCu-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - cellLocalId: - type: integer - plmnInfoList: - $ref: '#/components/schemas/PlmnInfoList' - nRFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - RRMPolicyRatio: - $ref: '#/components/schemas/RRMPolicyRatio-Multiple' - NRCellRelation: - $ref: '#/components/schemas/NRCellRelation-Multiple' - EUtranCellRelation: - $ref: '#/components/schemas/EUtranCellRelation-Multiple' - NRFreqRelation: - $ref: '#/components/schemas/NRFreqRelation-Multiple' - EUtranFreqRelation: - $ref: '#/components/schemas/EUtranFreqRelation-Multiple' - DESManagementFunction: - $ref: '#/components/schemas/DESManagementFunction-Single' - DMROFunction: - $ref: '#/components/schemas/DMROFunction-Single' - CESManagementFunction: - $ref: '#/components/schemas/CESManagementFunction-Single' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - - NrCellDu-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - operationalState: - $ref: 'genericNrm.yaml#/components/schemas/OperationalState' - cellLocalId: - type: integer - cellState: - $ref: '#/components/schemas/CellState' - plmnInfoList: - $ref: '#/components/schemas/PlmnInfoList' - npnIdentityList: - $ref: '#/components/schemas/NpnIdentityList' - nrPci: - $ref: '#/components/schemas/NrPci' - nrTac: - $ref: '#/components/schemas/NrTac' - arfcnDL: - type: integer - arfcnUL: - type: integer - arfcnSUL: - type: integer - bSChannelBwDL: - type: integer - bSChannelBwUL: - type: integer - bSChannelBwSUL: - type: integer - ssbFrequency: - type: integer - minimum: 0 - maximum: 3279165 - ssbPeriodicity: - $ref: '#/components/schemas/SsbPeriodicity' - ssbSubCarrierSpacing: - $ref: '#/components/schemas/SsbSubCarrierSpacing' - ssbOffset: - type: integer - minimum: 0 - maximum: 159 - ssbDuration: - $ref: '#/components/schemas/SsbDuration' - nrSectorCarrierRef: - type: array - items: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - bwpRef: - type: array - items: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - rimRSMonitoringStartTime: - type: string - rimRSMonitoringStopTime: - type: string - rimRSMonitoringWindowDuration: - type: integer - rimRSMonitoringWindowStartingOffset: - type: integer - rimRSMonitoringWindowPeriodicity: - type: integer - rimRSMonitoringOccasionInterval: - type: integer - rimRSMonitoringOccasionStartingOffset: - type: integer - nRFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - victimSetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - aggressorSetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - RRMPolicyRatio: - $ref: '#/components/schemas/RRMPolicyRatio-Multiple' - CPCIConfigurationFunction: - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - - NRFrequency-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - absoluteFrequencySSB: - type: integer - minimum: 0 - maximum: 3279165 - ssbSubCarrierSpacing: - $ref: '#/components/schemas/SsbSubCarrierSpacing' - multiFrequencyBandListNR: - type: integer - minimum: 1 - maximum: 256 - EUtranFrequency-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - earfcnDL: - type: integer - minimum: 0 - maximum: 262143 - multiBandInfoListEutra: - type: integer - minimum: 1 - maximum: 256 - - NrSectorCarrier-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - txDirection: - $ref: '#/components/schemas/TxDirection' - configuredMaxTxPower: - type: integer - arfcnDL: - type: integer - arfcnUL: - type: integer - bSChannelBwDL: - type: integer - bSChannelBwUL: - type: integer - sectorEquipmentFunctionRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - CommonBeamformingFunction: - $ref: '#/components/schemas/CommonBeamformingFunction-Single' - Bwp-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - bwpContext: - $ref: '#/components/schemas/BwpContext' - isInitialBwp: - $ref: '#/components/schemas/IsInitialBwp' - subCarrierSpacing: - type: integer - cyclicPrefix: - $ref: '#/components/schemas/CyclicPrefix' - startRB: - type: integer - numberOfRBs: - type: integer - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - CommonBeamformingFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - coverageShape: - $ref: '#/components/schemas/CoverageShape' - digitalAzimuth: - $ref: '#/components/schemas/DigitalAzimuth' - digitalTilt: - $ref: '#/components/schemas/DigitalTilt' - - type: object - properties: - Beam: - $ref: '#/components/schemas/Beam-Multiple' - Beam-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - beamIndex: - type: integer - beamType: - type: string - enum: - - SSB-BEAM - beamAzimuth: - type: integer - minimum: -1800 - maximum: 1800 - beamTilt: - type: integer - minimum: -900 - maximum: 900 - beamHorizWidth: - type: integer - minimum: 0 - maximum: 3599 - beamVertWidth: - type: integer - minimum: 0 - maximum: 1800 - RRMPolicyRatio-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: '#/components/schemas/RrmPolicy_-Attr' - - type: object - properties: - rRMPolicyMaxRatio: - type: integer - rRMPolicyMinRatio: - type: integer - rRMPolicyDedicatedRatio: - type: integer - - NRCellRelation-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - nRTCI: - type: integer - cellIndividualOffset: - $ref: '#/components/schemas/CellIndividualOffset' - adjacentNRCellRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - nRFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - isRemoveAllowed: - type: boolean - isHOAllowed: - type: boolean - isESCoveredBy: - $ref: '#/components/schemas/IsESCoveredBy' - isENDCAllowed: - type: boolean - isMLBAllowed: - type: boolean - EUtranCellRelation-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - adjacentEUtranCellRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - NRFreqRelation-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - offsetMO: - $ref: '#/components/schemas/QOffsetRangeList' - blackListEntry: - type: array - items: - type: integer - minimum: 0 - maximum: 1007 - blackListEntryIdleMode: - type: integer - cellReselectionPriority: - type: integer - cellReselectionSubPriority: - type: number - minimum: 0.2 - maximum: 0.8 - multipleOf: 0.2 - pMax: - type: integer - minimum: -30 - maximum: 33 - qOffsetFreq: - $ref: '#/components/schemas/QOffsetFreq' - qQualMin: - type: number - qRxLevMin: - type: integer - minimum: -140 - maximum: -44 - threshXHighP: - type: integer - minimum: 0 - maximum: 62 - threshXHighQ: - type: integer - minimum: 0 - maximum: 31 - threshXLowP: - type: integer - minimum: 0 - maximum: 62 - threshXLowQ: - type: integer - minimum: 0 - maximum: 31 - tReselectionNr: - type: integer - minimum: 0 - maximum: 7 - tReselectionNRSfHigh: - $ref: '#/components/schemas/TReselectionNRSf' - tReselectionNRSfMedium: - $ref: '#/components/schemas/TReselectionNRSf' - nRFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - EUtranFreqRelation-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - cellIndividualOffset: - $ref: '#/components/schemas/CellIndividualOffset' - blackListEntry: - type: array - items: - type: integer - minimum: 0 - maximum: 1007 - blackListEntryIdleMode: - type: integer - cellReselectionPriority: - type: integer - cellReselectionSubPriority: - type: number - minimum: 0.2 - maximum: 0.8 - multipleOf: 0.2 - pMax: - type: integer - minimum: -30 - maximum: 33 - qOffsetFreq: - $ref: '#/components/schemas/QOffsetFreq' - qQualMin: - type: number - qRxLevMin: - type: integer - minimum: -140 - maximum: -44 - threshXHighP: - type: integer - minimum: 0 - maximum: 62 - threshXHighQ: - type: integer - minimum: 0 - maximum: 31 - threshXLowP: - type: integer - minimum: 0 - maximum: 62 - threshXLowQ: - type: integer - minimum: 0 - maximum: 31 - tReselectionEutran: - type: integer - minimum: 0 - maximum: 7 - tReselectionNRSfHigh: - $ref: '#/components/schemas/TReselectionNRSf' - tReselectionNRSfMedium: - $ref: '#/components/schemas/TReselectionNRSf' - eUTranFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - DANRManagementFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - intrasystemANRManagementSwitch: - type: boolean - intersystemANRManagementSwitch: - type: boolean - - DESManagementFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - desSwitch: - type: boolean - intraRatEsActivationOriginalCellLoadParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - intraRatEsActivationCandidateCellsLoadParameters: - $ref: "#/components/schemas/IntraRatEsActivationCandidateCellsLoadParameters" - intraRatEsDeactivationCandidateCellsLoadParameters: - $ref: "#/components/schemas/IntraRatEsDeactivationCandidateCellsLoadParameters" - esNotAllowedTimePeriod: - $ref: "#/components/schemas/EsNotAllowedTimePeriod" - interRatEsActivationOriginalCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - interRatEsActivationCandidateCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - interRatEsDeactivationCandidateCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - isProbingCapable: - type: string - enum: - - yes - - no - energySavingState: - type: string - enum: - - isNotEnergySaving - - isEnergySaving - - DRACHOptimizationFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - drachOptimizationControl: - type: boolean - ueAccProbilityDist: - $ref: "#/components/schemas/UeAccProbilityDist" - ueAccDelayProbilityDist: - $ref: "#/components/schemas/UeAccDelayProbilityDist" - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - DMROFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - dmroControl: - type: boolean - maximumDeviationHoTrigger: - $ref: '#/components/schemas/MaximumDeviationHoTrigger' - minimumTimeBetweenHoTriggerChange: - $ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange' - tstoreUEcntxt: - $ref: '#/components/schemas/TstoreUEcntxt' - - DPCIConfigurationFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - dPciConfigurationControl: - type: boolean - nRPciList: - $ref: "#/components/schemas/NRPciList" - - CPCIConfigurationFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - cPciConfigurationControl: - type: boolean - cSonPciList: - $ref: "#/components/schemas/CSonPciList" - - CESManagementFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - cesSwitch: - type: boolean - intraRatEsActivationOriginalCellLoadParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - intraRatEsActivationCandidateCellsLoadParameters: - $ref: "#/components/schemas/IntraRatEsActivationCandidateCellsLoadParameters" - intraRatEsDeactivationCandidateCellsLoadParameters: - $ref: "#/components/schemas/IntraRatEsDeactivationCandidateCellsLoadParameters" - esNotAllowedTimePeriod: - $ref: "#/components/schemas/EsNotAllowedTimePeriod" - interRatEsActivationOriginalCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - interRatEsActivationCandidateCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - interRatEsDeactivationCandidateCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - energySavingControl: - type: string - enum: - - toBeEnergySaving - - toBeNotEnergySaving - energySavingState: - type: string - enum: - - isNotEnergySaving - - isEnergySaving - - RimRSGlobal-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - frequencyDomainPara: - $ref: '#/components/schemas/FrequencyDomainPara' - sequenceDomainPara: - $ref: '#/components/schemas/SequenceDomainPara' - timeDomainPara: - $ref: '#/components/schemas/TimeDomainPara' - RimRSSet: - $ref: '#/components/schemas/RimRSSet-Multiple' - - RimRSSet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - setId: - $ref: '#/components/schemas/RSSetId' - setType: - $ref: '#/components/schemas/RSSetType' - nRCellDURefs: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - - ExternalGnbDuFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_F1C: - $ref: '#/components/schemas/EP_F1C-Multiple' - EP_F1U: - $ref: '#/components/schemas/EP_F1U-Multiple' - ExternalGnbCuUpFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_E1: - $ref: '#/components/schemas/EP_E1-Multiple' - EP_F1U: - $ref: '#/components/schemas/EP_F1U-Multiple' - EP_XnU: - $ref: '#/components/schemas/EP_XnU-Multiple' - ExternalGnbCuCpFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: >- - genericNrm.yaml#/components/schemas/ManagedFunction-Attr - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - plmnId: - $ref: '#/components/schemas/PlmnId' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - ExternalNrCellCu: - $ref: '#/components/schemas/ExternalNrCellCu-Multiple' - EP_XnC: - $ref: '#/components/schemas/EP_XnC-Multiple' - EP_E1: - $ref: '#/components/schemas/EP_E1-Multiple' - EP_F1C: - $ref: '#/components/schemas/EP_F1C-Multiple' - ExternalNrCellCu-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - cellLocalId: - type: integer - nrPci: - $ref: '#/components/schemas/NrPci' - plmnIdList: - $ref: '#/components/schemas/PlmnIdList' - nRFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - ExternalENBFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - eNBId: - type: integer - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - ExternalEUTranCell: - $ref: '#/components/schemas/ExternalEUTranCell-Multiple' - ExternalEUTranCell-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - EUtranFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - EP_XnC-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_E1-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_F1C-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_NgC-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_X2C-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_XnU-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_F1U-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - epTransportRefs: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - - EP_NgU-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - epTransportRefs: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - - EP_X2U-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_S1U-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - ManagedElement-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedElement-Single' - GnbDuFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/GnbDuFunction-Single' - GnbCuUpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/GnbCuUpFunction-Single' - GnbCuCpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/GnbCuCpFunction-Single' - - NrCellDu-Multiple: - type: array - items: - $ref: '#/components/schemas/NrCellDu-Single' - NrCellCu-Multiple: - type: array - items: - $ref: '#/components/schemas/NrCellCu-Single' - - NRFrequency-Multiple: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/NRFrequency-Single' - EUtranFrequency-Multiple: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/EUtranFrequency-Single' - - NrSectorCarrier-Multiple: - type: array - items: - $ref: '#/components/schemas/NrSectorCarrier-Single' - Bwp-Multiple: - type: array - items: - $ref: '#/components/schemas/Bwp-Single' - Beam-Multiple: - type: array - items: - $ref: '#/components/schemas/Beam-Single' - RRMPolicyRatio-Multiple: - type: array - items: - $ref: '#/components/schemas/RRMPolicyRatio-Single' - - NRCellRelation-Multiple: - type: array - items: - $ref: '#/components/schemas/NRCellRelation-Single' - EUtranCellRelation-Multiple: - type: array - items: - $ref: '#/components/schemas/EUtranCellRelation-Single' - NRFreqRelation-Multiple: - type: array - items: - $ref: '#/components/schemas/NRFreqRelation-Single' - EUtranFreqRelation-Multiple: - type: array - items: - $ref: '#/components/schemas/EUtranFreqRelation-Single' - - RimRSSet-Multiple: - type: array - items: - $ref: '#/components/schemas/RimRSSet-Single' - - ExternalGnbDuFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalGnbDuFunction-Single' - ExternalGnbCuUpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalGnbCuUpFunction-Single' - ExternalGnbCuCpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalGnbCuCpFunction-Single' - ExternalNrCellCu-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalNrCellCu-Single' - - ExternalENBFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalENBFunction-Single' - ExternalEUTranCell-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalEUTranCell-Single' - - EP_E1-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_E1-Single' - EP_XnC-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_XnC-Single' - EP_F1C-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_F1C-Single' - EP_NgC-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_NgC-Single' - EP_X2C-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_X2C-Single' - EP_XnU-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_XnU-Single' - EP_F1U-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_F1U-Single' - EP_NgU-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_NgU-Single' - EP_X2U-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_X2U-Single' - EP_S1U-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_S1U-Single' - -#-------- Definitions in TS 28.541 for TS 28.532 --------------------------------- - - resources-nrNrm: - oneOf: - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' - - - $ref: '#/components/schemas/GnbDuFunction-Single' - - $ref: '#/components/schemas/GnbCuUpFunction-Single' - - $ref: '#/components/schemas/GnbCuCpFunction-Single' - - - $ref: '#/components/schemas/NrCellCu-Single' - - $ref: '#/components/schemas/NrCellDu-Single' - - - $ref: '#/components/schemas/NRFrequency-Single' - - $ref: '#/components/schemas/EUtranFrequency-Single' - - - $ref: '#/components/schemas/NrSectorCarrier-Single' - - $ref: '#/components/schemas/Bwp-Single' - - $ref: '#/components/schemas/CommonBeamformingFunction-Single' - - $ref: '#/components/schemas/Beam-Single' - - $ref: '#/components/schemas/RRMPolicyRatio-Single' - - - $ref: '#/components/schemas/NRCellRelation-Single' - - $ref: '#/components/schemas/EUtranCellRelation-Single' - - $ref: '#/components/schemas/NRFreqRelation-Single' - - $ref: '#/components/schemas/EUtranFreqRelation-Single' - - - $ref: '#/components/schemas/DANRManagementFunction-Single' - - $ref: '#/components/schemas/DESManagementFunction-Single' - - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - - $ref: '#/components/schemas/DMROFunction-Single' - - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - - $ref: '#/components/schemas/CESManagementFunction-Single' - - - $ref: '#/components/schemas/RimRSGlobal-Single' - - $ref: '#/components/schemas/RimRSSet-Single' - - - $ref: '#/components/schemas/ExternalGnbDuFunction-Single' - - $ref: '#/components/schemas/ExternalGnbCuUpFunction-Single' - - $ref: '#/components/schemas/ExternalGnbCuCpFunction-Single' - - $ref: '#/components/schemas/ExternalNrCellCu-Single' - - $ref: '#/components/schemas/ExternalENBFunction-Single' - - $ref: '#/components/schemas/ExternalEUTranCell-Single' - - - $ref: '#/components/schemas/EP_XnC-Single' - - $ref: '#/components/schemas/EP_E1-Single' - - $ref: '#/components/schemas/EP_F1C-Single' - - $ref: '#/components/schemas/EP_NgC-Single' - - $ref: '#/components/schemas/EP_X2C-Single' - - $ref: '#/components/schemas/EP_XnU-Single' - - $ref: '#/components/schemas/EP_F1U-Single' - - $ref: '#/components/schemas/EP_NgU-Single' - - $ref: '#/components/schemas/EP_X2U-Single' - - $ref: '#/components/schemas/EP_S1U-Single' diff --git a/OpenAPI/provMnS.yaml b/OpenAPI/provMnS.yaml deleted file mode 100644 index b2f84a4d2..000000000 --- a/OpenAPI/provMnS.yaml +++ /dev/null @@ -1,579 +0,0 @@ -openapi: 3.0.1 -info: - title: Provisioning MnS - version: 16.4.0 - description: >- - OAS 3.0.1 definition of the Provisioning MnS - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.532 V16.4.0; Generic management services - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ -servers: - - url: 'http://{URI-DN-prefix}/{root}/ProvMnS/v1640/{LDN-first-part}' - variables: - URI-DN-prefix: - description: See subclause 4.4 of TS 32.158 - default: example.com - root: - description: See subclause 4.4 of TS 32.158 - default: 3GPPManagement - LDN-first-part: - description: See subclause 4.4 of TS 32.158 - default: '' -paths: - '/{className}={id}': - parameters: - - name: className - in: path - required: true - schema: - $ref: '#/components/schemas/className-PathType' - - name: id - in: path - required: true - schema: - $ref: '#/components/schemas/id-PathType' - put: - summary: Replaces a complete single resource or creates it if it does not exist - description: >- - With HTTP PUT a complete resource is replaced or created if it does not - exist. The target resource is identified by the target URI. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/resourcePut-RequestType' - responses: - '200': - description: >- - Success case ("200 OK"). - This status code shall be returned when the resource is replaced, and - when the replaced resource representation is not identical to the resource - representation in the request. - This status code may be retourned when the resource is updated and when the - updated resource representation is identical to the resource representation - in the request. - The representation of the updated resource is returned in the response - message body. - content: - application/json: - schema: - $ref: '#/components/schemas/resourceUpdate-ResponseType' - '201': - description: >- - Success case ("201 Created"). - This status code shall be returned when the resource is created. - The representation of the created resource is returned in the response - message body. - content: - application/json: - schema: - $ref: '#/components/schemas/resourceCreation-ResponseType' - '204': - description: >- - Success case ("204 No Content"). - This status code may be returned only when the replaced resource - representation is identical to the representation in the request. - The response has no message body. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - callbacks: - notifyMOICreation: - '{request.body#/notificationRecipientAddress}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyMOICreation-NotifType' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response - has no message body. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - notifyMOIDeletion: - '{request.body#/notificationRecipientAddress}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyMOIDeletion-NotifType' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response - has no message body. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - notifyMOIAttributeValueChange: - '{request.body#/notificationRecipientAddress}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyMOIAttributeValueChange-NotifType' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response - has no message body. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - notifyMOIChanges: - '{request.body#/notificationRecipientAddress}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyMOIChanges-NotifType' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response - has no message body. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - get: - summary: Reads one or multiple resources - description: >- - With HTTP GET resources are read. The resources to be retrieved are - identified with the target URI. The attributes and fields parameter - of the query components allow to select the resource properties to be returned. - parameters: - - name: scope - in: query - description: >- - This parameter extends the set of targeted resources beyond the base - resource identified with the path component of the URI. No scoping - mechanism is specified in the present document. - required: false - schema: - $ref: '#/components/schemas/scope-QueryType' - style: form - explode: true - - name: filter - in: query - description: >- - This parameter reduces the targeted set of resources by applying a - filter to the scoped set of resource representations. Only resource - representations for which the filter construct evaluates to "true" - are targeted. No filter language is specified in the present - document. - required: false - schema: - $ref: '#/components/schemas/filter-QueryType' - - name: attributes - in: query - description: >- - This parameter specifies the attributes of the scoped resources that - are returned. - required: true - schema: - $ref: '#/components/schemas/attributes-QueryType' - style: form - explode: false - - name: fields - in: query - description: >- - This parameter specifies the attribute field of the scoped resources - that are returned. - required: false - schema: - $ref: '#/components/schemas/fields-QueryType' - style: form - explode: false - responses: - '200': - description: >- - Success case ("200 OK"). - The resources identified in the request for retrieval are returned - in the response message body. In case the attributes or fields query - parameters are used, only the selected attributes or sub-attributes are - returned. The response message body is constructed according to the - hierarchical response construction method (TS 32.158 [15]). - content: - application/json: - schema: - $ref: '#/components/schemas/resourceRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - patch: - summary: Patches one or multiple resources - description: >- - With HTTP PATCH resources are created, updated or deleted. The resources - to be modified are identified with the target URI (base resource) and - the patch document included in the request message body. - requestBody: - description: >- - The request body describes changes to be made to the target resources. - The following patch media types are available - - "application/merge-patch+json" (RFC 7396) - - "application/3gpp-merge-patch+json" (TS 32.158) - - "application/json-patch+json" (RFC 6902) - - "application/3gpp-json-patch+json" (TS 32.158) - required: true - content: - application/merge-patch+json: - schema: - $ref: '#/components/schemas/jsonMergePatch-RequestType' - application/3gpp-merge-patch+json: - schema: - $ref: '#/components/schemas/3gppJsonMergePatch-RequestType' - application/json-patch+json: - schema: - $ref: '#/components/schemas/jsonPatch-RequestType' - application/3gpp-json-patch+json: - schema: - $ref: '#/components/schemas/3gppJsonPatch-RequestType' - responses: - '200': - description: >- - Success case ("200 OK"). - This status code is returned when the updated the resource representations - shall be returned for some reason. - The resource representations are returned in the response message body. The - response message body is constructed according to the hierarchical response - construction method (TS 32.158 [15]) - content: - application/json: - schema: - $ref: '#/components/schemas/resourceUpdate-ResponseType' - '204': - description: >- - Success case ("204 No Content"). - This status code is returned when there is no need to return the updated - resource representations. - The response message body is empty. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: Deletes one or multiple resources - description: >- - With HTTP DELETE resources are deleted. The resources to be deleted are - identified with the target URI. - parameters: - - name: scope - in: query - description: >- - This parameter extends the set of targeted resources beyond the base - resource identified with the path component of the URI. No scoping - mechanism is specified in the present document. - required: false - schema: - $ref: '#/components/schemas/scope-QueryType' - - name: filter - in: query - description: >- - This parameter reduces the targeted set of resources by applying a - filter to the scoped set of resource representations. Only resources - representations for which the filter construct evaluates to "true" - are returned. No filter language is specified in the present - document. - required: false - schema: - $ref: '#/components/schemas/filter-QueryType' - responses: - '200': - description: >- - Success case ("200 OK"). - This status code shall be returned, when query parameters are present in - the request and one or multiple resources are deleted. - The URIs of the deleted resources are returned in the response message body. - '204': - description: >- - Success case ("204 No Content"). - This status code shall be returned, when no query parameters are present in - the request and only one resource is deleted. - The message body is empty. - content: - application/json: - schema: - $ref: '#/components/schemas/resourceDeletion-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - dateTime-Type: - type: string - format: date-time - long-Type: - type: integer - format: int64 - uri-Type: - type: string - correlatedNotification-Type: - type: object - properties: - source: - $ref: '#/components/schemas/uri-Type' - notificationIds: - type: array - items: - $ref: '#/components/schemas/notificationId-Type' - notificationId-Type: - $ref: '#/components/schemas/long-Type' - notificationType-Type: - type: string - enum: - - notifyMOICreation - - notifyMOIDeletion - - notifyMOIAttributeValueChange - systemDN-Type: - type: string - additionalText-Type: - type: string - sourceIndicator-Type: - type: string - enum: - - resourceOperation - - mangementOperation - - sONOperation - - unknown - header-Type: - type: object - properties: - href: - $ref: '#/components/schemas/uri-Type' - notificationId: - $ref: '#/components/schemas/notificationId-Type' - notificationType: - $ref: '#/components/schemas/notificationType-Type' - eventTime: - $ref: '#/components/schemas/dateTime-Type' - systemDN: - $ref: '#/components/schemas/systemDN-Type' - required: - - href - - notificationId - - notificationType - - eventTime - - systemDN - scopeType-Type: - type: string - enum: - - BASE_ONLY - - BASE_NTH_LEVEL - - BASE_SUBTREE - - BASE_ALL - scopeLevel-Type: - type: integer - className-PathType: - type: string - id-PathType: - type: string - attributes-QueryType: - type: array - items: - type: string - fields-QueryType: - type: array - items: - type: string - filter-QueryType: - type: string - scope-QueryType: - type: object - properties: - scopeType: - $ref: '#/components/schemas/scopeType-Type' - scopeLevel: - $ref: '#/components/schemas/scopeLevel-Type' - - resourcePut-RequestType: - $ref: '#/components/schemas/resourceRepresentation-Type' - jsonMergePatch-RequestType: - $ref: '#/components/schemas/resourceRepresentation-Type' - 3gppJsonMergePatch-RequestType: - $ref: '#/components/schemas/resourceRepresentation-Type' - jsonPatch-RequestType: - type: array - items: - type: object - 3gppJsonPatch-RequestType: - type: array - items: - type: object - - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - resourceRetrieval-ResponseType: - $ref: '#/components/schemas/resourceRepresentation-Type' - resourceCreation-ResponseType: - $ref: '#/components/schemas/resourceRepresentation-Type' - resourceUpdate-ResponseType: - $ref: '#/components/schemas/resourceRepresentation-Type' - resourceDeletion-ResponseType: - type: array - items: - $ref: '#/components/schemas/uri-Type' - - resourceRepresentation-Type: - oneOf: - - type: object - properties: - id: - type: string - attributes: - type: object - additionalProperties: - type: array - items: - type: object - - anyOf: - - $ref: 'genericNrm.yaml#/components/schemas/resources-genericNrm' - - $ref: 'nrNrm.yaml#/components/schemas/resources-nrNrm' - - $ref: '5gcNrm.yaml#/components/schemas/resources-5gcNrm' - - $ref: 'sliceNrm.yaml#/components/schemas/resources-sliceNrm' - - mOIChange-Type: - type: object - properties: - notificationId: - $ref: '#/components/schemas/notificationId-Type' - correlatedNotifications: - type: array - items: - $ref: '#/components/schemas/correlatedNotification-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' - sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' - path: - $ref: '#/components/schemas/uri-Type' - operation: - type: string - enum: - - CREATE - - DELETE - - REPLACE - value: - oneOf: - - type: object - additionalProperties: - nullable: true - - type: array - items: - type: object - minItems: 1 - maxItems: 2 - - notifyMOICreation-NotifType: - allOf: - - $ref: '#/components/schemas/header-Type' - - type: object - properties: - correlatedNotifications: - type: array - items: - $ref: '#/components/schemas/correlatedNotification-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' - sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' - attributeList: - type: object - additionalProperties: - nullable: true - notifyMOIDeletion-NotifType: - allOf: - - $ref: '#/components/schemas/header-Type' - - type: object - properties: - correlatedNotifications: - type: array - items: - $ref: '#/components/schemas/correlatedNotification-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' - sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' - attributeList: - type: object - additionalProperties: true - notifyMOIAttributeValueChange-NotifType: - allOf: - - $ref: '#/components/schemas/header-Type' - - type: object - properties: - correlatedNotifications: - type: array - items: - $ref: '#/components/schemas/correlatedNotification-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' - sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' - attributeValueChange: - type: object - additionalProperties: - type: array - minItems: 1 - maxItems: 2 - items: - nullable: true - required: - - attributeValueChange - notifyMOIChanges-NotifType: - allOf: - - $ref: '#/components/schemas/header-Type' - - type: object - properties: - mOIChanges: - type: array - items: - $ref: '#/components/schemas/mOIChange-Type' - required: - - mOIChanges diff --git a/OpenAPI/sliceNrm.yaml b/OpenAPI/sliceNrm.yaml deleted file mode 100644 index bf6b4d71c..000000000 --- a/OpenAPI/sliceNrm.yaml +++ /dev/null @@ -1,632 +0,0 @@ -openapi: 3.0.1 -info: - title: Slice NRM - version: 17.4.0 - description: >- - OAS 3.0.1 specification of the Slice NRM - @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.541; 5G NRM, Slice NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ -paths: {} -components: - schemas: - -#------------ Type definitions --------------------------------------------------- - - Float: - type: number - format: float - MobilityLevel: - type: string - enum: - - STATIONARY - - NOMADIC - - RESTRICTED MOBILITY - - FULLY MOBILITY - SynAvailability: - type: string - enum: - - NOT SUPPORTED - - BETWEEN BS AND UE - - BETWEEN BS AND UE & UE AND UE - PositioningAvailability: - type: array - items: - type: string - enum: - - CIDE-CID - - OTDOA - - RF FINGERPRINTING - - AECID - - HYBRID POSITIONING - - NET-RTK - Predictionfrequency: - type: string - enum: - - PERSEC - - PERMIN - - PERHOUR - SharingLevel: - type: string - enum: - - SHARED - - NON-SHARED - - NetworkSliceSharingIndicator: - type: string - enum: - - SHARED - - NON-SHARED - - ServiceType: - type: string - enum: - - eMBB - - RLLC - - MIoT - - V2X - SliceSimultaneousUse: - type: string - enum: - - ZERO - - ONE - - TWO - - THREE - - FOUR - Category: - type: string - enum: - - CHARACTER - - SCALABILITY - Tagging: - type: array - items: - type: string - enum: - - PERFORMANCE - - FUNCTION - - OPERATION - Exposure: - type: string - enum: - - API - - KPI - ServAttrCom: - type: object - properties: - category: - $ref: '#/components/schemas/Category' - tagging: - $ref: '#/components/schemas/Tagging' - exposure: - $ref: '#/components/schemas/Exposure' - Support: - type: string - enum: - - NOT SUPPORTED - - SUPPORTED - DelayTolerance: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - support: - $ref: '#/components/schemas/Support' - DeterministicComm: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - availability: - $ref: '#/components/schemas/Support' - periodicityList: - type: string - XLThpt: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - guaThpt: - $ref: '#/components/schemas/Float' - maxThpt: - $ref: '#/components/schemas/Float' - MaxPktSize: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - maxsize: - type: integer - MaxNumberofPDUSessions: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - nOofPDUSessions: - type: integer - KPIMonitoring: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - kPIList: - type: string - NBIoT: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - support: - $ref: '#/components/schemas/Support' - RadioSpectrum: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - nROperatingBands: - type: string - Synchronicity: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - availability: - $ref: '#/components/schemas/SynAvailability' - accuracy: - $ref: '#/components/schemas/Float' - SynchronicityRANSubnet: - type: object - properties: - availability: - $ref: '#/components/schemas/SynAvailability' - accuracy: - $ref: '#/components/schemas/Float' - Positioning: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - availability: - $ref: '#/components/schemas/PositioningAvailability' - predictionfrequency: - $ref: '#/components/schemas/Predictionfrequency' - accuracy: - $ref: '#/components/schemas/Float' - PositioningRANSubnet: - type: object - properties: - availability: - $ref: '#/components/schemas/PositioningAvailability' - predictionfrequency: - $ref: '#/components/schemas/Predictionfrequency' - accuracy: - $ref: '#/components/schemas/Float' - UserMgmtOpen: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - support: - $ref: '#/components/schemas/Support' - V2XCommModels: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - v2XMode: - $ref: '#/components/schemas/Support' - TermDensity: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - density: - type: integer - NsInfo: - type: object - properties: - nsInstanceId: - type: string - nsName: - type: string - EmbbEEPerfReq: - type: integer - UrllcEEPerfReq: - type: integer - MIoTEEPerfReq: - type: object - properties: - KpiType: - type: string - enum: - - MAXREGSUBS - - MEANACTIVEUES - Req: - type: integer - EEPerfReq: - oneOf: - - $ref: '#/components/schemas/EmbbEEPerfReq' - - $ref: '#/components/schemas/UrllcEEPerfReq' - - $ref: '#/components/schemas/MIoTEEPerfReq' - EnergyEfficiency: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - performance: - $ref: '#/components/schemas/EEPerfReq' - CNSliceSubnetProfile: - type: object - properties: - maxNumberofUEs: - type: integer - latency: - type: integer - dLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - dLThptPerUE: - $ref: '#/components/schemas/XLThpt' - uLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - uLThptPerUE: - $ref: '#/components/schemas/XLThpt' - maxNumberOfPDUSessions: - type: integer - coverageAreaTAList: - type: integer - resourceSharingLevel: - $ref: '#/components/schemas/SharingLevel' - dLMaxPktSize: - type: integer - uLMaxPktSize: - type: integer - delayTolerance: - $ref: '#/components/schemas/DelayTolerance' - synchronicity: - $ref: '#/components/schemas/SynchronicityRANSubnet' - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - reliability: - type: string - energyEfficiency: - type: integer - dLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - uLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - survivalTime: - type: string - RANSliceSubnetProfile: - type: object - properties: - coverageAreaTAList: - type: integer - uEMobilityLevel: - $ref: '#/components/schemas/MobilityLevel' - resourceSharingLevel: - $ref: '#/components/schemas/SharingLevel' - maxNumberofUEs: - type: integer - activityFactor: - type: integer - dLThptPerUE: - $ref: '#/components/schemas/XLThpt' - uLThptPerUE: - $ref: '#/components/schemas/XLThpt' - uESpeed: - type: integer - reliability: - type: string - serviceType: - $ref: '#/components/schemas/ServiceType' - dLMaxPktSize: - type: integer - uLMaxPktSize: - type: integer - nROperatingBands: - type: string - delayTolerance: - $ref: '#/components/schemas/DelayTolerance' - positioning: - $ref: '#/components/schemas/PositioningRANSubnet' - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - energyEfficiency: - type: integer - termDensity: - $ref: '#/components/schemas/TermDensity' - survivalTime: - type: string - synchronicity: - $ref: '#/components/schemas/SynchronicityRANSubnet' - dLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - uLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - TopSliceSubnetProfile: - type: object - properties: - latency: - type: integer - maxNumberofUEs: - type: integer - dLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - dLThptPerUE: - $ref: '#/components/schemas/XLThpt' - uLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - uLThptPerUE: - $ref: '#/components/schemas/XLThpt' - dLMaxPktSize: - type: integer - uLMaxPktSize: - type: integer - maxNumberOfPDUSessions: - type: integer - nROperatingBands: - type: string - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - energyEfficiency: - type: integer - synchronicity: - $ref: '#/components/schemas/Synchronicity' - delayTolerance: - $ref: '#/components/schemas/DelayTolerance' - positioning: - $ref: '#/components/schemas/Positioning' - termDensity: - $ref: '#/components/schemas/TermDensity' - activityFactor: - type: integer - coverageAreaTAList: - type: integer - resourceSharingLevel: - $ref: '#/components/schemas/SharingLevel' - uEMobilityLevel: - $ref: '#/components/schemas/MobilityLevel' - uESpeed: - type: integer - reliability: - type: string - serviceType: - $ref: '#/components/schemas/ServiceType' - dLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - uLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - survivalTime: - type: string - - ServiceProfile: - type: object - properties: - serviceProfileId: - type: string - plmnInfoList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList' - maxNumberofUEs: - type: number - latency: - type: number - uEMobilityLevel: - $ref: '#/components/schemas/MobilityLevel' - sst: - $ref: 'nrNrm.yaml#/components/schemas/Sst' - networkSliceSharingIndicator: - $ref: '#/components/schemas/NetworkSliceSharingIndicator' - availability: - type: number - delayTolerance: - $ref: '#/components/schemas/DelayTolerance' - dLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - uLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - dLThptPerSlice: - $ref: '#/components/schemas/XLThpt' - dLThptPerUE: - $ref: '#/components/schemas/XLThpt' - uLThptPerSlice: - $ref: '#/components/schemas/XLThpt' - uLThptPerUE: - $ref: '#/components/schemas/XLThpt' - dLMaxPktSize: - $ref: '#/components/schemas/MaxPktSize' - uLMaxPktSize: - $ref: '#/components/schemas/MaxPktSize' - maxNumberofPDUSessions: - $ref: '#/components/schemas/MaxNumberofPDUSessions' - kPIMonitoring: - $ref: '#/components/schemas/KPIMonitoring' - nBIoT: - $ref: '#/components/schemas/NBIoT' - radioSpectrum: - $ref: '#/components/schemas/RadioSpectrum' - synchronicity: - $ref: '#/components/schemas/Synchronicity' - positioning: - $ref: '#/components/schemas/Positioning' - userMgmtOpen: - $ref: '#/components/schemas/UserMgmtOpen' - v2XModels: - $ref: '#/components/schemas/V2XCommModels' - coverageArea: - type: string - termDensity: - $ref: '#/components/schemas/TermDensity' - activityFactor: - $ref: '#/components/schemas/Float' - uESpeed: - type: integer - jitter: - type: integer - survivalTime: - type: string - reliability: - type: string - maxDLDataVolume: - type: string - maxULDataVolume: - type: string - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - energyEfficiency: - $ref: '#/components/schemas/EnergyEfficiency' - SliceProfile: - type: object - properties: - serviceProfileId: - type: string - plmnInfoList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList' - cNSliceSubnetProfile: - $ref: '#/components/schemas/CNSliceSubnetProfile' - rANSliceSubnetProfile: - $ref: '#/components/schemas/RANSliceSubnetProfile' - topSliceSubnetProfile: - $ref: '#/components/schemas/TopSliceSubnetProfile' - - IpAddress: - oneOf: - - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' - - LogicInterfaceInfo: - type: object - properties: - logicalInterfceType: - type: string - enum: - - VLAN - - MPLS - - Segment - logicalInterfceId: - type: string - - ServiceProfileList: - type: array - items: - $ref: '#/components/schemas/ServiceProfile' - - SliceProfileList: - type: array - items: - $ref: '#/components/schemas/SliceProfile' - -#------------ Definition of concrete IOCs ---------------------------------------- - SubNetwork-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - NetworkSlice: - $ref: '#/components/schemas/NetworkSlice-Multiple' - NetworkSliceSubnet: - $ref: '#/components/schemas/NetworkSliceSubnet-Multiple' - EP_Transport: - $ref: '#/components/schemas/EP_Transport-Multiple' - - NetworkSlice-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - networkSliceSubnetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - operationalState: - $ref: 'genericNrm.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - serviceProfileList: - $ref: '#/components/schemas/ServiceProfileList' - - NetworkSliceSubnet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - managedFunctionRefList: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - networkSliceSubnetRefList: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - operationalState: - $ref: 'genericNrm.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - nsInfo: - $ref: '#/components/schemas/NsInfo' - sliceProfileList: - $ref: '#/components/schemas/SliceProfileList' - epTransportRefList: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - priorityLabel: - type: integer - - EP_Transport-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - ipAddress: - $ref: '#/components/schemas/IpAddress' - logicInterfaceInfo: - $ref: '#/components/schemas/LogicInterfaceInfo' - nextHopInfo: - type: string - qosProfile: - type: string - epApplicationRefs: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - - NetworkSlice-Multiple: - type: array - items: - $ref: '#/components/schemas/NetworkSlice-Single' - - NetworkSliceSubnet-Multiple: - type: array - items: - $ref: '#/components/schemas/NetworkSliceSubnet-Single' - - EP_Transport-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_Transport-Single' - -#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- - - resources-sliceNrm: - oneOf: - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/NetworkSlice-Single' - - $ref: '#/components/schemas/NetworkSliceSubnet-Single' - - $ref: '#/components/schemas/EP_Transport-Single' diff --git a/OpenAPI/streamingDataMnS.yaml b/OpenAPI/streamingDataMnS.yaml deleted file mode 100644 index ab7f71d4a..000000000 --- a/OpenAPI/streamingDataMnS.yaml +++ /dev/null @@ -1,453 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.532 Streaming data reporting service - version: 16.4.0 - description: OAS 3.0.1 specification for the Streaming data reporting service (Streaming MnS) -servers: - - url: '{protocol}://{root}/StreamingDataReportingMnS/{version}' - variables: - protocol: - description: Protocol used - enum: - - http - - https - - wss - default: https - root: - description: Indicates the host name and optional port, and an optional sequence of path segments that together represent a prefix path. - default: example.com - version: - description: Indicates the current version of the specification - default: 16.4.0 -paths: - '/connections': - post: - summary: Inform consumer about reporting streams to be carried by the new connection and receive a new connection id. - description: Exchange of meta-data (producer informs consumer about its own identity and the nature of the data to be reported via streaming) phase of the connection establishement by streaming data reporting producer to the streaming data reporting consumer (i.e. streaming target). - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/connectionRequest-Type' - responses: - '201': - description: Success case (201 Created). - headers: - Location: - description: Location of the created connection resource. - schema: - $ref: '#/components/schemas/connectionId-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/failedConnectionResponse-Type' - get: - summary: Obtain information about connections. - description: Enables the streaming data reporting service producer to obtain information about one or more streaming connections. - parameters: - - name: connectionIdList - in: query - description: The list of connectionId for which the connection information is to be returned. - required: false - schema: - type: array - items: - $ref: '#/components/schemas/connectionId-Type' - responses: - '200': - description: Success case (200 OK). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned. - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/connectionInfo-Type' - '202': - description: Partial success case (202 Partially retrieved). Subset of the resources identified in the request for retrieval are returned in the response message body. - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/connectionInfo-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' - '/connections/{connectionId}': - get: - summary: Obtain information about a connection. - description: Enables the streaming data reporting service producer to obtain information about one streaming connection. - parameters: - - name: connectionId - in: path - description: Indicate the ID (URI) of the connection for which the information is being retrieved - required: true - schema: - $ref: '#/components/schemas/connectionId-Type' - - name: Connection - in: header - schema: - $ref: '#/components/schemas/websocketHeaderConnection-Type' - - name: Sec-WebSocket-Extensions - in: header - schema: - $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Extensions-Type' - - name: Sec-WebSocket-Key - in: header - schema: - $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Key-Type' - - name: Sec-WebSocket-Protocol - in: header - schema: - $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Protocol-Type' - - name: Sec-WebSocket-Version - in: header - schema: - $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Version-Type' - responses: - '101': - description: Success case (101 Switching Protocols). The connection has been successfully switched to WebSocket. The response message body is absent. - headers: - Upgrade: - schema: - $ref: '#/components/schemas/websocketHeaderUpgrade-Type' - Connection: - schema: - $ref: '#/components/schemas/websocketHeaderConnection-Type' - Sec-WebSocket-Accept: - schema: - $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Accept-Type' - '200': - description: Success case (200 OK). The resource identified in the request for retrieval returned in the response message body. - content: - application/json: - schema: - $ref: '#/components/schemas/connectionInfo-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' - '/connections/{connectionId}/streams': - post: - summary: Inform consumer about new reporting streams on an existing connection. - description: Allows the producer to add one or more reporting streams to an already established streaming connection. - parameters: - - name: connectionId - in: path - description: Indicate the ID (URI) of the connection for which the reporting stream information is being added. - required: true - schema: - $ref: '#/components/schemas/connectionId-Type' - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/streamInfo-Type' - responses: - '201': - description: Success case (201 Posted). - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/streamInfo-Type' - '202': - description: Partial success case (202 Posted). - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/streamInfo-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' - delete: - summary: Remove reporting streams from an existing connection - description: Allows the producer to remove one or more reporting streams from an already established streaming connection. - parameters: - - name: connectionId - in: path - description: Indicate the ID (URI) of the connection for which the reporting stream information is being removed. - required: true - schema: - $ref: '#/components/schemas/connectionId-Type' - - name: streamIds - in: query - description: The list of streamId for the stream(s) to be deleted. - required: true - schema: - type: array - items: - $ref: '#/components/schemas/streamId-Type' - responses: - '204': - description: Success case (204 No Content). The stream information resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' - get: - summary: Obtain information about streams. - description: Enables the streaming data reporting service producer to obtain information about one or more reporting streams. - parameters: - - name: connectionId - in: path - description: Indicate the ID (URI) of the connection for which the information is being retrieved - required: true - schema: - $ref: '#/components/schemas/connectionId-Type' - - name: streamIds - in: query - description: The list of streamId for which the stream information is to be retrieved. - required: true - schema: - type: array - items: - $ref: '#/components/schemas/streamId-Type' - responses: - '200': - description: Success case (200 OK). - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/streamInfoWithReporters-Type' - '202': - description: Partial success case (202 Partially retrieved). - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/streamInfoWithReporters-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' - '/connections/{connectionId}/streams/{streamId}': - get: - summary: Obtain information about stream - description: Enables the streaming data reporting service producer to obtain information about a reporting stream. - parameters: - - name: connectionId - in: path - description: Indicate the ID (URI) of the connection for which the information is being retrieved - required: true - schema: - $ref: '#/components/schemas/connectionId-Type' - - name: streamId - in: path - description: Indicate the ID of the reporting stream for which the information is being retrieved - required: true - schema: - $ref: '#/components/schemas/streamId-Type' - responses: - '200': - description: Success case (200 OK). - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoWithReporters-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' -components: - schemas: - analyticsInfo-Type: - description: Information specific to analytics reporting. - type: object - properties: - activityDetails: - type: string - connectionId-Type: - $ref: '#/components/schemas/uri-Type' - connectionInfo-Type: - type: object - properties: - connection: - $ref: '#/components/schemas/connectionId-Type' - producer: - $ref: '#/components/schemas/producerId-Type' - streams: - type: array - items: - $ref: '#/components/schemas/streamId-Type' - connectionRequest-Type: - type: object - properties: - producer: - $ref: '#/components/schemas/producerId-Type' - streams: - type: array - items: - $ref: '#/components/schemas/streamInfo-Type' - errorResponse-Type: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - failedConnectionResponse-Type: - type: object - properties: - error: - type: array - items: - type: object - properties: - streamId: - $ref: '#/components/schemas/streamId-Type' - errorReason: - type: string - measObjDn-Type: - description: DN of the measured object instance (see 3GPP TS 28.550) - allOf: - - $ref: '#/components/schemas/systemDN-Type' - measTypes-Type: - description: an ordered list of measurement type or KPI whose measurement values or KPI result values are to be reported by the Performance Data Stream Units (see Annex C of TS 28.550) via this stream - type: array - items: - type: string - performanceInfo-Type: - description: Information specific to performance data reporting - type: object - properties: - measObjDn: - $ref: '#/components/schemas/measObjDn-Type' - measTypes: - $ref: '#/components/schemas/measTypes-Type' - measurementReaderId: - $ref: '#/components/schemas/systemDN-Type' - jobId: - type: string - required: - - measObjDn - - measTypes - producerId-Type: - description: DN of the streaming data reporting MnS producer. - allOf: - - $ref: '#/components/schemas/systemDN-Type' - serializationFormat-Type: - type: string - enum: - - GPB - - ASN1 - streamId-Type: - description: globally unique stream identifier - type: string - example: '26F452550021' - streamInfo-Type: - description: Reporting stream meta-data. - type: object - properties: - streamType: - $ref: '#/components/schemas/streamType-Type' - serializationFormat: - $ref: '#/components/schemas/serializationFormat-Type' - streamId: - oneOf: - - $ref: '#/components/schemas/streamId-Type' - - $ref: '#/components/schemas/traceReference-Type' - additionalInfo: - oneOf: - - $ref: '#/components/schemas/traceInfo-Type' - - $ref: '#/components/schemas/performanceInfo-Type' - - $ref: '#/components/schemas/analyticsInfo-Type' - - $ref: '#/components/schemas/vsDataContainer-Type' - required: - - streamType - - serializationFormat - - streamId - streamInfoWithReporters-Type: - description: Reporting stream meta-data with added information about reporters. - type: object - properties: - streamInfo: - $ref: '#/components/schemas/streamInfo-Type' - reporters: - type: array - items: - $ref: '#/components/schemas/producerId-Type' - systemDN-Type: - description: See 3GPP TS 32.300 for details - type: string - example: 'SubNetwork=ABCNetwork,SubNetwork=MUC01,GNBDUFunction=XYZ0100' - streamType-Type: - type: string - enum: - - TRACE - - PERFORMANCE - - ANALYTICS - - PROPRIETARY - traceInfo-Type: - description: Information specific to trace data reporting - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/TraceJob-Attr' - traceReference-Type: - description: Trace Reference (see clause 5.6 of 3GPP TS 32.422) as stream identifier for streaming trace data reporting - type: string - example: '4358070034D7' - uri-Type: - description: Resource URI - type: string - vsDataContainer-Type: - description: container for vendor specific data (see 3GPP TS 28.622) - type: object - properties: - vsDataType: - type: string - vsData: - type: string - vsDataFormatVersion: - type: string - websocketHeaderConnection-Type: - description: Header value for the upgrade request and response. - type: string - enum: - - Upgrade - websocketHeaderUpgrade-Type: - description: Header value for the upgrade to WebSocket request and response. - type: string - enum: - - websocket - websocketHeader-Sec-WebSocket-Accept-Type: - description: Header value for secure WebSocket response. Carries hash. - type: string - websocketHeader-Sec-WebSocket-Extensions-Type: - description: Header value for secure WebSocket request. Carries protocol extensions. - type: string - websocketHeader-Sec-WebSocket-Key-Type: - description: Header value for secure WebSocket request. Provides information to the server which is needed in order to confirm that the client is entitled to request an upgrade to WebSocket. - type: string - websocketHeader-Sec-WebSocket-Protocol-Type: - description: Header value for secure WebSocket request. Carries a comma-separated list of subprotocol names, in the order of preference. - type: string - websocketHeader-Sec-WebSocket-Version-Type: - description: Header value for secure WebSocket request and response. Carries the WebSocket protocol version to be used. - type: string -- GitLab From 224ca3c2e2831351f327a4be0b8c4287387bf231 Mon Sep 17 00:00:00 2001 From: "U-ERICSSON\\ETHBLL" Date: Sun, 2 Jan 2022 18:54:31 +0100 Subject: [PATCH 08/21] del readme from openapi --- OpenAPI/README.md | 73 ----------------------------------------------- 1 file changed, 73 deletions(-) delete mode 100644 OpenAPI/README.md diff --git a/OpenAPI/README.md b/OpenAPI/README.md deleted file mode 100644 index 9de057463..000000000 --- a/OpenAPI/README.md +++ /dev/null @@ -1,73 +0,0 @@ -# 3GPP SA5 models and MnS OpenAPI definitions - -(c) 2020, 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: - - -## Network Resource Models (NRM) - -* Generic NRM (TS 28.623) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/genericNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/genericNrm.yaml)) - -* Common NRM definitions (TS 28.623) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/comDefs.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/comDefs.yaml)) - -* NR NRM (TS 28.541) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/nrNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/nrNrm.yaml)) - -* 5GC NRM (TS 28.541) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/5gcNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/5gcNrm.yaml)) - -* Slice NRM (TS 28.541) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/sliceNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/sliceNrm.yaml)) - -* Communication Service Assurance NRM (TS 28.536) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/coslaNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/coslaNrm.yaml)) - -## Management Services (MnS) - -* Provisioning MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/provMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/provMnS.yaml)) - -* Fault Supervision MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/faultMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/faultMnS.yaml)) - -* Performance Measurement Job Control MnS (28.550) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerMeasJobCtlMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerMeasJobCtlMnS.yaml)) - -* Performance Data File Reporting MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerDataFileReportMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerDataFileReportMnS.yaml)) - -* Performance Threshold Monitoring MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerThresMonMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerThresMonMnS.yaml)) - -* Heartbeat Notifications(TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/heartbeatNtf.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/heartbeatNtf.yaml)) - -* Streaming Data Reporting MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/streamingDataMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/streamingDataMnS.yaml)) - -## Tools - -* [Frontend](https://forge.3gpp.org/swagger/tools/GitlabOpenAPIFrontend.htm) to invoke the Swagger Editor, Swagger UI, or to parse OpenAPI files with APIDevTools Swagger Parser/Validator, or to search for APIs referencing a data structure -* [API Parser/Linter](https://forge.3gpp.org/swagger/tools/parser.html) to parse OpenAPI files with APIDevTools Swagger Parser/Validator and run a number of [lint](https://en.wikipedia.org/wiki/Lint_\(software\)) rules to improve API quality -* [Data Type Finder](https://forge.3gpp.org/swagger/tools/types.html) to find the impacted APIs due to a change on a given data type -* [API Versions Overview](https://forge.3gpp.org/swagger/tools/versions.html) to show a comprehensive report of the versions of all APIs in the repository - -## Other 3GPP API definitions - -* [CT4](https://forge.3gpp.org/rep/3GPP/5G_APIs) specifications. -- GitLab From 73486562698ca155105a6687c32d6d1d0cad53de Mon Sep 17 00:00:00 2001 From: "U-ERICSSON\\ETHBLL" Date: Sun, 2 Jan 2022 18:57:24 +0100 Subject: [PATCH 09/21] add back OpenApi from Rel17-draft --- OpenAPI/5gcNrm.yaml | 2185 +++++++++++++++++++++++++++++ OpenAPI/PerDataFileReportMnS.yaml | 13 + OpenAPI/PerMeasJobCtlMnS.yaml | 280 ++++ OpenAPI/PerThresMonMnS.yaml | 102 ++ OpenAPI/PerfDataStreamingMnS.yaml | 363 +++++ OpenAPI/README.md | 73 + OpenAPI/comDefs.yaml | 84 ++ OpenAPI/coslaNrm.yaml | 168 +++ OpenAPI/faultMnS.yaml | 1144 +++++++++++++++ OpenAPI/genericNrm.yaml | 1606 +++++++++++++++++++++ OpenAPI/heartbeatNtf.yaml | 23 + OpenAPI/nrNrm.yaml | 1905 +++++++++++++++++++++++++ OpenAPI/provMnS.yaml | 579 ++++++++ OpenAPI/sliceNrm.yaml | 632 +++++++++ OpenAPI/streamingDataMnS.yaml | 453 ++++++ 15 files changed, 9610 insertions(+) create mode 100644 OpenAPI/5gcNrm.yaml create mode 100644 OpenAPI/PerDataFileReportMnS.yaml create mode 100644 OpenAPI/PerMeasJobCtlMnS.yaml create mode 100644 OpenAPI/PerThresMonMnS.yaml create mode 100644 OpenAPI/PerfDataStreamingMnS.yaml create mode 100644 OpenAPI/README.md create mode 100644 OpenAPI/comDefs.yaml create mode 100644 OpenAPI/coslaNrm.yaml create mode 100644 OpenAPI/faultMnS.yaml create mode 100644 OpenAPI/genericNrm.yaml create mode 100644 OpenAPI/heartbeatNtf.yaml create mode 100644 OpenAPI/nrNrm.yaml create mode 100644 OpenAPI/provMnS.yaml create mode 100644 OpenAPI/sliceNrm.yaml create mode 100644 OpenAPI/streamingDataMnS.yaml diff --git a/OpenAPI/5gcNrm.yaml b/OpenAPI/5gcNrm.yaml new file mode 100644 index 000000000..e4c4b2619 --- /dev/null +++ b/OpenAPI/5gcNrm.yaml @@ -0,0 +1,2185 @@ +openapi: 3.0.1 +info: + title: 3GPP 5GC NRM + version: 17.4.0 + description: >- + OAS 3.0.1 specification of the 5GC NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.541; 5G NRM, 5GC NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + AmfIdentifier: + type: object + description: 'AmfIdentifier comprise of amfRegionId, amfSetId and amfPointer' + properties: + amfRegionId: + $ref: '#/components/schemas/AmfRegionId' + amfSetId: + $ref: '#/components/schemas/AmfSetId' + amfPointer: + $ref: '#/components/schemas/AmfPointer' + AmfRegionId: + type: integer + description: AmfRegionId is defined in TS 23.003 + maximum: 255 + AmfSetId: + type: string + description: AmfSetId is defined in TS 23.003 + maximum: 1023 + AmfPointer: + type: integer + description: AmfPointer is defined in TS 23.003 + maximum: 63 + IpEndPoint: + type: object + properties: + ipv4Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + ipv6Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + ipv6Prefix: + $ref: 'genericNrm.yaml#/components/schemas/Ipv6Prefix' + transport: + $ref: 'genericNrm.yaml#/components/schemas/TransportProtocol' + port: + type: integer + NFProfileList: + type: array + description: List of NF profile + items: + $ref: '#/components/schemas/NFProfile' + NFProfile: + type: object + description: 'NF profile stored in NRF, defined in TS 29.510' + properties: + nFInstanceId: + type: string + description: uuid of NF instance + nFType: + $ref: 'genericNrm.yaml#/components/schemas/NFType' + nFStatus: + $ref: '#/components/schemas/NFStatus' + plmn: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + sNssais: + $ref: 'nrNrm.yaml#/components/schemas/Snssai' + fqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + nfServices: + type: array + items: + $ref: '#/components/schemas/NFService' + NFService: + type: object + description: NF Service is defined in TS 29.510 + properties: + serviceInstanceId: + type: string + serviceName: + type: string + version: + type: string + schema: + type: string + fqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + ipEndPoints: + type: array + items: + $ref: '#/components/schemas/IpEndPoint' + apiPrfix: + type: string + allowedPlmns: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + allowedNfTypes: + type: array + items: + $ref: 'genericNrm.yaml#/components/schemas/NFType' + allowedNssais: + type: array + items: + $ref: 'nrNrm.yaml#/components/schemas/Snssai' + NFStatus: + type: string + description: any of enumrated value + enum: + - REGISTERED + - SUSPENDED + CNSIIdList: + type: array + items: + $ref: '#/components/schemas/CNSIId' + CNSIId: + type: string + description: CNSI Id is defined in TS 29.531, only for Core Network + TACList: + type: array + items: + $ref: 'nrNrm.yaml#/components/schemas/NrTac' + WeightFactor: + type: integer + UdmInfo: + type: object + properties: + nFSrvGroupId: + type: string + AusfInfo: + type: object + properties: + nFSrvGroupId: + type: string + UpfInfo: + type: object + properties: + smfServingAreas: + type: string + AmfInfo: + type: object + properties: + priority: + type: integer + SupportedDataSetId: + type: string + description: any of enumrated value + enum: + - SUBSCRIPTION + - POLICY + - EXPOSURE + - APPLICATION + Udrinfo: + type: object + properties: + supportedDataSetIds: + type: array + items: + $ref: '#/components/schemas/SupportedDataSetId' + nFSrvGroupId: + type: string + NFInfo: + oneOf: + - $ref: '#/components/schemas/UdmInfo' + - $ref: '#/components/schemas/AusfInfo' + - $ref: '#/components/schemas/UpfInfo' + - $ref: '#/components/schemas/AmfInfo' + - $ref: '#/components/schemas/Udrinfo' + ManagedNFProfile: + type: object + properties: + nfInstanceID: + type: string + nfType: + $ref: 'genericNrm.yaml#/components/schemas/NFType' + authzInfo: + type: string + hostAddr: + $ref: 'genericNrm.yaml#/components/schemas/HostAddr' + locality: + type: string + nFInfo: + $ref: '#/components/schemas/NFInfo' + capacity: + type: integer + SEPPType: + type: string + description: any of enumrated value + enum: + - CSEPP + - PSEPP + SupportedFunc: + type: object + properties: + function: + type: string + policy: + type: string + SupportedFuncList: + type: array + items: + $ref: '#/components/schemas/SupportedFunc' + CommModelType: + type: string + description: any of enumrated value + enum: + - DIRECT_COMMUNICATION_WO_NRF + - DIRECT_COMMUNICATION_WITH_NRF + - INDIRECT_COMMUNICATION_WO_DEDICATED_DISCOVERY + - INDIRECT_COMMUNICATION_WITH_DEDICATED_DISCOVERY + CommModel: + type: object + properties: + groupId: + type: integer + commModelType: + $ref: '#/components/schemas/CommModelType' + targetNFServiceList: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + commModelConfiguration: + type: string + CommModelList: + type: array + items: + $ref: '#/components/schemas/CommModel' + CapabilityList: + type: array + items: + type: string + FiveQiDscpMapping: + type: object + properties: + fiveQIValues: + type: array + items: + type: integer + dscp: + type: integer + NetworkSliceInfo: + type: object + properties: + sNSSAI: + $ref: 'nrNrm.yaml#/components/schemas/Snssai' + cNSIId: + $ref: '#/components/schemas/CNSIId' + networkSliceRef: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + NetworkSliceInfoList: + type: array + items: + $ref: '#/components/schemas/NetworkSliceInfo' + + + PacketErrorRate: + type: object + properties: + scalar: + type: integer + exponent: + type: integer + + + + GtpUPathDelayThresholdsType: + type: object + properties: + n3AveragePacketDelayThreshold: + type: integer + n3MinPacketDelayThreshold: + type: integer + n3MaxPacketDelayThreshold: + type: integer + n9AveragePacketDelayThreshold: + type: integer + n9MinPacketDelayThreshold: + type: integer + n9MaxPacketDelayThreshold: + type: integer + QFPacketDelayThresholdsType: + type: object + properties: + thresholdDl: + type: integer + thresholdUl: + type: integer + thresholdRtt: + type: integer + + QosData: + type: object + properties: + qosId: + type: string + fiveQIValue: + type: integer + maxbrUl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxbrDl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrUl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrDl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' + arp: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Arp' + qosNotificationControl: + type: boolean + reflectiveQos: + type: boolean + sharingKeyDl: + type: string + sharingKeyUl: + type: string + maxPacketLossRateDl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPacketLossRateUl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + extMaxDataBurstVol: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + + QosDataList: + type: array + items: + $ref: '#/components/schemas/QosData' + + SteeringMode: + type: object + properties: + steerModeValue: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteerModeValue' + active: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessType' + standby: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessTypeRm' + threeGLoad: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Uinteger' + prioAcc: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessType' + + TrafficControlData: + type: object + properties: + tcId: + type: string + flowStatus: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus' + redirectInfo: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' + addRedirectInfo: + type: array + items: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' + minItems: 1 + muteNotif: + type: boolean + trafficSteeringPolIdDl: + type: string + nullable: true + trafficSteeringPolIdUl: + type: string + nullable: true + routeToLocs: + type: array + items: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + traffCorreInd: + type: boolean + upPathChgEvent: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' + steerFun: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringFunctionality' + steerModeDl: + $ref: '#/components/schemas/SteeringMode' + steerModeUl: + $ref: '#/components/schemas/SteeringMode' + mulAccCtrl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/MulticastAccessControl' + + TrafficControlDataList: + type: array + items: + $ref: '#/components/schemas/TrafficControlData' + + PccRule: + type: object + properties: + pccRuleId: + type: string + description: Univocally identifies the PCC rule within a PDU session. + flowInfoList: + type: array + items: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' + applicationId: + type: string + appDescriptor: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ApplicationDescriptor' + contentVersion: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' + precedence: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Uinteger' + afSigProtocol: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' + isAppRelocatable: + type: boolean + isUeAddrPreserved: + type: boolean + qosData: + type: array + items: + $ref: '#/components/schemas/QosDataList' + altQosParams: + type: array + items: + $ref: '#/components/schemas/QosDataList' + trafficControlData: + type: array + items: + $ref: '#/components/schemas/TrafficControlDataList' + conditionData: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ConditionData' + tscaiInputDl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + + SnssaiInfo: + type: object + properties: + plmnInfo: + $ref: 'nrNrm.yaml#/components/schemas/PlmnInfo' + administrativeState: + $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' + + NsacfInfoSnssai: + type: object + properties: + SnssaiInfo: + $ref: '#/components/schemas/SnssaiInfo' + isSubjectToNsac: + type: boolean + maxNumberofUEs: + type: integer + eACMode: + type: string + enum: + - INACTIVE + - ACTIVE + activeEacThreshhold: + type: integer + deactiveEacThreshhold: + type: integer + numberofUEs: + type: integer + uEIdList: + type: array + items: + type: string + + +#-------- Definition of concrete IOCs -------------------------------------------- + + SubNetwork-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + ExternalAmfFunction: + $ref: '#/components/schemas/ExternalAmfFunction-Multiple' + ExternalNrfFunction: + $ref: '#/components/schemas/ExternalNrfFunction-Multiple' + ExternalNssfFunction: + $ref: '#/components/schemas/ExternalNssfFunction-Multiple' + AmfSet: + $ref: '#/components/schemas/AmfSet-Multiple' + AmfRegion: + $ref: '#/components/schemas/AmfRegion-Multiple' + Configurable5QISet: + $ref: '#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '#/components/schemas/Dynamic5QISet-Multiple' + + ManagedElement-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' + - type: object + properties: + AmfFunction: + $ref: '#/components/schemas/AmfFunction-Multiple' + SmfFunction: + $ref: '#/components/schemas/SmfFunction-Multiple' + UpfFunction: + $ref: '#/components/schemas/UpfFunction-Multiple' + N3iwfFunction: + $ref: '#/components/schemas/N3iwfFunction-Multiple' + PcfFunction: + $ref: '#/components/schemas/PcfFunction-Multiple' + AusfFunction: + $ref: '#/components/schemas/AusfFunction-Multiple' + UdmFunction: + $ref: '#/components/schemas/UdmFunction-Multiple' + UdrFunction: + $ref: '#/components/schemas/UdrFunction-Multiple' + UdsfFunction: + $ref: '#/components/schemas/UdsfFunction-Multiple' + NrfFunction: + $ref: '#/components/schemas/NrfFunction-Multiple' + NssfFunction: + $ref: '#/components/schemas/NssfFunction-Multiple' + SmsfFunction: + $ref: '#/components/schemas/SmsfFunction-Multiple' + LmfFunction: + $ref: '#/components/schemas/LmfFunction-Multiple' + NgeirFunction: + $ref: '#/components/schemas/NgeirFunction-Multiple' + SeppFunction: + $ref: '#/components/schemas/SeppFunction-Multiple' + NwdafFunction: + $ref: '#/components/schemas/NwdafFunction-Multiple' + ScpFunction: + $ref: '#/components/schemas/ScpFunction-Multiple' + NefFunction: + $ref: '#/components/schemas/NefFunction-Multiple' + Configurable5QISet: + $ref: '#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '#/components/schemas/Dynamic5QISet-Multiple' + + AmfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + amfIdentifier: + $ref: '#/components/schemas/AmfIdentifier' + sBIFqdn: + type: string + weightFactor: + $ref: '#/components/schemas/WeightFactor' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + amfSet: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N2: + $ref: '#/components/schemas/EP_N2-Multiple' + EP_N8: + $ref: '#/components/schemas/EP_N8-Multiple' + EP_N11: + $ref: '#/components/schemas/EP_N11-Multiple' + EP_N12: + $ref: '#/components/schemas/EP_N12-Multiple' + EP_N14: + $ref: '#/components/schemas/EP_N14-Multiple' + EP_N15: + $ref: '#/components/schemas/EP_N15-Multiple' + EP_N17: + $ref: '#/components/schemas/EP_N17-Multiple' + EP_N20: + $ref: '#/components/schemas/EP_N20-Multiple' + EP_N22: + $ref: '#/components/schemas/EP_N22-Multiple' + EP_N26: + $ref: '#/components/schemas/EP_N26-Multiple' + EP_NLS: + $ref: '#/components/schemas/EP_NLS-Multiple' + EP_NLG: + $ref: '#/components/schemas/EP_NLG-Multiple' + AmfSet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + amfSetId: + $ref: '#/components/schemas/AmfSetId' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + AmfRegion-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + amfRegionId: + $ref: '#/components/schemas/AmfRegionId' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + SmfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + configurable5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + EP_N7: + $ref: '#/components/schemas/EP_N7-Multiple' + EP_N10: + $ref: '#/components/schemas/EP_N10-Multiple' + EP_N11: + $ref: '#/components/schemas/EP_N11-Multiple' + EP_N16: + $ref: '#/components/schemas/EP_N16-Multiple' + EP_S5C: + $ref: '#/components/schemas/EP_S5C-Multiple' + FiveQiDscpMappingSet: + $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' + GtpUPathQoSMonitoringControl: + $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' + QFQoSMonitoringControl: + $ref: '#/components/schemas/QFQoSMonitoringControl-Single' + PredefinedPccRuleSet: + $ref: '#/components/schemas/PredefinedPccRuleSet-Single' + + UpfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N3: + $ref: '#/components/schemas/EP_N3-Multiple' + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + EP_N6: + $ref: '#/components/schemas/EP_N6-Multiple' + EP_N9: + $ref: '#/components/schemas/EP_N9-Multiple' + EP_S5U: + $ref: '#/components/schemas/EP_S5U-Multiple' + N3iwfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N3: + $ref: '#/components/schemas/EP_N3-Multiple' + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + PcfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + configurable5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N5: + $ref: '#/components/schemas/EP_N5-Multiple' + EP_N7: + $ref: '#/components/schemas/EP_N7-Multiple' + EP_N15: + $ref: '#/components/schemas/EP_N15-Multiple' + EP_N16: + $ref: '#/components/schemas/EP_N16-Multiple' + EP_Rx: + $ref: '#/components/schemas/EP_Rx-Multiple' + PredefinedPccRuleSet: + $ref: '#/components/schemas/PredefinedPccRuleSet-Single' + + AusfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N12: + $ref: '#/components/schemas/EP_N12-Multiple' + EP_N13: + $ref: '#/components/schemas/EP_N13-Multiple' + UdmFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N8: + $ref: '#/components/schemas/EP_N8-Multiple' + EP_N10: + $ref: '#/components/schemas/EP_N10-Multiple' + EP_N13: + $ref: '#/components/schemas/EP_N13-Multiple' + UdrFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + UdsfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + NrfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + nFProfileList: + $ref: '#/components/schemas/NFProfileList' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N27: + $ref: '#/components/schemas/EP_N27-Multiple' + NssfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + nFProfileList: + $ref: '#/components/schemas/NFProfileList' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N22: + $ref: '#/components/schemas/EP_N22-Multiple' + EP_N31: + $ref: '#/components/schemas/EP_N31-Multiple' + SmsfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N20: + $ref: '#/components/schemas/EP_N20-Multiple' + EP_N21: + $ref: '#/components/schemas/EP_N21-Multiple' + EP_MAP_SMSC: + $ref: '#/components/schemas/EP_MAP_SMSC-Multiple' + LmfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_NLS: + $ref: '#/components/schemas/EP_NLS-Multiple' + NgeirFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N17: + $ref: '#/components/schemas/EP_N17-Multiple' + SeppFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnId: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + sEPPType: + $ref: '#/components/schemas/SEPPType' + sEPPId: + type: integer + fqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N32: + $ref: '#/components/schemas/EP_N32-Multiple' + NwdafFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + networkSliceInfoList: + $ref: '#/components/schemas/NetworkSliceInfoList' + + ScpFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + supportedFuncList: + $ref: '#/components/schemas/SupportedFuncList' + address: + $ref: 'genericNrm.yaml#/components/schemas/HostAddr' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + NefFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + capabilityList: + $ref: '#/components/schemas/CapabilityList' + isCAPIFSup: + type: boolean + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N33: + $ref: '#/components/schemas/EP_N33-Multiple' + NsacfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + nsacfInfoSnssai: + type: array + items: + $ref: '#/components/schemas/NsacfInfoSnssai' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N60: + $ref: '#/components/schemas/EP_N60-Multiple' + + DDNMFFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnId: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N64: + $ref: '#/components/schemas/EP_N64-Multiple' + EP_N65: + $ref: '#/components/schemas/EP_N65-Multiple' + EP_N66: + $ref: '#/components/schemas/EP_N66-Multiple' + + ExternalAmfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + amfIdentifier: + $ref: '#/components/schemas/AmfIdentifier' + ExternalNrfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + ExternalNssfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + ExternalSeppFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnId: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + sEPPId: + type: integer + fqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + + + EP_N2-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N3-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + epTransportRefs: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + EP_N4-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N5-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N6-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N7-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N8-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N9-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N10-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N11-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N12-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N13-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N14-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N15-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N16-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N17-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N20-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N21-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N22-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N26-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N27-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + + EP_N31-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N32-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + remotePlmnId: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + remoteSeppAddress: + $ref: 'genericNrm.yaml#/components/schemas/HostAddr' + remoteSeppId: + type: integer + n32cParas: + type: string + n32fPolicy: + type: string + withIPX: + type: boolean + EP_N33-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_S5C-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_S5U-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_Rx-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_MAP_SMSC-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_NLS-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_NLG-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N60-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N64-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N65-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N66-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + FiveQiDscpMappingSet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + FiveQiDscpMappingList: + type: array + items: + $ref: '#/components/schemas/FiveQiDscpMapping' + + FiveQICharacteristics-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + fiveQIValue: + type: integer + resourceType: + type: string + enum: + - GBR + - NonGBR + priorityLevel: + type: integer + packetDelayBudget: + type: integer + packetErrorRate: + $ref: '#/components/schemas/PacketErrorRate' + averagingWindow: + type: integer + maximumDataBurstVolume: + type: integer + FiveQICharacteristics-Multiple: + type: array + items: + $ref: '#/components/schemas/FiveQICharacteristics-Single' + Configurable5QISet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + configurable5QIs: + type: array + items: + $ref: '#/components/schemas/FiveQICharacteristics-Multiple' + + Dynamic5QISet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + dynamic5QIs: + type: array + items: + $ref: '#/components/schemas/FiveQICharacteristics-Multiple' + + GtpUPathQoSMonitoringControl-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + gtpUPathQoSMonitoringState: + type: string + enum: + - ENABLED + - DISABLED + gtpUPathMonitoredSNSSAIs: + type: array + items: + $ref: 'nrNrm.yaml#/components/schemas/Snssai' + monitoredDSCPs: + type: array + items: + type: integer + minimum: 0 + maximum: 255 + isEventTriggeredGtpUPathMonitoringSupported: + type: boolean + isPeriodicGtpUMonitoringSupported: + type: boolean + isImmediateGtpUMonitoringSupported: + type: boolean + gtpUPathDelayThresholds: + $ref: '#/components/schemas/GtpUPathDelayThresholdsType' + gtpUPathMinimumWaitTime: + type: integer + gtpUPathMeasurementPeriod: + type: integer + + QFQoSMonitoringControl-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + qFQoSMonitoringState: + type: string + enum: + - ENABLED + - DISABLED + qFMonitoredSNSSAIs: + type: array + items: + $ref: 'nrNrm.yaml#/components/schemas/Snssai' + qFMonitored5QIs: + type: array + items: + type: integer + minimum: 0 + maximum: 255 + isEventTriggeredQFMonitoringSupported: + type: boolean + isPeriodicQFMonitoringSupported: + type: boolean + isSessionReleasedQFMonitoringSupported: + type: boolean + qFPacketDelayThresholds: + $ref: '#/components/schemas/QFPacketDelayThresholdsType' + qFMinimumWaitTime: + type: integer + qFMeasurementPeriod: + type: integer + + PredefinedPccRuleSet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + predefinedPccRules: + type: array + items: + $ref: '#/components/schemas/PccRule' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + ManagedElement-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedElement-Single' + AmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfFunction-Single' + SmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SmfFunction-Single' + UpfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UpfFunction-Single' + N3iwfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/N3iwfFunction-Single' + PcfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/PcfFunction-Single' + AusfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AusfFunction-Single' + UdmFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdmFunction-Single' + UdrFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdrFunction-Single' + UdsfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdsfFunction-Single' + NrfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NrfFunction-Single' + NssfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NssfFunction-Single' + SmsfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SmsfFunction-Single' + LmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/LmfFunction-Single' + NgeirFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NgeirFunction-Single' + SeppFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SeppFunction-Single' + NwdafFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NwdafFunction-Single' + ScpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ScpFunction-Single' + NefFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NefFunction-Single' + + NsacfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NsacfFunction-Single' + + ExternalAmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalAmfFunction-Single' + ExternalNrfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalNrfFunction-Single' + ExternalNssfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalNssfFunction-Single' + ExternalSeppFunction-Nultiple: + type: array + items: + $ref: '#/components/schemas/ExternalSeppFunction-Single' + + AmfSet-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfSet-Single' + AmfRegion-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfRegion-Single' + + EP_N2-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N2-Single' + EP_N3-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N3-Single' + EP_N4-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N4-Single' + EP_N5-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N5-Single' + EP_N6-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N6-Single' + EP_N7-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N7-Single' + EP_N8-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N8-Single' + EP_N9-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N9-Single' + EP_N10-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N10-Single' + EP_N11-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N11-Single' + EP_N12-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N12-Single' + EP_N13-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N13-Single' + EP_N14-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N14-Single' + EP_N15-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N15-Single' + EP_N16-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N16-Single' + EP_N17-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N17-Single' + + EP_N20-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N20-Single' + EP_N21-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N21-Single' + EP_N22-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N22-Single' + + EP_N26-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N26-Single' + EP_N27-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N27-Single' + + EP_N31-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N31-Single' + EP_N32-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N32-Single' + EP_N33-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N33-Single' + EP_S5C-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_S5C-Single' + EP_S5U-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_S5U-Single' + EP_Rx-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Rx-Single' + EP_MAP_SMSC-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_MAP_SMSC-Single' + EP_NLS-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NLS-Single' + EP_NLG-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NLG-Single' + EP_N60-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N60-Single' + EP_N64-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N64-Single' + EP_N65-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N65-Single' + EP_N66-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N66-Single' + Configurable5QISet-Multiple: + type: array + items: + $ref: '#/components/schemas/Configurable5QISet-Single' + Dynamic5QISet-Multiple: + type: array + items: + $ref: '#/components/schemas/Dynamic5QISet-Single' + + + +#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- + + resources-5gcNrm: + oneOf: + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' + - $ref: '#/components/schemas/AmfFunction-Single' + - $ref: '#/components/schemas/SmfFunction-Single' + - $ref: '#/components/schemas/UpfFunction-Single' + - $ref: '#/components/schemas/N3iwfFunction-Single' + - $ref: '#/components/schemas/PcfFunction-Single' + - $ref: '#/components/schemas/AusfFunction-Single' + - $ref: '#/components/schemas/UdmFunction-Single' + - $ref: '#/components/schemas/UdrFunction-Single' + - $ref: '#/components/schemas/UdsfFunction-Single' + - $ref: '#/components/schemas/NrfFunction-Single' + - $ref: '#/components/schemas/NssfFunction-Single' + - $ref: '#/components/schemas/SmsfFunction-Single' + - $ref: '#/components/schemas/LmfFunction-Single' + - $ref: '#/components/schemas/NgeirFunction-Single' + - $ref: '#/components/schemas/SeppFunction-Single' + - $ref: '#/components/schemas/NwdafFunction-Single' + - $ref: '#/components/schemas/ScpFunction-Single' + - $ref: '#/components/schemas/NefFunction-Single' + - $ref: '#/components/schemas/NsacfFunction-Single' + + - $ref: '#/components/schemas/ExternalAmfFunction-Single' + - $ref: '#/components/schemas/ExternalNrfFunction-Single' + - $ref: '#/components/schemas/ExternalNssfFunction-Single' + - $ref: '#/components/schemas/ExternalSeppFunction-Single' + + - $ref: '#/components/schemas/AmfSet-Single' + - $ref: '#/components/schemas/AmfRegion-Single' + - $ref: '#/components/schemas/QFQoSMonitoringControl-Single' + - $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' + + - $ref: '#/components/schemas/EP_N2-Single' + - $ref: '#/components/schemas/EP_N3-Single' + - $ref: '#/components/schemas/EP_N4-Single' + - $ref: '#/components/schemas/EP_N5-Single' + - $ref: '#/components/schemas/EP_N6-Single' + - $ref: '#/components/schemas/EP_N7-Single' + - $ref: '#/components/schemas/EP_N8-Single' + - $ref: '#/components/schemas/EP_N9-Single' + - $ref: '#/components/schemas/EP_N10-Single' + - $ref: '#/components/schemas/EP_N11-Single' + - $ref: '#/components/schemas/EP_N12-Single' + - $ref: '#/components/schemas/EP_N13-Single' + - $ref: '#/components/schemas/EP_N14-Single' + - $ref: '#/components/schemas/EP_N15-Single' + - $ref: '#/components/schemas/EP_N16-Single' + - $ref: '#/components/schemas/EP_N17-Single' + + - $ref: '#/components/schemas/EP_N20-Single' + - $ref: '#/components/schemas/EP_N21-Single' + - $ref: '#/components/schemas/EP_N22-Single' + + - $ref: '#/components/schemas/EP_N26-Single' + - $ref: '#/components/schemas/EP_N27-Single' + + - $ref: '#/components/schemas/EP_N31-Single' + - $ref: '#/components/schemas/EP_N32-Single' + - $ref: '#/components/schemas/EP_N33-Single' + - $ref: '#/components/schemas/EP_N60-Single' + + - $ref: '#/components/schemas/EP_S5C-Single' + - $ref: '#/components/schemas/EP_S5U-Single' + - $ref: '#/components/schemas/EP_Rx-Single' + - $ref: '#/components/schemas/EP_MAP_SMSC-Single' + - $ref: '#/components/schemas/EP_NLS-Single' + - $ref: '#/components/schemas/EP_NLG-Single' + - $ref: '#/components/schemas/Configurable5QISet-Single' + - $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' + - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' + - $ref: '#/components/schemas/Dynamic5QISet-Single' diff --git a/OpenAPI/PerDataFileReportMnS.yaml b/OpenAPI/PerDataFileReportMnS.yaml new file mode 100644 index 000000000..83fd77acb --- /dev/null +++ b/OpenAPI/PerDataFileReportMnS.yaml @@ -0,0 +1,13 @@ +openapi: 3.0.1 +info: + title: TS 28.532 File data reporting Service + version: 16.6.0 + description: >- + OAS 3.0.1 specification of the File data reporting Management Service © 2020, + 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All + rights reserved. +externalDocs: + description: 3GPP TS 28.532 V16.5.0; Generic management services + url: 'http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/' +paths: {} + diff --git a/OpenAPI/PerMeasJobCtlMnS.yaml b/OpenAPI/PerMeasJobCtlMnS.yaml new file mode 100644 index 000000000..b6abe58b2 --- /dev/null +++ b/OpenAPI/PerMeasJobCtlMnS.yaml @@ -0,0 +1,280 @@ +openapi: 3.0.1 +info: + title: TS 28.550 Performance Measurement Job Control Service + version: 16.5.0 + description: >- + OAS 3.0.1 specification of the Performance Measurement Job Control Service + @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.550 V16.5.0; Performance assurance + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.550/ +servers: + - url: 'http://{URI-DN-prefix}/{root}/PerfMeasJobCtrlMnS/v1650/{LDN-first-part}' + variables: + URI-DN-prefix: + description: See subclause 4.4 of TS 32.158 + default: example.com + root: + description: See subclause 4.4 of TS 32.158 + default: 3GPPManagement + LDN-first-part: + description: See subclause 4.4 of TS 32.158 + default: '' +paths: + /measJobs: + post: + summary: Create a measurement job + description: To create a measurement job the representation of the measurement job is POSTed on the /measJobs collection resource. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/measJobCreation-RequestType' + responses: + '201': + description: Success case ("201 Created"). The representation of the newly created measurement job resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/measJobCreation-ResponseType' + '202': + description: Partial success case ("202 Partically created"). The representation of the newly created measurement job resource with unsupported list shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/measJobCreation-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + get: + summary: Read resources of measurement jobs + description: 'With HTTP GET, resources of measurement jobs are read. The resources to be read are identified with the path component (base resource) and the query component (jobIdList) of the URI. The fields query component allows to select the resource properties to be returned.' + parameters: + - name: jobIdList + in: query + description: This parameter identifies the list of jobId to select the resources from the collection resources identified with the path component of the URI. + required: true + schema: + type: array + items: + type: string + responses: + '200': + description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.' + content: + application/json: + schema: + $ref: '#/components/schemas/measJobsRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + '/measJobs/{jobId}': + get: + summary: Read resource of a single measurement job + description: 'With HTTP GET, resource of a measurement job is read. The resource to be read is identified with the path component of the URI.' + parameters: + - name: jobId + in: path + description: Identifies the measurement job to be read. + required: true + schema: + $ref: '#/components/schemas/uri-Type' + responses: + '200': + description: 'Success case ("200 OK"). The resource identified in the path for retrieval is returned in the response message body. ' + content: + application/json: + schema: + $ref: '#/components/schemas/measJobsRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + delete: + summary: Delete a single measurement job + description: The measurement job is deleted by deleting the corresponding measurement job resource. The resource to be deleted is identified with the path component of the URI. + parameters: + - name: jobId + in: path + description: Identifies the measurement job to be deleted. + required: true + schema: + $ref: '#/components/schemas/uri-Type' + responses: + '204': + description: Success case ("204 No Content"). The measurement job resource has been deleted. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' +components: + schemas: + dateTime-Type: + type: string + format: date-Time + uri-Type: + type: string + measJobCreation-RequestType: + type: object + properties: + iOCName: + type: string + iOCInstanceList: + type: array + items: + $ref: '#/components/schemas/uri-Type' + measurementCategoryList: + type: array + items: + type: string + reportingMethod: + $ref: '#/components/schemas/reportingMethod-Type' + granularityPeriod: + type: integer + reportingPeriod: + type: integer + startTime: + $ref: '#/components/schemas/dateTime-Type' + stopTime: + $ref: '#/components/schemas/dateTime-Type' + schedule: + $ref: '#/components/schemas/schedule-Type' + streamTarget: + type: string + priority: + $ref: '#/components/schemas/priority-Type' + reliability: + type: string + measJobCreation-ResponseType: + type: object + properties: + unsupportedList: + type: array + items: + $ref: '#/components/schemas/unsupportedMeas-Type' + measJobsRetrieval-ResponseType: + type: object + properties: + jobInfoList: + type: array + items: + $ref: '#/components/schemas/measJobInfo-ResourceType' + error-ResponseType: + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + measJobInfo-ResourceType: + type: object + properties: + href: + $ref: '#/components/schemas/uri-Type' + iOCName: + type: string + iOCInstanceList: + type: array + items: + $ref: '#/components/schemas/uri-Type' + measurementCategoryList: + type: array + items: + type: string + reportingMethod: + $ref: '#/components/schemas/reportingMethod-Type' + granularityPeriod: + type: integer + reportingPeriod: + type: integer + startTime: + $ref: '#/components/schemas/dateTime-Type' + stopTime: + $ref: '#/components/schemas/dateTime-Type' + schedule: + $ref: '#/components/schemas/schedule-Type' + streamTarget: + type: string + priority: + $ref: '#/components/schemas/priority-Type' + reliability: + type: string + schedule-Type: + type: object + properties: + scheduleOption: + $ref: '#/components/schemas/scheduleOption-Type' + dailySchedule: + type: array + items: + $ref: '#/components/schemas/timeInterval-Type' + weeklySchedule: + type: array + items: + $ref: '#/components/schemas/scheduleOfDay-Type' + timeInterval-Type: + type: object + properties: + intervalStart: + type: string + format: Time + intervalEnd: + type: string + format: Time + scheduleOfDay-Type: + type: object + properties: + dayOfWeek: + $ref: '#/components/schemas/dayOfWeek-Type' + intervalsOfDay: + type: array + items: + $ref: '#/components/schemas/timeInterval-Type' + unsupportedMeas-Type: + type: object + properties: + iOCInstance: + $ref: '#/components/schemas/uri-Type' + measurementTypeName: + type: string + reason: + type: string + reportingMethod-Type: + type: string + enum: + - file + - streaming + priority-Type: + type: string + enum: + - low + - medium + - high + scheduleOption-Type: + type: string + enum: + - daily + - weekly + dayOfWeek-Type: + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday diff --git a/OpenAPI/PerThresMonMnS.yaml b/OpenAPI/PerThresMonMnS.yaml new file mode 100644 index 000000000..923640a11 --- /dev/null +++ b/OpenAPI/PerThresMonMnS.yaml @@ -0,0 +1,102 @@ +openapi: 3.0.1 +info: + title: TS 28.532 Performance Threshold Monitoring Service + version: 16.4.0 + description: OAS 3.0.1 specification of the Performance Threshold Monitoring Service +servers: + - url: 'http://{monitoringNotifTarget}' + variables: + monitoringNotifTarget: + description: >- + The open API server of the performance threshold monitoring service is + located in the consumer side, see monitoringNotifTarget attribute of + the IOC ThresholdMonitor defined in 3GPP TS 28.622 [11]. + default: example.com +paths: + /notificationSink: + post: + summary: Send notifications about performance threshold crossing + description: To send a notifyThresholdCrossing notification + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/notifyThresholdCrossing-NotifType' + responses: + '204': + description: >- + Success case ("204 No Content"). The notification is successfully + delivered. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' +components: + schemas: + dateTime-Type: + type: string + format: date-Time + uri-Type: + type: string + long-Type: + type: string + format: long + thresholdLevel-Type: + type: integer + measurementTypeName-Type: + type: string + measurementValue-Type: + type: string + additionalText-Type: + type: string + error-ResponseType: + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + header-Type: + description: Header used in notifications as notification header + type: object + properties: + uri: + $ref: '#/components/schemas/uri-Type' + notificationId: + $ref: '#/components/schemas/notificationId-Type' + notificationType: + $ref: '#/components/schemas/notificationType-Type' + eventTime: + $ref: '#/components/schemas/dateTime-Type' + notificationId-Type: + $ref: '#/components/schemas/long-Type' + notificationType-Type: + type: string + enum: + - notifyThresholdCrossing + notifyThresholdCrossing-NotifType: + type: object + properties: + header: + $ref: '#/components/schemas/header-Type' + body: + type: object + properties: + startOfMonitoringGP: + $ref: '#/components/schemas/dateTime-Type' + endOfMonitoringGP: + $ref: '#/components/schemas/dateTime-Type' + monitoredObjectInstance: + $ref: '#/components/schemas/uri-Type' + thresholdLevel: + $ref: '#/components/schemas/thresholdLevel-Type' + measurementTypeName: + $ref: '#/components/schemas/measurementTypeName-Type' + measurementValue: + $ref: '#/components/schemas/measurementValue-Type' + additionalText: + $ref: '#/components/schemas/additionalText-Type' diff --git a/OpenAPI/PerfDataStreamingMnS.yaml b/OpenAPI/PerfDataStreamingMnS.yaml new file mode 100644 index 000000000..e040e14c8 --- /dev/null +++ b/OpenAPI/PerfDataStreamingMnS.yaml @@ -0,0 +1,363 @@ +openapi: 3.0.1 +info: + title: TS 28.550 Performance Data Streaming Service + version: 16.3.0 + description: OAS 3.0.1 specification of the Performance Data Streaming Service +servers: + - url: 'http://{streamTarget}/PerfDataStreamMnS/v1630' + description: This URL is used for posting the set of information about streams supported on the connection between the producer and the consumer. + variables: + streamTarget: + description: 'The open API server of the performance data streaming service is located in the consumer side,and the “streamTarget” part corresponds to the streamTarget parameter provided in the createMeasurementJob operation (see clause 6.1.1.2) or the streamTarget attribute of the MOI of MeasurementControlor MeasurementReader, see 3GPP TS 28.622 [5]).' + default: example.com + - url: 'wss://{streamTarget}/PerfDataStreamMnS/v1630/streamingConnection' + description: This URL is used for establishing the WebSocket connection for the performance data streaming service. + variables: + streamTarget: + description: 'The open API server of the performance data streaming service is located in the consumer side,and the “streamTarget” part corresponds to the streamTarget parameter provided in the createMeasurementJob operation (see clause 6.1.1.2) or the streamTarget attribute of the MOI of MeasurementControlor MeasurementReader, see 3GPP TS 28.622 [5]).' + default: example.com +paths: + /streamInfoList: + post: + summary: The set of information about the streams sent from the producer to the consumer + description: To send the streamInfoList from the producer to the consumer + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoListPost-RequestType' + responses: + '201': + description: Success case ("201 Posted"). The streamInfoList is successfully posted. + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoListPost-ResponseType' + '202': + description: Partial success case ("202 Partially posted"). The representation of the posted resource on stream information. + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoListPost-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + get: + summary: Read resources of stream information from the streaming consumer + description: 'With HTTP GET, resources of stream information are read. The resources to be read are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be returned.' + parameters: + - name: streamIdList + in: query + description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. + required: true + schema: + type: array + items: + type: integer + responses: + '200': + description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.' + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' + '202': + description: Partial success case ("202 Partially retrieved"). The representation of the retrieved resources on stream information. + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + patch: + summary: Update resources of stream information to the streaming consumer + description: 'With HTTP PATCH, resources of stream information are to be updated. The resources to be updated are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be updated.' + parameters: + - name: streamIdList + in: query + description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. + required: true + schema: + type: array + items: + type: integer + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoToUpdate-RequestType' + responses: + '200': + description: Success case ("200 OK"). The resources selected by the query parameter are updated and returned in the response message body. + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoUpdate-ResponseType' + '202': + description: Partial success case ("202 Partially updated"). The representation of the updated resources on stream information + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoUpdate-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + delete: + summary: The information of streams to be deleted by the producer to the consumer + description: 'With HTTP DELETE, resources of stream information are to be deleted. The resources to be deleted are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be deleted.' + parameters: + - name: streamIdList + in: query + description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. + required: true + schema: + type: array + items: + type: integer + responses: + '204': + description: Success case ("204 No Content"). The stream information resource has been deleted. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + '/streamInfoList/{streamId}': + get: + summary: Read resource of the stream information from the streaming consumer + description: 'With HTTP GET, resource of stream information is read. The resource to be read is identified with the path component the URI.' + parameters: + - name: streamId + in: path + description: Identifies the stream for which the information is to be retrieved. + required: true + schema: + $ref: '#/components/schemas/uri-Type' + responses: + '200': + description: Success case ("200 OK"). The resource identified in the request for retrieval is returned in the response message body. + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + patch: + summary: Update the resource of stream information to the streaming consumer + description: 'With HTTP PATCH, resource of stream information is to be updated. The resource to be updated is identified by the path component of the URI. ' + parameters: + - name: streamId + in: path + description: Identifies the stream for which the information is to be updated. + required: true + schema: + $ref: '#/components/schemas/uri-Type' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoToUpdate-RequestType' + responses: + '200': + description: Success case ("200 OK"). The resources identified by the path of the URI is updated and returned in the response message body. + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoUpdate-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + delete: + summary: The stream information to be deleted by the producer to the consumer + description: 'With HTTP DELETE, resource of stream information identified by the path component of the URI is to be deleted.' + parameters: + - name: streamId + in: path + description: Identifies the stream for which the information is to be deleted + required: true + schema: + $ref: '#/components/schemas/uri-Type' + responses: + '204': + description: Success case ("204 No Content"). The stream information resource has been deleted. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + /streamConnection: + get: + summary: The connection for streaming from the producer to the consumer + description: To establish the WebSocket connection between the producer and the consumer. The HTTP version of this operation shall not be earlier than HTTP/1.1 + parameters: + - in: header + name: Upgrade + required: true + schema: + $ref: '#/components/schemas/Upgrade-HeaderType' + - in: header + name: Connection + required: true + schema: + $ref: '#/components/schemas/Connection-HeaderType' + - in: header + name: Sec-WebSocket-Key + required: true + schema: + $ref: '#/components/schemas/Sec-WebSocket-Key-HeaderType' + - in: header + name: Sec-WebSocket-Version + required: true + schema: + $ref: '#/components/schemas/Sec-WebSocket-Version-HeaderType' + responses: + '101': + description: Success case ("101 Switching Protocols "). The connection has been successfully switched to WebSocket. The response message body is absent. + headers: + Upgrade: + schema: + $ref: '#/components/schemas/Upgrade-HeaderType' + Connection: + schema: + $ref: '#/components/schemas/Connection-HeaderType' + Sec-WebSocket-Accept-HeaderType: + schema: + $ref: '#/components/schemas/Sec-WebSocket-Accept-HeaderType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' +components: + schemas: + uri-Type: + type: string + streamInfoIn-Type: + type: object + properties: + streamId: + type: integer + iOCInstance: + $ref: '#/components/schemas/uri-Type' + measTypes: + type: array + items: + type: string + streamInfoOut-Type: + type: object + properties: + streamId: + $ref: '#/components/schemas/uri-Type' + iOCInstance: + $ref: '#/components/schemas/uri-Type' + measTypes: + type: array + items: + type: string + error-ResponseType: + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + streamInfoListPost-RequestType: + type: object + properties: + streamInfoList: + type: array + items: + $ref: '#/components/schemas/streamInfoIn-Type' + streamInfoListPost-ResponseType: + type: object + properties: + streamInfoListPosted: + type: array + items: + $ref: '#/components/schemas/streamInfoOut-Type' + streamInfoRetrieval-ResponseType: + type: object + properties: + streamInfoOut: + $ref: '#/components/schemas/streamInfoOut-Type' + listOfStreamInfoRetrieval-ResponseType: + type: object + properties: + listOfStreamInfoOut: + type: array + items: + $ref: '#/components/schemas/streamInfoOut-Type' + streamInfoToUpdatePropertyType: + type: object + properties: + iOCInstance: + description: 'The updated measured object instance, empty value means no update.' + allOf: + - $ref: '#/components/schemas/uri-Type' + measTypes: + description: 'The updated list of measurement type, empty value means no update.' + type: array + items: + type: string + streamInfoToUpdate-RequestType: + type: object + properties: + streamInfoToUpdate: + $ref: '#/components/schemas/streamInfoToUpdatePropertyType' + listOfStreamInfoToUpdate-RequestType: + type: object + properties: + listOfStreamInfoToUpdate: + type: array + items: + $ref: '#/components/schemas/streamInfoToUpdatePropertyType' + streamInfoUpdate-ResponseType: + type: object + properties: + streamInfoUpdated: + $ref: '#/components/schemas/streamInfoOut-Type' + listOfStreamInfoUpdate-ResponseType: + type: object + properties: + listOfStreamInfoUpdated: + type: array + items: + $ref: '#/components/schemas/streamInfoOut-Type' + Upgrade-HeaderType: + type: string + enum: + - websocket + Connection-HeaderType: + type: string + enum: + - Upgrade + Sec-WebSocket-Key-HeaderType: + type: string + Sec-WebSocket-Version-HeaderType: + type: string + Sec-WebSocket-Accept-HeaderType: + type: string diff --git a/OpenAPI/README.md b/OpenAPI/README.md new file mode 100644 index 000000000..9de057463 --- /dev/null +++ b/OpenAPI/README.md @@ -0,0 +1,73 @@ +# 3GPP SA5 models and MnS OpenAPI definitions + +(c) 2020, 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: + + +## Network Resource Models (NRM) + +* Generic NRM (TS 28.623) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/genericNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/genericNrm.yaml)) + +* Common NRM definitions (TS 28.623) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/comDefs.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/comDefs.yaml)) + +* NR NRM (TS 28.541) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/nrNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/nrNrm.yaml)) + +* 5GC NRM (TS 28.541) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/5gcNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/5gcNrm.yaml)) + +* Slice NRM (TS 28.541) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/sliceNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/sliceNrm.yaml)) + +* Communication Service Assurance NRM (TS 28.536) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/coslaNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/coslaNrm.yaml)) + +## Management Services (MnS) + +* Provisioning MnS (TS 28.532) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/provMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/provMnS.yaml)) + +* Fault Supervision MnS (TS 28.532) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/faultMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/faultMnS.yaml)) + +* Performance Measurement Job Control MnS (28.550) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerMeasJobCtlMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerMeasJobCtlMnS.yaml)) + +* Performance Data File Reporting MnS (TS 28.532) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerDataFileReportMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerDataFileReportMnS.yaml)) + +* Performance Threshold Monitoring MnS (TS 28.532) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerThresMonMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerThresMonMnS.yaml)) + +* Heartbeat Notifications(TS 28.532) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/heartbeatNtf.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/heartbeatNtf.yaml)) + +* Streaming Data Reporting MnS (TS 28.532) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/streamingDataMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/streamingDataMnS.yaml)) + +## Tools + +* [Frontend](https://forge.3gpp.org/swagger/tools/GitlabOpenAPIFrontend.htm) to invoke the Swagger Editor, Swagger UI, or to parse OpenAPI files with APIDevTools Swagger Parser/Validator, or to search for APIs referencing a data structure +* [API Parser/Linter](https://forge.3gpp.org/swagger/tools/parser.html) to parse OpenAPI files with APIDevTools Swagger Parser/Validator and run a number of [lint](https://en.wikipedia.org/wiki/Lint_\(software\)) rules to improve API quality +* [Data Type Finder](https://forge.3gpp.org/swagger/tools/types.html) to find the impacted APIs due to a change on a given data type +* [API Versions Overview](https://forge.3gpp.org/swagger/tools/versions.html) to show a comprehensive report of the versions of all APIs in the repository + +## Other 3GPP API definitions + +* [CT4](https://forge.3gpp.org/rep/3GPP/5G_APIs) specifications. diff --git a/OpenAPI/comDefs.yaml b/OpenAPI/comDefs.yaml new file mode 100644 index 000000000..04ab65161 --- /dev/null +++ b/OpenAPI/comDefs.yaml @@ -0,0 +1,84 @@ +openapi: 3.0.1 +info: + title: Common Type Definitions + version: 16.3.0 + description: >- + OAS 3.0.1 specification of common type definitions in the Generic NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623 V16.3.0; Generic NRM, Common Type Definitions + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: + Long: + type: string + format: long + Float: + type: string + format: float + DateTime: + type: string + format: date-Time + Dn: + type: string + Uri: + type: string + AttributeNameValuePairSet: + type: object + minProperties: 1 + AttributeValueChangeSet: + description: >- + The key in this map is the attribute name. The value of each key is an array. + When only one item is present in the array, it carries the new attribute + value. If two items are present, then the first item carries the old value + and the second item the new value. The items can be of any type including null. + type: object + additionalProperties: + type: array + minItems: 1 + maxItems: 2 + items: + nullable: true + Filter: + type: string + SystemDN: + type: string + NotificationId: + type: integer + NotificationHeader: + description: >- + Header used for all notifications types + type: object + required: + - uri + - notificationId + - notificationType + - eventTime + - systemDn + properties: + uri: + $ref: '#/components/schemas/Uri' + notificationId: + $ref: '#/components/schemas/NotificationId' + notificationType: + oneOf: + - $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes' + #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes' + # more to be added + eventTime: + $ref: '#/components/schemas/DateTime' + systemDN: + $ref: '#/components/schemas/SystemDN' + ErrorResponse: + description: >- + Default schema for the response message body in case the request + is not successful. + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string diff --git a/OpenAPI/coslaNrm.yaml b/OpenAPI/coslaNrm.yaml new file mode 100644 index 000000000..e6a0ef13a --- /dev/null +++ b/OpenAPI/coslaNrm.yaml @@ -0,0 +1,168 @@ +openapi: 3.0.2 + +info: + title: coslaNrm + version: 16.4.0 + description: + OAS 3.0.1 specification of the Cosla NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 28.536 V16.4.0; Cosla NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.536/ + +paths: {} + +components: + + schemas: + +#------------ Type definitions --------------------------------------------------- + + ControlLoopLifeCyclePhase: + type: string + enum: + - PREPARATION + - COMMISSIONING + - OPERATION + - DECOMMISSIONING + + ObservationTime: + type: integer + + AssuranceGoalStatusObserved: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceGoalStatusPredicted: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceTargetStatusObserved: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceTargetStatusPredicted: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceTarget: + type: object + properties: + assuranceTargetName: + type: string + assuranceTargetValue: + type: string + assuranceTargetStatusObserved: + $ref: '#/components/schemas/AssuranceTargetStatusObserved' + assuranceTargetStatusPredicted: + $ref: '#/components/schemas/AssuranceTargetStatusPredicted' + + AssuranceTargetList: + type: array + items: + $ref: '#/components/schemas/AssuranceTarget' + + +#-------- Definition of concrete IOCs -------------------------------------------- + + SubNetwork-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + AssuranceClosedControlLoop: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' + + ManagedElement-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' + - type: object + properties: + AssuranceClosedControlLoop: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' + + AssuranceClosedControlLoop-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + operationalState: + $ref: 'genericNrm.yaml#/components/schemas/OperationalState' + administrativeState: + $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' + controlLoopLifeCyclePhase: + $ref: '#/components/schemas/ControlLoopLifeCyclePhase' + AssuranceGoal: + $ref: '#/components/schemas/AssuranceGoal-Multiple' + + AssuranceGoal-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + observationTime: + $ref: '#/components/schemas/ObservationTime' + assuranceTargetList: + $ref: '#/components/schemas/AssuranceTargetList' + assuranceGoalStatusObserved: + $ref: '#/components/schemas/AssuranceGoalStatusObserved' + assuranceGoalStatusPredicted: + $ref: '#/components/schemas/AssuranceGoalStatusPredicted' + serviceProfileId: + type: string + sliceProfileId: + type: string + networkSliceRef: + $ref: 'comDefs.yaml#/components/schemas/Dn' + networkSliceSubnetRef: + $ref: 'comDefs.yaml#/components/schemas/Dn' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + AssuranceClosedControlLoop-Multiple: + type: array + items: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' + + AssuranceGoal-Multiple: + type: array + items: + $ref: '#/components/schemas/AssuranceGoal-Single' + +#------------ Definitions in TS 28.536 for TS 28.623 ----------------------------- + + resources-coslaNrm: + oneOf: + - $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' + - $ref: '#/components/schemas/AssuranceGoal-Single' + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' \ No newline at end of file diff --git a/OpenAPI/faultMnS.yaml b/OpenAPI/faultMnS.yaml new file mode 100644 index 000000000..499123b90 --- /dev/null +++ b/OpenAPI/faultMnS.yaml @@ -0,0 +1,1144 @@ +openapi: 3.0.1 +info: + title: Fault Supervision MnS + version: 16.4.0 + description: >- + OAS 3.0.1 definition of the Fault Supervision MnS + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.532 V16.4.0; Generic management services + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ +servers: + - url: '{MnSRoot}/FaultSupervisionMnS/{version}' + variables: + MnSRoot: + description: See subclause 4.4.3 of TS 32.158 + default: http://example.com/3GPPManagement + version: + description: Versi on number of the OpenAPI definition + default: XXX +paths: + /alarms: + get: + summary: Retrieve multiple alarms + description: >- + Retrieves the alarms identified by alarmAckState, baseObjectInstance + and filter. + parameters: + - name: alarmAckState + in: query + required: false + schema: + $ref: '#/components/schemas/AlarmAckState' + - name: baseObjectInstance + in: query + required: false + schema: + $ref: '#/components/schemas/Dn' + - name: filter + in: query + required: false + schema: + $ref: '#/components/schemas/Filter' + responses: + '200': + description: >- + Success case ("200 OK"). + Returns the alarms identified in the request. The alarmId is the key + of the map. + content: + application/json: + schema: + type: object + additionalProperties: + type: object + allOf: + - type: object + properties: + lastNotificationHeader: + $ref: '#/components/schemas/NotificationHeader' + - $ref: '#/components/schemas/AlarmRecord' + - type: object + properties: + comments: + $ref: '#/components/schemas/Comments' + default: + description: Response in case of error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + patch: + summary: 'Clear, acknowledge or unacknowledge multiple alarms' + description: >- + Clears, acknowledges or unacknowledges multiple alarms using patch. Depending + on which action is to be performed, different merge patch documents need + to be used. + requestBody: + description: >- + Patch documents for acknowledging and unacknowledging, or clearing multiple + alarms. The keys in the map are the alarmIds to be patched. + content: + application/merge-patch+json: + schema: + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/MergePatchAcknowledgeAlarm' + - type: object + additionalProperties: + $ref: '#/components/schemas/MergePatchClearAlarm' + responses: + '204': + description: >- + Success case ("204 No content"). + The response message body is empty. + default: + description: Response in case of error. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FailedAlarm' + /alarms/alarmCount: + get: + summary: Get the alarm count per perceived severity + parameters: + - name: alarmAckState + in: query + required: false + schema: + $ref: '#/components/schemas/AlarmAckState' + - name: filter + in: query + required: false + schema: + type: string + responses: + '200': + description: >- + Success case ("200 OK"). + The alarm count per perceived severity is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AlarmCount' + default: + description: Response in case of error. The error case needs rework. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /alarms/{alarmId}: + patch: + summary: 'Clear, acknowledge or unacknowledge a single alarm' + description: >- + Clears, acknowledges or uncknowldeges a single alarm by patching the alarm + information. A conditional acknowledge request based on the perceived + severity is not supported. + parameters: + - name: alarmId + in: path + description: Identifies the alarm to be patched. + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + oneOf: + - $ref: '#/components/schemas/MergePatchAcknowledgeAlarm' + - $ref: '#/components/schemas/MergePatchClearAlarm' + responses: + '204': + description: >- + Success case (204 No content). + The response message body is absent. + default: + description: Response in case of error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /alarms/{alarmId}/comments: + post: + summary: Add a comment to a single alarm + description: >- + Adds a comment to an alarm identified by alarmId. The id of the new comment + is allocated by the producer. + parameters: + - name: alarmId + in: path + description: Identifies the alarm to which the comment shall be added. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + responses: + '201': + description: >- + Success case (201 Created). + The representation of the newly created comment resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + headers: + Location: + description: URI of the newly created comment resource. + required: true + schema: + type: string + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /subscriptions: + post: + summary: Create a subscription + description: >- + To create a subscription the representation of the subscription is + POSTed on the /subscriptions collection resource. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + responses: + '201': + description: >- + Success case ("201 Created"). + The representation of the newly created subscription resource shall + be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + headers: + Location: + description: URI of the newly created subscription resource + required: true + schema: + type: string + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + callbacks: + notifyNewAlarm: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/NotifyNewAlarm' + - $ref: '#/components/schemas/NotifyNewSecAlarm' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyClearedAlarm: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyClearedAlarm' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyChangedAlarm: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyChangedAlarm' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyChangedAlarmGeneral: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/NotifyChangedAlarmGeneral' + - $ref: '#/components/schemas/NotifyChangedSecAlarmGeneral' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyCorrelatedNotificationChanged: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyCorrelatedNotificationChanged' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyAckStateChanged: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyAckStateChanged' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyComments: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyComments' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyPotentialFaultyAlarmList: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyPotentialFaultyAlarmList' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyAlarmListRebuilt: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyAlarmListRebuilt' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /subscriptions/{subscriptionId}: + delete: + summary: Delete a subscription + description: >- + The subscription is deleted by deleting the corresponding subscription + resource. The resource to be deleted is identified with the path + component of the URI. + parameters: + - name: subscriptionId + in: path + description: Identifies the subscription to be deleted. + required: true + schema: + type: string + responses: + '204': + description: >- + Success case ("204 No Content"). + The subscription resource has been deleted. The response message body + is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + +components: + schemas: + + #---- Definitions to be moved to comDefs.yaml --------------------------------------# + + Long: + type: string + format: long + Float: + type: string + format: float + DateTime: + type: string + format: date-Time + + Dn: + type: string + Uri: + type: string + + AttributeNameValuePairSet: + type: object + minProperties: 1 + AttributeValueChangeSet: + description: >- + The key in this map is the attribute name. The value of each key is an array. + When only one item is present in the array, it carries the new attribute + value. If two items are present, then the first item carries the old value + and the second item the new value. The items can be of any type including null. + type: object + additionalProperties: + type: array + minItems: 1 + maxItems: 2 + items: + nullable: true + + Filter: + type: string + SystemDN: + type: string + + NotificationId: + type: integer + NotificationHeader: + description: >- + Header used for all notification types + type: object + required: + - href + - notificationId + - notificationType + - eventTime + - systemDN + properties: + uri: + $ref: '#/components/schemas/Uri' + notificationId: + $ref: '#/components/schemas/NotificationId' + notificationType: + oneOf: + - $ref: '#/components/schemas/AlarmNotificationTypes' + #- $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes' + #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes' + # more to be added + eventTime: + $ref: '#/components/schemas/DateTime' + systemDN: + $ref: '#/components/schemas/SystemDN' + + ErrorResponse: + description: >- + Default schema for the response message body in case the request is not + successful. + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + + #---- End of definitions to be moved to comDefs.yaml -------------------------------# + + #---- Definition of AlarmRecord ----------------------------------------------------# + + AlarmId: + type: string + AlarmType: + type: string + enum: + - COMMUNICATIONS_ALARM + - QUALITY_OF_SERVICE_ALARM + - PROCESSING_ERROR_ALARM + - EQUIPMENT_ALARM + - ENVIRONMENTAL_ALARM + - INTEGRITY_VIOLATION + - OPERATIONAL_VIOLATION + - PHYSICAL_VIOLATION + - SECURITY_SERVICE_OR_MECHANISM_VIOLATION + - TIME_DOMAIN_VIOLATION + ProbableCause: + description: >- + The value of the probable cause may be a specific standardized string, or any + vendor provided string. Probable cause strings are not standardized in the + present document. They may be added in a future version. Up to then the + mapping of the generic probable cause strings "PROBABLE_CAUSE_001" to + "PROBABLE_CAUSE_005" is vendor specific. + The value of the probable cause may also be an integer. The mapping of integer + values to probable causes is vendor specific. + oneOf: + - anyOf: + - type: string + enum: + - PROBABLE_CAUSE_001 + - PROBABLE_CAUSE_002 + - PROBABLE_CAUSE_003 + - PROBABLE_CAUSE_004 + - PROBABLE_CAUSE_005 + - type: string + - type: integer + SpecificProblem: + oneOf: + - type: string + - type: integer + PerceivedSeverity: + type: string + enum: + - INDETERMINATE + - CRITICAL + - MAJOR + - MINOR + - WARNING + - CLEARED + TrendIndication: + type: string + enum: + - MORE_SEVERE + - NO_CHANGE + - LESS_SEVERE + ThresholdHysteresis: + type: object + required: + - high + properties: + high: + oneOf: + - type: integer + - $ref: '#/components/schemas/Float' + low: + $ref: '#/components/schemas/Float' + ThresholdLevelInd: + type: object + required: + - up + properties: + up: + $ref: '#/components/schemas/ThresholdHysteresis' + low: + $ref: '#/components/schemas/ThresholdHysteresis' + ThresholdInfo: + type: object + required: + - observedMeasurement + - observedValue + properties: + observedMeasurement: + type: string + observedValue: + oneOf: + - type: integer + - $ref: '#/components/schemas/Float' + thresholdLevelInd: + $ref: '#/components/schemas/ThresholdLevelInd' + armTime: + $ref: '#/components/schemas/DateTime' + CorrelatedNotification: + type: object + required: + - source + - notificationId + properties: + sourceObjectInstance: + $ref: '#/components/schemas/Dn' + notificationIds: + type: array + items: + $ref: '#/components/schemas/NotificationId' + CorrelatedNotifications: + type: array + items: + $ref: '#/components/schemas/CorrelatedNotification' + AckState: + type: string + enum: + - ACKNOWLEDGED + - UNACKNOWLEDGED + + AlarmRecord: + description: >- + The alarmId is not a property of an alarm record. It is used as key + in the map of alarm records instead. + type: object + properties: + # alarmId: + # $ref: '#/components/schemas/AlarmId' + objectInstance: + $ref: '#/components/schemas/Dn' + notificationId: + $ref: '#/components/schemas/NotificationId' + alarmRaisedTime: + $ref: '#/components/schemas/DateTime' + alarmChangedTime: + $ref: '#/components/schemas/DateTime' + alarmClearedTime: + $ref: '#/components/schemas/DateTime' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + specificProblem: + $ref: '#/components/schemas/SpecificProblem' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + backedUpStatus: + type: boolean + backUpObject: + $ref: '#/components/schemas/Dn' + trendIndication: + $ref: '#/components/schemas/TrendIndication' + thresholdinfo: + $ref: '#/components/schemas/ThresholdInfo' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + stateChangeDefinition: + $ref: '#/components/schemas/AttributeValueChangeSet' + monitoredAttributes: + $ref: '#/components/schemas/AttributeNameValuePairSet' + proposedRepairActions: + type: string + additionalText: + type: string + additionalInformation: + $ref: '#/components/schemas/AttributeNameValuePairSet' + + rootCauseIndicator: + type: boolean + + ackTime: + $ref: '#/components/schemas/DateTime' + ackUserId: + type: string + ackSystemId: + type: string + ackState: + $ref: '#/components/schemas/AckState' + + clearUserId: + type: string + clearSystemId: + type: string + serviceUser: + type: string + serviceProvider: + type: string + securityAlarmDetector: + type: string + + #---- Definition of alarm notifications --------------------------------------------# + + AlarmNotificationTypes: + type: string + enum: + - notifyNewAlarm + - notifyChangedAlarm + - notifyChangedAlarmGeneral + - notifyAckStateChanged + - notifyCorrelatedNotificationChanged + - notifyComments + - notifyClearedAlarm + - notifyAlarmListRebuiltAlarm + - notifyPotentialFaultyAlarmList + AlarmListAlignmentRequirement: + type: string + enum: + - ALIGNMENT_REQUIRED + - ALIGNMENT_NOT_REQUIRED + + NotifyNewAlarm: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + specificProblem: + $ref: '#/components/schemas/SpecificProblem' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + backedUpStatus: + type: boolean + backUpObject: + $ref: '#/components/schemas/Dn' + trendIndication: + $ref: '#/components/schemas/TrendIndication' + thresholdInfo: + $ref: '#/components/schemas/ThresholdInfo' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + stateChangeDefinition: + $ref: '#/components/schemas/AttributeValueChangeSet' + monitoredAttributes: + $ref: '#/components/schemas/AttributeNameValuePairSet' + proposedRepairActions: + type: string + additionalText: + type: string + additionalInformation: + $ref: '#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + NotifyNewSecAlarm: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - serviceUser + - serviceProvider + - securityAlarmDetector + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + additionalText: + type: string + additionalInformation: + $ref: '#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + serviceUser: + type: string + serviceProvider: + type: string + securityAlarmDetector: + type: string + NotifyClearedAlarm: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + clearUserId: + type: string + clearSystemId: + type: string + NotifyChangedAlarm: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + NotifyChangedAlarmGeneral: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - changedAlarmAttributes + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + specificProblem: + $ref: '#/components/schemas/SpecificProblem' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + backedUpStatus: + type: boolean + backUpObject: + $ref: '#/components/schemas/Dn' + trendIndication: + $ref: '#/components/schemas/TrendIndication' + thresholdInfo: + $ref: '#/components/schemas/ThresholdInfo' + stateChangeDefinition: + $ref: '#/components/schemas/AttributeValueChangeSet' + monitoredAttributes: + $ref: '#/components/schemas/AttributeNameValuePairSet' + proposedRepairActions: + type: string + additionalText: + type: string + additionalInformation: + $ref: '#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + changedAlarmAttributes: + $ref: '#/components/schemas/AttributeNameValuePairSet' + NotifyChangedSecAlarmGeneral: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - serviceUser + - serviceProvider + - securityAlarmDetector + - changedAlarmAttributes + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + additionalText: + type: string + additionalInformation: + $ref: '#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + serviceUser: + type: string + serviceProvider: + type: string + securityAlarmDetector: + type: string + changedAlarmAttributes: + $ref: '#/components/schemas/AttributeNameValuePairSet' + NotifyCorrelatedNotificationChanged: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - correlatedNotifications + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + rootCauseIndicator: + type: boolean + NotifyAckStateChanged: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - ackState + - ackUserId + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + ackState: + $ref: '#/components/schemas/AckState' + ackUserId: + type: string + ackSystemId: + type: string + NotifyComments: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - comments + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + comments: + $ref: '#/components/schemas/Comments' + NotifyPotentialFaultyAlarmList: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - reason + properties: + reason: + type: string + NotifyAlarmListRebuilt: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - reason + properties: + reason: + type: string + alarmListAlignmentRequirement: + $ref: '#/components/schemas/AlarmListAlignmentRequirement' + + #---- Definition of query parameters -----------------------------------------------# + + AlarmAckState: + type: string + enum: + - ALL_ALARMS + - ALL_ACTIVE_ALARMS + - ALL_ACTIVE_AND_ACKNOWLEDGED_ALARMS + - ALL_ACTIVE_AND_UNACKNOWLEDGED_ALARMS + - ALL_CLEARED_AND_UNACKNOWLEDGED_ALARMS + - ALL_UNACKNOWLEDGED_ALARMS + + #---- Definition of patch documents ------------------------------------------------# + + MergePatchAcknowledgeAlarm: + description: >- + Patch document acknowledging or unacknowledging a single alarm. For + acknowleding an alarm the value of ackState is ACKNOWLEDGED, for unacknowleding + an alarm the value of ackState is UNACKNOWLEDGED. + type: object + required: + - ackUserId + - ackState + properties: + ackUserId: + type: string + ackSystemId: + type: string + ackState: + $ref: '#/components/schemas/AckState' + MergePatchClearAlarm: + description: Patch document for clearing a single alarm + type: object + required: + - clearUserId + - perceivedSeverity + properties: + clearUserId: + type: string + clearSystemId: + type: string + perceivedSeverity: + type: string + enum: + - CLEARED + + #---- Definition of method responses -----------------------------------------------# + + FailedAlarm: + type: object + required: + - alarmId + - failureReason + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + failureReason: + type: string + + #---- Definition of resources ------------------------------------------------------# + + AlarmCount: + type: object + required: + - criticalCount + - majorCount + - minorCount + - warningCount + - indeterminateCount + - clearedCount + properties: + criticalCount: + type: integer + majorCount: + type: integer + minorCount: + type: integer + warningCount: + type: integer + indeterminateCount: + type: integer + clearedCount: + type: integer + Comment: + type: object + properties: + commentTime: + $ref: '#/components/schemas/DateTime' + commentUserId: + type: string + commentSystemId: + type: string + commentText: + type: string + Comments: + description: >- + Collection of comments. The comment identifiers are allocated by the + MnS producer and used as key in the map. + type: object + additionalProperties: + $ref: '#/components/schemas/Comment' + Subscription: + type: object + properties: + consumerReference: + $ref: '#/components/schemas/Uri' + timeTick: + $ref: '#/components/schemas/Long' + filter: + $ref: '#/components/schemas/Filter' diff --git a/OpenAPI/genericNrm.yaml b/OpenAPI/genericNrm.yaml new file mode 100644 index 000000000..0911920a2 --- /dev/null +++ b/OpenAPI/genericNrm.yaml @@ -0,0 +1,1606 @@ +openapi: 3.0.1 +info: + title: Generic NRM + version: 16.4.0 + description: >- + OAS 3.0.1 specification of the Generic NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623 V16.4.0; Generic NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + DateTime: + type: string + format: date-time + Dn: + type: string + maxLength: 400 + DnList: + type: array + items: + $ref: '#/components/schemas/Dn' + Mcc: + type: string + pattern: '^[0-9]{3}$' + Mnc: + type: string + pattern: '^[0-9]{2,3}$' + AdministrativeState: + type: string + enum: + - LOCKED + - UNLOCKED + OperationalState: + type: string + enum: + - ENABLED + - DISABLED + UsageState: + type: string + enum: + - IDEL + - ACTIVE + - BUSY + RegistrationState: + type: string + enum: + - REGISTERED + - DEREGISTERED + SetOfMcc: + type: array + items: + $ref: '#/components/schemas/Mcc' + ManagedElementType: + type: string + ManagedElementTypeList: + type: array + items: + $ref: '#/components/schemas/ManagedElementType' + VnfParameter: + type: object + properties: + vnfInstanceId: + type: string + vnfdId: + type: string + flavourId: + type: string + autoScalable: + type: boolean + VnfParametersList: + type: array + items: + $ref: '#/components/schemas/VnfParameter' + SiteLatitude: + type: number + format: float + minimum: -90 + maximum: 90 + SiteLongitude: + type: number + format: float + minimum: -180 + maximum: 180 + PeeParameter: + type: object + properties: + siteIdentification: + type: string + siteDescription: + type: string + siteLatitude: + $ref: '#/components/schemas/SiteLatitude' + siteLongitude: + $ref: '#/components/schemas/SiteLongitude' + equipmentType: + type: string + environmentType: + type: string + powerInterface: + type: string + PeeParametersList: + type: array + items: + $ref: '#/components/schemas/PeeParameter' + MonitoringGPList: + type: array + items: + type: integer + ThresholdInfoList: + type: array + items: + $ref: '#/components/schemas/ThresholdInfo' + ThresholdInfo: + type: object + properties: + measurementType: + type: string + direction: + $ref: '#/components/schemas/Direction' + thresholdPack: + $ref: '#/components/schemas/ThresholdPack' + Direction: + enum: + - Increasing + - Decreasing + ThresholdPack: + type: array + items: + $ref: '#/components/schemas/ThresholdPackElement' + ThresholdPackElement: + type: object + properties: + thresholdLevel: + type: integer + thresholdValue: + type: number + hysteresis: + type: number + Operation: + type: object + properties: + name: + type: string + allowedNFTypes: + $ref: '#/components/schemas/NFType' + operationSemantics: + $ref: '#/components/schemas/OperationSemantics' + OperationList: + type: array + items: + $ref: '#/components/schemas/Operation' + NFType: + type: string + description: ' NF name defined in TS 23.501' + enum: + - NRF + - UDM + - AMF + - SMF + - AUSF + - NEF + - PCF + - SMSF + - NSSF + - UDR + - LMF + - GMLC + - 5G_EIR + - SEPP + - UPF + - N3IWF + - AF + - UDSF + - DN + Fqdn: + type: string + OperationSemantics: + type: string + enum: + - REQUEST_RESPONSE + - SUBSCRIBE_NOTIFY + SAP: + type: object + properties: + host: + $ref: '#/components/schemas/HostAddr' + port: + type: integer + NFServiceType: + type: string + enum: + - Namf_Communication + - Namf_EventExposure + - Namf_MT + - Namf_Location + - Nsmf_PDUSession + - Nsmf_EventExposure + - Others + HostAddr: + oneOf: + - $ref: '#/components/schemas/Ipv4Addr' + - $ref: '#/components/schemas/Ipv6Addr' + - $ref: '#/components/schemas/Fqdn' + Ipv4Addr: + type: string + pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$' + example: '198.51.100.1' + Ipv4AddrRm: + type: string + pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$' + example: '198.51.100.1' + nullable: true + Ipv6Addr: + type: string + allOf: + - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' + example: '2001:db8:85a3::8a2e:370:7334' + Ipv6AddrRm: + type: string + allOf: + - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' + example: '2001:db8:85a3::8a2e:370:7334' + nullable: true + Ipv6Prefix: + type: string + allOf: + - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$' + example: '2001:db8:abcd:12::0/64' + Uri: + type: string + TransportProtocol: + anyOf: + - type: string + enum: + - TCP + - type: string + SupportedPerfMetricGroup: + type: object + properties: + performanceMetrics: + type: array + items: + type: string + granularityPeriods: + type: array + items: + type: integer + minimum: 1 + reportingMethods: + type: array + items: + type: string + enum: + - FILE_BASED_LOC_SET_BY_PRODUCER + - FILE_BASED_LOC_SET_BY_CONSUMER + - STREAM_BASED + ReportingCtrl: + oneOf: + - type: object + properties: + fileReportingPeriod: + type: integer + - type: object + properties: + fileReportingPeriod: + type: integer + fileLocation: + $ref: '#/components/schemas/Uri' + - type: object + properties: + streamTarget: + $ref: '#/components/schemas/Uri' + Scope: + type: object + properties: + scopeType: + type: string + enum: + - BASE_ONLY + - BASE_ALL + - BASE_NTH_LEVEL + - BASE_SUBTREE + scopeLevel: + type: integer + NotificationType: + type: string + enum: + - notifyMOICreation + - notifyMOIDeletion + - notifyMOIAttributeValueChanges + - notifyEvent + - notifyNewAlarm + - notifyChangedAlarm + - notifyAckStateChanged + - notifyComments + - notifyCorrelatedNotificationChanged + - notifyChangedAlarmGeneral + - notifyAlarmListRebuilt + - notifyPotentialFaultyAlarmList + - notifyFileReady + - notifyFilePreparationError + - notifyThresholdCrossing + NotificationTypes: + type: array + items: + $ref: '#/components/schemas/NotificationType' + +#-------- Definition of types used in Trace control NRM fragment------------------ + + tjJobType-Type: + type: string + description: Specifies whether the TraceJob represents only MDT, Logged MBSFN MDT, Trace or a combined Trace and MDT job. Applicable for Trace, MDT, RCEF and RLF reporting. See 3GPP TS 32.422 clause 5.9a for additional details. + enum: + - IMMEDIATE_MDT_ONLY + - LOGGED_MDT_ONLY + - TRACE_ONLY + - IMMEDIATE_MDT AND TRACE + - RLF_REPORT_ONLY + - RCEF_REPORT_ONLY + - LOGGED_MBSFN_MDT + + tjListOfInterfaces-Type: + description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details. + type: object + properties: + MSCServerInterfaces: + type: array + items: + type: string + enum: + - A + - Iu-CS + - Mc + - MAP-G + - MAP-B + - MAP-E + - MAP-F + - MAP-D + - MAP-C + - CAP + MGWInterfaces: + type: array + items: + type: string + enum: + - Mc + - Nb-UP + - Iu-UP + RNCInterfaces: + type: array + items: + type: string + enum: + - Iu-CS + - Iu-PS + - Iur + - Iub + - Uu + SGSNInterfaces: + type: array + items: + type: string + enum: + - Gb + - Iu-PS + - Gn + - MAP-Gr + - MAP-Gd + - MAP-Gf + - Ge + - Gs + - S6d + - S4 + - S3 + - S13 + GGSNInterfaces: + type: array + items: + type: string + enum: + - Gn + - Gi + - Gmb + S-CSCFInterfaces: + type: array + items: + type: string + enum: + - Mw + - Mg + - Mr + - Mi + P-CSCFInterfaces: + type: array + items: + type: string + enum: + - Gm + - Mw + I-CSCFInterfaces: + type: array + items: + type: string + enum: + - Cx + - Dx + - Mg + - Mw + MRFCInterfaces: + type: array + items: + type: string + enum: + - Mp + - Mr + MGCFInterfaces: + type: array + items: + type: string + enum: + - Mg + - Mj + - Mn + IBCFInterfaces: + type: array + items: + type: string + enum: + - Ix + - Mx + E-CSCFInterfaces: + type: array + items: + type: string + enum: + - Mw + - Ml + - Mm + - Mi/Mg + BGCFInterfaces: + type: array + items: + type: string + enum: + - Mi + - Mj + - Mk + ASInterfaces: + type: array + items: + type: string + enum: + - Dh + - Sh + - ISC + - Ut + HSSInterfaces: + type: array + items: + type: string + enum: + - MAP-C + - MAP-D + - Gc + - Gr + - Cx + - S6d + - S6a + - Sh + EIRInterfaces: + type: array + items: + type: string + enum: + - MAP-F + - S13 + - MAP-Gf + BM-SCInterfaces: + type: array + items: + type: string + enum: + - Gmb + MMEInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - S3 + - S6a + - S10 + - S11 + - S13 + SGWInterfaces: + type: array + items: + type: string + enum: + - S4 + - S5 + - S8 + - S11 + - Gxc + PDN_GWInterfaces: + type: array + items: + type: string + enum: + - S2a + - S2b + - S2c + - S5 + - S6b + - Gx + - S8 + - SGi + eNBInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - X2 + en-gNBInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - X2 + - Uu + - F1-C + - E1 + AMFInterfaces: + type: array + items: + type: string + enum: + - N1 + - N2 + - N8 + - N11 + - N12 + - N14 + - N15 + - N20 + - N22 + - N26 + AUSFInterfaces: + type: array + items: + type: string + enum: + - N12 + - N13 + NEFInterfaces: + type: array + items: + type: string + enum: + - N29 + - N30 + - N33 + NRFInterfaces: + type: array + items: + type: string + enum: + - N27 + NSSFInterfaces: + type: array + items: + type: string + enum: + - N22 + - N31 + PCFInterfaces: + type: array + items: + type: string + enum: + - N5 + - N7 + - N15 + SMFInterfaces: + type: array + items: + type: string + enum: + - N4 + - N7 + - N10 + - N11 + - S5-C + SMSFInterfaces: + type: array + items: + type: string + enum: + - N20 + - N21 + UDMInterfaces: + type: array + items: + type: string + enum: + - N8 + - N10 + - N13 + - N21 + UPFInterfaces: + type: array + items: + type: string + enum: + - N4 + ng-eNBInterfaces: + type: array + items: + type: string + enum: + - NG-C + - Xn-C + - Uu + gNB-CU-CPInterfaces: + type: array + items: + type: string + enum: + - NG-C + - Xn-C + - Uu + - F1-C + - E1 + - X2-C + gNB-CU-UPInterfaces: + type: array + items: + type: string + enum: + - E1 + gNB-DUInterfaces: + type: array + items: + type: string + enum: + - F1-C + + tjListOfNeTypes-Type: + description: The Network Element types where Trace Session activation is needed. See 3GPP TS 32.422 clause 5.4 for additional details. + type: array + items: + type: string + enum: + - MSC_SERVER + - SGSN + - MGW + - GGSN + - RNC + - BM_SC + - MME + - SGW + - PGW + - ENB + - EN_GNB + - GNB_CU_CP + - GNB_CU_UP + - GNB_DU + + tjPLMNTaget-Type: + type: object + description: The PLMN for which sessions shall be selected in the Trace Session in case of management based activation when several PLMNs are supported in the RAN (this means that shared cells and not shared cells are allowed for the specified PLMN. Note that the PLMN Target might differ from the PLMN specified in the Trace Reference, as that specifies the PLMN that is containing the management system requesting the Trace Session from the NE. See 3GPP TS 32.422 clause 5.9b for additional details. + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + required: + - mcc + - mnc + + tjStreamingTraceConsumerURI-Type: + type: string + description: The URI of the Trace Reporting MnS consumer (see 3GPP TS 28.532) to which the Trace records shall be sent. See 3GPP TS 32.422 clause 5.9 for additional details. + format: uri + + tjTraceCollectionEntityAddress-Type: + description: The IP address to which the Trace records shall be transferred. See 3GPP TS 32.422 clause 5.9 for additional details. + oneOf: + - $ref: '#/components/schemas/Ipv4Addr' + - $ref: '#/components/schemas/Ipv6Addr' + + tjTraceDepth-Type: + description: Specifies how detailed information should be recorded in the Network Element. The Trace Depth is a paremeter for Trace Session level, i.e., the Trace Depth is the same for all of the NEs to be traced in the same Trace Session. See 3GPP TS 32.422 clause 5.3 for additional details. + type: string + enum: + - MINIMUM + - MEDIUM + - MAXIMUM + - VENDORMINIMUM + - VENDORMEDIUM + - VENDORMAXIMUM + + tjTraceReference-Type: + type: object + description: The Trace Reference parameter shall be globally unique, therefore the Trace Reference shall compose as follows - MCC+MNC+Trace ID, where the MCC and MNC are coming with the Trace activation request from the management system to identify one PLMN containing the management system, and Trace ID is a 3 byte Octet String. See 3GPP TS 32.422 clause 5.6 for additional details. + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + traceId: + type: integer + required: + - mcc + - mnc + - traceId + + tjTraceReportingFormat-Type: + type: string + description: Specifies whether file-based or streaming reporting shall be used for this Trace Session. See 3GPP TS 32.422 clause 5.11 for additional details. + enum: + - FILE-BASED + - STREAMING + + tjTraceTarget-Type: + type: string + description: Type of trace target. For additional details see 3GPP TS 32.422. + enum: + - IMSI + - IMEI + - IMEISV + - PUBLIC_ID + - UTRAN_CELL + - E-UTRAN_CELL + - NG-RAN_CELL + - eNB + - RNC + - gNB + + tjTriggeringEvent-Type: + type: object + description: Specifies when to start a Trace Recording Session and which message shall be recorded first, when to stop a Trace Recording Session and which message shall be recorded last respectively. See 3GPP TS 32.422 clause 5.1 for additional detials. + properties: + NetworkElement: + type: string + enum: + - MSC_SERVER + - SGSN + - MGW + - GGSN + - BM_SC + - MME + - SGW + - PGW + - AMF + - SMF + - PCF + - UPF + EventBitmap: + type: integer + required: + - NetworkElement + - EventBitmap + + tjMDTAnonymizationOfData-Type: + description: Specifies level of MDT anonymization. For additional details see 3GPP TS 32.422 clause 5.10.12. + type: string + enum: + - NO_IDENTITY + - TAC_OF_IMEI + + tjMDTAreaConfigurationForNeighCell-Type: + description: Used for logged NR MDT and defines the area for which UE is requested to perform measurement logging for neighbour cells which have list of frequencies. For additional details see 3GPP TS 32.422 clause 5.10.26. + type: array + items: + type: object + properties: + frequency: + type: string + cell: + type: string + + tjMDTAreaScope-Type: + description: defines the area in terms or Cells or Tracking Area/Routing Area/Location Area where the MDT data collection shall take place. For additional details see 3GPP TS 32.422 clause 5.10.2. + allOf: + - $ref: '#/components/schemas/DnList' + + tjMDTCollectionPeriodRrmLte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.20. + type: string + enum: + - 250ms + - 500ms + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + - 8000ms + - 12000ms + - 16000ms + - 20000ms + - 24000ms + - 28000ms + - 32000ms + - 64000ms + + tjMDTCollectionPeriodRrmUmts-Type: + description: See details in 3GPP TS 32.422 clause 5.10.21. + type: string + enum: + - 1024ms + - 1280ms + - 2048ms + - 2560ms + - 5120ms + - 10240ms + - 1min + + tjMDTEventListForTriggeredMeasurement-Type: + description: See details in 3GPP TS 32.422 clause 5.10.28. + type: string + enum: + - OUT_OF_COVERAGE + - A2_EVENT + + tjMDTEventThreshold-Type: + description: See details in 3GPP TS 32.422 clause 5.10.7, 5.10.7a, 5.10.13 and 5.10.14. + type: object + properties: + EventThresholdRSRP: + type: integer + minimum: 0 + maximum: 97 + EventThresholdRSRQ: + type: integer + minimum: 0 + maximum: 34 + EventThreshold1F: + type: object + properties: + CPICH_RSCP: + type: integer + minimum: -120 + maximum: 25 + CPICH_EcNo: + type: integer + minimum: -24 + maximum: 0 + PathLoss: + type: integer + minimum: 30 + maximum: 165 + EventThreshold1I: + type: integer + minimum: -120 + maximum: 25 + + tjMDTListOfMeasurements-Type: + description: See details in 3GPP TS 32.422 clause 5.10.3 for details. + type: object + properties: + UMTS: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M6_DL + - M6_UL + - M7_DL + - M7_UL + LTE: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M1_EVENT_TRIGGERED + - M6 + - M7 + - M8 + - M9 + NR: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M6 + - M7 + - M8 + - M9 + + tjMDTLoggingDuration-Type: + description: See details in 3GPP TS 32.422 clause 5.10.9. + type: string + enum: + - 600s + - 1200s + - 2400s + - 3600s + - 5400s + - 7200s + + tjMDTLoggingInterval-Type: + description: See details in 3GPP TS 32.422 clause 5.10.8. + type: string + enum: + - 1.28s + - 2.56s + - 5.12s + - 10.24s + - 20.48s + - 30.72s + - 40.96s + - 61.44s + + tjMDTMBSFNAreaList-Type: + description: See details in 3GPP TS 32.422 clause 5.10.25. + type: array + items: + type: object + properties: + mbsfnAreaId: + type: integer + minimum: 1 + earfcn: + type: integer + minimum: 1 + required: + - mbsfnAreaId + - earfcn + + tjMDTMeasurementPeriodLTE-Type: + description: See details in 3GPP TS 32.422 clause 5.10.23. + type: string + enum: + - 1024ms + - 1280ms + - 2048ms + - 2560ms + - 5120ms + - 10240ms + - 1min + + tjMDTMeasurementPeriodUMTS-Type: + description: See details in 3GPP TS 32.422 clause 5.10.22. + type: string + enum: + - 250ms + - 500ms + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + - 8000ms + - 12000ms + - 16000ms + - 20000ms + - 24000ms + - 28000ms + - 32000ms + - 64000ms + + tjMDTMeasurementQuantity-Type: + description: See details in 3GPP TS 32.422 clause 5.10.15. + type: string + enum: + - CPICH_EcNo + - CPICH_RSCP + - PathLoss + + tjMDTPLMList-Type: + description: See details in 3GPP TS 32.422 clause 5.10.24. + type: array + items: + type: object + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + required: + - mcc + - mnc + maxItems: 16 + + tjMDTPositioningMethod-Type: + description: See details in 3GPP TS 32.422 clause 5.10.19. + type: string + enum: + - GNSS + - E-CELL_ID + + tjMDTReportAmount-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + tjMDTReportingTrigger-Type: + description: See details in 3GPP TS 32.422 clause 5.10.4. + type: array + items: + type: string + enum: + - PERIODICAL + - A2_FOR_LTE + - 1F_FOR_UMTS + - 1I_FOR_UMTS_MCPS_TDD + - A2_TRIGGERED_PERIODIC_FOR_LTE + - ALL_CONFIGURED_RRM_FOR_LTE + - ALL_CONFIGURED_RRM_FOR_UMTS + + tjMDTReportInterval-Type: + description: See details in 3GPP TS 32.422 clause 5.10.5. + type: string + enum: + - 250ms + - 500ms + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + - 8000ms + - 12000ms + - 16000ms + - 20000ms + - 24000ms + - 28000ms + - 32000ms + - 64000ms + - 120ms + - 240ms + - 480ms + - 640ms + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 60000ms + - 360000ms + - 720000ms + - 1800000ms + - 3600000ms + + tjMDTReportType-Type: + description: Report type for logged NR MDT. See details in 3GPP TS 32.422 clause 5.10.27. + type: string + enum: + - PERIODICAL + - EVENT_TRIGGERED + + tjMDTSensorInformation-Type: + description: See details in 3GPP TS 32.422 clause 5.10.29. + type: array + items: + type: string + enum: + - BAROMETRIC_PRESSURE + - UE_SPEED + - UE_ORIENTATION + + tjMDTTraceCollectionEntityID-Type: + description: See details in 3GPP TS 32.422 clause 5.10.11. Only tceID value may be sent over the air to the UE being configured for Logged MDT. + type: object + properties: + tceID: + type: integer + tcePLMN: + type: object + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + required: + - mcc + - mnc + tceAddress: + oneOf: + - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' + - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' + required: + - tceID + - tcePLMN + - tceAddress + + +#-------- end of Definition of types used in Trace control NRM fragment ---------- + + +#-------- Definition of abstract IOC Top ----------------------------------------- + + Top-Attr: + # This definition will be deprecated, when all occurances of Top-Attr + # are replaced by Top. + type: object + properties: + id: + type: string + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + Top: + type: object + properties: + id: + type: string + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + +#-------- Definition of IOCs with new name-containments defined in other TS ------ + + SubNetwork-Attr: + type: object + properties: + dnPrefix: + type: string + userLabel: + type: string + userDefinedNetworkType: + type: string + setOfMcc: + $ref: '#/components/schemas/SetOfMcc' + priorityLabel: + type: integer + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + ManagedElement-Attr: + type: object + properties: + dnPrefix: + type: string + managedElementTypeList: + $ref: '#/components/schemas/ManagedElementTypeList' + userLabel: + type: string + locationName: + type: string + managedBy: + $ref: '#/components/schemas/DnList' + vendorName: + type: string + userDefinedState: + type: string + swVersion: + type: string + priorityLabel: + type: integer + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + + SubNetwork-ncO: + type: object + properties: + ManagementNode: + $ref: '#/components/schemas/ManagementNode-Multiple' + MeContext: + $ref: '#/components/schemas/MeContext-Multiple' + PerfMetricJob: + $ref: '#/components/schemas/PerfMetricJob-Multiple' + ThresholdMonitor: + $ref: '#/components/schemas/ThresholdMonitor-Multiple' + ThresholdMonitoringCapability: + $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' + NtfSubscriptionControl: + $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' + TraceJob: + $ref: '#/components/schemas/TraceJob-Multiple' + AlarmList: + $ref: '#/components/schemas/AlarmList-Single' + MnsRegistry: + type: array + items: + $ref: '#/components/schemas/MnsRegistry' + ManagedElement-ncO: + type: object + properties: + PerfMetricJob: + $ref: '#/components/schemas/PerfMetricJob-Multiple' + ThresholdMonitor: + $ref: '#/components/schemas/ThresholdMonitor-Multiple' + ThresholdMonitoringCapability: + $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' + NtfSubscriptionControl: + $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' + TraceJob: + $ref: '#/components/schemas/TraceJob-Multiple' + AlarmList: + $ref: '#/components/schemas/AlarmList-Single' + +#-------- Definition of abstract IOCs -------------------------------------------- + + ManagedFunction-Attr: + type: object + properties: + userLabel: + type: string + vnfParametersList: + $ref: '#/components/schemas/VnfParametersList' + peeParametersList: + $ref: '#/components/schemas/PeeParametersList' + priorityLabel: + type: integer + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + EP_RP-Attr: + type: object + properties: + userLabel: + type: string + farEndEntity: + type: string + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + + TraceJob-Attr: + type: object + description: abstract class used as a container of all TraceJob attributes + properties: + tjJobType: + $ref: '#/components/schemas/tjJobType-Type' + tjListOfInterfaces: + $ref: '#/components/schemas/tjListOfInterfaces-Type' + tjListOfNeTypes: + $ref: '#/components/schemas/tjListOfNeTypes-Type' + tjPLMNTarget: + $ref: '#/components/schemas/tjPLMNTaget-Type' + tjTraceConsumer: + oneOf: + - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' + - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' + tjTraceDepth: + $ref: '#/components/schemas/tjTraceDepth-Type' + tjTraceReference: + $ref: '#/components/schemas/tjTraceReference-Type' + tjTraceReportingFormat: + $ref: '#/components/schemas/tjTraceReportingFormat-Type' + tjTraceTarget: + $ref: '#/components/schemas/tjTraceTarget-Type' + tjTriggeringEvent: + $ref: '#/components/schemas/tjTriggeringEvent-Type' + tjMDTAnonymizationOfData: + $ref: '#/components/schemas/tjMDTAnonymizationOfData-Type' + tjMDTAreaConfigurationForNeighCell: + $ref: '#/components/schemas/tjMDTAreaConfigurationForNeighCell-Type' + tjMDTAreaScope: + $ref: '#/components/schemas/tjMDTAreaScope-Type' + tjMDTCollectionPeriodRrmLte: + $ref: '#/components/schemas/tjMDTCollectionPeriodRrmLte-Type' + tjMDTCollectionPeriodRrmUmts: + $ref: '#/components/schemas/tjMDTCollectionPeriodRrmUmts-Type' + tjMDTEventListForTriggeredMeasurement: + $ref: '#/components/schemas/tjMDTEventListForTriggeredMeasurement-Type' + tjMDTEventThreshold: + $ref: '#/components/schemas/tjMDTEventThreshold-Type' + tjMDTListOfMeasurements: + $ref: '#/components/schemas/tjMDTListOfMeasurements-Type' + tjMDTLoggingDuration: + $ref: '#/components/schemas/tjMDTLoggingDuration-Type' + tjMDTLoggingInterval: + $ref: '#/components/schemas/tjMDTLoggingInterval-Type' + tjMDTMBSFNAreaList: + $ref: '#/components/schemas/tjMDTMBSFNAreaList-Type' + tjMDTMeasurementPeriodLTE: + $ref: '#/components/schemas/tjMDTMeasurementPeriodLTE-Type' + tjMDTMeasurementPeriodUMTS: + $ref: '#/components/schemas/tjMDTMeasurementPeriodUMTS-Type' + tjMDTMeasurementQuantity: + $ref: '#/components/schemas/tjMDTMeasurementQuantity-Type' + tjMDTPLMList: + $ref: '#/components/schemas/tjMDTPLMList-Type' + tjMDTPositioningMethod: + $ref: '#/components/schemas/tjMDTPositioningMethod-Type' + tjMDTReportAmount: + $ref: '#/components/schemas/tjMDTReportAmount-Type' + tjMDTReportingTrigger: + $ref: '#/components/schemas/tjMDTReportingTrigger-Type' + tjMDTReportInterval: + $ref: '#/components/schemas/tjMDTReportInterval-Type' + tjMDTReportType: + $ref: '#/components/schemas/tjMDTReportType-Type' + tjMDTSensorInformation: + $ref: '#/components/schemas/tjMDTSensorInformation-Type' + tjMDTTraceCollectionEntityID: + $ref: '#/components/schemas/tjMDTTraceCollectionEntityID-Type' + required: + - tjJobType + - tjTraceReference + - tjTraceConsumer + - tjTraceReportingFormat + - tjTraceTarget + + ManagedFunction-ncO: + type: object + properties: + PerfMetricJob: + $ref: '#/components/schemas/PerfMetricJob-Multiple' + ThresholdMonitor: + $ref: '#/components/schemas/ThresholdMonitor-Multiple' + ThresholdMonitoringCapability: + $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' + ManagedNFService: + $ref: '#/components/schemas/ManagedNFService-Multiple' + TraceJob: + $ref: '#/components/schemas/TraceJob-Multiple' + + MnsRegistry: + type: object + properties: + mnsLabel: + type: string + mnsType: + type: string + mnsVersion: + type: string + mnsAddress: + type: string + +#-------- Definition of concrete IOCs -------------------------------------------- + + VsDataContainer-Single: + type: object + properties: + id: + type: string + attributes: + type: object + properties: + vsDataType: + type: string + vsDataFormatVersion: + type: string + vsData: + nullable: true + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + ManagedNFService-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + userLabel: + type: string + nFServiceType: + $ref: '#/components/schemas/NFServiceType' + sAP: + $ref: '#/components/schemas/SAP' + operations: + $ref: '#/components/schemas/OperationList' + administrativeState: + $ref: '#/components/schemas/AdministrativeState' + operationalState: + $ref: '#/components/schemas/OperationalState' + usageState: + $ref: '#/components/schemas/UsageState' + registrationState: + $ref: '#/components/schemas/RegistrationState' + ManagementNode-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + userLabel: + type: string + managedElements: + $ref: '#/components/schemas/DnList' + vendorName: + type: string + userDefinedState: + type: string + locationName: + type: string + swVersion: + type: string + MeContext-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + dnPrefix: + type: string + PerfMetricJob-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + administrativeState: + $ref: '#/components/schemas/AdministrativeState' + operationalState: + $ref: '#/components/schemas/OperationalState' + perfMetricJobGroupId: + type: string + performanceMetrics: + type: array + items: + type: string + granularityPeriod: + type: integer + minimum: 1 + objectInstances: + $ref: '#/components/schemas/DnList' + rootObjectInstances: + $ref: '#/components/schemas/DnList' + reportingCtrl: + $ref: '#/components/schemas/ReportingCtrl' + ThresholdMonitoringCapability-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + supportedMonitoringGPs: + $ref: '#/components/schemas/MonitoringGPList' + ThresholdMonitor-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + thresholdInfoList: + $ref: '#/components/schemas/ThresholdInfoList' + monitoringGP: + type: integer + monitoringNotifTarget: + type: string + monitoredIOCName: + type: string + monitoredObjectDNs: + $ref: '#/components/schemas/DnList' + NtfSubscriptionControl-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + notificationRecipientAddress: + $ref: '#/components/schemas/Uri' + notificationTypes: + $ref: '#/components/schemas/NotificationTypes' + scope: + $ref: '#/components/schemas/Scope' + notificationFilter: + type: string + HeartbeatControl: + $ref: '#/components/schemas/HeartbeatControl-Single' + HeartbeatControl-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + heartbeatNtfPeriod: + type: integer + triggerHeartbeatNtf: + type: boolean + TraceJob-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + $ref: '#/components/schemas/TraceJob-Attr' + + AlarmList-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + administrativeState: + $ref: '#/components/schemas/AdministrativeState' + operationalState: + $ref: '#/components/schemas/OperationalState' + numOfAlarmRecords: + type: integer + lastModification: + $ref: '#/components/schemas/DateTime' + alarmRecords: + description: >- + This resource represents a map of alarm records. + The alarmIds are used as keys in the map. + type: object + additionalProperties: + $ref: 'faultMnS.yaml#/components/schemas/AlarmRecord' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + VsDataContainer-Multiple: + type: array + items: + $ref: '#/components/schemas/VsDataContainer-Single' + ManagedNFService-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedNFService-Single' + ManagementNode-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagementNode-Single' + MeContext-Multiple: + type: array + items: + $ref: '#/components/schemas/MeContext-Single' + PerfMetricJob-Multiple: + type: array + items: + $ref: '#/components/schemas/PerfMetricJob-Single' + ThresholdMonitor-Multiple: + type: array + items: + $ref: '#/components/schemas/ThresholdMonitor-Single' + NtfSubscriptionControl-Multiple: + type: array + items: + $ref: '#/components/schemas/NtfSubscriptionControl-Single' + TraceJob-Multiple: + type: array + items: + $ref: '#/components/schemas/TraceJob-Single' + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + + resources-genericNrm: + oneOf: + + - $ref: '#/components/schemas/VsDataContainer-Single' + + - $ref: '#/components/schemas/ManagementNode-Single' + - $ref: '#/components/schemas/MeContext-Single' + + - $ref: '#/components/schemas/ManagedNFService-Single' + + - $ref: '#/components/schemas/PerfMetricJob-Single' + + - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' + - $ref: '#/components/schemas/ThresholdMonitor-Single' + + - $ref: '#/components/schemas/NtfSubscriptionControl-Single' + - $ref: '#/components/schemas/HeartbeatControl-Single' + - $ref: '#/components/schemas/TraceJob-Single' + + - $ref: '#/components/schemas/AlarmList-Single' diff --git a/OpenAPI/heartbeatNtf.yaml b/OpenAPI/heartbeatNtf.yaml new file mode 100644 index 000000000..afde5066d --- /dev/null +++ b/OpenAPI/heartbeatNtf.yaml @@ -0,0 +1,23 @@ +openapi: 3.0.1 +info: + title: Heartbeat notification + version: 16.3.0 + description: >- + OAS 3.0.1 specification of the heartbeat notification + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.532 V16.3.0; Heartbeat notification + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.6532/ +paths: {} +components: + schemas: + hearbeatNtfPeriod-Type: + type: integer + notifyHeartbeat-NotifType: + allOf: + - $ref: 'provMnS.yaml#/components/schemas/header-Type' + - type: object + properties: + heartbeatNtfPeriod: + $ref: '#/components/schemas/hearbeatNtfPeriod-Type' diff --git a/OpenAPI/nrNrm.yaml b/OpenAPI/nrNrm.yaml new file mode 100644 index 000000000..850106631 --- /dev/null +++ b/OpenAPI/nrNrm.yaml @@ -0,0 +1,1905 @@ +openapi: 3.0.1 +info: + title: NR NRM + version: 17.4.0 + description: >- + OAS 3.0.1 specification of the NR NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.541; 5G NRM, NR NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + GnbId: + type: string + GnbIdLength: + type: integer + minimum: 22 + maximum: 32 + GnbName: + type: string + maxLength: 150 + GnbDuId: + type: number + minimum: 0 + maximum: 68719476735 + GnbCuUpId: + type: number + minimum: 0 + maximum: 68719476735 + + Sst: + type: integer + maximum: 255 + Snssai: + type: object + properties: + sst: + $ref: '#/components/schemas/Sst' + sd: + type: string + SnssaiList: + type: array + items: + $ref: '#/components/schemas/Snssai' + + Mnc: + type: string + pattern: '[0-9]{3}|[0-9]{2}' + PlmnId: + type: object + properties: + mcc: + $ref: 'genericNrm.yaml#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + PlmnIdList: + type: array + items: + $ref: '#/components/schemas/PlmnId' + PlmnInfo: + type: object + properties: + plmnId": + $ref: '#/components/schemas/PlmnId' + snssai: + $ref: '#/components/schemas/Snssai' + PlmnInfoList: + type: array + items: + $ref: '#/components/schemas/PlmnInfo' + cagId: + type: string + nid: + type: string + NpnIdentity: + type: object + properties: + plmnId": + $ref: '#/components/schemas/PlmnId' + cagidList: + $ref: '#/components/schemas/cagId' + nidList: + $ref: '#/components/schemas/nid' + NpnIdentityList: + type: array + items: + $ref: '#/components/schemas/NpnIdentity' + GGnbId: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}-(22|23|24|25|26|27|28|29|30|31|32)-[0-9]{1,10}' + GEnbId: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}-(18|20|21|22)-[0-9]{1,7}' + + GGnbIdList: + type: array + items: + $ref: '#/components/schemas/GGnbId' + + GEnbIdList: + type: array + items: + $ref: '#/components/schemas/GEnbId' + + NrPci: + type: integer + maximum: 503 + NrTac: + type: integer + maximum: 16777215 + Tai: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + nrTac: + $ref: '#/components/schemas/NrTac' + + BackhaulAddress: + type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + tai: + $ref: "#/components/schemas/Tai" + MappingSetIDBackhaulAddress: + type: object + properties: + setID: + type: integer + backhaulAddress: + $ref: '#/components/schemas/BackhaulAddress' + IntraRatEsActivationOriginalCellLoadParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + IntraRatEsActivationCandidateCellsLoadParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + IntraRatEsDeactivationCandidateCellsLoadParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + EsNotAllowedTimePeriod: + type: object + properties: + startTimeandendTime: + type: string + periodOfDay: + type: string + daysOfWeekList: + type: string + listoftimeperiods: + type: string + InterRatEsActivationOriginalCellParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + InterRatEsActivationCandidateCellParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + InterRatEsDeactivationCandidateCellParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + + UeAccProbilityDist: + type: object + properties: + targetProbability: + type: integer + numberofpreamblessent: + type: integer + + UeAccDelayProbilityDist: + type: object + properties: + targetProbability: + type: integer + accessdelay: + type: integer + + NRPciList: + type: object + properties: + NRPci: + type: integer + + CSonPciList: + type: object + properties: + NRPci: + type: integer + + MaximumDeviationHoTrigger: + type: integer + minimum: -20 + maximum: 20 + + MinimumTimeBetweenHoTriggerChange: + type: integer + minimum: 0 + maximum: 604800 + + TstoreUEcntxt: + type: integer + minimum: 0 + maximum: 1023 + + CellState: + type: string + enum: + - IDLE + - INACTIVE + - ACTIVE + CyclicPrefix: + type: string + enum: + - '15' + - '30' + - '60' + - '120' + TxDirection: + type: string + enum: + - DL + - UL + - DL and UL + BwpContext: + type: string + enum: + - DL + - UL + - SUL + IsInitialBwp: + type: string + enum: + - INITIAL + - OTHER + - SUL + QuotaType: + type: string + enum: + - STRICT + - FLOAT + IsESCoveredBy: + type: string + enum: + - NO + - PARTIAL + - FULL + RrmPolicyMember: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + snssai: + $ref: '#/components/schemas/Snssai' + RrmPolicyMemberList: + type: array + items: + $ref: '#/components/schemas/RrmPolicyMember' + AddressWithVlan: + type: object + properties: + ipv4Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + ipv6Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + vlanId: + type: integer + minimum: 0 + maximum: 4096 + LocalAddress: + type: object + properties: + addressWithVlan: + $ref: '#/components/schemas/AddressWithVlan' + port: + type: integer + minimum: 0 + maximum: 65535 + RemoteAddress: + type: object + properties: + ipv4Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + ipv6Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + + CellIndividualOffset: + type: object + properties: + rsrpOffsetSSB: + type: integer + rsrqOffsetSSB: + type: integer + sinrOffsetSSB: + type: integer + rsrpOffsetCSI-RS: + type: integer + rsrqOffsetCSI-RS: + type: integer + sinrOffsetCSI-RS: + type: integer + QOffsetRange: + type: integer + enum: + - -24 + - -22 + - -20 + - -18 + - -16 + - -14 + - -12 + - -10 + - -8 + - -6 + - -5 + - -4 + - -3 + - -2 + - -1 + - 0 + - 24 + - 22 + - 20 + - 18 + - 16 + - 14 + - 12 + - 10 + - 8 + - 6 + - 5 + - 4 + - 3 + - 2 + - 1 + QOffsetRangeList: + type: object + properties: + rsrpOffsetSSB: + $ref: '#/components/schemas/QOffsetRange' + rsrqOffsetSSB: + $ref: '#/components/schemas/QOffsetRange' + sinrOffsetSSB: + $ref: '#/components/schemas/QOffsetRange' + rsrpOffsetCSI-RS: + $ref: '#/components/schemas/QOffsetRange' + rsrqOffsetCSI-RS: + $ref: '#/components/schemas/QOffsetRange' + sinrOffsetCSI-RS: + $ref: '#/components/schemas/QOffsetRange' + QOffsetFreq: + type: number + TReselectionNRSf: + type: integer + enum: + - 25 + - 50 + - 75 + - 100 + SsbPeriodicity: + type: integer + enum: + - 5 + - 10 + - 20 + - 40 + - 80 + - 160 + SsbDuration: + type: integer + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + SsbSubCarrierSpacing: + type: integer + enum: + - 15 + - 30 + - 120 + - 240 + CoverageShape: + type: integer + maximum: 65535 + DigitalTilt: + type: integer + minimum: -900 + maximum: 900 + DigitalAzimuth: + type: integer + minimum: -1800 + maximum: 1800 + + RSSetId: + type: integer + maximum: 4194303 + + RSSetType: + type: string + enum: + - RS1 + - RS2 + + FrequencyDomainPara: + type: object + properties: + rimRSSubcarrierSpacing: + type: integer + rIMRSBandwidth: + type: integer + nrofGlobalRIMRSFrequencyCandidates: + type: integer + rimRSCommonCarrierReferencePoint: + type: integer + rimRSStartingFrequencyOffsetIdList: + type: array + items: + type: integer + + SequenceDomainPara: + type: object + properties: + nrofRIMRSSequenceCandidatesofRS1: + type: integer + rimRSScrambleIdListofRS1: + type: array + items: + type: integer + nrofRIMRSSequenceCandidatesofRS2: + type: integer + rimRSScrambleIdListofRS2: + type: array + items: + type: integer + enableEnoughNotEnoughIndication: + type: string + enum: + - ENABLE + - DISABLE + RIMRSScrambleTimerMultiplier: + type: integer + RIMRSScrambleTimerOffset: + type: integer + + TimeDomainPara: + type: object + properties: + dlULSwitchingPeriod1: + type: string + enum: + - MS0P5 + - MS0P625 + - MS1 + - MS1P25 + - MS2 + - MS2P5 + - MS3 + - MS4 + - MS5 + - MS10 + - MS20 + symbolOffsetOfReferencePoint1: + type: integer + dlULSwitchingPeriod2: + type: string + enum: + - MS0P5 + - MS0P625 + - MS1 + - MS1P25 + - MS2 + - MS2P5 + - MS3 + - MS4 + - MS5 + - MS10 + - MS20 + symbolOffsetOfReferencePoint2: + type: integer + totalnrofSetIdofRS1: + type: integer + totalnrofSetIdofRS2: + type: integer + nrofConsecutiveRIMRS1: + type: integer + nrofConsecutiveRIMRS2: + type: integer + consecutiveRIMRS1List: + type: array + items: + type: integer + consecutiveRIMRS2List: + type: array + items: + type: integer + enablenearfarIndicationRS1: + type: string + enum: + - ENABLE + - DISABLE + enablenearfarIndicationRS2: + type: string + enum: + - ENABLE + - DISABLE + + RimRSReportInfo: + type: object + properties: + detectedSetID: + type: integer + propagationDelay: + type: integer + functionalityOfRIMRS: + type: string + enum: + - RS1 + - RS2 + - RS1forEnoughMitigation + - RS1forNotEnoughMitigation + + RimRSReportConf: + type: object + properties: + reportIndicator: + type: string + enum: + - ENABLE + - DISABLE + reportInterval: + type: integer + nrofRIMRSReportInfo: + type: integer + maxPropagationDelay: + type: integer + rimRSReportInfoList: + type: array + items: + $ref: '#/components/schemas/RimRSReportInfo' + TceMappingInfo: + type: object + properties: + TceIPAddress: + oneOf: + - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + TceID: + type: integer + PlmnTarget: + $ref: '#/components/schemas/PlmnId' + TceMappingInfoList: + type: array + items: + $ref: '#/components/schemas/TceMappingInfo' + + +#-------- Definition of abstract IOCs -------------------------------------------- + + RrmPolicy_-Attr: + type: object + properties: + resourceType: + type: string + rRMPolicyMemberList: + $ref: '#/components/schemas/RrmPolicyMemberList' + + +#-------- Definition of concrete IOCs -------------------------------------------- + + SubNetwork-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + NRFrequency: + $ref: '#/components/schemas/NRFrequency-Multiple' + ExternalGnbCuCpFunction: + $ref: '#/components/schemas/ExternalGnbCuCpFunction-Multiple' + ExternalENBFunction: + $ref: '#/components/schemas/ExternalENBFunction-Multiple' + EUtranFrequency: + $ref: '#/components/schemas/EUtranFrequency-Multiple' + DESManagementFunction: + $ref: '#/components/schemas/DESManagementFunction-Single' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + DMROFunction: + $ref: '#/components/schemas/DMROFunction-Single' + DPCIConfigurationFunction: + $ref: '#/components/schemas/DPCIConfigurationFunction-Single' + CPCIConfigurationFunction: + $ref: '#/components/schemas/CPCIConfigurationFunction-Single' + CESManagementFunction: + $ref: '#/components/schemas/CESManagementFunction-Single' + Configurable5QISet: + $ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' + RimRSGlobal: + $ref: '#/components/schemas/RimRSGlobal-Single' + Dynamic5QISet: + $ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' + + ManagedElement-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' + - type: object + properties: + GnbDuFunction: + $ref: '#/components/schemas/GnbDuFunction-Multiple' + GnbCuUpFunction: + $ref: '#/components/schemas/GnbCuUpFunction-Multiple' + GnbCuCpFunction: + $ref: '#/components/schemas/GnbCuCpFunction-Multiple' + DESManagementFunction: + $ref: '#/components/schemas/DESManagementFunction-Single' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + DMROFunction: + $ref: '#/components/schemas/DMROFunction-Single' + DPCIConfigurationFunction: + $ref: '#/components/schemas/DPCIConfigurationFunction-Single' + CPCIConfigurationFunction: + $ref: '#/components/schemas/CPCIConfigurationFunction-Single' + CESManagementFunction: + $ref: '#/components/schemas/CESManagementFunction-Single' + Configurable5QISet: + $ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' + + GnbDuFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + gnbDuId: + $ref: '#/components/schemas/GnbDuId' + gnbDuName: + $ref: '#/components/schemas/GnbName' + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + rimRSReportConf: + $ref: '#/components/schemas/RimRSReportConf' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + RRMPolicyRatio: + $ref: '#/components/schemas/RRMPolicyRatio-Multiple' + NrCellDu: + $ref: '#/components/schemas/NrCellDu-Multiple' + Bwp-Multiple: + $ref: '#/components/schemas/Bwp-Multiple' + NrSectorCarrier-Multiple: + $ref: '#/components/schemas/NrSectorCarrier-Multiple' + EP_F1C: + $ref: '#/components/schemas/EP_F1C-Single' + EP_F1U: + $ref: '#/components/schemas/EP_F1U-Multiple' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + GnbCuUpFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + gnbCuUpId: + $ref: '#/components/schemas/GnbCuUpId' + plmnInfoList: + $ref: '#/components/schemas/PlmnInfoList' + configurable5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + RRMPolicyRatio: + $ref: '#/components/schemas/RRMPolicyRatio-Multiple' + EP_E1: + $ref: '#/components/schemas/EP_E1-Single' + EP_XnU: + $ref: '#/components/schemas/EP_XnU-Multiple' + EP_F1U: + $ref: '#/components/schemas/EP_F1U-Multiple' + EP_NgU: + $ref: '#/components/schemas/EP_NgU-Multiple' + EP_X2U: + $ref: '#/components/schemas/EP_X2U-Multiple' + EP_S1U: + $ref: '#/components/schemas/EP_S1U-Multiple' + GnbCuCpFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + gnbCuName: + $ref: '#/components/schemas/GnbName' + plmnId: + $ref: '#/components/schemas/PlmnId' + x2BlackList: + $ref: '#/components/schemas/GGnbIdList' + xnBlackList: + $ref: '#/components/schemas/GGnbIdList' + x2WhiteList: + $ref: '#/components/schemas/GGnbIdList' + xnWhiteList: + $ref: '#/components/schemas/GGnbIdList' + x2XnHOBlackList: + $ref: '#/components/schemas/GEnbIdList' + mappingSetIDBackhaulAddress: + $ref: '#/components/schemas/MappingSetIDBackhaulAddress' + tceMappingInfoList: + $ref: '#/components/schemas/TceMappingInfoList' + configurable5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + RRMPolicyRatio: + $ref: '#/components/schemas/RRMPolicyRatio-Multiple' + NrCellCu: + $ref: '#/components/schemas/NrCellCu-Multiple' + EP_XnC: + $ref: '#/components/schemas/EP_XnC-Multiple' + EP_E1: + $ref: '#/components/schemas/EP_E1-Multiple' + EP_F1C: + $ref: '#/components/schemas/EP_F1C-Multiple' + EP_NgC: + $ref: '#/components/schemas/EP_NgC-Multiple' + EP_X2C: + $ref: '#/components/schemas/EP_X2C-Multiple' + DANRManagementFunction: + $ref: '#/components/schemas/DANRManagementFunction-Single' + DESManagementFunction: + $ref: '#/components/schemas/DESManagementFunction-Single' + DMROFunction: + $ref: '#/components/schemas/DMROFunction-Single' + + NrCellCu-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + cellLocalId: + type: integer + plmnInfoList: + $ref: '#/components/schemas/PlmnInfoList' + nRFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + RRMPolicyRatio: + $ref: '#/components/schemas/RRMPolicyRatio-Multiple' + NRCellRelation: + $ref: '#/components/schemas/NRCellRelation-Multiple' + EUtranCellRelation: + $ref: '#/components/schemas/EUtranCellRelation-Multiple' + NRFreqRelation: + $ref: '#/components/schemas/NRFreqRelation-Multiple' + EUtranFreqRelation: + $ref: '#/components/schemas/EUtranFreqRelation-Multiple' + DESManagementFunction: + $ref: '#/components/schemas/DESManagementFunction-Single' + DMROFunction: + $ref: '#/components/schemas/DMROFunction-Single' + CESManagementFunction: + $ref: '#/components/schemas/CESManagementFunction-Single' + DPCIConfigurationFunction: + $ref: '#/components/schemas/DPCIConfigurationFunction-Single' + + NrCellDu-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + administrativeState: + $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'genericNrm.yaml#/components/schemas/OperationalState' + cellLocalId: + type: integer + cellState: + $ref: '#/components/schemas/CellState' + plmnInfoList: + $ref: '#/components/schemas/PlmnInfoList' + npnIdentityList: + $ref: '#/components/schemas/NpnIdentityList' + nrPci: + $ref: '#/components/schemas/NrPci' + nrTac: + $ref: '#/components/schemas/NrTac' + arfcnDL: + type: integer + arfcnUL: + type: integer + arfcnSUL: + type: integer + bSChannelBwDL: + type: integer + bSChannelBwUL: + type: integer + bSChannelBwSUL: + type: integer + ssbFrequency: + type: integer + minimum: 0 + maximum: 3279165 + ssbPeriodicity: + $ref: '#/components/schemas/SsbPeriodicity' + ssbSubCarrierSpacing: + $ref: '#/components/schemas/SsbSubCarrierSpacing' + ssbOffset: + type: integer + minimum: 0 + maximum: 159 + ssbDuration: + $ref: '#/components/schemas/SsbDuration' + nrSectorCarrierRef: + type: array + items: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + bwpRef: + type: array + items: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + rimRSMonitoringStartTime: + type: string + rimRSMonitoringStopTime: + type: string + rimRSMonitoringWindowDuration: + type: integer + rimRSMonitoringWindowStartingOffset: + type: integer + rimRSMonitoringWindowPeriodicity: + type: integer + rimRSMonitoringOccasionInterval: + type: integer + rimRSMonitoringOccasionStartingOffset: + type: integer + nRFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + victimSetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + aggressorSetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + RRMPolicyRatio: + $ref: '#/components/schemas/RRMPolicyRatio-Multiple' + CPCIConfigurationFunction: + $ref: '#/components/schemas/CPCIConfigurationFunction-Single' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + + NRFrequency-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + absoluteFrequencySSB: + type: integer + minimum: 0 + maximum: 3279165 + ssbSubCarrierSpacing: + $ref: '#/components/schemas/SsbSubCarrierSpacing' + multiFrequencyBandListNR: + type: integer + minimum: 1 + maximum: 256 + EUtranFrequency-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + earfcnDL: + type: integer + minimum: 0 + maximum: 262143 + multiBandInfoListEutra: + type: integer + minimum: 1 + maximum: 256 + + NrSectorCarrier-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + txDirection: + $ref: '#/components/schemas/TxDirection' + configuredMaxTxPower: + type: integer + arfcnDL: + type: integer + arfcnUL: + type: integer + bSChannelBwDL: + type: integer + bSChannelBwUL: + type: integer + sectorEquipmentFunctionRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + CommonBeamformingFunction: + $ref: '#/components/schemas/CommonBeamformingFunction-Single' + Bwp-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + bwpContext: + $ref: '#/components/schemas/BwpContext' + isInitialBwp: + $ref: '#/components/schemas/IsInitialBwp' + subCarrierSpacing: + type: integer + cyclicPrefix: + $ref: '#/components/schemas/CyclicPrefix' + startRB: + type: integer + numberOfRBs: + type: integer + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + CommonBeamformingFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + coverageShape: + $ref: '#/components/schemas/CoverageShape' + digitalAzimuth: + $ref: '#/components/schemas/DigitalAzimuth' + digitalTilt: + $ref: '#/components/schemas/DigitalTilt' + - type: object + properties: + Beam: + $ref: '#/components/schemas/Beam-Multiple' + Beam-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + beamIndex: + type: integer + beamType: + type: string + enum: + - SSB-BEAM + beamAzimuth: + type: integer + minimum: -1800 + maximum: 1800 + beamTilt: + type: integer + minimum: -900 + maximum: 900 + beamHorizWidth: + type: integer + minimum: 0 + maximum: 3599 + beamVertWidth: + type: integer + minimum: 0 + maximum: 1800 + RRMPolicyRatio-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: '#/components/schemas/RrmPolicy_-Attr' + - type: object + properties: + rRMPolicyMaxRatio: + type: integer + rRMPolicyMinRatio: + type: integer + rRMPolicyDedicatedRatio: + type: integer + + NRCellRelation-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + nRTCI: + type: integer + cellIndividualOffset: + $ref: '#/components/schemas/CellIndividualOffset' + adjacentNRCellRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + nRFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + isRemoveAllowed: + type: boolean + isHOAllowed: + type: boolean + isESCoveredBy: + $ref: '#/components/schemas/IsESCoveredBy' + isENDCAllowed: + type: boolean + isMLBAllowed: + type: boolean + EUtranCellRelation-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + adjacentEUtranCellRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + NRFreqRelation-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + offsetMO: + $ref: '#/components/schemas/QOffsetRangeList' + blackListEntry: + type: array + items: + type: integer + minimum: 0 + maximum: 1007 + blackListEntryIdleMode: + type: integer + cellReselectionPriority: + type: integer + cellReselectionSubPriority: + type: number + minimum: 0.2 + maximum: 0.8 + multipleOf: 0.2 + pMax: + type: integer + minimum: -30 + maximum: 33 + qOffsetFreq: + $ref: '#/components/schemas/QOffsetFreq' + qQualMin: + type: number + qRxLevMin: + type: integer + minimum: -140 + maximum: -44 + threshXHighP: + type: integer + minimum: 0 + maximum: 62 + threshXHighQ: + type: integer + minimum: 0 + maximum: 31 + threshXLowP: + type: integer + minimum: 0 + maximum: 62 + threshXLowQ: + type: integer + minimum: 0 + maximum: 31 + tReselectionNr: + type: integer + minimum: 0 + maximum: 7 + tReselectionNRSfHigh: + $ref: '#/components/schemas/TReselectionNRSf' + tReselectionNRSfMedium: + $ref: '#/components/schemas/TReselectionNRSf' + nRFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + EUtranFreqRelation-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + cellIndividualOffset: + $ref: '#/components/schemas/CellIndividualOffset' + blackListEntry: + type: array + items: + type: integer + minimum: 0 + maximum: 1007 + blackListEntryIdleMode: + type: integer + cellReselectionPriority: + type: integer + cellReselectionSubPriority: + type: number + minimum: 0.2 + maximum: 0.8 + multipleOf: 0.2 + pMax: + type: integer + minimum: -30 + maximum: 33 + qOffsetFreq: + $ref: '#/components/schemas/QOffsetFreq' + qQualMin: + type: number + qRxLevMin: + type: integer + minimum: -140 + maximum: -44 + threshXHighP: + type: integer + minimum: 0 + maximum: 62 + threshXHighQ: + type: integer + minimum: 0 + maximum: 31 + threshXLowP: + type: integer + minimum: 0 + maximum: 62 + threshXLowQ: + type: integer + minimum: 0 + maximum: 31 + tReselectionEutran: + type: integer + minimum: 0 + maximum: 7 + tReselectionNRSfHigh: + $ref: '#/components/schemas/TReselectionNRSf' + tReselectionNRSfMedium: + $ref: '#/components/schemas/TReselectionNRSf' + eUTranFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + DANRManagementFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + intrasystemANRManagementSwitch: + type: boolean + intersystemANRManagementSwitch: + type: boolean + + DESManagementFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + desSwitch: + type: boolean + intraRatEsActivationOriginalCellLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + intraRatEsActivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationCandidateCellsLoadParameters" + intraRatEsDeactivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsDeactivationCandidateCellsLoadParameters" + esNotAllowedTimePeriod: + $ref: "#/components/schemas/EsNotAllowedTimePeriod" + interRatEsActivationOriginalCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsActivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsDeactivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + isProbingCapable: + type: string + enum: + - yes + - no + energySavingState: + type: string + enum: + - isNotEnergySaving + - isEnergySaving + + DRACHOptimizationFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + drachOptimizationControl: + type: boolean + ueAccProbilityDist: + $ref: "#/components/schemas/UeAccProbilityDist" + ueAccDelayProbilityDist: + $ref: "#/components/schemas/UeAccDelayProbilityDist" + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + + DMROFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + dmroControl: + type: boolean + maximumDeviationHoTrigger: + $ref: '#/components/schemas/MaximumDeviationHoTrigger' + minimumTimeBetweenHoTriggerChange: + $ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange' + tstoreUEcntxt: + $ref: '#/components/schemas/TstoreUEcntxt' + + DPCIConfigurationFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + dPciConfigurationControl: + type: boolean + nRPciList: + $ref: "#/components/schemas/NRPciList" + + CPCIConfigurationFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + cPciConfigurationControl: + type: boolean + cSonPciList: + $ref: "#/components/schemas/CSonPciList" + + CESManagementFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + cesSwitch: + type: boolean + intraRatEsActivationOriginalCellLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + intraRatEsActivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationCandidateCellsLoadParameters" + intraRatEsDeactivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsDeactivationCandidateCellsLoadParameters" + esNotAllowedTimePeriod: + $ref: "#/components/schemas/EsNotAllowedTimePeriod" + interRatEsActivationOriginalCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsActivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsDeactivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + energySavingControl: + type: string + enum: + - toBeEnergySaving + - toBeNotEnergySaving + energySavingState: + type: string + enum: + - isNotEnergySaving + - isEnergySaving + + RimRSGlobal-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + frequencyDomainPara: + $ref: '#/components/schemas/FrequencyDomainPara' + sequenceDomainPara: + $ref: '#/components/schemas/SequenceDomainPara' + timeDomainPara: + $ref: '#/components/schemas/TimeDomainPara' + RimRSSet: + $ref: '#/components/schemas/RimRSSet-Multiple' + + RimRSSet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + setId: + $ref: '#/components/schemas/RSSetId' + setType: + $ref: '#/components/schemas/RSSetType' + nRCellDURefs: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + + ExternalGnbDuFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_F1C: + $ref: '#/components/schemas/EP_F1C-Multiple' + EP_F1U: + $ref: '#/components/schemas/EP_F1U-Multiple' + ExternalGnbCuUpFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_E1: + $ref: '#/components/schemas/EP_E1-Multiple' + EP_F1U: + $ref: '#/components/schemas/EP_F1U-Multiple' + EP_XnU: + $ref: '#/components/schemas/EP_XnU-Multiple' + ExternalGnbCuCpFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: >- + genericNrm.yaml#/components/schemas/ManagedFunction-Attr + - type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + plmnId: + $ref: '#/components/schemas/PlmnId' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + ExternalNrCellCu: + $ref: '#/components/schemas/ExternalNrCellCu-Multiple' + EP_XnC: + $ref: '#/components/schemas/EP_XnC-Multiple' + EP_E1: + $ref: '#/components/schemas/EP_E1-Multiple' + EP_F1C: + $ref: '#/components/schemas/EP_F1C-Multiple' + ExternalNrCellCu-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + cellLocalId: + type: integer + nrPci: + $ref: '#/components/schemas/NrPci' + plmnIdList: + $ref: '#/components/schemas/PlmnIdList' + nRFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + ExternalENBFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + eNBId: + type: integer + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + ExternalEUTranCell: + $ref: '#/components/schemas/ExternalEUTranCell-Multiple' + ExternalEUTranCell-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + EUtranFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + + EP_XnC-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_E1-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_F1C-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_NgC-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_X2C-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_XnU-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_F1U-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + epTransportRefs: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + + EP_NgU-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + epTransportRefs: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + + EP_X2U-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_S1U-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + ManagedElement-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedElement-Single' + GnbDuFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/GnbDuFunction-Single' + GnbCuUpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/GnbCuUpFunction-Single' + GnbCuCpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/GnbCuCpFunction-Single' + + NrCellDu-Multiple: + type: array + items: + $ref: '#/components/schemas/NrCellDu-Single' + NrCellCu-Multiple: + type: array + items: + $ref: '#/components/schemas/NrCellCu-Single' + + NRFrequency-Multiple: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/NRFrequency-Single' + EUtranFrequency-Multiple: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/EUtranFrequency-Single' + + NrSectorCarrier-Multiple: + type: array + items: + $ref: '#/components/schemas/NrSectorCarrier-Single' + Bwp-Multiple: + type: array + items: + $ref: '#/components/schemas/Bwp-Single' + Beam-Multiple: + type: array + items: + $ref: '#/components/schemas/Beam-Single' + RRMPolicyRatio-Multiple: + type: array + items: + $ref: '#/components/schemas/RRMPolicyRatio-Single' + + NRCellRelation-Multiple: + type: array + items: + $ref: '#/components/schemas/NRCellRelation-Single' + EUtranCellRelation-Multiple: + type: array + items: + $ref: '#/components/schemas/EUtranCellRelation-Single' + NRFreqRelation-Multiple: + type: array + items: + $ref: '#/components/schemas/NRFreqRelation-Single' + EUtranFreqRelation-Multiple: + type: array + items: + $ref: '#/components/schemas/EUtranFreqRelation-Single' + + RimRSSet-Multiple: + type: array + items: + $ref: '#/components/schemas/RimRSSet-Single' + + ExternalGnbDuFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalGnbDuFunction-Single' + ExternalGnbCuUpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalGnbCuUpFunction-Single' + ExternalGnbCuCpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalGnbCuCpFunction-Single' + ExternalNrCellCu-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalNrCellCu-Single' + + ExternalENBFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalENBFunction-Single' + ExternalEUTranCell-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalEUTranCell-Single' + + EP_E1-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_E1-Single' + EP_XnC-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_XnC-Single' + EP_F1C-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_F1C-Single' + EP_NgC-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NgC-Single' + EP_X2C-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_X2C-Single' + EP_XnU-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_XnU-Single' + EP_F1U-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_F1U-Single' + EP_NgU-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NgU-Single' + EP_X2U-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_X2U-Single' + EP_S1U-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_S1U-Single' + +#-------- Definitions in TS 28.541 for TS 28.532 --------------------------------- + + resources-nrNrm: + oneOf: + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' + + - $ref: '#/components/schemas/GnbDuFunction-Single' + - $ref: '#/components/schemas/GnbCuUpFunction-Single' + - $ref: '#/components/schemas/GnbCuCpFunction-Single' + + - $ref: '#/components/schemas/NrCellCu-Single' + - $ref: '#/components/schemas/NrCellDu-Single' + + - $ref: '#/components/schemas/NRFrequency-Single' + - $ref: '#/components/schemas/EUtranFrequency-Single' + + - $ref: '#/components/schemas/NrSectorCarrier-Single' + - $ref: '#/components/schemas/Bwp-Single' + - $ref: '#/components/schemas/CommonBeamformingFunction-Single' + - $ref: '#/components/schemas/Beam-Single' + - $ref: '#/components/schemas/RRMPolicyRatio-Single' + + - $ref: '#/components/schemas/NRCellRelation-Single' + - $ref: '#/components/schemas/EUtranCellRelation-Single' + - $ref: '#/components/schemas/NRFreqRelation-Single' + - $ref: '#/components/schemas/EUtranFreqRelation-Single' + + - $ref: '#/components/schemas/DANRManagementFunction-Single' + - $ref: '#/components/schemas/DESManagementFunction-Single' + - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + - $ref: '#/components/schemas/DMROFunction-Single' + - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' + - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' + - $ref: '#/components/schemas/CESManagementFunction-Single' + + - $ref: '#/components/schemas/RimRSGlobal-Single' + - $ref: '#/components/schemas/RimRSSet-Single' + + - $ref: '#/components/schemas/ExternalGnbDuFunction-Single' + - $ref: '#/components/schemas/ExternalGnbCuUpFunction-Single' + - $ref: '#/components/schemas/ExternalGnbCuCpFunction-Single' + - $ref: '#/components/schemas/ExternalNrCellCu-Single' + - $ref: '#/components/schemas/ExternalENBFunction-Single' + - $ref: '#/components/schemas/ExternalEUTranCell-Single' + + - $ref: '#/components/schemas/EP_XnC-Single' + - $ref: '#/components/schemas/EP_E1-Single' + - $ref: '#/components/schemas/EP_F1C-Single' + - $ref: '#/components/schemas/EP_NgC-Single' + - $ref: '#/components/schemas/EP_X2C-Single' + - $ref: '#/components/schemas/EP_XnU-Single' + - $ref: '#/components/schemas/EP_F1U-Single' + - $ref: '#/components/schemas/EP_NgU-Single' + - $ref: '#/components/schemas/EP_X2U-Single' + - $ref: '#/components/schemas/EP_S1U-Single' diff --git a/OpenAPI/provMnS.yaml b/OpenAPI/provMnS.yaml new file mode 100644 index 000000000..b2f84a4d2 --- /dev/null +++ b/OpenAPI/provMnS.yaml @@ -0,0 +1,579 @@ +openapi: 3.0.1 +info: + title: Provisioning MnS + version: 16.4.0 + description: >- + OAS 3.0.1 definition of the Provisioning MnS + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.532 V16.4.0; Generic management services + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ +servers: + - url: 'http://{URI-DN-prefix}/{root}/ProvMnS/v1640/{LDN-first-part}' + variables: + URI-DN-prefix: + description: See subclause 4.4 of TS 32.158 + default: example.com + root: + description: See subclause 4.4 of TS 32.158 + default: 3GPPManagement + LDN-first-part: + description: See subclause 4.4 of TS 32.158 + default: '' +paths: + '/{className}={id}': + parameters: + - name: className + in: path + required: true + schema: + $ref: '#/components/schemas/className-PathType' + - name: id + in: path + required: true + schema: + $ref: '#/components/schemas/id-PathType' + put: + summary: Replaces a complete single resource or creates it if it does not exist + description: >- + With HTTP PUT a complete resource is replaced or created if it does not + exist. The target resource is identified by the target URI. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/resourcePut-RequestType' + responses: + '200': + description: >- + Success case ("200 OK"). + This status code shall be returned when the resource is replaced, and + when the replaced resource representation is not identical to the resource + representation in the request. + This status code may be retourned when the resource is updated and when the + updated resource representation is identical to the resource representation + in the request. + The representation of the updated resource is returned in the response + message body. + content: + application/json: + schema: + $ref: '#/components/schemas/resourceUpdate-ResponseType' + '201': + description: >- + Success case ("201 Created"). + This status code shall be returned when the resource is created. + The representation of the created resource is returned in the response + message body. + content: + application/json: + schema: + $ref: '#/components/schemas/resourceCreation-ResponseType' + '204': + description: >- + Success case ("204 No Content"). + This status code may be returned only when the replaced resource + representation is identical to the representation in the request. + The response has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + callbacks: + notifyMOICreation: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/notifyMOICreation-NotifType' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + notifyMOIDeletion: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/notifyMOIDeletion-NotifType' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + notifyMOIAttributeValueChange: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/notifyMOIAttributeValueChange-NotifType' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + notifyMOIChanges: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/notifyMOIChanges-NotifType' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + get: + summary: Reads one or multiple resources + description: >- + With HTTP GET resources are read. The resources to be retrieved are + identified with the target URI. The attributes and fields parameter + of the query components allow to select the resource properties to be returned. + parameters: + - name: scope + in: query + description: >- + This parameter extends the set of targeted resources beyond the base + resource identified with the path component of the URI. No scoping + mechanism is specified in the present document. + required: false + schema: + $ref: '#/components/schemas/scope-QueryType' + style: form + explode: true + - name: filter + in: query + description: >- + This parameter reduces the targeted set of resources by applying a + filter to the scoped set of resource representations. Only resource + representations for which the filter construct evaluates to "true" + are targeted. No filter language is specified in the present + document. + required: false + schema: + $ref: '#/components/schemas/filter-QueryType' + - name: attributes + in: query + description: >- + This parameter specifies the attributes of the scoped resources that + are returned. + required: true + schema: + $ref: '#/components/schemas/attributes-QueryType' + style: form + explode: false + - name: fields + in: query + description: >- + This parameter specifies the attribute field of the scoped resources + that are returned. + required: false + schema: + $ref: '#/components/schemas/fields-QueryType' + style: form + explode: false + responses: + '200': + description: >- + Success case ("200 OK"). + The resources identified in the request for retrieval are returned + in the response message body. In case the attributes or fields query + parameters are used, only the selected attributes or sub-attributes are + returned. The response message body is constructed according to the + hierarchical response construction method (TS 32.158 [15]). + content: + application/json: + schema: + $ref: '#/components/schemas/resourceRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + patch: + summary: Patches one or multiple resources + description: >- + With HTTP PATCH resources are created, updated or deleted. The resources + to be modified are identified with the target URI (base resource) and + the patch document included in the request message body. + requestBody: + description: >- + The request body describes changes to be made to the target resources. + The following patch media types are available + - "application/merge-patch+json" (RFC 7396) + - "application/3gpp-merge-patch+json" (TS 32.158) + - "application/json-patch+json" (RFC 6902) + - "application/3gpp-json-patch+json" (TS 32.158) + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/jsonMergePatch-RequestType' + application/3gpp-merge-patch+json: + schema: + $ref: '#/components/schemas/3gppJsonMergePatch-RequestType' + application/json-patch+json: + schema: + $ref: '#/components/schemas/jsonPatch-RequestType' + application/3gpp-json-patch+json: + schema: + $ref: '#/components/schemas/3gppJsonPatch-RequestType' + responses: + '200': + description: >- + Success case ("200 OK"). + This status code is returned when the updated the resource representations + shall be returned for some reason. + The resource representations are returned in the response message body. The + response message body is constructed according to the hierarchical response + construction method (TS 32.158 [15]) + content: + application/json: + schema: + $ref: '#/components/schemas/resourceUpdate-ResponseType' + '204': + description: >- + Success case ("204 No Content"). + This status code is returned when there is no need to return the updated + resource representations. + The response message body is empty. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + delete: + summary: Deletes one or multiple resources + description: >- + With HTTP DELETE resources are deleted. The resources to be deleted are + identified with the target URI. + parameters: + - name: scope + in: query + description: >- + This parameter extends the set of targeted resources beyond the base + resource identified with the path component of the URI. No scoping + mechanism is specified in the present document. + required: false + schema: + $ref: '#/components/schemas/scope-QueryType' + - name: filter + in: query + description: >- + This parameter reduces the targeted set of resources by applying a + filter to the scoped set of resource representations. Only resources + representations for which the filter construct evaluates to "true" + are returned. No filter language is specified in the present + document. + required: false + schema: + $ref: '#/components/schemas/filter-QueryType' + responses: + '200': + description: >- + Success case ("200 OK"). + This status code shall be returned, when query parameters are present in + the request and one or multiple resources are deleted. + The URIs of the deleted resources are returned in the response message body. + '204': + description: >- + Success case ("204 No Content"). + This status code shall be returned, when no query parameters are present in + the request and only one resource is deleted. + The message body is empty. + content: + application/json: + schema: + $ref: '#/components/schemas/resourceDeletion-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' +components: + schemas: + dateTime-Type: + type: string + format: date-time + long-Type: + type: integer + format: int64 + uri-Type: + type: string + correlatedNotification-Type: + type: object + properties: + source: + $ref: '#/components/schemas/uri-Type' + notificationIds: + type: array + items: + $ref: '#/components/schemas/notificationId-Type' + notificationId-Type: + $ref: '#/components/schemas/long-Type' + notificationType-Type: + type: string + enum: + - notifyMOICreation + - notifyMOIDeletion + - notifyMOIAttributeValueChange + systemDN-Type: + type: string + additionalText-Type: + type: string + sourceIndicator-Type: + type: string + enum: + - resourceOperation + - mangementOperation + - sONOperation + - unknown + header-Type: + type: object + properties: + href: + $ref: '#/components/schemas/uri-Type' + notificationId: + $ref: '#/components/schemas/notificationId-Type' + notificationType: + $ref: '#/components/schemas/notificationType-Type' + eventTime: + $ref: '#/components/schemas/dateTime-Type' + systemDN: + $ref: '#/components/schemas/systemDN-Type' + required: + - href + - notificationId + - notificationType + - eventTime + - systemDN + scopeType-Type: + type: string + enum: + - BASE_ONLY + - BASE_NTH_LEVEL + - BASE_SUBTREE + - BASE_ALL + scopeLevel-Type: + type: integer + className-PathType: + type: string + id-PathType: + type: string + attributes-QueryType: + type: array + items: + type: string + fields-QueryType: + type: array + items: + type: string + filter-QueryType: + type: string + scope-QueryType: + type: object + properties: + scopeType: + $ref: '#/components/schemas/scopeType-Type' + scopeLevel: + $ref: '#/components/schemas/scopeLevel-Type' + + resourcePut-RequestType: + $ref: '#/components/schemas/resourceRepresentation-Type' + jsonMergePatch-RequestType: + $ref: '#/components/schemas/resourceRepresentation-Type' + 3gppJsonMergePatch-RequestType: + $ref: '#/components/schemas/resourceRepresentation-Type' + jsonPatch-RequestType: + type: array + items: + type: object + 3gppJsonPatch-RequestType: + type: array + items: + type: object + + error-ResponseType: + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + resourceRetrieval-ResponseType: + $ref: '#/components/schemas/resourceRepresentation-Type' + resourceCreation-ResponseType: + $ref: '#/components/schemas/resourceRepresentation-Type' + resourceUpdate-ResponseType: + $ref: '#/components/schemas/resourceRepresentation-Type' + resourceDeletion-ResponseType: + type: array + items: + $ref: '#/components/schemas/uri-Type' + + resourceRepresentation-Type: + oneOf: + - type: object + properties: + id: + type: string + attributes: + type: object + additionalProperties: + type: array + items: + type: object + - anyOf: + - $ref: 'genericNrm.yaml#/components/schemas/resources-genericNrm' + - $ref: 'nrNrm.yaml#/components/schemas/resources-nrNrm' + - $ref: '5gcNrm.yaml#/components/schemas/resources-5gcNrm' + - $ref: 'sliceNrm.yaml#/components/schemas/resources-sliceNrm' + + mOIChange-Type: + type: object + properties: + notificationId: + $ref: '#/components/schemas/notificationId-Type' + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/correlatedNotification-Type' + additionalText: + $ref: '#/components/schemas/additionalText-Type' + sourceIndicator: + $ref: '#/components/schemas/sourceIndicator-Type' + path: + $ref: '#/components/schemas/uri-Type' + operation: + type: string + enum: + - CREATE + - DELETE + - REPLACE + value: + oneOf: + - type: object + additionalProperties: + nullable: true + - type: array + items: + type: object + minItems: 1 + maxItems: 2 + + notifyMOICreation-NotifType: + allOf: + - $ref: '#/components/schemas/header-Type' + - type: object + properties: + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/correlatedNotification-Type' + additionalText: + $ref: '#/components/schemas/additionalText-Type' + sourceIndicator: + $ref: '#/components/schemas/sourceIndicator-Type' + attributeList: + type: object + additionalProperties: + nullable: true + notifyMOIDeletion-NotifType: + allOf: + - $ref: '#/components/schemas/header-Type' + - type: object + properties: + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/correlatedNotification-Type' + additionalText: + $ref: '#/components/schemas/additionalText-Type' + sourceIndicator: + $ref: '#/components/schemas/sourceIndicator-Type' + attributeList: + type: object + additionalProperties: true + notifyMOIAttributeValueChange-NotifType: + allOf: + - $ref: '#/components/schemas/header-Type' + - type: object + properties: + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/correlatedNotification-Type' + additionalText: + $ref: '#/components/schemas/additionalText-Type' + sourceIndicator: + $ref: '#/components/schemas/sourceIndicator-Type' + attributeValueChange: + type: object + additionalProperties: + type: array + minItems: 1 + maxItems: 2 + items: + nullable: true + required: + - attributeValueChange + notifyMOIChanges-NotifType: + allOf: + - $ref: '#/components/schemas/header-Type' + - type: object + properties: + mOIChanges: + type: array + items: + $ref: '#/components/schemas/mOIChange-Type' + required: + - mOIChanges diff --git a/OpenAPI/sliceNrm.yaml b/OpenAPI/sliceNrm.yaml new file mode 100644 index 000000000..bf6b4d71c --- /dev/null +++ b/OpenAPI/sliceNrm.yaml @@ -0,0 +1,632 @@ +openapi: 3.0.1 +info: + title: Slice NRM + version: 17.4.0 + description: >- + OAS 3.0.1 specification of the Slice NRM + @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.541; 5G NRM, Slice NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ +paths: {} +components: + schemas: + +#------------ Type definitions --------------------------------------------------- + + Float: + type: number + format: float + MobilityLevel: + type: string + enum: + - STATIONARY + - NOMADIC + - RESTRICTED MOBILITY + - FULLY MOBILITY + SynAvailability: + type: string + enum: + - NOT SUPPORTED + - BETWEEN BS AND UE + - BETWEEN BS AND UE & UE AND UE + PositioningAvailability: + type: array + items: + type: string + enum: + - CIDE-CID + - OTDOA + - RF FINGERPRINTING + - AECID + - HYBRID POSITIONING + - NET-RTK + Predictionfrequency: + type: string + enum: + - PERSEC + - PERMIN + - PERHOUR + SharingLevel: + type: string + enum: + - SHARED + - NON-SHARED + + NetworkSliceSharingIndicator: + type: string + enum: + - SHARED + - NON-SHARED + + ServiceType: + type: string + enum: + - eMBB + - RLLC + - MIoT + - V2X + SliceSimultaneousUse: + type: string + enum: + - ZERO + - ONE + - TWO + - THREE + - FOUR + Category: + type: string + enum: + - CHARACTER + - SCALABILITY + Tagging: + type: array + items: + type: string + enum: + - PERFORMANCE + - FUNCTION + - OPERATION + Exposure: + type: string + enum: + - API + - KPI + ServAttrCom: + type: object + properties: + category: + $ref: '#/components/schemas/Category' + tagging: + $ref: '#/components/schemas/Tagging' + exposure: + $ref: '#/components/schemas/Exposure' + Support: + type: string + enum: + - NOT SUPPORTED + - SUPPORTED + DelayTolerance: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + support: + $ref: '#/components/schemas/Support' + DeterministicComm: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + availability: + $ref: '#/components/schemas/Support' + periodicityList: + type: string + XLThpt: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + guaThpt: + $ref: '#/components/schemas/Float' + maxThpt: + $ref: '#/components/schemas/Float' + MaxPktSize: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + maxsize: + type: integer + MaxNumberofPDUSessions: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + nOofPDUSessions: + type: integer + KPIMonitoring: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + kPIList: + type: string + NBIoT: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + support: + $ref: '#/components/schemas/Support' + RadioSpectrum: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + nROperatingBands: + type: string + Synchronicity: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + availability: + $ref: '#/components/schemas/SynAvailability' + accuracy: + $ref: '#/components/schemas/Float' + SynchronicityRANSubnet: + type: object + properties: + availability: + $ref: '#/components/schemas/SynAvailability' + accuracy: + $ref: '#/components/schemas/Float' + Positioning: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + availability: + $ref: '#/components/schemas/PositioningAvailability' + predictionfrequency: + $ref: '#/components/schemas/Predictionfrequency' + accuracy: + $ref: '#/components/schemas/Float' + PositioningRANSubnet: + type: object + properties: + availability: + $ref: '#/components/schemas/PositioningAvailability' + predictionfrequency: + $ref: '#/components/schemas/Predictionfrequency' + accuracy: + $ref: '#/components/schemas/Float' + UserMgmtOpen: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + support: + $ref: '#/components/schemas/Support' + V2XCommModels: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + v2XMode: + $ref: '#/components/schemas/Support' + TermDensity: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + density: + type: integer + NsInfo: + type: object + properties: + nsInstanceId: + type: string + nsName: + type: string + EmbbEEPerfReq: + type: integer + UrllcEEPerfReq: + type: integer + MIoTEEPerfReq: + type: object + properties: + KpiType: + type: string + enum: + - MAXREGSUBS + - MEANACTIVEUES + Req: + type: integer + EEPerfReq: + oneOf: + - $ref: '#/components/schemas/EmbbEEPerfReq' + - $ref: '#/components/schemas/UrllcEEPerfReq' + - $ref: '#/components/schemas/MIoTEEPerfReq' + EnergyEfficiency: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + performance: + $ref: '#/components/schemas/EEPerfReq' + CNSliceSubnetProfile: + type: object + properties: + maxNumberofUEs: + type: integer + latency: + type: integer + dLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + maxNumberOfPDUSessions: + type: integer + coverageAreaTAList: + type: integer + resourceSharingLevel: + $ref: '#/components/schemas/SharingLevel' + dLMaxPktSize: + type: integer + uLMaxPktSize: + type: integer + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + synchronicity: + $ref: '#/components/schemas/SynchronicityRANSubnet' + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + reliability: + type: string + energyEfficiency: + type: integer + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + survivalTime: + type: string + RANSliceSubnetProfile: + type: object + properties: + coverageAreaTAList: + type: integer + uEMobilityLevel: + $ref: '#/components/schemas/MobilityLevel' + resourceSharingLevel: + $ref: '#/components/schemas/SharingLevel' + maxNumberofUEs: + type: integer + activityFactor: + type: integer + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uESpeed: + type: integer + reliability: + type: string + serviceType: + $ref: '#/components/schemas/ServiceType' + dLMaxPktSize: + type: integer + uLMaxPktSize: + type: integer + nROperatingBands: + type: string + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + positioning: + $ref: '#/components/schemas/PositioningRANSubnet' + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + energyEfficiency: + type: integer + termDensity: + $ref: '#/components/schemas/TermDensity' + survivalTime: + type: string + synchronicity: + $ref: '#/components/schemas/SynchronicityRANSubnet' + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + TopSliceSubnetProfile: + type: object + properties: + latency: + type: integer + maxNumberofUEs: + type: integer + dLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + dLMaxPktSize: + type: integer + uLMaxPktSize: + type: integer + maxNumberOfPDUSessions: + type: integer + nROperatingBands: + type: string + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + energyEfficiency: + type: integer + synchronicity: + $ref: '#/components/schemas/Synchronicity' + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + positioning: + $ref: '#/components/schemas/Positioning' + termDensity: + $ref: '#/components/schemas/TermDensity' + activityFactor: + type: integer + coverageAreaTAList: + type: integer + resourceSharingLevel: + $ref: '#/components/schemas/SharingLevel' + uEMobilityLevel: + $ref: '#/components/schemas/MobilityLevel' + uESpeed: + type: integer + reliability: + type: string + serviceType: + $ref: '#/components/schemas/ServiceType' + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + survivalTime: + type: string + + ServiceProfile: + type: object + properties: + serviceProfileId: + type: string + plmnInfoList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList' + maxNumberofUEs: + type: number + latency: + type: number + uEMobilityLevel: + $ref: '#/components/schemas/MobilityLevel' + sst: + $ref: 'nrNrm.yaml#/components/schemas/Sst' + networkSliceSharingIndicator: + $ref: '#/components/schemas/NetworkSliceSharingIndicator' + availability: + type: number + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + dLThptPerSlice: + $ref: '#/components/schemas/XLThpt' + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerSlice: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + dLMaxPktSize: + $ref: '#/components/schemas/MaxPktSize' + uLMaxPktSize: + $ref: '#/components/schemas/MaxPktSize' + maxNumberofPDUSessions: + $ref: '#/components/schemas/MaxNumberofPDUSessions' + kPIMonitoring: + $ref: '#/components/schemas/KPIMonitoring' + nBIoT: + $ref: '#/components/schemas/NBIoT' + radioSpectrum: + $ref: '#/components/schemas/RadioSpectrum' + synchronicity: + $ref: '#/components/schemas/Synchronicity' + positioning: + $ref: '#/components/schemas/Positioning' + userMgmtOpen: + $ref: '#/components/schemas/UserMgmtOpen' + v2XModels: + $ref: '#/components/schemas/V2XCommModels' + coverageArea: + type: string + termDensity: + $ref: '#/components/schemas/TermDensity' + activityFactor: + $ref: '#/components/schemas/Float' + uESpeed: + type: integer + jitter: + type: integer + survivalTime: + type: string + reliability: + type: string + maxDLDataVolume: + type: string + maxULDataVolume: + type: string + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + energyEfficiency: + $ref: '#/components/schemas/EnergyEfficiency' + SliceProfile: + type: object + properties: + serviceProfileId: + type: string + plmnInfoList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList' + cNSliceSubnetProfile: + $ref: '#/components/schemas/CNSliceSubnetProfile' + rANSliceSubnetProfile: + $ref: '#/components/schemas/RANSliceSubnetProfile' + topSliceSubnetProfile: + $ref: '#/components/schemas/TopSliceSubnetProfile' + + IpAddress: + oneOf: + - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + + LogicInterfaceInfo: + type: object + properties: + logicalInterfceType: + type: string + enum: + - VLAN + - MPLS + - Segment + logicalInterfceId: + type: string + + ServiceProfileList: + type: array + items: + $ref: '#/components/schemas/ServiceProfile' + + SliceProfileList: + type: array + items: + $ref: '#/components/schemas/SliceProfile' + +#------------ Definition of concrete IOCs ---------------------------------------- + SubNetwork-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + NetworkSlice: + $ref: '#/components/schemas/NetworkSlice-Multiple' + NetworkSliceSubnet: + $ref: '#/components/schemas/NetworkSliceSubnet-Multiple' + EP_Transport: + $ref: '#/components/schemas/EP_Transport-Multiple' + + NetworkSlice-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + networkSliceSubnetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + operationalState: + $ref: 'genericNrm.yaml#/components/schemas/OperationalState' + administrativeState: + $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' + serviceProfileList: + $ref: '#/components/schemas/ServiceProfileList' + + NetworkSliceSubnet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + managedFunctionRefList: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + networkSliceSubnetRefList: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + operationalState: + $ref: 'genericNrm.yaml#/components/schemas/OperationalState' + administrativeState: + $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' + nsInfo: + $ref: '#/components/schemas/NsInfo' + sliceProfileList: + $ref: '#/components/schemas/SliceProfileList' + epTransportRefList: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + priorityLabel: + type: integer + + EP_Transport-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + ipAddress: + $ref: '#/components/schemas/IpAddress' + logicInterfaceInfo: + $ref: '#/components/schemas/LogicInterfaceInfo' + nextHopInfo: + type: string + qosProfile: + type: string + epApplicationRefs: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + + NetworkSlice-Multiple: + type: array + items: + $ref: '#/components/schemas/NetworkSlice-Single' + + NetworkSliceSubnet-Multiple: + type: array + items: + $ref: '#/components/schemas/NetworkSliceSubnet-Single' + + EP_Transport-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Transport-Single' + +#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- + + resources-sliceNrm: + oneOf: + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/NetworkSlice-Single' + - $ref: '#/components/schemas/NetworkSliceSubnet-Single' + - $ref: '#/components/schemas/EP_Transport-Single' diff --git a/OpenAPI/streamingDataMnS.yaml b/OpenAPI/streamingDataMnS.yaml new file mode 100644 index 000000000..ab7f71d4a --- /dev/null +++ b/OpenAPI/streamingDataMnS.yaml @@ -0,0 +1,453 @@ +openapi: 3.0.1 +info: + title: TS 28.532 Streaming data reporting service + version: 16.4.0 + description: OAS 3.0.1 specification for the Streaming data reporting service (Streaming MnS) +servers: + - url: '{protocol}://{root}/StreamingDataReportingMnS/{version}' + variables: + protocol: + description: Protocol used + enum: + - http + - https + - wss + default: https + root: + description: Indicates the host name and optional port, and an optional sequence of path segments that together represent a prefix path. + default: example.com + version: + description: Indicates the current version of the specification + default: 16.4.0 +paths: + '/connections': + post: + summary: Inform consumer about reporting streams to be carried by the new connection and receive a new connection id. + description: Exchange of meta-data (producer informs consumer about its own identity and the nature of the data to be reported via streaming) phase of the connection establishement by streaming data reporting producer to the streaming data reporting consumer (i.e. streaming target). + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/connectionRequest-Type' + responses: + '201': + description: Success case (201 Created). + headers: + Location: + description: Location of the created connection resource. + schema: + $ref: '#/components/schemas/connectionId-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/failedConnectionResponse-Type' + get: + summary: Obtain information about connections. + description: Enables the streaming data reporting service producer to obtain information about one or more streaming connections. + parameters: + - name: connectionIdList + in: query + description: The list of connectionId for which the connection information is to be returned. + required: false + schema: + type: array + items: + $ref: '#/components/schemas/connectionId-Type' + responses: + '200': + description: Success case (200 OK). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/connectionInfo-Type' + '202': + description: Partial success case (202 Partially retrieved). Subset of the resources identified in the request for retrieval are returned in the response message body. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/connectionInfo-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' + '/connections/{connectionId}': + get: + summary: Obtain information about a connection. + description: Enables the streaming data reporting service producer to obtain information about one streaming connection. + parameters: + - name: connectionId + in: path + description: Indicate the ID (URI) of the connection for which the information is being retrieved + required: true + schema: + $ref: '#/components/schemas/connectionId-Type' + - name: Connection + in: header + schema: + $ref: '#/components/schemas/websocketHeaderConnection-Type' + - name: Sec-WebSocket-Extensions + in: header + schema: + $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Extensions-Type' + - name: Sec-WebSocket-Key + in: header + schema: + $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Key-Type' + - name: Sec-WebSocket-Protocol + in: header + schema: + $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Protocol-Type' + - name: Sec-WebSocket-Version + in: header + schema: + $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Version-Type' + responses: + '101': + description: Success case (101 Switching Protocols). The connection has been successfully switched to WebSocket. The response message body is absent. + headers: + Upgrade: + schema: + $ref: '#/components/schemas/websocketHeaderUpgrade-Type' + Connection: + schema: + $ref: '#/components/schemas/websocketHeaderConnection-Type' + Sec-WebSocket-Accept: + schema: + $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Accept-Type' + '200': + description: Success case (200 OK). The resource identified in the request for retrieval returned in the response message body. + content: + application/json: + schema: + $ref: '#/components/schemas/connectionInfo-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' + '/connections/{connectionId}/streams': + post: + summary: Inform consumer about new reporting streams on an existing connection. + description: Allows the producer to add one or more reporting streams to an already established streaming connection. + parameters: + - name: connectionId + in: path + description: Indicate the ID (URI) of the connection for which the reporting stream information is being added. + required: true + schema: + $ref: '#/components/schemas/connectionId-Type' + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/streamInfo-Type' + responses: + '201': + description: Success case (201 Posted). + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/streamInfo-Type' + '202': + description: Partial success case (202 Posted). + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/streamInfo-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' + delete: + summary: Remove reporting streams from an existing connection + description: Allows the producer to remove one or more reporting streams from an already established streaming connection. + parameters: + - name: connectionId + in: path + description: Indicate the ID (URI) of the connection for which the reporting stream information is being removed. + required: true + schema: + $ref: '#/components/schemas/connectionId-Type' + - name: streamIds + in: query + description: The list of streamId for the stream(s) to be deleted. + required: true + schema: + type: array + items: + $ref: '#/components/schemas/streamId-Type' + responses: + '204': + description: Success case (204 No Content). The stream information resource has been deleted. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' + get: + summary: Obtain information about streams. + description: Enables the streaming data reporting service producer to obtain information about one or more reporting streams. + parameters: + - name: connectionId + in: path + description: Indicate the ID (URI) of the connection for which the information is being retrieved + required: true + schema: + $ref: '#/components/schemas/connectionId-Type' + - name: streamIds + in: query + description: The list of streamId for which the stream information is to be retrieved. + required: true + schema: + type: array + items: + $ref: '#/components/schemas/streamId-Type' + responses: + '200': + description: Success case (200 OK). + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/streamInfoWithReporters-Type' + '202': + description: Partial success case (202 Partially retrieved). + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/streamInfoWithReporters-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' + '/connections/{connectionId}/streams/{streamId}': + get: + summary: Obtain information about stream + description: Enables the streaming data reporting service producer to obtain information about a reporting stream. + parameters: + - name: connectionId + in: path + description: Indicate the ID (URI) of the connection for which the information is being retrieved + required: true + schema: + $ref: '#/components/schemas/connectionId-Type' + - name: streamId + in: path + description: Indicate the ID of the reporting stream for which the information is being retrieved + required: true + schema: + $ref: '#/components/schemas/streamId-Type' + responses: + '200': + description: Success case (200 OK). + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoWithReporters-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' +components: + schemas: + analyticsInfo-Type: + description: Information specific to analytics reporting. + type: object + properties: + activityDetails: + type: string + connectionId-Type: + $ref: '#/components/schemas/uri-Type' + connectionInfo-Type: + type: object + properties: + connection: + $ref: '#/components/schemas/connectionId-Type' + producer: + $ref: '#/components/schemas/producerId-Type' + streams: + type: array + items: + $ref: '#/components/schemas/streamId-Type' + connectionRequest-Type: + type: object + properties: + producer: + $ref: '#/components/schemas/producerId-Type' + streams: + type: array + items: + $ref: '#/components/schemas/streamInfo-Type' + errorResponse-Type: + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + failedConnectionResponse-Type: + type: object + properties: + error: + type: array + items: + type: object + properties: + streamId: + $ref: '#/components/schemas/streamId-Type' + errorReason: + type: string + measObjDn-Type: + description: DN of the measured object instance (see 3GPP TS 28.550) + allOf: + - $ref: '#/components/schemas/systemDN-Type' + measTypes-Type: + description: an ordered list of measurement type or KPI whose measurement values or KPI result values are to be reported by the Performance Data Stream Units (see Annex C of TS 28.550) via this stream + type: array + items: + type: string + performanceInfo-Type: + description: Information specific to performance data reporting + type: object + properties: + measObjDn: + $ref: '#/components/schemas/measObjDn-Type' + measTypes: + $ref: '#/components/schemas/measTypes-Type' + measurementReaderId: + $ref: '#/components/schemas/systemDN-Type' + jobId: + type: string + required: + - measObjDn + - measTypes + producerId-Type: + description: DN of the streaming data reporting MnS producer. + allOf: + - $ref: '#/components/schemas/systemDN-Type' + serializationFormat-Type: + type: string + enum: + - GPB + - ASN1 + streamId-Type: + description: globally unique stream identifier + type: string + example: '26F452550021' + streamInfo-Type: + description: Reporting stream meta-data. + type: object + properties: + streamType: + $ref: '#/components/schemas/streamType-Type' + serializationFormat: + $ref: '#/components/schemas/serializationFormat-Type' + streamId: + oneOf: + - $ref: '#/components/schemas/streamId-Type' + - $ref: '#/components/schemas/traceReference-Type' + additionalInfo: + oneOf: + - $ref: '#/components/schemas/traceInfo-Type' + - $ref: '#/components/schemas/performanceInfo-Type' + - $ref: '#/components/schemas/analyticsInfo-Type' + - $ref: '#/components/schemas/vsDataContainer-Type' + required: + - streamType + - serializationFormat + - streamId + streamInfoWithReporters-Type: + description: Reporting stream meta-data with added information about reporters. + type: object + properties: + streamInfo: + $ref: '#/components/schemas/streamInfo-Type' + reporters: + type: array + items: + $ref: '#/components/schemas/producerId-Type' + systemDN-Type: + description: See 3GPP TS 32.300 for details + type: string + example: 'SubNetwork=ABCNetwork,SubNetwork=MUC01,GNBDUFunction=XYZ0100' + streamType-Type: + type: string + enum: + - TRACE + - PERFORMANCE + - ANALYTICS + - PROPRIETARY + traceInfo-Type: + description: Information specific to trace data reporting + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/TraceJob-Attr' + traceReference-Type: + description: Trace Reference (see clause 5.6 of 3GPP TS 32.422) as stream identifier for streaming trace data reporting + type: string + example: '4358070034D7' + uri-Type: + description: Resource URI + type: string + vsDataContainer-Type: + description: container for vendor specific data (see 3GPP TS 28.622) + type: object + properties: + vsDataType: + type: string + vsData: + type: string + vsDataFormatVersion: + type: string + websocketHeaderConnection-Type: + description: Header value for the upgrade request and response. + type: string + enum: + - Upgrade + websocketHeaderUpgrade-Type: + description: Header value for the upgrade to WebSocket request and response. + type: string + enum: + - websocket + websocketHeader-Sec-WebSocket-Accept-Type: + description: Header value for secure WebSocket response. Carries hash. + type: string + websocketHeader-Sec-WebSocket-Extensions-Type: + description: Header value for secure WebSocket request. Carries protocol extensions. + type: string + websocketHeader-Sec-WebSocket-Key-Type: + description: Header value for secure WebSocket request. Provides information to the server which is needed in order to confirm that the client is entitled to request an upgrade to WebSocket. + type: string + websocketHeader-Sec-WebSocket-Protocol-Type: + description: Header value for secure WebSocket request. Carries a comma-separated list of subprotocol names, in the order of preference. + type: string + websocketHeader-Sec-WebSocket-Version-Type: + description: Header value for secure WebSocket request and response. Carries the WebSocket protocol version to be used. + type: string -- GitLab From e984aa9984c9c4d02a24ec898dd130ac5f4d9306 Mon Sep 17 00:00:00 2001 From: "U-ERICSSON\\ETHBLL" Date: Sun, 2 Jan 2022 19:29:43 +0100 Subject: [PATCH 10/21] delete all yaml 2 --- OpenAPI/5gcNrm.yaml | 2185 ----------------------------- OpenAPI/PerDataFileReportMnS.yaml | 13 - OpenAPI/PerMeasJobCtlMnS.yaml | 280 ---- OpenAPI/PerThresMonMnS.yaml | 102 -- OpenAPI/PerfDataStreamingMnS.yaml | 363 ----- OpenAPI/comDefs.yaml | 84 -- OpenAPI/coslaNrm.yaml | 168 --- OpenAPI/faultMnS.yaml | 1144 --------------- OpenAPI/genericNrm.yaml | 1606 --------------------- OpenAPI/heartbeatNtf.yaml | 23 - OpenAPI/nrNrm.yaml | 1905 ------------------------- OpenAPI/provMnS.yaml | 579 -------- OpenAPI/sliceNrm.yaml | 632 --------- OpenAPI/streamingDataMnS.yaml | 453 ------ 14 files changed, 9537 deletions(-) delete mode 100644 OpenAPI/5gcNrm.yaml delete mode 100644 OpenAPI/PerDataFileReportMnS.yaml delete mode 100644 OpenAPI/PerMeasJobCtlMnS.yaml delete mode 100644 OpenAPI/PerThresMonMnS.yaml delete mode 100644 OpenAPI/PerfDataStreamingMnS.yaml delete mode 100644 OpenAPI/comDefs.yaml delete mode 100644 OpenAPI/coslaNrm.yaml delete mode 100644 OpenAPI/faultMnS.yaml delete mode 100644 OpenAPI/genericNrm.yaml delete mode 100644 OpenAPI/heartbeatNtf.yaml delete mode 100644 OpenAPI/nrNrm.yaml delete mode 100644 OpenAPI/provMnS.yaml delete mode 100644 OpenAPI/sliceNrm.yaml delete mode 100644 OpenAPI/streamingDataMnS.yaml diff --git a/OpenAPI/5gcNrm.yaml b/OpenAPI/5gcNrm.yaml deleted file mode 100644 index e4c4b2619..000000000 --- a/OpenAPI/5gcNrm.yaml +++ /dev/null @@ -1,2185 +0,0 @@ -openapi: 3.0.1 -info: - title: 3GPP 5GC NRM - version: 17.4.0 - description: >- - OAS 3.0.1 specification of the 5GC NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.541; 5G NRM, 5GC NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ -paths: {} -components: - schemas: - -#-------- Definition of types----------------------------------------------------- - - AmfIdentifier: - type: object - description: 'AmfIdentifier comprise of amfRegionId, amfSetId and amfPointer' - properties: - amfRegionId: - $ref: '#/components/schemas/AmfRegionId' - amfSetId: - $ref: '#/components/schemas/AmfSetId' - amfPointer: - $ref: '#/components/schemas/AmfPointer' - AmfRegionId: - type: integer - description: AmfRegionId is defined in TS 23.003 - maximum: 255 - AmfSetId: - type: string - description: AmfSetId is defined in TS 23.003 - maximum: 1023 - AmfPointer: - type: integer - description: AmfPointer is defined in TS 23.003 - maximum: 63 - IpEndPoint: - type: object - properties: - ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' - ipv6Prefix: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Prefix' - transport: - $ref: 'genericNrm.yaml#/components/schemas/TransportProtocol' - port: - type: integer - NFProfileList: - type: array - description: List of NF profile - items: - $ref: '#/components/schemas/NFProfile' - NFProfile: - type: object - description: 'NF profile stored in NRF, defined in TS 29.510' - properties: - nFInstanceId: - type: string - description: uuid of NF instance - nFType: - $ref: 'genericNrm.yaml#/components/schemas/NFType' - nFStatus: - $ref: '#/components/schemas/NFStatus' - plmn: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - sNssais: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - interPlmnFqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - nfServices: - type: array - items: - $ref: '#/components/schemas/NFService' - NFService: - type: object - description: NF Service is defined in TS 29.510 - properties: - serviceInstanceId: - type: string - serviceName: - type: string - version: - type: string - schema: - type: string - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - interPlmnFqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - ipEndPoints: - type: array - items: - $ref: '#/components/schemas/IpEndPoint' - apiPrfix: - type: string - allowedPlmns: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - allowedNfTypes: - type: array - items: - $ref: 'genericNrm.yaml#/components/schemas/NFType' - allowedNssais: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - NFStatus: - type: string - description: any of enumrated value - enum: - - REGISTERED - - SUSPENDED - CNSIIdList: - type: array - items: - $ref: '#/components/schemas/CNSIId' - CNSIId: - type: string - description: CNSI Id is defined in TS 29.531, only for Core Network - TACList: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/NrTac' - WeightFactor: - type: integer - UdmInfo: - type: object - properties: - nFSrvGroupId: - type: string - AusfInfo: - type: object - properties: - nFSrvGroupId: - type: string - UpfInfo: - type: object - properties: - smfServingAreas: - type: string - AmfInfo: - type: object - properties: - priority: - type: integer - SupportedDataSetId: - type: string - description: any of enumrated value - enum: - - SUBSCRIPTION - - POLICY - - EXPOSURE - - APPLICATION - Udrinfo: - type: object - properties: - supportedDataSetIds: - type: array - items: - $ref: '#/components/schemas/SupportedDataSetId' - nFSrvGroupId: - type: string - NFInfo: - oneOf: - - $ref: '#/components/schemas/UdmInfo' - - $ref: '#/components/schemas/AusfInfo' - - $ref: '#/components/schemas/UpfInfo' - - $ref: '#/components/schemas/AmfInfo' - - $ref: '#/components/schemas/Udrinfo' - ManagedNFProfile: - type: object - properties: - nfInstanceID: - type: string - nfType: - $ref: 'genericNrm.yaml#/components/schemas/NFType' - authzInfo: - type: string - hostAddr: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' - locality: - type: string - nFInfo: - $ref: '#/components/schemas/NFInfo' - capacity: - type: integer - SEPPType: - type: string - description: any of enumrated value - enum: - - CSEPP - - PSEPP - SupportedFunc: - type: object - properties: - function: - type: string - policy: - type: string - SupportedFuncList: - type: array - items: - $ref: '#/components/schemas/SupportedFunc' - CommModelType: - type: string - description: any of enumrated value - enum: - - DIRECT_COMMUNICATION_WO_NRF - - DIRECT_COMMUNICATION_WITH_NRF - - INDIRECT_COMMUNICATION_WO_DEDICATED_DISCOVERY - - INDIRECT_COMMUNICATION_WITH_DEDICATED_DISCOVERY - CommModel: - type: object - properties: - groupId: - type: integer - commModelType: - $ref: '#/components/schemas/CommModelType' - targetNFServiceList: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - commModelConfiguration: - type: string - CommModelList: - type: array - items: - $ref: '#/components/schemas/CommModel' - CapabilityList: - type: array - items: - type: string - FiveQiDscpMapping: - type: object - properties: - fiveQIValues: - type: array - items: - type: integer - dscp: - type: integer - NetworkSliceInfo: - type: object - properties: - sNSSAI: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - cNSIId: - $ref: '#/components/schemas/CNSIId' - networkSliceRef: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - NetworkSliceInfoList: - type: array - items: - $ref: '#/components/schemas/NetworkSliceInfo' - - - PacketErrorRate: - type: object - properties: - scalar: - type: integer - exponent: - type: integer - - - - GtpUPathDelayThresholdsType: - type: object - properties: - n3AveragePacketDelayThreshold: - type: integer - n3MinPacketDelayThreshold: - type: integer - n3MaxPacketDelayThreshold: - type: integer - n9AveragePacketDelayThreshold: - type: integer - n9MinPacketDelayThreshold: - type: integer - n9MaxPacketDelayThreshold: - type: integer - QFPacketDelayThresholdsType: - type: object - properties: - thresholdDl: - type: integer - thresholdUl: - type: integer - thresholdRtt: - type: integer - - QosData: - type: object - properties: - qosId: - type: string - fiveQIValue: - type: integer - maxbrUl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' - maxbrDl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' - gbrUl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' - gbrDl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' - arp: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Arp' - qosNotificationControl: - type: boolean - reflectiveQos: - type: boolean - sharingKeyDl: - type: string - sharingKeyUl: - type: string - maxPacketLossRateDl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' - maxPacketLossRateUl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' - extMaxDataBurstVol: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' - - QosDataList: - type: array - items: - $ref: '#/components/schemas/QosData' - - SteeringMode: - type: object - properties: - steerModeValue: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteerModeValue' - active: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessType' - standby: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessTypeRm' - threeGLoad: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Uinteger' - prioAcc: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessType' - - TrafficControlData: - type: object - properties: - tcId: - type: string - flowStatus: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus' - redirectInfo: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' - addRedirectInfo: - type: array - items: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' - minItems: 1 - muteNotif: - type: boolean - trafficSteeringPolIdDl: - type: string - nullable: true - trafficSteeringPolIdUl: - type: string - nullable: true - routeToLocs: - type: array - items: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/RouteToLocation' - traffCorreInd: - type: boolean - upPathChgEvent: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' - steerFun: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringFunctionality' - steerModeDl: - $ref: '#/components/schemas/SteeringMode' - steerModeUl: - $ref: '#/components/schemas/SteeringMode' - mulAccCtrl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/MulticastAccessControl' - - TrafficControlDataList: - type: array - items: - $ref: '#/components/schemas/TrafficControlData' - - PccRule: - type: object - properties: - pccRuleId: - type: string - description: Univocally identifies the PCC rule within a PDU session. - flowInfoList: - type: array - items: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' - applicationId: - type: string - appDescriptor: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ApplicationDescriptor' - contentVersion: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' - precedence: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Uinteger' - afSigProtocol: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' - isAppRelocatable: - type: boolean - isUeAddrPreserved: - type: boolean - qosData: - type: array - items: - $ref: '#/components/schemas/QosDataList' - altQosParams: - type: array - items: - $ref: '#/components/schemas/QosDataList' - trafficControlData: - type: array - items: - $ref: '#/components/schemas/TrafficControlDataList' - conditionData: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ConditionData' - tscaiInputDl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' - tscaiInputUl: - $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' - - SnssaiInfo: - type: object - properties: - plmnInfo: - $ref: 'nrNrm.yaml#/components/schemas/PlmnInfo' - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - - NsacfInfoSnssai: - type: object - properties: - SnssaiInfo: - $ref: '#/components/schemas/SnssaiInfo' - isSubjectToNsac: - type: boolean - maxNumberofUEs: - type: integer - eACMode: - type: string - enum: - - INACTIVE - - ACTIVE - activeEacThreshhold: - type: integer - deactiveEacThreshhold: - type: integer - numberofUEs: - type: integer - uEIdList: - type: array - items: - type: string - - -#-------- Definition of concrete IOCs -------------------------------------------- - - SubNetwork-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - ExternalAmfFunction: - $ref: '#/components/schemas/ExternalAmfFunction-Multiple' - ExternalNrfFunction: - $ref: '#/components/schemas/ExternalNrfFunction-Multiple' - ExternalNssfFunction: - $ref: '#/components/schemas/ExternalNssfFunction-Multiple' - AmfSet: - $ref: '#/components/schemas/AmfSet-Multiple' - AmfRegion: - $ref: '#/components/schemas/AmfRegion-Multiple' - Configurable5QISet: - $ref: '#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: '#/components/schemas/Dynamic5QISet-Multiple' - - ManagedElement-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' - - type: object - properties: - AmfFunction: - $ref: '#/components/schemas/AmfFunction-Multiple' - SmfFunction: - $ref: '#/components/schemas/SmfFunction-Multiple' - UpfFunction: - $ref: '#/components/schemas/UpfFunction-Multiple' - N3iwfFunction: - $ref: '#/components/schemas/N3iwfFunction-Multiple' - PcfFunction: - $ref: '#/components/schemas/PcfFunction-Multiple' - AusfFunction: - $ref: '#/components/schemas/AusfFunction-Multiple' - UdmFunction: - $ref: '#/components/schemas/UdmFunction-Multiple' - UdrFunction: - $ref: '#/components/schemas/UdrFunction-Multiple' - UdsfFunction: - $ref: '#/components/schemas/UdsfFunction-Multiple' - NrfFunction: - $ref: '#/components/schemas/NrfFunction-Multiple' - NssfFunction: - $ref: '#/components/schemas/NssfFunction-Multiple' - SmsfFunction: - $ref: '#/components/schemas/SmsfFunction-Multiple' - LmfFunction: - $ref: '#/components/schemas/LmfFunction-Multiple' - NgeirFunction: - $ref: '#/components/schemas/NgeirFunction-Multiple' - SeppFunction: - $ref: '#/components/schemas/SeppFunction-Multiple' - NwdafFunction: - $ref: '#/components/schemas/NwdafFunction-Multiple' - ScpFunction: - $ref: '#/components/schemas/ScpFunction-Multiple' - NefFunction: - $ref: '#/components/schemas/NefFunction-Multiple' - Configurable5QISet: - $ref: '#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: '#/components/schemas/Dynamic5QISet-Multiple' - - AmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - amfIdentifier: - $ref: '#/components/schemas/AmfIdentifier' - sBIFqdn: - type: string - weightFactor: - $ref: '#/components/schemas/WeightFactor' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - amfSet: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N2: - $ref: '#/components/schemas/EP_N2-Multiple' - EP_N8: - $ref: '#/components/schemas/EP_N8-Multiple' - EP_N11: - $ref: '#/components/schemas/EP_N11-Multiple' - EP_N12: - $ref: '#/components/schemas/EP_N12-Multiple' - EP_N14: - $ref: '#/components/schemas/EP_N14-Multiple' - EP_N15: - $ref: '#/components/schemas/EP_N15-Multiple' - EP_N17: - $ref: '#/components/schemas/EP_N17-Multiple' - EP_N20: - $ref: '#/components/schemas/EP_N20-Multiple' - EP_N22: - $ref: '#/components/schemas/EP_N22-Multiple' - EP_N26: - $ref: '#/components/schemas/EP_N26-Multiple' - EP_NLS: - $ref: '#/components/schemas/EP_NLS-Multiple' - EP_NLG: - $ref: '#/components/schemas/EP_NLG-Multiple' - AmfSet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - amfSetId: - $ref: '#/components/schemas/AmfSetId' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - AmfRegion-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - amfRegionId: - $ref: '#/components/schemas/AmfRegionId' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - SmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - configurable5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - dynamic5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N4: - $ref: '#/components/schemas/EP_N4-Multiple' - EP_N7: - $ref: '#/components/schemas/EP_N7-Multiple' - EP_N10: - $ref: '#/components/schemas/EP_N10-Multiple' - EP_N11: - $ref: '#/components/schemas/EP_N11-Multiple' - EP_N16: - $ref: '#/components/schemas/EP_N16-Multiple' - EP_S5C: - $ref: '#/components/schemas/EP_S5C-Multiple' - FiveQiDscpMappingSet: - $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' - GtpUPathQoSMonitoringControl: - $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' - QFQoSMonitoringControl: - $ref: '#/components/schemas/QFQoSMonitoringControl-Single' - PredefinedPccRuleSet: - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' - - UpfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N3: - $ref: '#/components/schemas/EP_N3-Multiple' - EP_N4: - $ref: '#/components/schemas/EP_N4-Multiple' - EP_N6: - $ref: '#/components/schemas/EP_N6-Multiple' - EP_N9: - $ref: '#/components/schemas/EP_N9-Multiple' - EP_S5U: - $ref: '#/components/schemas/EP_S5U-Multiple' - N3iwfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N3: - $ref: '#/components/schemas/EP_N3-Multiple' - EP_N4: - $ref: '#/components/schemas/EP_N4-Multiple' - PcfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - configurable5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - dynamic5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N5: - $ref: '#/components/schemas/EP_N5-Multiple' - EP_N7: - $ref: '#/components/schemas/EP_N7-Multiple' - EP_N15: - $ref: '#/components/schemas/EP_N15-Multiple' - EP_N16: - $ref: '#/components/schemas/EP_N16-Multiple' - EP_Rx: - $ref: '#/components/schemas/EP_Rx-Multiple' - PredefinedPccRuleSet: - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' - - AusfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N12: - $ref: '#/components/schemas/EP_N12-Multiple' - EP_N13: - $ref: '#/components/schemas/EP_N13-Multiple' - UdmFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N8: - $ref: '#/components/schemas/EP_N8-Multiple' - EP_N10: - $ref: '#/components/schemas/EP_N10-Multiple' - EP_N13: - $ref: '#/components/schemas/EP_N13-Multiple' - UdrFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - UdsfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - NrfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - cNSIIdList: - $ref: '#/components/schemas/CNSIIdList' - nFProfileList: - $ref: '#/components/schemas/NFProfileList' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N27: - $ref: '#/components/schemas/EP_N27-Multiple' - NssfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - cNSIIdList: - $ref: '#/components/schemas/CNSIIdList' - nFProfileList: - $ref: '#/components/schemas/NFProfileList' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N22: - $ref: '#/components/schemas/EP_N22-Multiple' - EP_N31: - $ref: '#/components/schemas/EP_N31-Multiple' - SmsfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N20: - $ref: '#/components/schemas/EP_N20-Multiple' - EP_N21: - $ref: '#/components/schemas/EP_N21-Multiple' - EP_MAP_SMSC: - $ref: '#/components/schemas/EP_MAP_SMSC-Multiple' - LmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_NLS: - $ref: '#/components/schemas/EP_NLS-Multiple' - NgeirFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N17: - $ref: '#/components/schemas/EP_N17-Multiple' - SeppFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnId: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - sEPPType: - $ref: '#/components/schemas/SEPPType' - sEPPId: - type: integer - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N32: - $ref: '#/components/schemas/EP_N32-Multiple' - NwdafFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - networkSliceInfoList: - $ref: '#/components/schemas/NetworkSliceInfoList' - - ScpFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - supportedFuncList: - $ref: '#/components/schemas/SupportedFuncList' - address: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - NefFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - capabilityList: - $ref: '#/components/schemas/CapabilityList' - isCAPIFSup: - type: boolean - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N33: - $ref: '#/components/schemas/EP_N33-Multiple' - NsacfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - nsacfInfoSnssai: - type: array - items: - $ref: '#/components/schemas/NsacfInfoSnssai' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N60: - $ref: '#/components/schemas/EP_N60-Multiple' - - DDNMFFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnId: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - sBIFqdn: - type: string - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N64: - $ref: '#/components/schemas/EP_N64-Multiple' - EP_N65: - $ref: '#/components/schemas/EP_N65-Multiple' - EP_N66: - $ref: '#/components/schemas/EP_N66-Multiple' - - ExternalAmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - amfIdentifier: - $ref: '#/components/schemas/AmfIdentifier' - ExternalNrfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - ExternalNssfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - ExternalSeppFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnId: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - sEPPId: - type: integer - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - - - EP_N2-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N3-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - epTransportRefs: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - EP_N4-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N5-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N6-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N7-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N8-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N9-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N10-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N11-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N12-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N13-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N14-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N15-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N16-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N17-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - EP_N20-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - EP_N21-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N22-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - EP_N26-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N27-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - - EP_N31-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N32-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - remotePlmnId: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - remoteSeppAddress: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' - remoteSeppId: - type: integer - n32cParas: - type: string - n32fPolicy: - type: string - withIPX: - type: boolean - EP_N33-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_S5C-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_S5U-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_Rx-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_MAP_SMSC-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_NLS-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_NLG-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - EP_N60-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N64-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N65-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N66-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - FiveQiDscpMappingSet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - FiveQiDscpMappingList: - type: array - items: - $ref: '#/components/schemas/FiveQiDscpMapping' - - FiveQICharacteristics-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - fiveQIValue: - type: integer - resourceType: - type: string - enum: - - GBR - - NonGBR - priorityLevel: - type: integer - packetDelayBudget: - type: integer - packetErrorRate: - $ref: '#/components/schemas/PacketErrorRate' - averagingWindow: - type: integer - maximumDataBurstVolume: - type: integer - FiveQICharacteristics-Multiple: - type: array - items: - $ref: '#/components/schemas/FiveQICharacteristics-Single' - Configurable5QISet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - configurable5QIs: - type: array - items: - $ref: '#/components/schemas/FiveQICharacteristics-Multiple' - - Dynamic5QISet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - dynamic5QIs: - type: array - items: - $ref: '#/components/schemas/FiveQICharacteristics-Multiple' - - GtpUPathQoSMonitoringControl-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - gtpUPathQoSMonitoringState: - type: string - enum: - - ENABLED - - DISABLED - gtpUPathMonitoredSNSSAIs: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - monitoredDSCPs: - type: array - items: - type: integer - minimum: 0 - maximum: 255 - isEventTriggeredGtpUPathMonitoringSupported: - type: boolean - isPeriodicGtpUMonitoringSupported: - type: boolean - isImmediateGtpUMonitoringSupported: - type: boolean - gtpUPathDelayThresholds: - $ref: '#/components/schemas/GtpUPathDelayThresholdsType' - gtpUPathMinimumWaitTime: - type: integer - gtpUPathMeasurementPeriod: - type: integer - - QFQoSMonitoringControl-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - qFQoSMonitoringState: - type: string - enum: - - ENABLED - - DISABLED - qFMonitoredSNSSAIs: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - qFMonitored5QIs: - type: array - items: - type: integer - minimum: 0 - maximum: 255 - isEventTriggeredQFMonitoringSupported: - type: boolean - isPeriodicQFMonitoringSupported: - type: boolean - isSessionReleasedQFMonitoringSupported: - type: boolean - qFPacketDelayThresholds: - $ref: '#/components/schemas/QFPacketDelayThresholdsType' - qFMinimumWaitTime: - type: integer - qFMeasurementPeriod: - type: integer - - PredefinedPccRuleSet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - predefinedPccRules: - type: array - items: - $ref: '#/components/schemas/PccRule' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - ManagedElement-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedElement-Single' - AmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/AmfFunction-Single' - SmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/SmfFunction-Single' - UpfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UpfFunction-Single' - N3iwfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/N3iwfFunction-Single' - PcfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/PcfFunction-Single' - AusfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/AusfFunction-Single' - UdmFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UdmFunction-Single' - UdrFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UdrFunction-Single' - UdsfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UdsfFunction-Single' - NrfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NrfFunction-Single' - NssfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NssfFunction-Single' - SmsfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/SmsfFunction-Single' - LmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/LmfFunction-Single' - NgeirFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NgeirFunction-Single' - SeppFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/SeppFunction-Single' - NwdafFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NwdafFunction-Single' - ScpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ScpFunction-Single' - NefFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NefFunction-Single' - - NsacfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NsacfFunction-Single' - - ExternalAmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalAmfFunction-Single' - ExternalNrfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalNrfFunction-Single' - ExternalNssfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalNssfFunction-Single' - ExternalSeppFunction-Nultiple: - type: array - items: - $ref: '#/components/schemas/ExternalSeppFunction-Single' - - AmfSet-Multiple: - type: array - items: - $ref: '#/components/schemas/AmfSet-Single' - AmfRegion-Multiple: - type: array - items: - $ref: '#/components/schemas/AmfRegion-Single' - - EP_N2-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N2-Single' - EP_N3-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N3-Single' - EP_N4-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N4-Single' - EP_N5-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N5-Single' - EP_N6-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N6-Single' - EP_N7-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N7-Single' - EP_N8-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N8-Single' - EP_N9-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N9-Single' - EP_N10-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N10-Single' - EP_N11-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N11-Single' - EP_N12-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N12-Single' - EP_N13-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N13-Single' - EP_N14-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N14-Single' - EP_N15-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N15-Single' - EP_N16-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N16-Single' - EP_N17-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N17-Single' - - EP_N20-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N20-Single' - EP_N21-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N21-Single' - EP_N22-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N22-Single' - - EP_N26-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N26-Single' - EP_N27-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N27-Single' - - EP_N31-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N31-Single' - EP_N32-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N32-Single' - EP_N33-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N33-Single' - EP_S5C-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_S5C-Single' - EP_S5U-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_S5U-Single' - EP_Rx-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_Rx-Single' - EP_MAP_SMSC-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_MAP_SMSC-Single' - EP_NLS-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_NLS-Single' - EP_NLG-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_NLG-Single' - EP_N60-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N60-Single' - EP_N64-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N64-Single' - EP_N65-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N65-Single' - EP_N66-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N66-Single' - Configurable5QISet-Multiple: - type: array - items: - $ref: '#/components/schemas/Configurable5QISet-Single' - Dynamic5QISet-Multiple: - type: array - items: - $ref: '#/components/schemas/Dynamic5QISet-Single' - - - -#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- - - resources-5gcNrm: - oneOf: - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' - - $ref: '#/components/schemas/AmfFunction-Single' - - $ref: '#/components/schemas/SmfFunction-Single' - - $ref: '#/components/schemas/UpfFunction-Single' - - $ref: '#/components/schemas/N3iwfFunction-Single' - - $ref: '#/components/schemas/PcfFunction-Single' - - $ref: '#/components/schemas/AusfFunction-Single' - - $ref: '#/components/schemas/UdmFunction-Single' - - $ref: '#/components/schemas/UdrFunction-Single' - - $ref: '#/components/schemas/UdsfFunction-Single' - - $ref: '#/components/schemas/NrfFunction-Single' - - $ref: '#/components/schemas/NssfFunction-Single' - - $ref: '#/components/schemas/SmsfFunction-Single' - - $ref: '#/components/schemas/LmfFunction-Single' - - $ref: '#/components/schemas/NgeirFunction-Single' - - $ref: '#/components/schemas/SeppFunction-Single' - - $ref: '#/components/schemas/NwdafFunction-Single' - - $ref: '#/components/schemas/ScpFunction-Single' - - $ref: '#/components/schemas/NefFunction-Single' - - $ref: '#/components/schemas/NsacfFunction-Single' - - - $ref: '#/components/schemas/ExternalAmfFunction-Single' - - $ref: '#/components/schemas/ExternalNrfFunction-Single' - - $ref: '#/components/schemas/ExternalNssfFunction-Single' - - $ref: '#/components/schemas/ExternalSeppFunction-Single' - - - $ref: '#/components/schemas/AmfSet-Single' - - $ref: '#/components/schemas/AmfRegion-Single' - - $ref: '#/components/schemas/QFQoSMonitoringControl-Single' - - $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' - - - $ref: '#/components/schemas/EP_N2-Single' - - $ref: '#/components/schemas/EP_N3-Single' - - $ref: '#/components/schemas/EP_N4-Single' - - $ref: '#/components/schemas/EP_N5-Single' - - $ref: '#/components/schemas/EP_N6-Single' - - $ref: '#/components/schemas/EP_N7-Single' - - $ref: '#/components/schemas/EP_N8-Single' - - $ref: '#/components/schemas/EP_N9-Single' - - $ref: '#/components/schemas/EP_N10-Single' - - $ref: '#/components/schemas/EP_N11-Single' - - $ref: '#/components/schemas/EP_N12-Single' - - $ref: '#/components/schemas/EP_N13-Single' - - $ref: '#/components/schemas/EP_N14-Single' - - $ref: '#/components/schemas/EP_N15-Single' - - $ref: '#/components/schemas/EP_N16-Single' - - $ref: '#/components/schemas/EP_N17-Single' - - - $ref: '#/components/schemas/EP_N20-Single' - - $ref: '#/components/schemas/EP_N21-Single' - - $ref: '#/components/schemas/EP_N22-Single' - - - $ref: '#/components/schemas/EP_N26-Single' - - $ref: '#/components/schemas/EP_N27-Single' - - - $ref: '#/components/schemas/EP_N31-Single' - - $ref: '#/components/schemas/EP_N32-Single' - - $ref: '#/components/schemas/EP_N33-Single' - - $ref: '#/components/schemas/EP_N60-Single' - - - $ref: '#/components/schemas/EP_S5C-Single' - - $ref: '#/components/schemas/EP_S5U-Single' - - $ref: '#/components/schemas/EP_Rx-Single' - - $ref: '#/components/schemas/EP_MAP_SMSC-Single' - - $ref: '#/components/schemas/EP_NLS-Single' - - $ref: '#/components/schemas/EP_NLG-Single' - - $ref: '#/components/schemas/Configurable5QISet-Single' - - $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' - - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' - - $ref: '#/components/schemas/Dynamic5QISet-Single' diff --git a/OpenAPI/PerDataFileReportMnS.yaml b/OpenAPI/PerDataFileReportMnS.yaml deleted file mode 100644 index 83fd77acb..000000000 --- a/OpenAPI/PerDataFileReportMnS.yaml +++ /dev/null @@ -1,13 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.532 File data reporting Service - version: 16.6.0 - description: >- - OAS 3.0.1 specification of the File data reporting Management Service © 2020, - 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All - rights reserved. -externalDocs: - description: 3GPP TS 28.532 V16.5.0; Generic management services - url: 'http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/' -paths: {} - diff --git a/OpenAPI/PerMeasJobCtlMnS.yaml b/OpenAPI/PerMeasJobCtlMnS.yaml deleted file mode 100644 index b6abe58b2..000000000 --- a/OpenAPI/PerMeasJobCtlMnS.yaml +++ /dev/null @@ -1,280 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.550 Performance Measurement Job Control Service - version: 16.5.0 - description: >- - OAS 3.0.1 specification of the Performance Measurement Job Control Service - @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.550 V16.5.0; Performance assurance - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.550/ -servers: - - url: 'http://{URI-DN-prefix}/{root}/PerfMeasJobCtrlMnS/v1650/{LDN-first-part}' - variables: - URI-DN-prefix: - description: See subclause 4.4 of TS 32.158 - default: example.com - root: - description: See subclause 4.4 of TS 32.158 - default: 3GPPManagement - LDN-first-part: - description: See subclause 4.4 of TS 32.158 - default: '' -paths: - /measJobs: - post: - summary: Create a measurement job - description: To create a measurement job the representation of the measurement job is POSTed on the /measJobs collection resource. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/measJobCreation-RequestType' - responses: - '201': - description: Success case ("201 Created"). The representation of the newly created measurement job resource shall be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/measJobCreation-ResponseType' - '202': - description: Partial success case ("202 Partically created"). The representation of the newly created measurement job resource with unsupported list shall be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/measJobCreation-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - get: - summary: Read resources of measurement jobs - description: 'With HTTP GET, resources of measurement jobs are read. The resources to be read are identified with the path component (base resource) and the query component (jobIdList) of the URI. The fields query component allows to select the resource properties to be returned.' - parameters: - - name: jobIdList - in: query - description: This parameter identifies the list of jobId to select the resources from the collection resources identified with the path component of the URI. - required: true - schema: - type: array - items: - type: string - responses: - '200': - description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.' - content: - application/json: - schema: - $ref: '#/components/schemas/measJobsRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - '/measJobs/{jobId}': - get: - summary: Read resource of a single measurement job - description: 'With HTTP GET, resource of a measurement job is read. The resource to be read is identified with the path component of the URI.' - parameters: - - name: jobId - in: path - description: Identifies the measurement job to be read. - required: true - schema: - $ref: '#/components/schemas/uri-Type' - responses: - '200': - description: 'Success case ("200 OK"). The resource identified in the path for retrieval is returned in the response message body. ' - content: - application/json: - schema: - $ref: '#/components/schemas/measJobsRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: Delete a single measurement job - description: The measurement job is deleted by deleting the corresponding measurement job resource. The resource to be deleted is identified with the path component of the URI. - parameters: - - name: jobId - in: path - description: Identifies the measurement job to be deleted. - required: true - schema: - $ref: '#/components/schemas/uri-Type' - responses: - '204': - description: Success case ("204 No Content"). The measurement job resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - dateTime-Type: - type: string - format: date-Time - uri-Type: - type: string - measJobCreation-RequestType: - type: object - properties: - iOCName: - type: string - iOCInstanceList: - type: array - items: - $ref: '#/components/schemas/uri-Type' - measurementCategoryList: - type: array - items: - type: string - reportingMethod: - $ref: '#/components/schemas/reportingMethod-Type' - granularityPeriod: - type: integer - reportingPeriod: - type: integer - startTime: - $ref: '#/components/schemas/dateTime-Type' - stopTime: - $ref: '#/components/schemas/dateTime-Type' - schedule: - $ref: '#/components/schemas/schedule-Type' - streamTarget: - type: string - priority: - $ref: '#/components/schemas/priority-Type' - reliability: - type: string - measJobCreation-ResponseType: - type: object - properties: - unsupportedList: - type: array - items: - $ref: '#/components/schemas/unsupportedMeas-Type' - measJobsRetrieval-ResponseType: - type: object - properties: - jobInfoList: - type: array - items: - $ref: '#/components/schemas/measJobInfo-ResourceType' - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - measJobInfo-ResourceType: - type: object - properties: - href: - $ref: '#/components/schemas/uri-Type' - iOCName: - type: string - iOCInstanceList: - type: array - items: - $ref: '#/components/schemas/uri-Type' - measurementCategoryList: - type: array - items: - type: string - reportingMethod: - $ref: '#/components/schemas/reportingMethod-Type' - granularityPeriod: - type: integer - reportingPeriod: - type: integer - startTime: - $ref: '#/components/schemas/dateTime-Type' - stopTime: - $ref: '#/components/schemas/dateTime-Type' - schedule: - $ref: '#/components/schemas/schedule-Type' - streamTarget: - type: string - priority: - $ref: '#/components/schemas/priority-Type' - reliability: - type: string - schedule-Type: - type: object - properties: - scheduleOption: - $ref: '#/components/schemas/scheduleOption-Type' - dailySchedule: - type: array - items: - $ref: '#/components/schemas/timeInterval-Type' - weeklySchedule: - type: array - items: - $ref: '#/components/schemas/scheduleOfDay-Type' - timeInterval-Type: - type: object - properties: - intervalStart: - type: string - format: Time - intervalEnd: - type: string - format: Time - scheduleOfDay-Type: - type: object - properties: - dayOfWeek: - $ref: '#/components/schemas/dayOfWeek-Type' - intervalsOfDay: - type: array - items: - $ref: '#/components/schemas/timeInterval-Type' - unsupportedMeas-Type: - type: object - properties: - iOCInstance: - $ref: '#/components/schemas/uri-Type' - measurementTypeName: - type: string - reason: - type: string - reportingMethod-Type: - type: string - enum: - - file - - streaming - priority-Type: - type: string - enum: - - low - - medium - - high - scheduleOption-Type: - type: string - enum: - - daily - - weekly - dayOfWeek-Type: - type: string - enum: - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday diff --git a/OpenAPI/PerThresMonMnS.yaml b/OpenAPI/PerThresMonMnS.yaml deleted file mode 100644 index 923640a11..000000000 --- a/OpenAPI/PerThresMonMnS.yaml +++ /dev/null @@ -1,102 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.532 Performance Threshold Monitoring Service - version: 16.4.0 - description: OAS 3.0.1 specification of the Performance Threshold Monitoring Service -servers: - - url: 'http://{monitoringNotifTarget}' - variables: - monitoringNotifTarget: - description: >- - The open API server of the performance threshold monitoring service is - located in the consumer side, see monitoringNotifTarget attribute of - the IOC ThresholdMonitor defined in 3GPP TS 28.622 [11]. - default: example.com -paths: - /notificationSink: - post: - summary: Send notifications about performance threshold crossing - description: To send a notifyThresholdCrossing notification - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyThresholdCrossing-NotifType' - responses: - '204': - description: >- - Success case ("204 No Content"). The notification is successfully - delivered. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - dateTime-Type: - type: string - format: date-Time - uri-Type: - type: string - long-Type: - type: string - format: long - thresholdLevel-Type: - type: integer - measurementTypeName-Type: - type: string - measurementValue-Type: - type: string - additionalText-Type: - type: string - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - header-Type: - description: Header used in notifications as notification header - type: object - properties: - uri: - $ref: '#/components/schemas/uri-Type' - notificationId: - $ref: '#/components/schemas/notificationId-Type' - notificationType: - $ref: '#/components/schemas/notificationType-Type' - eventTime: - $ref: '#/components/schemas/dateTime-Type' - notificationId-Type: - $ref: '#/components/schemas/long-Type' - notificationType-Type: - type: string - enum: - - notifyThresholdCrossing - notifyThresholdCrossing-NotifType: - type: object - properties: - header: - $ref: '#/components/schemas/header-Type' - body: - type: object - properties: - startOfMonitoringGP: - $ref: '#/components/schemas/dateTime-Type' - endOfMonitoringGP: - $ref: '#/components/schemas/dateTime-Type' - monitoredObjectInstance: - $ref: '#/components/schemas/uri-Type' - thresholdLevel: - $ref: '#/components/schemas/thresholdLevel-Type' - measurementTypeName: - $ref: '#/components/schemas/measurementTypeName-Type' - measurementValue: - $ref: '#/components/schemas/measurementValue-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' diff --git a/OpenAPI/PerfDataStreamingMnS.yaml b/OpenAPI/PerfDataStreamingMnS.yaml deleted file mode 100644 index e040e14c8..000000000 --- a/OpenAPI/PerfDataStreamingMnS.yaml +++ /dev/null @@ -1,363 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.550 Performance Data Streaming Service - version: 16.3.0 - description: OAS 3.0.1 specification of the Performance Data Streaming Service -servers: - - url: 'http://{streamTarget}/PerfDataStreamMnS/v1630' - description: This URL is used for posting the set of information about streams supported on the connection between the producer and the consumer. - variables: - streamTarget: - description: 'The open API server of the performance data streaming service is located in the consumer side,and the “streamTarget” part corresponds to the streamTarget parameter provided in the createMeasurementJob operation (see clause 6.1.1.2) or the streamTarget attribute of the MOI of MeasurementControlor MeasurementReader, see 3GPP TS 28.622 [5]).' - default: example.com - - url: 'wss://{streamTarget}/PerfDataStreamMnS/v1630/streamingConnection' - description: This URL is used for establishing the WebSocket connection for the performance data streaming service. - variables: - streamTarget: - description: 'The open API server of the performance data streaming service is located in the consumer side,and the “streamTarget” part corresponds to the streamTarget parameter provided in the createMeasurementJob operation (see clause 6.1.1.2) or the streamTarget attribute of the MOI of MeasurementControlor MeasurementReader, see 3GPP TS 28.622 [5]).' - default: example.com -paths: - /streamInfoList: - post: - summary: The set of information about the streams sent from the producer to the consumer - description: To send the streamInfoList from the producer to the consumer - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoListPost-RequestType' - responses: - '201': - description: Success case ("201 Posted"). The streamInfoList is successfully posted. - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoListPost-ResponseType' - '202': - description: Partial success case ("202 Partially posted"). The representation of the posted resource on stream information. - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoListPost-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - get: - summary: Read resources of stream information from the streaming consumer - description: 'With HTTP GET, resources of stream information are read. The resources to be read are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be returned.' - parameters: - - name: streamIdList - in: query - description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. - required: true - schema: - type: array - items: - type: integer - responses: - '200': - description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.' - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' - '202': - description: Partial success case ("202 Partially retrieved"). The representation of the retrieved resources on stream information. - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - patch: - summary: Update resources of stream information to the streaming consumer - description: 'With HTTP PATCH, resources of stream information are to be updated. The resources to be updated are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be updated.' - parameters: - - name: streamIdList - in: query - description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. - required: true - schema: - type: array - items: - type: integer - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoToUpdate-RequestType' - responses: - '200': - description: Success case ("200 OK"). The resources selected by the query parameter are updated and returned in the response message body. - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoUpdate-ResponseType' - '202': - description: Partial success case ("202 Partially updated"). The representation of the updated resources on stream information - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoUpdate-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: The information of streams to be deleted by the producer to the consumer - description: 'With HTTP DELETE, resources of stream information are to be deleted. The resources to be deleted are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be deleted.' - parameters: - - name: streamIdList - in: query - description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. - required: true - schema: - type: array - items: - type: integer - responses: - '204': - description: Success case ("204 No Content"). The stream information resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - '/streamInfoList/{streamId}': - get: - summary: Read resource of the stream information from the streaming consumer - description: 'With HTTP GET, resource of stream information is read. The resource to be read is identified with the path component the URI.' - parameters: - - name: streamId - in: path - description: Identifies the stream for which the information is to be retrieved. - required: true - schema: - $ref: '#/components/schemas/uri-Type' - responses: - '200': - description: Success case ("200 OK"). The resource identified in the request for retrieval is returned in the response message body. - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - patch: - summary: Update the resource of stream information to the streaming consumer - description: 'With HTTP PATCH, resource of stream information is to be updated. The resource to be updated is identified by the path component of the URI. ' - parameters: - - name: streamId - in: path - description: Identifies the stream for which the information is to be updated. - required: true - schema: - $ref: '#/components/schemas/uri-Type' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoToUpdate-RequestType' - responses: - '200': - description: Success case ("200 OK"). The resources identified by the path of the URI is updated and returned in the response message body. - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoUpdate-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: The stream information to be deleted by the producer to the consumer - description: 'With HTTP DELETE, resource of stream information identified by the path component of the URI is to be deleted.' - parameters: - - name: streamId - in: path - description: Identifies the stream for which the information is to be deleted - required: true - schema: - $ref: '#/components/schemas/uri-Type' - responses: - '204': - description: Success case ("204 No Content"). The stream information resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - /streamConnection: - get: - summary: The connection for streaming from the producer to the consumer - description: To establish the WebSocket connection between the producer and the consumer. The HTTP version of this operation shall not be earlier than HTTP/1.1 - parameters: - - in: header - name: Upgrade - required: true - schema: - $ref: '#/components/schemas/Upgrade-HeaderType' - - in: header - name: Connection - required: true - schema: - $ref: '#/components/schemas/Connection-HeaderType' - - in: header - name: Sec-WebSocket-Key - required: true - schema: - $ref: '#/components/schemas/Sec-WebSocket-Key-HeaderType' - - in: header - name: Sec-WebSocket-Version - required: true - schema: - $ref: '#/components/schemas/Sec-WebSocket-Version-HeaderType' - responses: - '101': - description: Success case ("101 Switching Protocols "). The connection has been successfully switched to WebSocket. The response message body is absent. - headers: - Upgrade: - schema: - $ref: '#/components/schemas/Upgrade-HeaderType' - Connection: - schema: - $ref: '#/components/schemas/Connection-HeaderType' - Sec-WebSocket-Accept-HeaderType: - schema: - $ref: '#/components/schemas/Sec-WebSocket-Accept-HeaderType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - uri-Type: - type: string - streamInfoIn-Type: - type: object - properties: - streamId: - type: integer - iOCInstance: - $ref: '#/components/schemas/uri-Type' - measTypes: - type: array - items: - type: string - streamInfoOut-Type: - type: object - properties: - streamId: - $ref: '#/components/schemas/uri-Type' - iOCInstance: - $ref: '#/components/schemas/uri-Type' - measTypes: - type: array - items: - type: string - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - streamInfoListPost-RequestType: - type: object - properties: - streamInfoList: - type: array - items: - $ref: '#/components/schemas/streamInfoIn-Type' - streamInfoListPost-ResponseType: - type: object - properties: - streamInfoListPosted: - type: array - items: - $ref: '#/components/schemas/streamInfoOut-Type' - streamInfoRetrieval-ResponseType: - type: object - properties: - streamInfoOut: - $ref: '#/components/schemas/streamInfoOut-Type' - listOfStreamInfoRetrieval-ResponseType: - type: object - properties: - listOfStreamInfoOut: - type: array - items: - $ref: '#/components/schemas/streamInfoOut-Type' - streamInfoToUpdatePropertyType: - type: object - properties: - iOCInstance: - description: 'The updated measured object instance, empty value means no update.' - allOf: - - $ref: '#/components/schemas/uri-Type' - measTypes: - description: 'The updated list of measurement type, empty value means no update.' - type: array - items: - type: string - streamInfoToUpdate-RequestType: - type: object - properties: - streamInfoToUpdate: - $ref: '#/components/schemas/streamInfoToUpdatePropertyType' - listOfStreamInfoToUpdate-RequestType: - type: object - properties: - listOfStreamInfoToUpdate: - type: array - items: - $ref: '#/components/schemas/streamInfoToUpdatePropertyType' - streamInfoUpdate-ResponseType: - type: object - properties: - streamInfoUpdated: - $ref: '#/components/schemas/streamInfoOut-Type' - listOfStreamInfoUpdate-ResponseType: - type: object - properties: - listOfStreamInfoUpdated: - type: array - items: - $ref: '#/components/schemas/streamInfoOut-Type' - Upgrade-HeaderType: - type: string - enum: - - websocket - Connection-HeaderType: - type: string - enum: - - Upgrade - Sec-WebSocket-Key-HeaderType: - type: string - Sec-WebSocket-Version-HeaderType: - type: string - Sec-WebSocket-Accept-HeaderType: - type: string diff --git a/OpenAPI/comDefs.yaml b/OpenAPI/comDefs.yaml deleted file mode 100644 index 04ab65161..000000000 --- a/OpenAPI/comDefs.yaml +++ /dev/null @@ -1,84 +0,0 @@ -openapi: 3.0.1 -info: - title: Common Type Definitions - version: 16.3.0 - description: >- - OAS 3.0.1 specification of common type definitions in the Generic NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.623 V16.3.0; Generic NRM, Common Type Definitions - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ -paths: {} -components: - schemas: - Long: - type: string - format: long - Float: - type: string - format: float - DateTime: - type: string - format: date-Time - Dn: - type: string - Uri: - type: string - AttributeNameValuePairSet: - type: object - minProperties: 1 - AttributeValueChangeSet: - description: >- - The key in this map is the attribute name. The value of each key is an array. - When only one item is present in the array, it carries the new attribute - value. If two items are present, then the first item carries the old value - and the second item the new value. The items can be of any type including null. - type: object - additionalProperties: - type: array - minItems: 1 - maxItems: 2 - items: - nullable: true - Filter: - type: string - SystemDN: - type: string - NotificationId: - type: integer - NotificationHeader: - description: >- - Header used for all notifications types - type: object - required: - - uri - - notificationId - - notificationType - - eventTime - - systemDn - properties: - uri: - $ref: '#/components/schemas/Uri' - notificationId: - $ref: '#/components/schemas/NotificationId' - notificationType: - oneOf: - - $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes' - #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes' - # more to be added - eventTime: - $ref: '#/components/schemas/DateTime' - systemDN: - $ref: '#/components/schemas/SystemDN' - ErrorResponse: - description: >- - Default schema for the response message body in case the request - is not successful. - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string diff --git a/OpenAPI/coslaNrm.yaml b/OpenAPI/coslaNrm.yaml deleted file mode 100644 index e6a0ef13a..000000000 --- a/OpenAPI/coslaNrm.yaml +++ /dev/null @@ -1,168 +0,0 @@ -openapi: 3.0.2 - -info: - title: coslaNrm - version: 16.4.0 - description: - OAS 3.0.1 specification of the Cosla NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. - -externalDocs: - description: 3GPP TS 28.536 V16.4.0; Cosla NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.536/ - -paths: {} - -components: - - schemas: - -#------------ Type definitions --------------------------------------------------- - - ControlLoopLifeCyclePhase: - type: string - enum: - - PREPARATION - - COMMISSIONING - - OPERATION - - DECOMMISSIONING - - ObservationTime: - type: integer - - AssuranceGoalStatusObserved: - type: string - enum: - - FULFILLED - - NOT_FULFILLED - - AssuranceGoalStatusPredicted: - type: string - enum: - - FULFILLED - - NOT_FULFILLED - - AssuranceTargetStatusObserved: - type: string - enum: - - FULFILLED - - NOT_FULFILLED - - AssuranceTargetStatusPredicted: - type: string - enum: - - FULFILLED - - NOT_FULFILLED - - AssuranceTarget: - type: object - properties: - assuranceTargetName: - type: string - assuranceTargetValue: - type: string - assuranceTargetStatusObserved: - $ref: '#/components/schemas/AssuranceTargetStatusObserved' - assuranceTargetStatusPredicted: - $ref: '#/components/schemas/AssuranceTargetStatusPredicted' - - AssuranceTargetList: - type: array - items: - $ref: '#/components/schemas/AssuranceTarget' - - -#-------- Definition of concrete IOCs -------------------------------------------- - - SubNetwork-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - AssuranceClosedControlLoop: - $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' - - ManagedElement-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' - - type: object - properties: - AssuranceClosedControlLoop: - $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' - - AssuranceClosedControlLoop-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - operationalState: - $ref: 'genericNrm.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - controlLoopLifeCyclePhase: - $ref: '#/components/schemas/ControlLoopLifeCyclePhase' - AssuranceGoal: - $ref: '#/components/schemas/AssuranceGoal-Multiple' - - AssuranceGoal-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - observationTime: - $ref: '#/components/schemas/ObservationTime' - assuranceTargetList: - $ref: '#/components/schemas/AssuranceTargetList' - assuranceGoalStatusObserved: - $ref: '#/components/schemas/AssuranceGoalStatusObserved' - assuranceGoalStatusPredicted: - $ref: '#/components/schemas/AssuranceGoalStatusPredicted' - serviceProfileId: - type: string - sliceProfileId: - type: string - networkSliceRef: - $ref: 'comDefs.yaml#/components/schemas/Dn' - networkSliceSubnetRef: - $ref: 'comDefs.yaml#/components/schemas/Dn' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - AssuranceClosedControlLoop-Multiple: - type: array - items: - $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' - - AssuranceGoal-Multiple: - type: array - items: - $ref: '#/components/schemas/AssuranceGoal-Single' - -#------------ Definitions in TS 28.536 for TS 28.623 ----------------------------- - - resources-coslaNrm: - oneOf: - - $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' - - $ref: '#/components/schemas/AssuranceGoal-Single' - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' \ No newline at end of file diff --git a/OpenAPI/faultMnS.yaml b/OpenAPI/faultMnS.yaml deleted file mode 100644 index 499123b90..000000000 --- a/OpenAPI/faultMnS.yaml +++ /dev/null @@ -1,1144 +0,0 @@ -openapi: 3.0.1 -info: - title: Fault Supervision MnS - version: 16.4.0 - description: >- - OAS 3.0.1 definition of the Fault Supervision MnS - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.532 V16.4.0; Generic management services - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ -servers: - - url: '{MnSRoot}/FaultSupervisionMnS/{version}' - variables: - MnSRoot: - description: See subclause 4.4.3 of TS 32.158 - default: http://example.com/3GPPManagement - version: - description: Versi on number of the OpenAPI definition - default: XXX -paths: - /alarms: - get: - summary: Retrieve multiple alarms - description: >- - Retrieves the alarms identified by alarmAckState, baseObjectInstance - and filter. - parameters: - - name: alarmAckState - in: query - required: false - schema: - $ref: '#/components/schemas/AlarmAckState' - - name: baseObjectInstance - in: query - required: false - schema: - $ref: '#/components/schemas/Dn' - - name: filter - in: query - required: false - schema: - $ref: '#/components/schemas/Filter' - responses: - '200': - description: >- - Success case ("200 OK"). - Returns the alarms identified in the request. The alarmId is the key - of the map. - content: - application/json: - schema: - type: object - additionalProperties: - type: object - allOf: - - type: object - properties: - lastNotificationHeader: - $ref: '#/components/schemas/NotificationHeader' - - $ref: '#/components/schemas/AlarmRecord' - - type: object - properties: - comments: - $ref: '#/components/schemas/Comments' - default: - description: Response in case of error. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - patch: - summary: 'Clear, acknowledge or unacknowledge multiple alarms' - description: >- - Clears, acknowledges or unacknowledges multiple alarms using patch. Depending - on which action is to be performed, different merge patch documents need - to be used. - requestBody: - description: >- - Patch documents for acknowledging and unacknowledging, or clearing multiple - alarms. The keys in the map are the alarmIds to be patched. - content: - application/merge-patch+json: - schema: - oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/MergePatchAcknowledgeAlarm' - - type: object - additionalProperties: - $ref: '#/components/schemas/MergePatchClearAlarm' - responses: - '204': - description: >- - Success case ("204 No content"). - The response message body is empty. - default: - description: Response in case of error. - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/FailedAlarm' - /alarms/alarmCount: - get: - summary: Get the alarm count per perceived severity - parameters: - - name: alarmAckState - in: query - required: false - schema: - $ref: '#/components/schemas/AlarmAckState' - - name: filter - in: query - required: false - schema: - type: string - responses: - '200': - description: >- - Success case ("200 OK"). - The alarm count per perceived severity is returned. - content: - application/json: - schema: - $ref: '#/components/schemas/AlarmCount' - default: - description: Response in case of error. The error case needs rework. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - /alarms/{alarmId}: - patch: - summary: 'Clear, acknowledge or unacknowledge a single alarm' - description: >- - Clears, acknowledges or uncknowldeges a single alarm by patching the alarm - information. A conditional acknowledge request based on the perceived - severity is not supported. - parameters: - - name: alarmId - in: path - description: Identifies the alarm to be patched. - required: true - schema: - type: string - requestBody: - required: true - content: - application/merge-patch+json: - schema: - oneOf: - - $ref: '#/components/schemas/MergePatchAcknowledgeAlarm' - - $ref: '#/components/schemas/MergePatchClearAlarm' - responses: - '204': - description: >- - Success case (204 No content). - The response message body is absent. - default: - description: Response in case of error. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - /alarms/{alarmId}/comments: - post: - summary: Add a comment to a single alarm - description: >- - Adds a comment to an alarm identified by alarmId. The id of the new comment - is allocated by the producer. - parameters: - - name: alarmId - in: path - description: Identifies the alarm to which the comment shall be added. - required: true - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Comment' - responses: - '201': - description: >- - Success case (201 Created). - The representation of the newly created comment resource shall be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/Comment' - headers: - Location: - description: URI of the newly created comment resource. - required: true - schema: - type: string - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - - /subscriptions: - post: - summary: Create a subscription - description: >- - To create a subscription the representation of the subscription is - POSTed on the /subscriptions collection resource. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Subscription' - responses: - '201': - description: >- - Success case ("201 Created"). - The representation of the newly created subscription resource shall - be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/Subscription' - headers: - Location: - description: URI of the newly created subscription resource - required: true - schema: - type: string - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - callbacks: - notifyNewAlarm: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/NotifyNewAlarm' - - $ref: '#/components/schemas/NotifyNewSecAlarm' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyClearedAlarm: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyClearedAlarm' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyChangedAlarm: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyChangedAlarm' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyChangedAlarmGeneral: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/NotifyChangedAlarmGeneral' - - $ref: '#/components/schemas/NotifyChangedSecAlarmGeneral' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyCorrelatedNotificationChanged: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyCorrelatedNotificationChanged' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyAckStateChanged: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyAckStateChanged' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyComments: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyComments' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyPotentialFaultyAlarmList: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyPotentialFaultyAlarmList' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - notifyAlarmListRebuilt: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyAlarmListRebuilt' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}: - delete: - summary: Delete a subscription - description: >- - The subscription is deleted by deleting the corresponding subscription - resource. The resource to be deleted is identified with the path - component of the URI. - parameters: - - name: subscriptionId - in: path - description: Identifies the subscription to be deleted. - required: true - schema: - type: string - responses: - '204': - description: >- - Success case ("204 No Content"). - The subscription resource has been deleted. The response message body - is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - -components: - schemas: - - #---- Definitions to be moved to comDefs.yaml --------------------------------------# - - Long: - type: string - format: long - Float: - type: string - format: float - DateTime: - type: string - format: date-Time - - Dn: - type: string - Uri: - type: string - - AttributeNameValuePairSet: - type: object - minProperties: 1 - AttributeValueChangeSet: - description: >- - The key in this map is the attribute name. The value of each key is an array. - When only one item is present in the array, it carries the new attribute - value. If two items are present, then the first item carries the old value - and the second item the new value. The items can be of any type including null. - type: object - additionalProperties: - type: array - minItems: 1 - maxItems: 2 - items: - nullable: true - - Filter: - type: string - SystemDN: - type: string - - NotificationId: - type: integer - NotificationHeader: - description: >- - Header used for all notification types - type: object - required: - - href - - notificationId - - notificationType - - eventTime - - systemDN - properties: - uri: - $ref: '#/components/schemas/Uri' - notificationId: - $ref: '#/components/schemas/NotificationId' - notificationType: - oneOf: - - $ref: '#/components/schemas/AlarmNotificationTypes' - #- $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes' - #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes' - # more to be added - eventTime: - $ref: '#/components/schemas/DateTime' - systemDN: - $ref: '#/components/schemas/SystemDN' - - ErrorResponse: - description: >- - Default schema for the response message body in case the request is not - successful. - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - - #---- End of definitions to be moved to comDefs.yaml -------------------------------# - - #---- Definition of AlarmRecord ----------------------------------------------------# - - AlarmId: - type: string - AlarmType: - type: string - enum: - - COMMUNICATIONS_ALARM - - QUALITY_OF_SERVICE_ALARM - - PROCESSING_ERROR_ALARM - - EQUIPMENT_ALARM - - ENVIRONMENTAL_ALARM - - INTEGRITY_VIOLATION - - OPERATIONAL_VIOLATION - - PHYSICAL_VIOLATION - - SECURITY_SERVICE_OR_MECHANISM_VIOLATION - - TIME_DOMAIN_VIOLATION - ProbableCause: - description: >- - The value of the probable cause may be a specific standardized string, or any - vendor provided string. Probable cause strings are not standardized in the - present document. They may be added in a future version. Up to then the - mapping of the generic probable cause strings "PROBABLE_CAUSE_001" to - "PROBABLE_CAUSE_005" is vendor specific. - The value of the probable cause may also be an integer. The mapping of integer - values to probable causes is vendor specific. - oneOf: - - anyOf: - - type: string - enum: - - PROBABLE_CAUSE_001 - - PROBABLE_CAUSE_002 - - PROBABLE_CAUSE_003 - - PROBABLE_CAUSE_004 - - PROBABLE_CAUSE_005 - - type: string - - type: integer - SpecificProblem: - oneOf: - - type: string - - type: integer - PerceivedSeverity: - type: string - enum: - - INDETERMINATE - - CRITICAL - - MAJOR - - MINOR - - WARNING - - CLEARED - TrendIndication: - type: string - enum: - - MORE_SEVERE - - NO_CHANGE - - LESS_SEVERE - ThresholdHysteresis: - type: object - required: - - high - properties: - high: - oneOf: - - type: integer - - $ref: '#/components/schemas/Float' - low: - $ref: '#/components/schemas/Float' - ThresholdLevelInd: - type: object - required: - - up - properties: - up: - $ref: '#/components/schemas/ThresholdHysteresis' - low: - $ref: '#/components/schemas/ThresholdHysteresis' - ThresholdInfo: - type: object - required: - - observedMeasurement - - observedValue - properties: - observedMeasurement: - type: string - observedValue: - oneOf: - - type: integer - - $ref: '#/components/schemas/Float' - thresholdLevelInd: - $ref: '#/components/schemas/ThresholdLevelInd' - armTime: - $ref: '#/components/schemas/DateTime' - CorrelatedNotification: - type: object - required: - - source - - notificationId - properties: - sourceObjectInstance: - $ref: '#/components/schemas/Dn' - notificationIds: - type: array - items: - $ref: '#/components/schemas/NotificationId' - CorrelatedNotifications: - type: array - items: - $ref: '#/components/schemas/CorrelatedNotification' - AckState: - type: string - enum: - - ACKNOWLEDGED - - UNACKNOWLEDGED - - AlarmRecord: - description: >- - The alarmId is not a property of an alarm record. It is used as key - in the map of alarm records instead. - type: object - properties: - # alarmId: - # $ref: '#/components/schemas/AlarmId' - objectInstance: - $ref: '#/components/schemas/Dn' - notificationId: - $ref: '#/components/schemas/NotificationId' - alarmRaisedTime: - $ref: '#/components/schemas/DateTime' - alarmChangedTime: - $ref: '#/components/schemas/DateTime' - alarmClearedTime: - $ref: '#/components/schemas/DateTime' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - specificProblem: - $ref: '#/components/schemas/SpecificProblem' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - backedUpStatus: - type: boolean - backUpObject: - $ref: '#/components/schemas/Dn' - trendIndication: - $ref: '#/components/schemas/TrendIndication' - thresholdinfo: - $ref: '#/components/schemas/ThresholdInfo' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - stateChangeDefinition: - $ref: '#/components/schemas/AttributeValueChangeSet' - monitoredAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' - proposedRepairActions: - type: string - additionalText: - type: string - additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' - - rootCauseIndicator: - type: boolean - - ackTime: - $ref: '#/components/schemas/DateTime' - ackUserId: - type: string - ackSystemId: - type: string - ackState: - $ref: '#/components/schemas/AckState' - - clearUserId: - type: string - clearSystemId: - type: string - serviceUser: - type: string - serviceProvider: - type: string - securityAlarmDetector: - type: string - - #---- Definition of alarm notifications --------------------------------------------# - - AlarmNotificationTypes: - type: string - enum: - - notifyNewAlarm - - notifyChangedAlarm - - notifyChangedAlarmGeneral - - notifyAckStateChanged - - notifyCorrelatedNotificationChanged - - notifyComments - - notifyClearedAlarm - - notifyAlarmListRebuiltAlarm - - notifyPotentialFaultyAlarmList - AlarmListAlignmentRequirement: - type: string - enum: - - ALIGNMENT_REQUIRED - - ALIGNMENT_NOT_REQUIRED - - NotifyNewAlarm: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - specificProblem: - $ref: '#/components/schemas/SpecificProblem' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - backedUpStatus: - type: boolean - backUpObject: - $ref: '#/components/schemas/Dn' - trendIndication: - $ref: '#/components/schemas/TrendIndication' - thresholdInfo: - $ref: '#/components/schemas/ThresholdInfo' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - stateChangeDefinition: - $ref: '#/components/schemas/AttributeValueChangeSet' - monitoredAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' - proposedRepairActions: - type: string - additionalText: - type: string - additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - NotifyNewSecAlarm: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - serviceUser - - serviceProvider - - securityAlarmDetector - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - additionalText: - type: string - additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - serviceUser: - type: string - serviceProvider: - type: string - securityAlarmDetector: - type: string - NotifyClearedAlarm: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - clearUserId: - type: string - clearSystemId: - type: string - NotifyChangedAlarm: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - NotifyChangedAlarmGeneral: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - changedAlarmAttributes - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - specificProblem: - $ref: '#/components/schemas/SpecificProblem' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - backedUpStatus: - type: boolean - backUpObject: - $ref: '#/components/schemas/Dn' - trendIndication: - $ref: '#/components/schemas/TrendIndication' - thresholdInfo: - $ref: '#/components/schemas/ThresholdInfo' - stateChangeDefinition: - $ref: '#/components/schemas/AttributeValueChangeSet' - monitoredAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' - proposedRepairActions: - type: string - additionalText: - type: string - additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - changedAlarmAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' - NotifyChangedSecAlarmGeneral: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - serviceUser - - serviceProvider - - securityAlarmDetector - - changedAlarmAttributes - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - additionalText: - type: string - additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - serviceUser: - type: string - serviceProvider: - type: string - securityAlarmDetector: - type: string - changedAlarmAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' - NotifyCorrelatedNotificationChanged: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - correlatedNotifications - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - rootCauseIndicator: - type: boolean - NotifyAckStateChanged: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - ackState - - ackUserId - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - ackState: - $ref: '#/components/schemas/AckState' - ackUserId: - type: string - ackSystemId: - type: string - NotifyComments: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - comments - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - comments: - $ref: '#/components/schemas/Comments' - NotifyPotentialFaultyAlarmList: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - reason - properties: - reason: - type: string - NotifyAlarmListRebuilt: - allOf: - - $ref: '#/components/schemas/NotificationHeader' - - type: object - required: - - reason - properties: - reason: - type: string - alarmListAlignmentRequirement: - $ref: '#/components/schemas/AlarmListAlignmentRequirement' - - #---- Definition of query parameters -----------------------------------------------# - - AlarmAckState: - type: string - enum: - - ALL_ALARMS - - ALL_ACTIVE_ALARMS - - ALL_ACTIVE_AND_ACKNOWLEDGED_ALARMS - - ALL_ACTIVE_AND_UNACKNOWLEDGED_ALARMS - - ALL_CLEARED_AND_UNACKNOWLEDGED_ALARMS - - ALL_UNACKNOWLEDGED_ALARMS - - #---- Definition of patch documents ------------------------------------------------# - - MergePatchAcknowledgeAlarm: - description: >- - Patch document acknowledging or unacknowledging a single alarm. For - acknowleding an alarm the value of ackState is ACKNOWLEDGED, for unacknowleding - an alarm the value of ackState is UNACKNOWLEDGED. - type: object - required: - - ackUserId - - ackState - properties: - ackUserId: - type: string - ackSystemId: - type: string - ackState: - $ref: '#/components/schemas/AckState' - MergePatchClearAlarm: - description: Patch document for clearing a single alarm - type: object - required: - - clearUserId - - perceivedSeverity - properties: - clearUserId: - type: string - clearSystemId: - type: string - perceivedSeverity: - type: string - enum: - - CLEARED - - #---- Definition of method responses -----------------------------------------------# - - FailedAlarm: - type: object - required: - - alarmId - - failureReason - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - failureReason: - type: string - - #---- Definition of resources ------------------------------------------------------# - - AlarmCount: - type: object - required: - - criticalCount - - majorCount - - minorCount - - warningCount - - indeterminateCount - - clearedCount - properties: - criticalCount: - type: integer - majorCount: - type: integer - minorCount: - type: integer - warningCount: - type: integer - indeterminateCount: - type: integer - clearedCount: - type: integer - Comment: - type: object - properties: - commentTime: - $ref: '#/components/schemas/DateTime' - commentUserId: - type: string - commentSystemId: - type: string - commentText: - type: string - Comments: - description: >- - Collection of comments. The comment identifiers are allocated by the - MnS producer and used as key in the map. - type: object - additionalProperties: - $ref: '#/components/schemas/Comment' - Subscription: - type: object - properties: - consumerReference: - $ref: '#/components/schemas/Uri' - timeTick: - $ref: '#/components/schemas/Long' - filter: - $ref: '#/components/schemas/Filter' diff --git a/OpenAPI/genericNrm.yaml b/OpenAPI/genericNrm.yaml deleted file mode 100644 index 0911920a2..000000000 --- a/OpenAPI/genericNrm.yaml +++ /dev/null @@ -1,1606 +0,0 @@ -openapi: 3.0.1 -info: - title: Generic NRM - version: 16.4.0 - description: >- - OAS 3.0.1 specification of the Generic NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.623 V16.4.0; Generic NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ -paths: {} -components: - schemas: - -#-------- Definition of types----------------------------------------------------- - - DateTime: - type: string - format: date-time - Dn: - type: string - maxLength: 400 - DnList: - type: array - items: - $ref: '#/components/schemas/Dn' - Mcc: - type: string - pattern: '^[0-9]{3}$' - Mnc: - type: string - pattern: '^[0-9]{2,3}$' - AdministrativeState: - type: string - enum: - - LOCKED - - UNLOCKED - OperationalState: - type: string - enum: - - ENABLED - - DISABLED - UsageState: - type: string - enum: - - IDEL - - ACTIVE - - BUSY - RegistrationState: - type: string - enum: - - REGISTERED - - DEREGISTERED - SetOfMcc: - type: array - items: - $ref: '#/components/schemas/Mcc' - ManagedElementType: - type: string - ManagedElementTypeList: - type: array - items: - $ref: '#/components/schemas/ManagedElementType' - VnfParameter: - type: object - properties: - vnfInstanceId: - type: string - vnfdId: - type: string - flavourId: - type: string - autoScalable: - type: boolean - VnfParametersList: - type: array - items: - $ref: '#/components/schemas/VnfParameter' - SiteLatitude: - type: number - format: float - minimum: -90 - maximum: 90 - SiteLongitude: - type: number - format: float - minimum: -180 - maximum: 180 - PeeParameter: - type: object - properties: - siteIdentification: - type: string - siteDescription: - type: string - siteLatitude: - $ref: '#/components/schemas/SiteLatitude' - siteLongitude: - $ref: '#/components/schemas/SiteLongitude' - equipmentType: - type: string - environmentType: - type: string - powerInterface: - type: string - PeeParametersList: - type: array - items: - $ref: '#/components/schemas/PeeParameter' - MonitoringGPList: - type: array - items: - type: integer - ThresholdInfoList: - type: array - items: - $ref: '#/components/schemas/ThresholdInfo' - ThresholdInfo: - type: object - properties: - measurementType: - type: string - direction: - $ref: '#/components/schemas/Direction' - thresholdPack: - $ref: '#/components/schemas/ThresholdPack' - Direction: - enum: - - Increasing - - Decreasing - ThresholdPack: - type: array - items: - $ref: '#/components/schemas/ThresholdPackElement' - ThresholdPackElement: - type: object - properties: - thresholdLevel: - type: integer - thresholdValue: - type: number - hysteresis: - type: number - Operation: - type: object - properties: - name: - type: string - allowedNFTypes: - $ref: '#/components/schemas/NFType' - operationSemantics: - $ref: '#/components/schemas/OperationSemantics' - OperationList: - type: array - items: - $ref: '#/components/schemas/Operation' - NFType: - type: string - description: ' NF name defined in TS 23.501' - enum: - - NRF - - UDM - - AMF - - SMF - - AUSF - - NEF - - PCF - - SMSF - - NSSF - - UDR - - LMF - - GMLC - - 5G_EIR - - SEPP - - UPF - - N3IWF - - AF - - UDSF - - DN - Fqdn: - type: string - OperationSemantics: - type: string - enum: - - REQUEST_RESPONSE - - SUBSCRIBE_NOTIFY - SAP: - type: object - properties: - host: - $ref: '#/components/schemas/HostAddr' - port: - type: integer - NFServiceType: - type: string - enum: - - Namf_Communication - - Namf_EventExposure - - Namf_MT - - Namf_Location - - Nsmf_PDUSession - - Nsmf_EventExposure - - Others - HostAddr: - oneOf: - - $ref: '#/components/schemas/Ipv4Addr' - - $ref: '#/components/schemas/Ipv6Addr' - - $ref: '#/components/schemas/Fqdn' - Ipv4Addr: - type: string - pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$' - example: '198.51.100.1' - Ipv4AddrRm: - type: string - pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$' - example: '198.51.100.1' - nullable: true - Ipv6Addr: - type: string - allOf: - - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$' - - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' - example: '2001:db8:85a3::8a2e:370:7334' - Ipv6AddrRm: - type: string - allOf: - - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$' - - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' - example: '2001:db8:85a3::8a2e:370:7334' - nullable: true - Ipv6Prefix: - type: string - allOf: - - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$' - - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$' - example: '2001:db8:abcd:12::0/64' - Uri: - type: string - TransportProtocol: - anyOf: - - type: string - enum: - - TCP - - type: string - SupportedPerfMetricGroup: - type: object - properties: - performanceMetrics: - type: array - items: - type: string - granularityPeriods: - type: array - items: - type: integer - minimum: 1 - reportingMethods: - type: array - items: - type: string - enum: - - FILE_BASED_LOC_SET_BY_PRODUCER - - FILE_BASED_LOC_SET_BY_CONSUMER - - STREAM_BASED - ReportingCtrl: - oneOf: - - type: object - properties: - fileReportingPeriod: - type: integer - - type: object - properties: - fileReportingPeriod: - type: integer - fileLocation: - $ref: '#/components/schemas/Uri' - - type: object - properties: - streamTarget: - $ref: '#/components/schemas/Uri' - Scope: - type: object - properties: - scopeType: - type: string - enum: - - BASE_ONLY - - BASE_ALL - - BASE_NTH_LEVEL - - BASE_SUBTREE - scopeLevel: - type: integer - NotificationType: - type: string - enum: - - notifyMOICreation - - notifyMOIDeletion - - notifyMOIAttributeValueChanges - - notifyEvent - - notifyNewAlarm - - notifyChangedAlarm - - notifyAckStateChanged - - notifyComments - - notifyCorrelatedNotificationChanged - - notifyChangedAlarmGeneral - - notifyAlarmListRebuilt - - notifyPotentialFaultyAlarmList - - notifyFileReady - - notifyFilePreparationError - - notifyThresholdCrossing - NotificationTypes: - type: array - items: - $ref: '#/components/schemas/NotificationType' - -#-------- Definition of types used in Trace control NRM fragment------------------ - - tjJobType-Type: - type: string - description: Specifies whether the TraceJob represents only MDT, Logged MBSFN MDT, Trace or a combined Trace and MDT job. Applicable for Trace, MDT, RCEF and RLF reporting. See 3GPP TS 32.422 clause 5.9a for additional details. - enum: - - IMMEDIATE_MDT_ONLY - - LOGGED_MDT_ONLY - - TRACE_ONLY - - IMMEDIATE_MDT AND TRACE - - RLF_REPORT_ONLY - - RCEF_REPORT_ONLY - - LOGGED_MBSFN_MDT - - tjListOfInterfaces-Type: - description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details. - type: object - properties: - MSCServerInterfaces: - type: array - items: - type: string - enum: - - A - - Iu-CS - - Mc - - MAP-G - - MAP-B - - MAP-E - - MAP-F - - MAP-D - - MAP-C - - CAP - MGWInterfaces: - type: array - items: - type: string - enum: - - Mc - - Nb-UP - - Iu-UP - RNCInterfaces: - type: array - items: - type: string - enum: - - Iu-CS - - Iu-PS - - Iur - - Iub - - Uu - SGSNInterfaces: - type: array - items: - type: string - enum: - - Gb - - Iu-PS - - Gn - - MAP-Gr - - MAP-Gd - - MAP-Gf - - Ge - - Gs - - S6d - - S4 - - S3 - - S13 - GGSNInterfaces: - type: array - items: - type: string - enum: - - Gn - - Gi - - Gmb - S-CSCFInterfaces: - type: array - items: - type: string - enum: - - Mw - - Mg - - Mr - - Mi - P-CSCFInterfaces: - type: array - items: - type: string - enum: - - Gm - - Mw - I-CSCFInterfaces: - type: array - items: - type: string - enum: - - Cx - - Dx - - Mg - - Mw - MRFCInterfaces: - type: array - items: - type: string - enum: - - Mp - - Mr - MGCFInterfaces: - type: array - items: - type: string - enum: - - Mg - - Mj - - Mn - IBCFInterfaces: - type: array - items: - type: string - enum: - - Ix - - Mx - E-CSCFInterfaces: - type: array - items: - type: string - enum: - - Mw - - Ml - - Mm - - Mi/Mg - BGCFInterfaces: - type: array - items: - type: string - enum: - - Mi - - Mj - - Mk - ASInterfaces: - type: array - items: - type: string - enum: - - Dh - - Sh - - ISC - - Ut - HSSInterfaces: - type: array - items: - type: string - enum: - - MAP-C - - MAP-D - - Gc - - Gr - - Cx - - S6d - - S6a - - Sh - EIRInterfaces: - type: array - items: - type: string - enum: - - MAP-F - - S13 - - MAP-Gf - BM-SCInterfaces: - type: array - items: - type: string - enum: - - Gmb - MMEInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - S3 - - S6a - - S10 - - S11 - - S13 - SGWInterfaces: - type: array - items: - type: string - enum: - - S4 - - S5 - - S8 - - S11 - - Gxc - PDN_GWInterfaces: - type: array - items: - type: string - enum: - - S2a - - S2b - - S2c - - S5 - - S6b - - Gx - - S8 - - SGi - eNBInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - X2 - en-gNBInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - X2 - - Uu - - F1-C - - E1 - AMFInterfaces: - type: array - items: - type: string - enum: - - N1 - - N2 - - N8 - - N11 - - N12 - - N14 - - N15 - - N20 - - N22 - - N26 - AUSFInterfaces: - type: array - items: - type: string - enum: - - N12 - - N13 - NEFInterfaces: - type: array - items: - type: string - enum: - - N29 - - N30 - - N33 - NRFInterfaces: - type: array - items: - type: string - enum: - - N27 - NSSFInterfaces: - type: array - items: - type: string - enum: - - N22 - - N31 - PCFInterfaces: - type: array - items: - type: string - enum: - - N5 - - N7 - - N15 - SMFInterfaces: - type: array - items: - type: string - enum: - - N4 - - N7 - - N10 - - N11 - - S5-C - SMSFInterfaces: - type: array - items: - type: string - enum: - - N20 - - N21 - UDMInterfaces: - type: array - items: - type: string - enum: - - N8 - - N10 - - N13 - - N21 - UPFInterfaces: - type: array - items: - type: string - enum: - - N4 - ng-eNBInterfaces: - type: array - items: - type: string - enum: - - NG-C - - Xn-C - - Uu - gNB-CU-CPInterfaces: - type: array - items: - type: string - enum: - - NG-C - - Xn-C - - Uu - - F1-C - - E1 - - X2-C - gNB-CU-UPInterfaces: - type: array - items: - type: string - enum: - - E1 - gNB-DUInterfaces: - type: array - items: - type: string - enum: - - F1-C - - tjListOfNeTypes-Type: - description: The Network Element types where Trace Session activation is needed. See 3GPP TS 32.422 clause 5.4 for additional details. - type: array - items: - type: string - enum: - - MSC_SERVER - - SGSN - - MGW - - GGSN - - RNC - - BM_SC - - MME - - SGW - - PGW - - ENB - - EN_GNB - - GNB_CU_CP - - GNB_CU_UP - - GNB_DU - - tjPLMNTaget-Type: - type: object - description: The PLMN for which sessions shall be selected in the Trace Session in case of management based activation when several PLMNs are supported in the RAN (this means that shared cells and not shared cells are allowed for the specified PLMN. Note that the PLMN Target might differ from the PLMN specified in the Trace Reference, as that specifies the PLMN that is containing the management system requesting the Trace Session from the NE. See 3GPP TS 32.422 clause 5.9b for additional details. - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - required: - - mcc - - mnc - - tjStreamingTraceConsumerURI-Type: - type: string - description: The URI of the Trace Reporting MnS consumer (see 3GPP TS 28.532) to which the Trace records shall be sent. See 3GPP TS 32.422 clause 5.9 for additional details. - format: uri - - tjTraceCollectionEntityAddress-Type: - description: The IP address to which the Trace records shall be transferred. See 3GPP TS 32.422 clause 5.9 for additional details. - oneOf: - - $ref: '#/components/schemas/Ipv4Addr' - - $ref: '#/components/schemas/Ipv6Addr' - - tjTraceDepth-Type: - description: Specifies how detailed information should be recorded in the Network Element. The Trace Depth is a paremeter for Trace Session level, i.e., the Trace Depth is the same for all of the NEs to be traced in the same Trace Session. See 3GPP TS 32.422 clause 5.3 for additional details. - type: string - enum: - - MINIMUM - - MEDIUM - - MAXIMUM - - VENDORMINIMUM - - VENDORMEDIUM - - VENDORMAXIMUM - - tjTraceReference-Type: - type: object - description: The Trace Reference parameter shall be globally unique, therefore the Trace Reference shall compose as follows - MCC+MNC+Trace ID, where the MCC and MNC are coming with the Trace activation request from the management system to identify one PLMN containing the management system, and Trace ID is a 3 byte Octet String. See 3GPP TS 32.422 clause 5.6 for additional details. - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - traceId: - type: integer - required: - - mcc - - mnc - - traceId - - tjTraceReportingFormat-Type: - type: string - description: Specifies whether file-based or streaming reporting shall be used for this Trace Session. See 3GPP TS 32.422 clause 5.11 for additional details. - enum: - - FILE-BASED - - STREAMING - - tjTraceTarget-Type: - type: string - description: Type of trace target. For additional details see 3GPP TS 32.422. - enum: - - IMSI - - IMEI - - IMEISV - - PUBLIC_ID - - UTRAN_CELL - - E-UTRAN_CELL - - NG-RAN_CELL - - eNB - - RNC - - gNB - - tjTriggeringEvent-Type: - type: object - description: Specifies when to start a Trace Recording Session and which message shall be recorded first, when to stop a Trace Recording Session and which message shall be recorded last respectively. See 3GPP TS 32.422 clause 5.1 for additional detials. - properties: - NetworkElement: - type: string - enum: - - MSC_SERVER - - SGSN - - MGW - - GGSN - - BM_SC - - MME - - SGW - - PGW - - AMF - - SMF - - PCF - - UPF - EventBitmap: - type: integer - required: - - NetworkElement - - EventBitmap - - tjMDTAnonymizationOfData-Type: - description: Specifies level of MDT anonymization. For additional details see 3GPP TS 32.422 clause 5.10.12. - type: string - enum: - - NO_IDENTITY - - TAC_OF_IMEI - - tjMDTAreaConfigurationForNeighCell-Type: - description: Used for logged NR MDT and defines the area for which UE is requested to perform measurement logging for neighbour cells which have list of frequencies. For additional details see 3GPP TS 32.422 clause 5.10.26. - type: array - items: - type: object - properties: - frequency: - type: string - cell: - type: string - - tjMDTAreaScope-Type: - description: defines the area in terms or Cells or Tracking Area/Routing Area/Location Area where the MDT data collection shall take place. For additional details see 3GPP TS 32.422 clause 5.10.2. - allOf: - - $ref: '#/components/schemas/DnList' - - tjMDTCollectionPeriodRrmLte-Type: - description: See details in 3GPP TS 32.422 clause 5.10.20. - type: string - enum: - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - - tjMDTCollectionPeriodRrmUmts-Type: - description: See details in 3GPP TS 32.422 clause 5.10.21. - type: string - enum: - - 1024ms - - 1280ms - - 2048ms - - 2560ms - - 5120ms - - 10240ms - - 1min - - tjMDTEventListForTriggeredMeasurement-Type: - description: See details in 3GPP TS 32.422 clause 5.10.28. - type: string - enum: - - OUT_OF_COVERAGE - - A2_EVENT - - tjMDTEventThreshold-Type: - description: See details in 3GPP TS 32.422 clause 5.10.7, 5.10.7a, 5.10.13 and 5.10.14. - type: object - properties: - EventThresholdRSRP: - type: integer - minimum: 0 - maximum: 97 - EventThresholdRSRQ: - type: integer - minimum: 0 - maximum: 34 - EventThreshold1F: - type: object - properties: - CPICH_RSCP: - type: integer - minimum: -120 - maximum: 25 - CPICH_EcNo: - type: integer - minimum: -24 - maximum: 0 - PathLoss: - type: integer - minimum: 30 - maximum: 165 - EventThreshold1I: - type: integer - minimum: -120 - maximum: 25 - - tjMDTListOfMeasurements-Type: - description: See details in 3GPP TS 32.422 clause 5.10.3 for details. - type: object - properties: - UMTS: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M6_DL - - M6_UL - - M7_DL - - M7_UL - LTE: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M1_EVENT_TRIGGERED - - M6 - - M7 - - M8 - - M9 - NR: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M6 - - M7 - - M8 - - M9 - - tjMDTLoggingDuration-Type: - description: See details in 3GPP TS 32.422 clause 5.10.9. - type: string - enum: - - 600s - - 1200s - - 2400s - - 3600s - - 5400s - - 7200s - - tjMDTLoggingInterval-Type: - description: See details in 3GPP TS 32.422 clause 5.10.8. - type: string - enum: - - 1.28s - - 2.56s - - 5.12s - - 10.24s - - 20.48s - - 30.72s - - 40.96s - - 61.44s - - tjMDTMBSFNAreaList-Type: - description: See details in 3GPP TS 32.422 clause 5.10.25. - type: array - items: - type: object - properties: - mbsfnAreaId: - type: integer - minimum: 1 - earfcn: - type: integer - minimum: 1 - required: - - mbsfnAreaId - - earfcn - - tjMDTMeasurementPeriodLTE-Type: - description: See details in 3GPP TS 32.422 clause 5.10.23. - type: string - enum: - - 1024ms - - 1280ms - - 2048ms - - 2560ms - - 5120ms - - 10240ms - - 1min - - tjMDTMeasurementPeriodUMTS-Type: - description: See details in 3GPP TS 32.422 clause 5.10.22. - type: string - enum: - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - - tjMDTMeasurementQuantity-Type: - description: See details in 3GPP TS 32.422 clause 5.10.15. - type: string - enum: - - CPICH_EcNo - - CPICH_RSCP - - PathLoss - - tjMDTPLMList-Type: - description: See details in 3GPP TS 32.422 clause 5.10.24. - type: array - items: - type: object - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - required: - - mcc - - mnc - maxItems: 16 - - tjMDTPositioningMethod-Type: - description: See details in 3GPP TS 32.422 clause 5.10.19. - type: string - enum: - - GNSS - - E-CELL_ID - - tjMDTReportAmount-Type: - description: See details in 3GPP TS 32.422 clause 5.10.6. - type: string - enum: - - 1 - - 2 - - 4 - - 8 - - 16 - - 32 - - 64 - - INFINITY - - tjMDTReportingTrigger-Type: - description: See details in 3GPP TS 32.422 clause 5.10.4. - type: array - items: - type: string - enum: - - PERIODICAL - - A2_FOR_LTE - - 1F_FOR_UMTS - - 1I_FOR_UMTS_MCPS_TDD - - A2_TRIGGERED_PERIODIC_FOR_LTE - - ALL_CONFIGURED_RRM_FOR_LTE - - ALL_CONFIGURED_RRM_FOR_UMTS - - tjMDTReportInterval-Type: - description: See details in 3GPP TS 32.422 clause 5.10.5. - type: string - enum: - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - - 120ms - - 240ms - - 480ms - - 640ms - - 1024ms - - 2048ms - - 5120ms - - 10240ms - - 60000ms - - 360000ms - - 720000ms - - 1800000ms - - 3600000ms - - tjMDTReportType-Type: - description: Report type for logged NR MDT. See details in 3GPP TS 32.422 clause 5.10.27. - type: string - enum: - - PERIODICAL - - EVENT_TRIGGERED - - tjMDTSensorInformation-Type: - description: See details in 3GPP TS 32.422 clause 5.10.29. - type: array - items: - type: string - enum: - - BAROMETRIC_PRESSURE - - UE_SPEED - - UE_ORIENTATION - - tjMDTTraceCollectionEntityID-Type: - description: See details in 3GPP TS 32.422 clause 5.10.11. Only tceID value may be sent over the air to the UE being configured for Logged MDT. - type: object - properties: - tceID: - type: integer - tcePLMN: - type: object - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - required: - - mcc - - mnc - tceAddress: - oneOf: - - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' - - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' - required: - - tceID - - tcePLMN - - tceAddress - - -#-------- end of Definition of types used in Trace control NRM fragment ---------- - - -#-------- Definition of abstract IOC Top ----------------------------------------- - - Top-Attr: - # This definition will be deprecated, when all occurances of Top-Attr - # are replaced by Top. - type: object - properties: - id: - type: string - VsDataContainer: - $ref: '#/components/schemas/VsDataContainer-Multiple' - Top: - type: object - properties: - id: - type: string - VsDataContainer: - $ref: '#/components/schemas/VsDataContainer-Multiple' - -#-------- Definition of IOCs with new name-containments defined in other TS ------ - - SubNetwork-Attr: - type: object - properties: - dnPrefix: - type: string - userLabel: - type: string - userDefinedNetworkType: - type: string - setOfMcc: - $ref: '#/components/schemas/SetOfMcc' - priorityLabel: - type: integer - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - ManagedElement-Attr: - type: object - properties: - dnPrefix: - type: string - managedElementTypeList: - $ref: '#/components/schemas/ManagedElementTypeList' - userLabel: - type: string - locationName: - type: string - managedBy: - $ref: '#/components/schemas/DnList' - vendorName: - type: string - userDefinedState: - type: string - swVersion: - type: string - priorityLabel: - type: integer - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - - SubNetwork-ncO: - type: object - properties: - ManagementNode: - $ref: '#/components/schemas/ManagementNode-Multiple' - MeContext: - $ref: '#/components/schemas/MeContext-Multiple' - PerfMetricJob: - $ref: '#/components/schemas/PerfMetricJob-Multiple' - ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' - ThresholdMonitoringCapability: - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - NtfSubscriptionControl: - $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' - TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' - AlarmList: - $ref: '#/components/schemas/AlarmList-Single' - MnsRegistry: - type: array - items: - $ref: '#/components/schemas/MnsRegistry' - ManagedElement-ncO: - type: object - properties: - PerfMetricJob: - $ref: '#/components/schemas/PerfMetricJob-Multiple' - ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' - ThresholdMonitoringCapability: - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - NtfSubscriptionControl: - $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' - TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' - AlarmList: - $ref: '#/components/schemas/AlarmList-Single' - -#-------- Definition of abstract IOCs -------------------------------------------- - - ManagedFunction-Attr: - type: object - properties: - userLabel: - type: string - vnfParametersList: - $ref: '#/components/schemas/VnfParametersList' - peeParametersList: - $ref: '#/components/schemas/PeeParametersList' - priorityLabel: - type: integer - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - EP_RP-Attr: - type: object - properties: - userLabel: - type: string - farEndEntity: - type: string - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - - TraceJob-Attr: - type: object - description: abstract class used as a container of all TraceJob attributes - properties: - tjJobType: - $ref: '#/components/schemas/tjJobType-Type' - tjListOfInterfaces: - $ref: '#/components/schemas/tjListOfInterfaces-Type' - tjListOfNeTypes: - $ref: '#/components/schemas/tjListOfNeTypes-Type' - tjPLMNTarget: - $ref: '#/components/schemas/tjPLMNTaget-Type' - tjTraceConsumer: - oneOf: - - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' - - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' - tjTraceDepth: - $ref: '#/components/schemas/tjTraceDepth-Type' - tjTraceReference: - $ref: '#/components/schemas/tjTraceReference-Type' - tjTraceReportingFormat: - $ref: '#/components/schemas/tjTraceReportingFormat-Type' - tjTraceTarget: - $ref: '#/components/schemas/tjTraceTarget-Type' - tjTriggeringEvent: - $ref: '#/components/schemas/tjTriggeringEvent-Type' - tjMDTAnonymizationOfData: - $ref: '#/components/schemas/tjMDTAnonymizationOfData-Type' - tjMDTAreaConfigurationForNeighCell: - $ref: '#/components/schemas/tjMDTAreaConfigurationForNeighCell-Type' - tjMDTAreaScope: - $ref: '#/components/schemas/tjMDTAreaScope-Type' - tjMDTCollectionPeriodRrmLte: - $ref: '#/components/schemas/tjMDTCollectionPeriodRrmLte-Type' - tjMDTCollectionPeriodRrmUmts: - $ref: '#/components/schemas/tjMDTCollectionPeriodRrmUmts-Type' - tjMDTEventListForTriggeredMeasurement: - $ref: '#/components/schemas/tjMDTEventListForTriggeredMeasurement-Type' - tjMDTEventThreshold: - $ref: '#/components/schemas/tjMDTEventThreshold-Type' - tjMDTListOfMeasurements: - $ref: '#/components/schemas/tjMDTListOfMeasurements-Type' - tjMDTLoggingDuration: - $ref: '#/components/schemas/tjMDTLoggingDuration-Type' - tjMDTLoggingInterval: - $ref: '#/components/schemas/tjMDTLoggingInterval-Type' - tjMDTMBSFNAreaList: - $ref: '#/components/schemas/tjMDTMBSFNAreaList-Type' - tjMDTMeasurementPeriodLTE: - $ref: '#/components/schemas/tjMDTMeasurementPeriodLTE-Type' - tjMDTMeasurementPeriodUMTS: - $ref: '#/components/schemas/tjMDTMeasurementPeriodUMTS-Type' - tjMDTMeasurementQuantity: - $ref: '#/components/schemas/tjMDTMeasurementQuantity-Type' - tjMDTPLMList: - $ref: '#/components/schemas/tjMDTPLMList-Type' - tjMDTPositioningMethod: - $ref: '#/components/schemas/tjMDTPositioningMethod-Type' - tjMDTReportAmount: - $ref: '#/components/schemas/tjMDTReportAmount-Type' - tjMDTReportingTrigger: - $ref: '#/components/schemas/tjMDTReportingTrigger-Type' - tjMDTReportInterval: - $ref: '#/components/schemas/tjMDTReportInterval-Type' - tjMDTReportType: - $ref: '#/components/schemas/tjMDTReportType-Type' - tjMDTSensorInformation: - $ref: '#/components/schemas/tjMDTSensorInformation-Type' - tjMDTTraceCollectionEntityID: - $ref: '#/components/schemas/tjMDTTraceCollectionEntityID-Type' - required: - - tjJobType - - tjTraceReference - - tjTraceConsumer - - tjTraceReportingFormat - - tjTraceTarget - - ManagedFunction-ncO: - type: object - properties: - PerfMetricJob: - $ref: '#/components/schemas/PerfMetricJob-Multiple' - ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' - ThresholdMonitoringCapability: - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - ManagedNFService: - $ref: '#/components/schemas/ManagedNFService-Multiple' - TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' - - MnsRegistry: - type: object - properties: - mnsLabel: - type: string - mnsType: - type: string - mnsVersion: - type: string - mnsAddress: - type: string - -#-------- Definition of concrete IOCs -------------------------------------------- - - VsDataContainer-Single: - type: object - properties: - id: - type: string - attributes: - type: object - properties: - vsDataType: - type: string - vsDataFormatVersion: - type: string - vsData: - nullable: true - VsDataContainer: - $ref: '#/components/schemas/VsDataContainer-Multiple' - ManagedNFService-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - userLabel: - type: string - nFServiceType: - $ref: '#/components/schemas/NFServiceType' - sAP: - $ref: '#/components/schemas/SAP' - operations: - $ref: '#/components/schemas/OperationList' - administrativeState: - $ref: '#/components/schemas/AdministrativeState' - operationalState: - $ref: '#/components/schemas/OperationalState' - usageState: - $ref: '#/components/schemas/UsageState' - registrationState: - $ref: '#/components/schemas/RegistrationState' - ManagementNode-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - userLabel: - type: string - managedElements: - $ref: '#/components/schemas/DnList' - vendorName: - type: string - userDefinedState: - type: string - locationName: - type: string - swVersion: - type: string - MeContext-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - dnPrefix: - type: string - PerfMetricJob-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - administrativeState: - $ref: '#/components/schemas/AdministrativeState' - operationalState: - $ref: '#/components/schemas/OperationalState' - perfMetricJobGroupId: - type: string - performanceMetrics: - type: array - items: - type: string - granularityPeriod: - type: integer - minimum: 1 - objectInstances: - $ref: '#/components/schemas/DnList' - rootObjectInstances: - $ref: '#/components/schemas/DnList' - reportingCtrl: - $ref: '#/components/schemas/ReportingCtrl' - ThresholdMonitoringCapability-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - supportedMonitoringGPs: - $ref: '#/components/schemas/MonitoringGPList' - ThresholdMonitor-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - thresholdInfoList: - $ref: '#/components/schemas/ThresholdInfoList' - monitoringGP: - type: integer - monitoringNotifTarget: - type: string - monitoredIOCName: - type: string - monitoredObjectDNs: - $ref: '#/components/schemas/DnList' - NtfSubscriptionControl-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - notificationRecipientAddress: - $ref: '#/components/schemas/Uri' - notificationTypes: - $ref: '#/components/schemas/NotificationTypes' - scope: - $ref: '#/components/schemas/Scope' - notificationFilter: - type: string - HeartbeatControl: - $ref: '#/components/schemas/HeartbeatControl-Single' - HeartbeatControl-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - heartbeatNtfPeriod: - type: integer - triggerHeartbeatNtf: - type: boolean - TraceJob-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - $ref: '#/components/schemas/TraceJob-Attr' - - AlarmList-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - administrativeState: - $ref: '#/components/schemas/AdministrativeState' - operationalState: - $ref: '#/components/schemas/OperationalState' - numOfAlarmRecords: - type: integer - lastModification: - $ref: '#/components/schemas/DateTime' - alarmRecords: - description: >- - This resource represents a map of alarm records. - The alarmIds are used as keys in the map. - type: object - additionalProperties: - $ref: 'faultMnS.yaml#/components/schemas/AlarmRecord' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - VsDataContainer-Multiple: - type: array - items: - $ref: '#/components/schemas/VsDataContainer-Single' - ManagedNFService-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedNFService-Single' - ManagementNode-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagementNode-Single' - MeContext-Multiple: - type: array - items: - $ref: '#/components/schemas/MeContext-Single' - PerfMetricJob-Multiple: - type: array - items: - $ref: '#/components/schemas/PerfMetricJob-Single' - ThresholdMonitor-Multiple: - type: array - items: - $ref: '#/components/schemas/ThresholdMonitor-Single' - NtfSubscriptionControl-Multiple: - type: array - items: - $ref: '#/components/schemas/NtfSubscriptionControl-Single' - TraceJob-Multiple: - type: array - items: - $ref: '#/components/schemas/TraceJob-Single' - -#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- - - resources-genericNrm: - oneOf: - - - $ref: '#/components/schemas/VsDataContainer-Single' - - - $ref: '#/components/schemas/ManagementNode-Single' - - $ref: '#/components/schemas/MeContext-Single' - - - $ref: '#/components/schemas/ManagedNFService-Single' - - - $ref: '#/components/schemas/PerfMetricJob-Single' - - - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - - $ref: '#/components/schemas/ThresholdMonitor-Single' - - - $ref: '#/components/schemas/NtfSubscriptionControl-Single' - - $ref: '#/components/schemas/HeartbeatControl-Single' - - $ref: '#/components/schemas/TraceJob-Single' - - - $ref: '#/components/schemas/AlarmList-Single' diff --git a/OpenAPI/heartbeatNtf.yaml b/OpenAPI/heartbeatNtf.yaml deleted file mode 100644 index afde5066d..000000000 --- a/OpenAPI/heartbeatNtf.yaml +++ /dev/null @@ -1,23 +0,0 @@ -openapi: 3.0.1 -info: - title: Heartbeat notification - version: 16.3.0 - description: >- - OAS 3.0.1 specification of the heartbeat notification - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.532 V16.3.0; Heartbeat notification - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.6532/ -paths: {} -components: - schemas: - hearbeatNtfPeriod-Type: - type: integer - notifyHeartbeat-NotifType: - allOf: - - $ref: 'provMnS.yaml#/components/schemas/header-Type' - - type: object - properties: - heartbeatNtfPeriod: - $ref: '#/components/schemas/hearbeatNtfPeriod-Type' diff --git a/OpenAPI/nrNrm.yaml b/OpenAPI/nrNrm.yaml deleted file mode 100644 index 850106631..000000000 --- a/OpenAPI/nrNrm.yaml +++ /dev/null @@ -1,1905 +0,0 @@ -openapi: 3.0.1 -info: - title: NR NRM - version: 17.4.0 - description: >- - OAS 3.0.1 specification of the NR NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.541; 5G NRM, NR NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ -paths: {} -components: - schemas: - -#-------- Definition of types----------------------------------------------------- - - GnbId: - type: string - GnbIdLength: - type: integer - minimum: 22 - maximum: 32 - GnbName: - type: string - maxLength: 150 - GnbDuId: - type: number - minimum: 0 - maximum: 68719476735 - GnbCuUpId: - type: number - minimum: 0 - maximum: 68719476735 - - Sst: - type: integer - maximum: 255 - Snssai: - type: object - properties: - sst: - $ref: '#/components/schemas/Sst' - sd: - type: string - SnssaiList: - type: array - items: - $ref: '#/components/schemas/Snssai' - - Mnc: - type: string - pattern: '[0-9]{3}|[0-9]{2}' - PlmnId: - type: object - properties: - mcc: - $ref: 'genericNrm.yaml#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - PlmnIdList: - type: array - items: - $ref: '#/components/schemas/PlmnId' - PlmnInfo: - type: object - properties: - plmnId": - $ref: '#/components/schemas/PlmnId' - snssai: - $ref: '#/components/schemas/Snssai' - PlmnInfoList: - type: array - items: - $ref: '#/components/schemas/PlmnInfo' - cagId: - type: string - nid: - type: string - NpnIdentity: - type: object - properties: - plmnId": - $ref: '#/components/schemas/PlmnId' - cagidList: - $ref: '#/components/schemas/cagId' - nidList: - $ref: '#/components/schemas/nid' - NpnIdentityList: - type: array - items: - $ref: '#/components/schemas/NpnIdentity' - GGnbId: - type: string - pattern: '^[0-9]{3}[0-9]{2,3}-(22|23|24|25|26|27|28|29|30|31|32)-[0-9]{1,10}' - GEnbId: - type: string - pattern: '^[0-9]{3}[0-9]{2,3}-(18|20|21|22)-[0-9]{1,7}' - - GGnbIdList: - type: array - items: - $ref: '#/components/schemas/GGnbId' - - GEnbIdList: - type: array - items: - $ref: '#/components/schemas/GEnbId' - - NrPci: - type: integer - maximum: 503 - NrTac: - type: integer - maximum: 16777215 - Tai: - type: object - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - nrTac: - $ref: '#/components/schemas/NrTac' - - BackhaulAddress: - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - tai: - $ref: "#/components/schemas/Tai" - MappingSetIDBackhaulAddress: - type: object - properties: - setID: - type: integer - backhaulAddress: - $ref: '#/components/schemas/BackhaulAddress' - IntraRatEsActivationOriginalCellLoadParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - IntraRatEsActivationCandidateCellsLoadParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - IntraRatEsDeactivationCandidateCellsLoadParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - EsNotAllowedTimePeriod: - type: object - properties: - startTimeandendTime: - type: string - periodOfDay: - type: string - daysOfWeekList: - type: string - listoftimeperiods: - type: string - InterRatEsActivationOriginalCellParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - InterRatEsActivationCandidateCellParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - InterRatEsDeactivationCandidateCellParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - - UeAccProbilityDist: - type: object - properties: - targetProbability: - type: integer - numberofpreamblessent: - type: integer - - UeAccDelayProbilityDist: - type: object - properties: - targetProbability: - type: integer - accessdelay: - type: integer - - NRPciList: - type: object - properties: - NRPci: - type: integer - - CSonPciList: - type: object - properties: - NRPci: - type: integer - - MaximumDeviationHoTrigger: - type: integer - minimum: -20 - maximum: 20 - - MinimumTimeBetweenHoTriggerChange: - type: integer - minimum: 0 - maximum: 604800 - - TstoreUEcntxt: - type: integer - minimum: 0 - maximum: 1023 - - CellState: - type: string - enum: - - IDLE - - INACTIVE - - ACTIVE - CyclicPrefix: - type: string - enum: - - '15' - - '30' - - '60' - - '120' - TxDirection: - type: string - enum: - - DL - - UL - - DL and UL - BwpContext: - type: string - enum: - - DL - - UL - - SUL - IsInitialBwp: - type: string - enum: - - INITIAL - - OTHER - - SUL - QuotaType: - type: string - enum: - - STRICT - - FLOAT - IsESCoveredBy: - type: string - enum: - - NO - - PARTIAL - - FULL - RrmPolicyMember: - type: object - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - snssai: - $ref: '#/components/schemas/Snssai' - RrmPolicyMemberList: - type: array - items: - $ref: '#/components/schemas/RrmPolicyMember' - AddressWithVlan: - type: object - properties: - ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' - vlanId: - type: integer - minimum: 0 - maximum: 4096 - LocalAddress: - type: object - properties: - addressWithVlan: - $ref: '#/components/schemas/AddressWithVlan' - port: - type: integer - minimum: 0 - maximum: 65535 - RemoteAddress: - type: object - properties: - ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' - - CellIndividualOffset: - type: object - properties: - rsrpOffsetSSB: - type: integer - rsrqOffsetSSB: - type: integer - sinrOffsetSSB: - type: integer - rsrpOffsetCSI-RS: - type: integer - rsrqOffsetCSI-RS: - type: integer - sinrOffsetCSI-RS: - type: integer - QOffsetRange: - type: integer - enum: - - -24 - - -22 - - -20 - - -18 - - -16 - - -14 - - -12 - - -10 - - -8 - - -6 - - -5 - - -4 - - -3 - - -2 - - -1 - - 0 - - 24 - - 22 - - 20 - - 18 - - 16 - - 14 - - 12 - - 10 - - 8 - - 6 - - 5 - - 4 - - 3 - - 2 - - 1 - QOffsetRangeList: - type: object - properties: - rsrpOffsetSSB: - $ref: '#/components/schemas/QOffsetRange' - rsrqOffsetSSB: - $ref: '#/components/schemas/QOffsetRange' - sinrOffsetSSB: - $ref: '#/components/schemas/QOffsetRange' - rsrpOffsetCSI-RS: - $ref: '#/components/schemas/QOffsetRange' - rsrqOffsetCSI-RS: - $ref: '#/components/schemas/QOffsetRange' - sinrOffsetCSI-RS: - $ref: '#/components/schemas/QOffsetRange' - QOffsetFreq: - type: number - TReselectionNRSf: - type: integer - enum: - - 25 - - 50 - - 75 - - 100 - SsbPeriodicity: - type: integer - enum: - - 5 - - 10 - - 20 - - 40 - - 80 - - 160 - SsbDuration: - type: integer - enum: - - 1 - - 2 - - 3 - - 4 - - 5 - SsbSubCarrierSpacing: - type: integer - enum: - - 15 - - 30 - - 120 - - 240 - CoverageShape: - type: integer - maximum: 65535 - DigitalTilt: - type: integer - minimum: -900 - maximum: 900 - DigitalAzimuth: - type: integer - minimum: -1800 - maximum: 1800 - - RSSetId: - type: integer - maximum: 4194303 - - RSSetType: - type: string - enum: - - RS1 - - RS2 - - FrequencyDomainPara: - type: object - properties: - rimRSSubcarrierSpacing: - type: integer - rIMRSBandwidth: - type: integer - nrofGlobalRIMRSFrequencyCandidates: - type: integer - rimRSCommonCarrierReferencePoint: - type: integer - rimRSStartingFrequencyOffsetIdList: - type: array - items: - type: integer - - SequenceDomainPara: - type: object - properties: - nrofRIMRSSequenceCandidatesofRS1: - type: integer - rimRSScrambleIdListofRS1: - type: array - items: - type: integer - nrofRIMRSSequenceCandidatesofRS2: - type: integer - rimRSScrambleIdListofRS2: - type: array - items: - type: integer - enableEnoughNotEnoughIndication: - type: string - enum: - - ENABLE - - DISABLE - RIMRSScrambleTimerMultiplier: - type: integer - RIMRSScrambleTimerOffset: - type: integer - - TimeDomainPara: - type: object - properties: - dlULSwitchingPeriod1: - type: string - enum: - - MS0P5 - - MS0P625 - - MS1 - - MS1P25 - - MS2 - - MS2P5 - - MS3 - - MS4 - - MS5 - - MS10 - - MS20 - symbolOffsetOfReferencePoint1: - type: integer - dlULSwitchingPeriod2: - type: string - enum: - - MS0P5 - - MS0P625 - - MS1 - - MS1P25 - - MS2 - - MS2P5 - - MS3 - - MS4 - - MS5 - - MS10 - - MS20 - symbolOffsetOfReferencePoint2: - type: integer - totalnrofSetIdofRS1: - type: integer - totalnrofSetIdofRS2: - type: integer - nrofConsecutiveRIMRS1: - type: integer - nrofConsecutiveRIMRS2: - type: integer - consecutiveRIMRS1List: - type: array - items: - type: integer - consecutiveRIMRS2List: - type: array - items: - type: integer - enablenearfarIndicationRS1: - type: string - enum: - - ENABLE - - DISABLE - enablenearfarIndicationRS2: - type: string - enum: - - ENABLE - - DISABLE - - RimRSReportInfo: - type: object - properties: - detectedSetID: - type: integer - propagationDelay: - type: integer - functionalityOfRIMRS: - type: string - enum: - - RS1 - - RS2 - - RS1forEnoughMitigation - - RS1forNotEnoughMitigation - - RimRSReportConf: - type: object - properties: - reportIndicator: - type: string - enum: - - ENABLE - - DISABLE - reportInterval: - type: integer - nrofRIMRSReportInfo: - type: integer - maxPropagationDelay: - type: integer - rimRSReportInfoList: - type: array - items: - $ref: '#/components/schemas/RimRSReportInfo' - TceMappingInfo: - type: object - properties: - TceIPAddress: - oneOf: - - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' - TceID: - type: integer - PlmnTarget: - $ref: '#/components/schemas/PlmnId' - TceMappingInfoList: - type: array - items: - $ref: '#/components/schemas/TceMappingInfo' - - -#-------- Definition of abstract IOCs -------------------------------------------- - - RrmPolicy_-Attr: - type: object - properties: - resourceType: - type: string - rRMPolicyMemberList: - $ref: '#/components/schemas/RrmPolicyMemberList' - - -#-------- Definition of concrete IOCs -------------------------------------------- - - SubNetwork-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - NRFrequency: - $ref: '#/components/schemas/NRFrequency-Multiple' - ExternalGnbCuCpFunction: - $ref: '#/components/schemas/ExternalGnbCuCpFunction-Multiple' - ExternalENBFunction: - $ref: '#/components/schemas/ExternalENBFunction-Multiple' - EUtranFrequency: - $ref: '#/components/schemas/EUtranFrequency-Multiple' - DESManagementFunction: - $ref: '#/components/schemas/DESManagementFunction-Single' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - DMROFunction: - $ref: '#/components/schemas/DMROFunction-Single' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - CPCIConfigurationFunction: - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - CESManagementFunction: - $ref: '#/components/schemas/CESManagementFunction-Single' - Configurable5QISet: - $ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' - RimRSGlobal: - $ref: '#/components/schemas/RimRSGlobal-Single' - Dynamic5QISet: - $ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' - - ManagedElement-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' - - type: object - properties: - GnbDuFunction: - $ref: '#/components/schemas/GnbDuFunction-Multiple' - GnbCuUpFunction: - $ref: '#/components/schemas/GnbCuUpFunction-Multiple' - GnbCuCpFunction: - $ref: '#/components/schemas/GnbCuCpFunction-Multiple' - DESManagementFunction: - $ref: '#/components/schemas/DESManagementFunction-Single' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - DMROFunction: - $ref: '#/components/schemas/DMROFunction-Single' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - CPCIConfigurationFunction: - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - CESManagementFunction: - $ref: '#/components/schemas/CESManagementFunction-Single' - Configurable5QISet: - $ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' - - GnbDuFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbDuId: - $ref: '#/components/schemas/GnbDuId' - gnbDuName: - $ref: '#/components/schemas/GnbName' - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - rimRSReportConf: - $ref: '#/components/schemas/RimRSReportConf' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - RRMPolicyRatio: - $ref: '#/components/schemas/RRMPolicyRatio-Multiple' - NrCellDu: - $ref: '#/components/schemas/NrCellDu-Multiple' - Bwp-Multiple: - $ref: '#/components/schemas/Bwp-Multiple' - NrSectorCarrier-Multiple: - $ref: '#/components/schemas/NrSectorCarrier-Multiple' - EP_F1C: - $ref: '#/components/schemas/EP_F1C-Single' - EP_F1U: - $ref: '#/components/schemas/EP_F1U-Multiple' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - GnbCuUpFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - gnbCuUpId: - $ref: '#/components/schemas/GnbCuUpId' - plmnInfoList: - $ref: '#/components/schemas/PlmnInfoList' - configurable5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - dynamic5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - RRMPolicyRatio: - $ref: '#/components/schemas/RRMPolicyRatio-Multiple' - EP_E1: - $ref: '#/components/schemas/EP_E1-Single' - EP_XnU: - $ref: '#/components/schemas/EP_XnU-Multiple' - EP_F1U: - $ref: '#/components/schemas/EP_F1U-Multiple' - EP_NgU: - $ref: '#/components/schemas/EP_NgU-Multiple' - EP_X2U: - $ref: '#/components/schemas/EP_X2U-Multiple' - EP_S1U: - $ref: '#/components/schemas/EP_S1U-Multiple' - GnbCuCpFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - gnbCuName: - $ref: '#/components/schemas/GnbName' - plmnId: - $ref: '#/components/schemas/PlmnId' - x2BlackList: - $ref: '#/components/schemas/GGnbIdList' - xnBlackList: - $ref: '#/components/schemas/GGnbIdList' - x2WhiteList: - $ref: '#/components/schemas/GGnbIdList' - xnWhiteList: - $ref: '#/components/schemas/GGnbIdList' - x2XnHOBlackList: - $ref: '#/components/schemas/GEnbIdList' - mappingSetIDBackhaulAddress: - $ref: '#/components/schemas/MappingSetIDBackhaulAddress' - tceMappingInfoList: - $ref: '#/components/schemas/TceMappingInfoList' - configurable5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - dynamic5QISetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - RRMPolicyRatio: - $ref: '#/components/schemas/RRMPolicyRatio-Multiple' - NrCellCu: - $ref: '#/components/schemas/NrCellCu-Multiple' - EP_XnC: - $ref: '#/components/schemas/EP_XnC-Multiple' - EP_E1: - $ref: '#/components/schemas/EP_E1-Multiple' - EP_F1C: - $ref: '#/components/schemas/EP_F1C-Multiple' - EP_NgC: - $ref: '#/components/schemas/EP_NgC-Multiple' - EP_X2C: - $ref: '#/components/schemas/EP_X2C-Multiple' - DANRManagementFunction: - $ref: '#/components/schemas/DANRManagementFunction-Single' - DESManagementFunction: - $ref: '#/components/schemas/DESManagementFunction-Single' - DMROFunction: - $ref: '#/components/schemas/DMROFunction-Single' - - NrCellCu-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - cellLocalId: - type: integer - plmnInfoList: - $ref: '#/components/schemas/PlmnInfoList' - nRFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - RRMPolicyRatio: - $ref: '#/components/schemas/RRMPolicyRatio-Multiple' - NRCellRelation: - $ref: '#/components/schemas/NRCellRelation-Multiple' - EUtranCellRelation: - $ref: '#/components/schemas/EUtranCellRelation-Multiple' - NRFreqRelation: - $ref: '#/components/schemas/NRFreqRelation-Multiple' - EUtranFreqRelation: - $ref: '#/components/schemas/EUtranFreqRelation-Multiple' - DESManagementFunction: - $ref: '#/components/schemas/DESManagementFunction-Single' - DMROFunction: - $ref: '#/components/schemas/DMROFunction-Single' - CESManagementFunction: - $ref: '#/components/schemas/CESManagementFunction-Single' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - - NrCellDu-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - operationalState: - $ref: 'genericNrm.yaml#/components/schemas/OperationalState' - cellLocalId: - type: integer - cellState: - $ref: '#/components/schemas/CellState' - plmnInfoList: - $ref: '#/components/schemas/PlmnInfoList' - npnIdentityList: - $ref: '#/components/schemas/NpnIdentityList' - nrPci: - $ref: '#/components/schemas/NrPci' - nrTac: - $ref: '#/components/schemas/NrTac' - arfcnDL: - type: integer - arfcnUL: - type: integer - arfcnSUL: - type: integer - bSChannelBwDL: - type: integer - bSChannelBwUL: - type: integer - bSChannelBwSUL: - type: integer - ssbFrequency: - type: integer - minimum: 0 - maximum: 3279165 - ssbPeriodicity: - $ref: '#/components/schemas/SsbPeriodicity' - ssbSubCarrierSpacing: - $ref: '#/components/schemas/SsbSubCarrierSpacing' - ssbOffset: - type: integer - minimum: 0 - maximum: 159 - ssbDuration: - $ref: '#/components/schemas/SsbDuration' - nrSectorCarrierRef: - type: array - items: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - bwpRef: - type: array - items: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - rimRSMonitoringStartTime: - type: string - rimRSMonitoringStopTime: - type: string - rimRSMonitoringWindowDuration: - type: integer - rimRSMonitoringWindowStartingOffset: - type: integer - rimRSMonitoringWindowPeriodicity: - type: integer - rimRSMonitoringOccasionInterval: - type: integer - rimRSMonitoringOccasionStartingOffset: - type: integer - nRFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - victimSetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - aggressorSetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - RRMPolicyRatio: - $ref: '#/components/schemas/RRMPolicyRatio-Multiple' - CPCIConfigurationFunction: - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - - NRFrequency-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - absoluteFrequencySSB: - type: integer - minimum: 0 - maximum: 3279165 - ssbSubCarrierSpacing: - $ref: '#/components/schemas/SsbSubCarrierSpacing' - multiFrequencyBandListNR: - type: integer - minimum: 1 - maximum: 256 - EUtranFrequency-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - earfcnDL: - type: integer - minimum: 0 - maximum: 262143 - multiBandInfoListEutra: - type: integer - minimum: 1 - maximum: 256 - - NrSectorCarrier-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - txDirection: - $ref: '#/components/schemas/TxDirection' - configuredMaxTxPower: - type: integer - arfcnDL: - type: integer - arfcnUL: - type: integer - bSChannelBwDL: - type: integer - bSChannelBwUL: - type: integer - sectorEquipmentFunctionRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - CommonBeamformingFunction: - $ref: '#/components/schemas/CommonBeamformingFunction-Single' - Bwp-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - bwpContext: - $ref: '#/components/schemas/BwpContext' - isInitialBwp: - $ref: '#/components/schemas/IsInitialBwp' - subCarrierSpacing: - type: integer - cyclicPrefix: - $ref: '#/components/schemas/CyclicPrefix' - startRB: - type: integer - numberOfRBs: - type: integer - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - CommonBeamformingFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - coverageShape: - $ref: '#/components/schemas/CoverageShape' - digitalAzimuth: - $ref: '#/components/schemas/DigitalAzimuth' - digitalTilt: - $ref: '#/components/schemas/DigitalTilt' - - type: object - properties: - Beam: - $ref: '#/components/schemas/Beam-Multiple' - Beam-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - beamIndex: - type: integer - beamType: - type: string - enum: - - SSB-BEAM - beamAzimuth: - type: integer - minimum: -1800 - maximum: 1800 - beamTilt: - type: integer - minimum: -900 - maximum: 900 - beamHorizWidth: - type: integer - minimum: 0 - maximum: 3599 - beamVertWidth: - type: integer - minimum: 0 - maximum: 1800 - RRMPolicyRatio-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: '#/components/schemas/RrmPolicy_-Attr' - - type: object - properties: - rRMPolicyMaxRatio: - type: integer - rRMPolicyMinRatio: - type: integer - rRMPolicyDedicatedRatio: - type: integer - - NRCellRelation-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - nRTCI: - type: integer - cellIndividualOffset: - $ref: '#/components/schemas/CellIndividualOffset' - adjacentNRCellRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - nRFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - isRemoveAllowed: - type: boolean - isHOAllowed: - type: boolean - isESCoveredBy: - $ref: '#/components/schemas/IsESCoveredBy' - isENDCAllowed: - type: boolean - isMLBAllowed: - type: boolean - EUtranCellRelation-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - adjacentEUtranCellRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - NRFreqRelation-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - offsetMO: - $ref: '#/components/schemas/QOffsetRangeList' - blackListEntry: - type: array - items: - type: integer - minimum: 0 - maximum: 1007 - blackListEntryIdleMode: - type: integer - cellReselectionPriority: - type: integer - cellReselectionSubPriority: - type: number - minimum: 0.2 - maximum: 0.8 - multipleOf: 0.2 - pMax: - type: integer - minimum: -30 - maximum: 33 - qOffsetFreq: - $ref: '#/components/schemas/QOffsetFreq' - qQualMin: - type: number - qRxLevMin: - type: integer - minimum: -140 - maximum: -44 - threshXHighP: - type: integer - minimum: 0 - maximum: 62 - threshXHighQ: - type: integer - minimum: 0 - maximum: 31 - threshXLowP: - type: integer - minimum: 0 - maximum: 62 - threshXLowQ: - type: integer - minimum: 0 - maximum: 31 - tReselectionNr: - type: integer - minimum: 0 - maximum: 7 - tReselectionNRSfHigh: - $ref: '#/components/schemas/TReselectionNRSf' - tReselectionNRSfMedium: - $ref: '#/components/schemas/TReselectionNRSf' - nRFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - EUtranFreqRelation-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - cellIndividualOffset: - $ref: '#/components/schemas/CellIndividualOffset' - blackListEntry: - type: array - items: - type: integer - minimum: 0 - maximum: 1007 - blackListEntryIdleMode: - type: integer - cellReselectionPriority: - type: integer - cellReselectionSubPriority: - type: number - minimum: 0.2 - maximum: 0.8 - multipleOf: 0.2 - pMax: - type: integer - minimum: -30 - maximum: 33 - qOffsetFreq: - $ref: '#/components/schemas/QOffsetFreq' - qQualMin: - type: number - qRxLevMin: - type: integer - minimum: -140 - maximum: -44 - threshXHighP: - type: integer - minimum: 0 - maximum: 62 - threshXHighQ: - type: integer - minimum: 0 - maximum: 31 - threshXLowP: - type: integer - minimum: 0 - maximum: 62 - threshXLowQ: - type: integer - minimum: 0 - maximum: 31 - tReselectionEutran: - type: integer - minimum: 0 - maximum: 7 - tReselectionNRSfHigh: - $ref: '#/components/schemas/TReselectionNRSf' - tReselectionNRSfMedium: - $ref: '#/components/schemas/TReselectionNRSf' - eUTranFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - DANRManagementFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - intrasystemANRManagementSwitch: - type: boolean - intersystemANRManagementSwitch: - type: boolean - - DESManagementFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - desSwitch: - type: boolean - intraRatEsActivationOriginalCellLoadParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - intraRatEsActivationCandidateCellsLoadParameters: - $ref: "#/components/schemas/IntraRatEsActivationCandidateCellsLoadParameters" - intraRatEsDeactivationCandidateCellsLoadParameters: - $ref: "#/components/schemas/IntraRatEsDeactivationCandidateCellsLoadParameters" - esNotAllowedTimePeriod: - $ref: "#/components/schemas/EsNotAllowedTimePeriod" - interRatEsActivationOriginalCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - interRatEsActivationCandidateCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - interRatEsDeactivationCandidateCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - isProbingCapable: - type: string - enum: - - yes - - no - energySavingState: - type: string - enum: - - isNotEnergySaving - - isEnergySaving - - DRACHOptimizationFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - drachOptimizationControl: - type: boolean - ueAccProbilityDist: - $ref: "#/components/schemas/UeAccProbilityDist" - ueAccDelayProbilityDist: - $ref: "#/components/schemas/UeAccDelayProbilityDist" - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - DMROFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - dmroControl: - type: boolean - maximumDeviationHoTrigger: - $ref: '#/components/schemas/MaximumDeviationHoTrigger' - minimumTimeBetweenHoTriggerChange: - $ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange' - tstoreUEcntxt: - $ref: '#/components/schemas/TstoreUEcntxt' - - DPCIConfigurationFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - dPciConfigurationControl: - type: boolean - nRPciList: - $ref: "#/components/schemas/NRPciList" - - CPCIConfigurationFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - cPciConfigurationControl: - type: boolean - cSonPciList: - $ref: "#/components/schemas/CSonPciList" - - CESManagementFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - cesSwitch: - type: boolean - intraRatEsActivationOriginalCellLoadParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - intraRatEsActivationCandidateCellsLoadParameters: - $ref: "#/components/schemas/IntraRatEsActivationCandidateCellsLoadParameters" - intraRatEsDeactivationCandidateCellsLoadParameters: - $ref: "#/components/schemas/IntraRatEsDeactivationCandidateCellsLoadParameters" - esNotAllowedTimePeriod: - $ref: "#/components/schemas/EsNotAllowedTimePeriod" - interRatEsActivationOriginalCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - interRatEsActivationCandidateCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - interRatEsDeactivationCandidateCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" - energySavingControl: - type: string - enum: - - toBeEnergySaving - - toBeNotEnergySaving - energySavingState: - type: string - enum: - - isNotEnergySaving - - isEnergySaving - - RimRSGlobal-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - frequencyDomainPara: - $ref: '#/components/schemas/FrequencyDomainPara' - sequenceDomainPara: - $ref: '#/components/schemas/SequenceDomainPara' - timeDomainPara: - $ref: '#/components/schemas/TimeDomainPara' - RimRSSet: - $ref: '#/components/schemas/RimRSSet-Multiple' - - RimRSSet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - setId: - $ref: '#/components/schemas/RSSetId' - setType: - $ref: '#/components/schemas/RSSetType' - nRCellDURefs: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - - ExternalGnbDuFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_F1C: - $ref: '#/components/schemas/EP_F1C-Multiple' - EP_F1U: - $ref: '#/components/schemas/EP_F1U-Multiple' - ExternalGnbCuUpFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_E1: - $ref: '#/components/schemas/EP_E1-Multiple' - EP_F1U: - $ref: '#/components/schemas/EP_F1U-Multiple' - EP_XnU: - $ref: '#/components/schemas/EP_XnU-Multiple' - ExternalGnbCuCpFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: >- - genericNrm.yaml#/components/schemas/ManagedFunction-Attr - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - plmnId: - $ref: '#/components/schemas/PlmnId' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - ExternalNrCellCu: - $ref: '#/components/schemas/ExternalNrCellCu-Multiple' - EP_XnC: - $ref: '#/components/schemas/EP_XnC-Multiple' - EP_E1: - $ref: '#/components/schemas/EP_E1-Multiple' - EP_F1C: - $ref: '#/components/schemas/EP_F1C-Multiple' - ExternalNrCellCu-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - cellLocalId: - type: integer - nrPci: - $ref: '#/components/schemas/NrPci' - plmnIdList: - $ref: '#/components/schemas/PlmnIdList' - nRFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - ExternalENBFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - eNBId: - type: integer - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - ExternalEUTranCell: - $ref: '#/components/schemas/ExternalEUTranCell-Multiple' - ExternalEUTranCell-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - EUtranFrequencyRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - EP_XnC-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_E1-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_F1C-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_NgC-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_X2C-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_XnU-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_F1U-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - epTransportRefs: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - - EP_NgU-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - epTransportRefs: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - - EP_X2U-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - EP_S1U-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - ManagedElement-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedElement-Single' - GnbDuFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/GnbDuFunction-Single' - GnbCuUpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/GnbCuUpFunction-Single' - GnbCuCpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/GnbCuCpFunction-Single' - - NrCellDu-Multiple: - type: array - items: - $ref: '#/components/schemas/NrCellDu-Single' - NrCellCu-Multiple: - type: array - items: - $ref: '#/components/schemas/NrCellCu-Single' - - NRFrequency-Multiple: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/NRFrequency-Single' - EUtranFrequency-Multiple: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/EUtranFrequency-Single' - - NrSectorCarrier-Multiple: - type: array - items: - $ref: '#/components/schemas/NrSectorCarrier-Single' - Bwp-Multiple: - type: array - items: - $ref: '#/components/schemas/Bwp-Single' - Beam-Multiple: - type: array - items: - $ref: '#/components/schemas/Beam-Single' - RRMPolicyRatio-Multiple: - type: array - items: - $ref: '#/components/schemas/RRMPolicyRatio-Single' - - NRCellRelation-Multiple: - type: array - items: - $ref: '#/components/schemas/NRCellRelation-Single' - EUtranCellRelation-Multiple: - type: array - items: - $ref: '#/components/schemas/EUtranCellRelation-Single' - NRFreqRelation-Multiple: - type: array - items: - $ref: '#/components/schemas/NRFreqRelation-Single' - EUtranFreqRelation-Multiple: - type: array - items: - $ref: '#/components/schemas/EUtranFreqRelation-Single' - - RimRSSet-Multiple: - type: array - items: - $ref: '#/components/schemas/RimRSSet-Single' - - ExternalGnbDuFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalGnbDuFunction-Single' - ExternalGnbCuUpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalGnbCuUpFunction-Single' - ExternalGnbCuCpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalGnbCuCpFunction-Single' - ExternalNrCellCu-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalNrCellCu-Single' - - ExternalENBFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalENBFunction-Single' - ExternalEUTranCell-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalEUTranCell-Single' - - EP_E1-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_E1-Single' - EP_XnC-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_XnC-Single' - EP_F1C-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_F1C-Single' - EP_NgC-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_NgC-Single' - EP_X2C-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_X2C-Single' - EP_XnU-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_XnU-Single' - EP_F1U-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_F1U-Single' - EP_NgU-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_NgU-Single' - EP_X2U-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_X2U-Single' - EP_S1U-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_S1U-Single' - -#-------- Definitions in TS 28.541 for TS 28.532 --------------------------------- - - resources-nrNrm: - oneOf: - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' - - - $ref: '#/components/schemas/GnbDuFunction-Single' - - $ref: '#/components/schemas/GnbCuUpFunction-Single' - - $ref: '#/components/schemas/GnbCuCpFunction-Single' - - - $ref: '#/components/schemas/NrCellCu-Single' - - $ref: '#/components/schemas/NrCellDu-Single' - - - $ref: '#/components/schemas/NRFrequency-Single' - - $ref: '#/components/schemas/EUtranFrequency-Single' - - - $ref: '#/components/schemas/NrSectorCarrier-Single' - - $ref: '#/components/schemas/Bwp-Single' - - $ref: '#/components/schemas/CommonBeamformingFunction-Single' - - $ref: '#/components/schemas/Beam-Single' - - $ref: '#/components/schemas/RRMPolicyRatio-Single' - - - $ref: '#/components/schemas/NRCellRelation-Single' - - $ref: '#/components/schemas/EUtranCellRelation-Single' - - $ref: '#/components/schemas/NRFreqRelation-Single' - - $ref: '#/components/schemas/EUtranFreqRelation-Single' - - - $ref: '#/components/schemas/DANRManagementFunction-Single' - - $ref: '#/components/schemas/DESManagementFunction-Single' - - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - - $ref: '#/components/schemas/DMROFunction-Single' - - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - - $ref: '#/components/schemas/CESManagementFunction-Single' - - - $ref: '#/components/schemas/RimRSGlobal-Single' - - $ref: '#/components/schemas/RimRSSet-Single' - - - $ref: '#/components/schemas/ExternalGnbDuFunction-Single' - - $ref: '#/components/schemas/ExternalGnbCuUpFunction-Single' - - $ref: '#/components/schemas/ExternalGnbCuCpFunction-Single' - - $ref: '#/components/schemas/ExternalNrCellCu-Single' - - $ref: '#/components/schemas/ExternalENBFunction-Single' - - $ref: '#/components/schemas/ExternalEUTranCell-Single' - - - $ref: '#/components/schemas/EP_XnC-Single' - - $ref: '#/components/schemas/EP_E1-Single' - - $ref: '#/components/schemas/EP_F1C-Single' - - $ref: '#/components/schemas/EP_NgC-Single' - - $ref: '#/components/schemas/EP_X2C-Single' - - $ref: '#/components/schemas/EP_XnU-Single' - - $ref: '#/components/schemas/EP_F1U-Single' - - $ref: '#/components/schemas/EP_NgU-Single' - - $ref: '#/components/schemas/EP_X2U-Single' - - $ref: '#/components/schemas/EP_S1U-Single' diff --git a/OpenAPI/provMnS.yaml b/OpenAPI/provMnS.yaml deleted file mode 100644 index b2f84a4d2..000000000 --- a/OpenAPI/provMnS.yaml +++ /dev/null @@ -1,579 +0,0 @@ -openapi: 3.0.1 -info: - title: Provisioning MnS - version: 16.4.0 - description: >- - OAS 3.0.1 definition of the Provisioning MnS - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.532 V16.4.0; Generic management services - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ -servers: - - url: 'http://{URI-DN-prefix}/{root}/ProvMnS/v1640/{LDN-first-part}' - variables: - URI-DN-prefix: - description: See subclause 4.4 of TS 32.158 - default: example.com - root: - description: See subclause 4.4 of TS 32.158 - default: 3GPPManagement - LDN-first-part: - description: See subclause 4.4 of TS 32.158 - default: '' -paths: - '/{className}={id}': - parameters: - - name: className - in: path - required: true - schema: - $ref: '#/components/schemas/className-PathType' - - name: id - in: path - required: true - schema: - $ref: '#/components/schemas/id-PathType' - put: - summary: Replaces a complete single resource or creates it if it does not exist - description: >- - With HTTP PUT a complete resource is replaced or created if it does not - exist. The target resource is identified by the target URI. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/resourcePut-RequestType' - responses: - '200': - description: >- - Success case ("200 OK"). - This status code shall be returned when the resource is replaced, and - when the replaced resource representation is not identical to the resource - representation in the request. - This status code may be retourned when the resource is updated and when the - updated resource representation is identical to the resource representation - in the request. - The representation of the updated resource is returned in the response - message body. - content: - application/json: - schema: - $ref: '#/components/schemas/resourceUpdate-ResponseType' - '201': - description: >- - Success case ("201 Created"). - This status code shall be returned when the resource is created. - The representation of the created resource is returned in the response - message body. - content: - application/json: - schema: - $ref: '#/components/schemas/resourceCreation-ResponseType' - '204': - description: >- - Success case ("204 No Content"). - This status code may be returned only when the replaced resource - representation is identical to the representation in the request. - The response has no message body. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - callbacks: - notifyMOICreation: - '{request.body#/notificationRecipientAddress}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyMOICreation-NotifType' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response - has no message body. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - notifyMOIDeletion: - '{request.body#/notificationRecipientAddress}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyMOIDeletion-NotifType' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response - has no message body. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - notifyMOIAttributeValueChange: - '{request.body#/notificationRecipientAddress}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyMOIAttributeValueChange-NotifType' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response - has no message body. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - notifyMOIChanges: - '{request.body#/notificationRecipientAddress}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyMOIChanges-NotifType' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response - has no message body. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - get: - summary: Reads one or multiple resources - description: >- - With HTTP GET resources are read. The resources to be retrieved are - identified with the target URI. The attributes and fields parameter - of the query components allow to select the resource properties to be returned. - parameters: - - name: scope - in: query - description: >- - This parameter extends the set of targeted resources beyond the base - resource identified with the path component of the URI. No scoping - mechanism is specified in the present document. - required: false - schema: - $ref: '#/components/schemas/scope-QueryType' - style: form - explode: true - - name: filter - in: query - description: >- - This parameter reduces the targeted set of resources by applying a - filter to the scoped set of resource representations. Only resource - representations for which the filter construct evaluates to "true" - are targeted. No filter language is specified in the present - document. - required: false - schema: - $ref: '#/components/schemas/filter-QueryType' - - name: attributes - in: query - description: >- - This parameter specifies the attributes of the scoped resources that - are returned. - required: true - schema: - $ref: '#/components/schemas/attributes-QueryType' - style: form - explode: false - - name: fields - in: query - description: >- - This parameter specifies the attribute field of the scoped resources - that are returned. - required: false - schema: - $ref: '#/components/schemas/fields-QueryType' - style: form - explode: false - responses: - '200': - description: >- - Success case ("200 OK"). - The resources identified in the request for retrieval are returned - in the response message body. In case the attributes or fields query - parameters are used, only the selected attributes or sub-attributes are - returned. The response message body is constructed according to the - hierarchical response construction method (TS 32.158 [15]). - content: - application/json: - schema: - $ref: '#/components/schemas/resourceRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - patch: - summary: Patches one or multiple resources - description: >- - With HTTP PATCH resources are created, updated or deleted. The resources - to be modified are identified with the target URI (base resource) and - the patch document included in the request message body. - requestBody: - description: >- - The request body describes changes to be made to the target resources. - The following patch media types are available - - "application/merge-patch+json" (RFC 7396) - - "application/3gpp-merge-patch+json" (TS 32.158) - - "application/json-patch+json" (RFC 6902) - - "application/3gpp-json-patch+json" (TS 32.158) - required: true - content: - application/merge-patch+json: - schema: - $ref: '#/components/schemas/jsonMergePatch-RequestType' - application/3gpp-merge-patch+json: - schema: - $ref: '#/components/schemas/3gppJsonMergePatch-RequestType' - application/json-patch+json: - schema: - $ref: '#/components/schemas/jsonPatch-RequestType' - application/3gpp-json-patch+json: - schema: - $ref: '#/components/schemas/3gppJsonPatch-RequestType' - responses: - '200': - description: >- - Success case ("200 OK"). - This status code is returned when the updated the resource representations - shall be returned for some reason. - The resource representations are returned in the response message body. The - response message body is constructed according to the hierarchical response - construction method (TS 32.158 [15]) - content: - application/json: - schema: - $ref: '#/components/schemas/resourceUpdate-ResponseType' - '204': - description: >- - Success case ("204 No Content"). - This status code is returned when there is no need to return the updated - resource representations. - The response message body is empty. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: Deletes one or multiple resources - description: >- - With HTTP DELETE resources are deleted. The resources to be deleted are - identified with the target URI. - parameters: - - name: scope - in: query - description: >- - This parameter extends the set of targeted resources beyond the base - resource identified with the path component of the URI. No scoping - mechanism is specified in the present document. - required: false - schema: - $ref: '#/components/schemas/scope-QueryType' - - name: filter - in: query - description: >- - This parameter reduces the targeted set of resources by applying a - filter to the scoped set of resource representations. Only resources - representations for which the filter construct evaluates to "true" - are returned. No filter language is specified in the present - document. - required: false - schema: - $ref: '#/components/schemas/filter-QueryType' - responses: - '200': - description: >- - Success case ("200 OK"). - This status code shall be returned, when query parameters are present in - the request and one or multiple resources are deleted. - The URIs of the deleted resources are returned in the response message body. - '204': - description: >- - Success case ("204 No Content"). - This status code shall be returned, when no query parameters are present in - the request and only one resource is deleted. - The message body is empty. - content: - application/json: - schema: - $ref: '#/components/schemas/resourceDeletion-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - dateTime-Type: - type: string - format: date-time - long-Type: - type: integer - format: int64 - uri-Type: - type: string - correlatedNotification-Type: - type: object - properties: - source: - $ref: '#/components/schemas/uri-Type' - notificationIds: - type: array - items: - $ref: '#/components/schemas/notificationId-Type' - notificationId-Type: - $ref: '#/components/schemas/long-Type' - notificationType-Type: - type: string - enum: - - notifyMOICreation - - notifyMOIDeletion - - notifyMOIAttributeValueChange - systemDN-Type: - type: string - additionalText-Type: - type: string - sourceIndicator-Type: - type: string - enum: - - resourceOperation - - mangementOperation - - sONOperation - - unknown - header-Type: - type: object - properties: - href: - $ref: '#/components/schemas/uri-Type' - notificationId: - $ref: '#/components/schemas/notificationId-Type' - notificationType: - $ref: '#/components/schemas/notificationType-Type' - eventTime: - $ref: '#/components/schemas/dateTime-Type' - systemDN: - $ref: '#/components/schemas/systemDN-Type' - required: - - href - - notificationId - - notificationType - - eventTime - - systemDN - scopeType-Type: - type: string - enum: - - BASE_ONLY - - BASE_NTH_LEVEL - - BASE_SUBTREE - - BASE_ALL - scopeLevel-Type: - type: integer - className-PathType: - type: string - id-PathType: - type: string - attributes-QueryType: - type: array - items: - type: string - fields-QueryType: - type: array - items: - type: string - filter-QueryType: - type: string - scope-QueryType: - type: object - properties: - scopeType: - $ref: '#/components/schemas/scopeType-Type' - scopeLevel: - $ref: '#/components/schemas/scopeLevel-Type' - - resourcePut-RequestType: - $ref: '#/components/schemas/resourceRepresentation-Type' - jsonMergePatch-RequestType: - $ref: '#/components/schemas/resourceRepresentation-Type' - 3gppJsonMergePatch-RequestType: - $ref: '#/components/schemas/resourceRepresentation-Type' - jsonPatch-RequestType: - type: array - items: - type: object - 3gppJsonPatch-RequestType: - type: array - items: - type: object - - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - resourceRetrieval-ResponseType: - $ref: '#/components/schemas/resourceRepresentation-Type' - resourceCreation-ResponseType: - $ref: '#/components/schemas/resourceRepresentation-Type' - resourceUpdate-ResponseType: - $ref: '#/components/schemas/resourceRepresentation-Type' - resourceDeletion-ResponseType: - type: array - items: - $ref: '#/components/schemas/uri-Type' - - resourceRepresentation-Type: - oneOf: - - type: object - properties: - id: - type: string - attributes: - type: object - additionalProperties: - type: array - items: - type: object - - anyOf: - - $ref: 'genericNrm.yaml#/components/schemas/resources-genericNrm' - - $ref: 'nrNrm.yaml#/components/schemas/resources-nrNrm' - - $ref: '5gcNrm.yaml#/components/schemas/resources-5gcNrm' - - $ref: 'sliceNrm.yaml#/components/schemas/resources-sliceNrm' - - mOIChange-Type: - type: object - properties: - notificationId: - $ref: '#/components/schemas/notificationId-Type' - correlatedNotifications: - type: array - items: - $ref: '#/components/schemas/correlatedNotification-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' - sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' - path: - $ref: '#/components/schemas/uri-Type' - operation: - type: string - enum: - - CREATE - - DELETE - - REPLACE - value: - oneOf: - - type: object - additionalProperties: - nullable: true - - type: array - items: - type: object - minItems: 1 - maxItems: 2 - - notifyMOICreation-NotifType: - allOf: - - $ref: '#/components/schemas/header-Type' - - type: object - properties: - correlatedNotifications: - type: array - items: - $ref: '#/components/schemas/correlatedNotification-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' - sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' - attributeList: - type: object - additionalProperties: - nullable: true - notifyMOIDeletion-NotifType: - allOf: - - $ref: '#/components/schemas/header-Type' - - type: object - properties: - correlatedNotifications: - type: array - items: - $ref: '#/components/schemas/correlatedNotification-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' - sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' - attributeList: - type: object - additionalProperties: true - notifyMOIAttributeValueChange-NotifType: - allOf: - - $ref: '#/components/schemas/header-Type' - - type: object - properties: - correlatedNotifications: - type: array - items: - $ref: '#/components/schemas/correlatedNotification-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' - sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' - attributeValueChange: - type: object - additionalProperties: - type: array - minItems: 1 - maxItems: 2 - items: - nullable: true - required: - - attributeValueChange - notifyMOIChanges-NotifType: - allOf: - - $ref: '#/components/schemas/header-Type' - - type: object - properties: - mOIChanges: - type: array - items: - $ref: '#/components/schemas/mOIChange-Type' - required: - - mOIChanges diff --git a/OpenAPI/sliceNrm.yaml b/OpenAPI/sliceNrm.yaml deleted file mode 100644 index bf6b4d71c..000000000 --- a/OpenAPI/sliceNrm.yaml +++ /dev/null @@ -1,632 +0,0 @@ -openapi: 3.0.1 -info: - title: Slice NRM - version: 17.4.0 - description: >- - OAS 3.0.1 specification of the Slice NRM - @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.541; 5G NRM, Slice NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ -paths: {} -components: - schemas: - -#------------ Type definitions --------------------------------------------------- - - Float: - type: number - format: float - MobilityLevel: - type: string - enum: - - STATIONARY - - NOMADIC - - RESTRICTED MOBILITY - - FULLY MOBILITY - SynAvailability: - type: string - enum: - - NOT SUPPORTED - - BETWEEN BS AND UE - - BETWEEN BS AND UE & UE AND UE - PositioningAvailability: - type: array - items: - type: string - enum: - - CIDE-CID - - OTDOA - - RF FINGERPRINTING - - AECID - - HYBRID POSITIONING - - NET-RTK - Predictionfrequency: - type: string - enum: - - PERSEC - - PERMIN - - PERHOUR - SharingLevel: - type: string - enum: - - SHARED - - NON-SHARED - - NetworkSliceSharingIndicator: - type: string - enum: - - SHARED - - NON-SHARED - - ServiceType: - type: string - enum: - - eMBB - - RLLC - - MIoT - - V2X - SliceSimultaneousUse: - type: string - enum: - - ZERO - - ONE - - TWO - - THREE - - FOUR - Category: - type: string - enum: - - CHARACTER - - SCALABILITY - Tagging: - type: array - items: - type: string - enum: - - PERFORMANCE - - FUNCTION - - OPERATION - Exposure: - type: string - enum: - - API - - KPI - ServAttrCom: - type: object - properties: - category: - $ref: '#/components/schemas/Category' - tagging: - $ref: '#/components/schemas/Tagging' - exposure: - $ref: '#/components/schemas/Exposure' - Support: - type: string - enum: - - NOT SUPPORTED - - SUPPORTED - DelayTolerance: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - support: - $ref: '#/components/schemas/Support' - DeterministicComm: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - availability: - $ref: '#/components/schemas/Support' - periodicityList: - type: string - XLThpt: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - guaThpt: - $ref: '#/components/schemas/Float' - maxThpt: - $ref: '#/components/schemas/Float' - MaxPktSize: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - maxsize: - type: integer - MaxNumberofPDUSessions: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - nOofPDUSessions: - type: integer - KPIMonitoring: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - kPIList: - type: string - NBIoT: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - support: - $ref: '#/components/schemas/Support' - RadioSpectrum: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - nROperatingBands: - type: string - Synchronicity: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - availability: - $ref: '#/components/schemas/SynAvailability' - accuracy: - $ref: '#/components/schemas/Float' - SynchronicityRANSubnet: - type: object - properties: - availability: - $ref: '#/components/schemas/SynAvailability' - accuracy: - $ref: '#/components/schemas/Float' - Positioning: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - availability: - $ref: '#/components/schemas/PositioningAvailability' - predictionfrequency: - $ref: '#/components/schemas/Predictionfrequency' - accuracy: - $ref: '#/components/schemas/Float' - PositioningRANSubnet: - type: object - properties: - availability: - $ref: '#/components/schemas/PositioningAvailability' - predictionfrequency: - $ref: '#/components/schemas/Predictionfrequency' - accuracy: - $ref: '#/components/schemas/Float' - UserMgmtOpen: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - support: - $ref: '#/components/schemas/Support' - V2XCommModels: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - v2XMode: - $ref: '#/components/schemas/Support' - TermDensity: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - density: - type: integer - NsInfo: - type: object - properties: - nsInstanceId: - type: string - nsName: - type: string - EmbbEEPerfReq: - type: integer - UrllcEEPerfReq: - type: integer - MIoTEEPerfReq: - type: object - properties: - KpiType: - type: string - enum: - - MAXREGSUBS - - MEANACTIVEUES - Req: - type: integer - EEPerfReq: - oneOf: - - $ref: '#/components/schemas/EmbbEEPerfReq' - - $ref: '#/components/schemas/UrllcEEPerfReq' - - $ref: '#/components/schemas/MIoTEEPerfReq' - EnergyEfficiency: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - performance: - $ref: '#/components/schemas/EEPerfReq' - CNSliceSubnetProfile: - type: object - properties: - maxNumberofUEs: - type: integer - latency: - type: integer - dLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - dLThptPerUE: - $ref: '#/components/schemas/XLThpt' - uLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - uLThptPerUE: - $ref: '#/components/schemas/XLThpt' - maxNumberOfPDUSessions: - type: integer - coverageAreaTAList: - type: integer - resourceSharingLevel: - $ref: '#/components/schemas/SharingLevel' - dLMaxPktSize: - type: integer - uLMaxPktSize: - type: integer - delayTolerance: - $ref: '#/components/schemas/DelayTolerance' - synchronicity: - $ref: '#/components/schemas/SynchronicityRANSubnet' - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - reliability: - type: string - energyEfficiency: - type: integer - dLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - uLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - survivalTime: - type: string - RANSliceSubnetProfile: - type: object - properties: - coverageAreaTAList: - type: integer - uEMobilityLevel: - $ref: '#/components/schemas/MobilityLevel' - resourceSharingLevel: - $ref: '#/components/schemas/SharingLevel' - maxNumberofUEs: - type: integer - activityFactor: - type: integer - dLThptPerUE: - $ref: '#/components/schemas/XLThpt' - uLThptPerUE: - $ref: '#/components/schemas/XLThpt' - uESpeed: - type: integer - reliability: - type: string - serviceType: - $ref: '#/components/schemas/ServiceType' - dLMaxPktSize: - type: integer - uLMaxPktSize: - type: integer - nROperatingBands: - type: string - delayTolerance: - $ref: '#/components/schemas/DelayTolerance' - positioning: - $ref: '#/components/schemas/PositioningRANSubnet' - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - energyEfficiency: - type: integer - termDensity: - $ref: '#/components/schemas/TermDensity' - survivalTime: - type: string - synchronicity: - $ref: '#/components/schemas/SynchronicityRANSubnet' - dLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - uLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - TopSliceSubnetProfile: - type: object - properties: - latency: - type: integer - maxNumberofUEs: - type: integer - dLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - dLThptPerUE: - $ref: '#/components/schemas/XLThpt' - uLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - uLThptPerUE: - $ref: '#/components/schemas/XLThpt' - dLMaxPktSize: - type: integer - uLMaxPktSize: - type: integer - maxNumberOfPDUSessions: - type: integer - nROperatingBands: - type: string - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - energyEfficiency: - type: integer - synchronicity: - $ref: '#/components/schemas/Synchronicity' - delayTolerance: - $ref: '#/components/schemas/DelayTolerance' - positioning: - $ref: '#/components/schemas/Positioning' - termDensity: - $ref: '#/components/schemas/TermDensity' - activityFactor: - type: integer - coverageAreaTAList: - type: integer - resourceSharingLevel: - $ref: '#/components/schemas/SharingLevel' - uEMobilityLevel: - $ref: '#/components/schemas/MobilityLevel' - uESpeed: - type: integer - reliability: - type: string - serviceType: - $ref: '#/components/schemas/ServiceType' - dLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - uLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - survivalTime: - type: string - - ServiceProfile: - type: object - properties: - serviceProfileId: - type: string - plmnInfoList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList' - maxNumberofUEs: - type: number - latency: - type: number - uEMobilityLevel: - $ref: '#/components/schemas/MobilityLevel' - sst: - $ref: 'nrNrm.yaml#/components/schemas/Sst' - networkSliceSharingIndicator: - $ref: '#/components/schemas/NetworkSliceSharingIndicator' - availability: - type: number - delayTolerance: - $ref: '#/components/schemas/DelayTolerance' - dLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - uLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - dLThptPerSlice: - $ref: '#/components/schemas/XLThpt' - dLThptPerUE: - $ref: '#/components/schemas/XLThpt' - uLThptPerSlice: - $ref: '#/components/schemas/XLThpt' - uLThptPerUE: - $ref: '#/components/schemas/XLThpt' - dLMaxPktSize: - $ref: '#/components/schemas/MaxPktSize' - uLMaxPktSize: - $ref: '#/components/schemas/MaxPktSize' - maxNumberofPDUSessions: - $ref: '#/components/schemas/MaxNumberofPDUSessions' - kPIMonitoring: - $ref: '#/components/schemas/KPIMonitoring' - nBIoT: - $ref: '#/components/schemas/NBIoT' - radioSpectrum: - $ref: '#/components/schemas/RadioSpectrum' - synchronicity: - $ref: '#/components/schemas/Synchronicity' - positioning: - $ref: '#/components/schemas/Positioning' - userMgmtOpen: - $ref: '#/components/schemas/UserMgmtOpen' - v2XModels: - $ref: '#/components/schemas/V2XCommModels' - coverageArea: - type: string - termDensity: - $ref: '#/components/schemas/TermDensity' - activityFactor: - $ref: '#/components/schemas/Float' - uESpeed: - type: integer - jitter: - type: integer - survivalTime: - type: string - reliability: - type: string - maxDLDataVolume: - type: string - maxULDataVolume: - type: string - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - energyEfficiency: - $ref: '#/components/schemas/EnergyEfficiency' - SliceProfile: - type: object - properties: - serviceProfileId: - type: string - plmnInfoList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList' - cNSliceSubnetProfile: - $ref: '#/components/schemas/CNSliceSubnetProfile' - rANSliceSubnetProfile: - $ref: '#/components/schemas/RANSliceSubnetProfile' - topSliceSubnetProfile: - $ref: '#/components/schemas/TopSliceSubnetProfile' - - IpAddress: - oneOf: - - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' - - LogicInterfaceInfo: - type: object - properties: - logicalInterfceType: - type: string - enum: - - VLAN - - MPLS - - Segment - logicalInterfceId: - type: string - - ServiceProfileList: - type: array - items: - $ref: '#/components/schemas/ServiceProfile' - - SliceProfileList: - type: array - items: - $ref: '#/components/schemas/SliceProfile' - -#------------ Definition of concrete IOCs ---------------------------------------- - SubNetwork-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - NetworkSlice: - $ref: '#/components/schemas/NetworkSlice-Multiple' - NetworkSliceSubnet: - $ref: '#/components/schemas/NetworkSliceSubnet-Multiple' - EP_Transport: - $ref: '#/components/schemas/EP_Transport-Multiple' - - NetworkSlice-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - networkSliceSubnetRef: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - operationalState: - $ref: 'genericNrm.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - serviceProfileList: - $ref: '#/components/schemas/ServiceProfileList' - - NetworkSliceSubnet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - managedFunctionRefList: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - networkSliceSubnetRefList: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - operationalState: - $ref: 'genericNrm.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - nsInfo: - $ref: '#/components/schemas/NsInfo' - sliceProfileList: - $ref: '#/components/schemas/SliceProfileList' - epTransportRefList: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - priorityLabel: - type: integer - - EP_Transport-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - ipAddress: - $ref: '#/components/schemas/IpAddress' - logicInterfaceInfo: - $ref: '#/components/schemas/LogicInterfaceInfo' - nextHopInfo: - type: string - qosProfile: - type: string - epApplicationRefs: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - - NetworkSlice-Multiple: - type: array - items: - $ref: '#/components/schemas/NetworkSlice-Single' - - NetworkSliceSubnet-Multiple: - type: array - items: - $ref: '#/components/schemas/NetworkSliceSubnet-Single' - - EP_Transport-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_Transport-Single' - -#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- - - resources-sliceNrm: - oneOf: - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/NetworkSlice-Single' - - $ref: '#/components/schemas/NetworkSliceSubnet-Single' - - $ref: '#/components/schemas/EP_Transport-Single' diff --git a/OpenAPI/streamingDataMnS.yaml b/OpenAPI/streamingDataMnS.yaml deleted file mode 100644 index ab7f71d4a..000000000 --- a/OpenAPI/streamingDataMnS.yaml +++ /dev/null @@ -1,453 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.532 Streaming data reporting service - version: 16.4.0 - description: OAS 3.0.1 specification for the Streaming data reporting service (Streaming MnS) -servers: - - url: '{protocol}://{root}/StreamingDataReportingMnS/{version}' - variables: - protocol: - description: Protocol used - enum: - - http - - https - - wss - default: https - root: - description: Indicates the host name and optional port, and an optional sequence of path segments that together represent a prefix path. - default: example.com - version: - description: Indicates the current version of the specification - default: 16.4.0 -paths: - '/connections': - post: - summary: Inform consumer about reporting streams to be carried by the new connection and receive a new connection id. - description: Exchange of meta-data (producer informs consumer about its own identity and the nature of the data to be reported via streaming) phase of the connection establishement by streaming data reporting producer to the streaming data reporting consumer (i.e. streaming target). - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/connectionRequest-Type' - responses: - '201': - description: Success case (201 Created). - headers: - Location: - description: Location of the created connection resource. - schema: - $ref: '#/components/schemas/connectionId-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/failedConnectionResponse-Type' - get: - summary: Obtain information about connections. - description: Enables the streaming data reporting service producer to obtain information about one or more streaming connections. - parameters: - - name: connectionIdList - in: query - description: The list of connectionId for which the connection information is to be returned. - required: false - schema: - type: array - items: - $ref: '#/components/schemas/connectionId-Type' - responses: - '200': - description: Success case (200 OK). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned. - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/connectionInfo-Type' - '202': - description: Partial success case (202 Partially retrieved). Subset of the resources identified in the request for retrieval are returned in the response message body. - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/connectionInfo-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' - '/connections/{connectionId}': - get: - summary: Obtain information about a connection. - description: Enables the streaming data reporting service producer to obtain information about one streaming connection. - parameters: - - name: connectionId - in: path - description: Indicate the ID (URI) of the connection for which the information is being retrieved - required: true - schema: - $ref: '#/components/schemas/connectionId-Type' - - name: Connection - in: header - schema: - $ref: '#/components/schemas/websocketHeaderConnection-Type' - - name: Sec-WebSocket-Extensions - in: header - schema: - $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Extensions-Type' - - name: Sec-WebSocket-Key - in: header - schema: - $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Key-Type' - - name: Sec-WebSocket-Protocol - in: header - schema: - $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Protocol-Type' - - name: Sec-WebSocket-Version - in: header - schema: - $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Version-Type' - responses: - '101': - description: Success case (101 Switching Protocols). The connection has been successfully switched to WebSocket. The response message body is absent. - headers: - Upgrade: - schema: - $ref: '#/components/schemas/websocketHeaderUpgrade-Type' - Connection: - schema: - $ref: '#/components/schemas/websocketHeaderConnection-Type' - Sec-WebSocket-Accept: - schema: - $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Accept-Type' - '200': - description: Success case (200 OK). The resource identified in the request for retrieval returned in the response message body. - content: - application/json: - schema: - $ref: '#/components/schemas/connectionInfo-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' - '/connections/{connectionId}/streams': - post: - summary: Inform consumer about new reporting streams on an existing connection. - description: Allows the producer to add one or more reporting streams to an already established streaming connection. - parameters: - - name: connectionId - in: path - description: Indicate the ID (URI) of the connection for which the reporting stream information is being added. - required: true - schema: - $ref: '#/components/schemas/connectionId-Type' - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/streamInfo-Type' - responses: - '201': - description: Success case (201 Posted). - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/streamInfo-Type' - '202': - description: Partial success case (202 Posted). - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/streamInfo-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' - delete: - summary: Remove reporting streams from an existing connection - description: Allows the producer to remove one or more reporting streams from an already established streaming connection. - parameters: - - name: connectionId - in: path - description: Indicate the ID (URI) of the connection for which the reporting stream information is being removed. - required: true - schema: - $ref: '#/components/schemas/connectionId-Type' - - name: streamIds - in: query - description: The list of streamId for the stream(s) to be deleted. - required: true - schema: - type: array - items: - $ref: '#/components/schemas/streamId-Type' - responses: - '204': - description: Success case (204 No Content). The stream information resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' - get: - summary: Obtain information about streams. - description: Enables the streaming data reporting service producer to obtain information about one or more reporting streams. - parameters: - - name: connectionId - in: path - description: Indicate the ID (URI) of the connection for which the information is being retrieved - required: true - schema: - $ref: '#/components/schemas/connectionId-Type' - - name: streamIds - in: query - description: The list of streamId for which the stream information is to be retrieved. - required: true - schema: - type: array - items: - $ref: '#/components/schemas/streamId-Type' - responses: - '200': - description: Success case (200 OK). - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/streamInfoWithReporters-Type' - '202': - description: Partial success case (202 Partially retrieved). - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/streamInfoWithReporters-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' - '/connections/{connectionId}/streams/{streamId}': - get: - summary: Obtain information about stream - description: Enables the streaming data reporting service producer to obtain information about a reporting stream. - parameters: - - name: connectionId - in: path - description: Indicate the ID (URI) of the connection for which the information is being retrieved - required: true - schema: - $ref: '#/components/schemas/connectionId-Type' - - name: streamId - in: path - description: Indicate the ID of the reporting stream for which the information is being retrieved - required: true - schema: - $ref: '#/components/schemas/streamId-Type' - responses: - '200': - description: Success case (200 OK). - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoWithReporters-Type' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/errorResponse-Type' -components: - schemas: - analyticsInfo-Type: - description: Information specific to analytics reporting. - type: object - properties: - activityDetails: - type: string - connectionId-Type: - $ref: '#/components/schemas/uri-Type' - connectionInfo-Type: - type: object - properties: - connection: - $ref: '#/components/schemas/connectionId-Type' - producer: - $ref: '#/components/schemas/producerId-Type' - streams: - type: array - items: - $ref: '#/components/schemas/streamId-Type' - connectionRequest-Type: - type: object - properties: - producer: - $ref: '#/components/schemas/producerId-Type' - streams: - type: array - items: - $ref: '#/components/schemas/streamInfo-Type' - errorResponse-Type: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - failedConnectionResponse-Type: - type: object - properties: - error: - type: array - items: - type: object - properties: - streamId: - $ref: '#/components/schemas/streamId-Type' - errorReason: - type: string - measObjDn-Type: - description: DN of the measured object instance (see 3GPP TS 28.550) - allOf: - - $ref: '#/components/schemas/systemDN-Type' - measTypes-Type: - description: an ordered list of measurement type or KPI whose measurement values or KPI result values are to be reported by the Performance Data Stream Units (see Annex C of TS 28.550) via this stream - type: array - items: - type: string - performanceInfo-Type: - description: Information specific to performance data reporting - type: object - properties: - measObjDn: - $ref: '#/components/schemas/measObjDn-Type' - measTypes: - $ref: '#/components/schemas/measTypes-Type' - measurementReaderId: - $ref: '#/components/schemas/systemDN-Type' - jobId: - type: string - required: - - measObjDn - - measTypes - producerId-Type: - description: DN of the streaming data reporting MnS producer. - allOf: - - $ref: '#/components/schemas/systemDN-Type' - serializationFormat-Type: - type: string - enum: - - GPB - - ASN1 - streamId-Type: - description: globally unique stream identifier - type: string - example: '26F452550021' - streamInfo-Type: - description: Reporting stream meta-data. - type: object - properties: - streamType: - $ref: '#/components/schemas/streamType-Type' - serializationFormat: - $ref: '#/components/schemas/serializationFormat-Type' - streamId: - oneOf: - - $ref: '#/components/schemas/streamId-Type' - - $ref: '#/components/schemas/traceReference-Type' - additionalInfo: - oneOf: - - $ref: '#/components/schemas/traceInfo-Type' - - $ref: '#/components/schemas/performanceInfo-Type' - - $ref: '#/components/schemas/analyticsInfo-Type' - - $ref: '#/components/schemas/vsDataContainer-Type' - required: - - streamType - - serializationFormat - - streamId - streamInfoWithReporters-Type: - description: Reporting stream meta-data with added information about reporters. - type: object - properties: - streamInfo: - $ref: '#/components/schemas/streamInfo-Type' - reporters: - type: array - items: - $ref: '#/components/schemas/producerId-Type' - systemDN-Type: - description: See 3GPP TS 32.300 for details - type: string - example: 'SubNetwork=ABCNetwork,SubNetwork=MUC01,GNBDUFunction=XYZ0100' - streamType-Type: - type: string - enum: - - TRACE - - PERFORMANCE - - ANALYTICS - - PROPRIETARY - traceInfo-Type: - description: Information specific to trace data reporting - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/TraceJob-Attr' - traceReference-Type: - description: Trace Reference (see clause 5.6 of 3GPP TS 32.422) as stream identifier for streaming trace data reporting - type: string - example: '4358070034D7' - uri-Type: - description: Resource URI - type: string - vsDataContainer-Type: - description: container for vendor specific data (see 3GPP TS 28.622) - type: object - properties: - vsDataType: - type: string - vsData: - type: string - vsDataFormatVersion: - type: string - websocketHeaderConnection-Type: - description: Header value for the upgrade request and response. - type: string - enum: - - Upgrade - websocketHeaderUpgrade-Type: - description: Header value for the upgrade to WebSocket request and response. - type: string - enum: - - websocket - websocketHeader-Sec-WebSocket-Accept-Type: - description: Header value for secure WebSocket response. Carries hash. - type: string - websocketHeader-Sec-WebSocket-Extensions-Type: - description: Header value for secure WebSocket request. Carries protocol extensions. - type: string - websocketHeader-Sec-WebSocket-Key-Type: - description: Header value for secure WebSocket request. Provides information to the server which is needed in order to confirm that the client is entitled to request an upgrade to WebSocket. - type: string - websocketHeader-Sec-WebSocket-Protocol-Type: - description: Header value for secure WebSocket request. Carries a comma-separated list of subprotocol names, in the order of preference. - type: string - websocketHeader-Sec-WebSocket-Version-Type: - description: Header value for secure WebSocket request and response. Carries the WebSocket protocol version to be used. - type: string -- GitLab From b8e3135836dd7b641c9116794152b43bb9cb6f82 Mon Sep 17 00:00:00 2001 From: "U-ERICSSON\\ETHBLL" Date: Sun, 2 Jan 2022 19:34:54 +0100 Subject: [PATCH 11/21] add back yaml 2 --- OpenAPI/5gcNrm.yaml | 2185 +++++++++++++++++++++++++++++ OpenAPI/PerDataFileReportMnS.yaml | 13 + OpenAPI/PerMeasJobCtlMnS.yaml | 280 ++++ OpenAPI/PerThresMonMnS.yaml | 102 ++ OpenAPI/PerfDataStreamingMnS.yaml | 363 +++++ OpenAPI/comDefs.yaml | 84 ++ OpenAPI/coslaNrm.yaml | 168 +++ OpenAPI/faultMnS.yaml | 1144 +++++++++++++++ OpenAPI/genericNrm.yaml | 1606 +++++++++++++++++++++ OpenAPI/heartbeatNtf.yaml | 23 + OpenAPI/nrNrm.yaml | 1905 +++++++++++++++++++++++++ OpenAPI/provMnS.yaml | 579 ++++++++ OpenAPI/sliceNrm.yaml | 632 +++++++++ OpenAPI/streamingDataMnS.yaml | 453 ++++++ 14 files changed, 9537 insertions(+) create mode 100644 OpenAPI/5gcNrm.yaml create mode 100644 OpenAPI/PerDataFileReportMnS.yaml create mode 100644 OpenAPI/PerMeasJobCtlMnS.yaml create mode 100644 OpenAPI/PerThresMonMnS.yaml create mode 100644 OpenAPI/PerfDataStreamingMnS.yaml create mode 100644 OpenAPI/comDefs.yaml create mode 100644 OpenAPI/coslaNrm.yaml create mode 100644 OpenAPI/faultMnS.yaml create mode 100644 OpenAPI/genericNrm.yaml create mode 100644 OpenAPI/heartbeatNtf.yaml create mode 100644 OpenAPI/nrNrm.yaml create mode 100644 OpenAPI/provMnS.yaml create mode 100644 OpenAPI/sliceNrm.yaml create mode 100644 OpenAPI/streamingDataMnS.yaml diff --git a/OpenAPI/5gcNrm.yaml b/OpenAPI/5gcNrm.yaml new file mode 100644 index 000000000..e4c4b2619 --- /dev/null +++ b/OpenAPI/5gcNrm.yaml @@ -0,0 +1,2185 @@ +openapi: 3.0.1 +info: + title: 3GPP 5GC NRM + version: 17.4.0 + description: >- + OAS 3.0.1 specification of the 5GC NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.541; 5G NRM, 5GC NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + AmfIdentifier: + type: object + description: 'AmfIdentifier comprise of amfRegionId, amfSetId and amfPointer' + properties: + amfRegionId: + $ref: '#/components/schemas/AmfRegionId' + amfSetId: + $ref: '#/components/schemas/AmfSetId' + amfPointer: + $ref: '#/components/schemas/AmfPointer' + AmfRegionId: + type: integer + description: AmfRegionId is defined in TS 23.003 + maximum: 255 + AmfSetId: + type: string + description: AmfSetId is defined in TS 23.003 + maximum: 1023 + AmfPointer: + type: integer + description: AmfPointer is defined in TS 23.003 + maximum: 63 + IpEndPoint: + type: object + properties: + ipv4Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + ipv6Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + ipv6Prefix: + $ref: 'genericNrm.yaml#/components/schemas/Ipv6Prefix' + transport: + $ref: 'genericNrm.yaml#/components/schemas/TransportProtocol' + port: + type: integer + NFProfileList: + type: array + description: List of NF profile + items: + $ref: '#/components/schemas/NFProfile' + NFProfile: + type: object + description: 'NF profile stored in NRF, defined in TS 29.510' + properties: + nFInstanceId: + type: string + description: uuid of NF instance + nFType: + $ref: 'genericNrm.yaml#/components/schemas/NFType' + nFStatus: + $ref: '#/components/schemas/NFStatus' + plmn: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + sNssais: + $ref: 'nrNrm.yaml#/components/schemas/Snssai' + fqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + nfServices: + type: array + items: + $ref: '#/components/schemas/NFService' + NFService: + type: object + description: NF Service is defined in TS 29.510 + properties: + serviceInstanceId: + type: string + serviceName: + type: string + version: + type: string + schema: + type: string + fqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + ipEndPoints: + type: array + items: + $ref: '#/components/schemas/IpEndPoint' + apiPrfix: + type: string + allowedPlmns: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + allowedNfTypes: + type: array + items: + $ref: 'genericNrm.yaml#/components/schemas/NFType' + allowedNssais: + type: array + items: + $ref: 'nrNrm.yaml#/components/schemas/Snssai' + NFStatus: + type: string + description: any of enumrated value + enum: + - REGISTERED + - SUSPENDED + CNSIIdList: + type: array + items: + $ref: '#/components/schemas/CNSIId' + CNSIId: + type: string + description: CNSI Id is defined in TS 29.531, only for Core Network + TACList: + type: array + items: + $ref: 'nrNrm.yaml#/components/schemas/NrTac' + WeightFactor: + type: integer + UdmInfo: + type: object + properties: + nFSrvGroupId: + type: string + AusfInfo: + type: object + properties: + nFSrvGroupId: + type: string + UpfInfo: + type: object + properties: + smfServingAreas: + type: string + AmfInfo: + type: object + properties: + priority: + type: integer + SupportedDataSetId: + type: string + description: any of enumrated value + enum: + - SUBSCRIPTION + - POLICY + - EXPOSURE + - APPLICATION + Udrinfo: + type: object + properties: + supportedDataSetIds: + type: array + items: + $ref: '#/components/schemas/SupportedDataSetId' + nFSrvGroupId: + type: string + NFInfo: + oneOf: + - $ref: '#/components/schemas/UdmInfo' + - $ref: '#/components/schemas/AusfInfo' + - $ref: '#/components/schemas/UpfInfo' + - $ref: '#/components/schemas/AmfInfo' + - $ref: '#/components/schemas/Udrinfo' + ManagedNFProfile: + type: object + properties: + nfInstanceID: + type: string + nfType: + $ref: 'genericNrm.yaml#/components/schemas/NFType' + authzInfo: + type: string + hostAddr: + $ref: 'genericNrm.yaml#/components/schemas/HostAddr' + locality: + type: string + nFInfo: + $ref: '#/components/schemas/NFInfo' + capacity: + type: integer + SEPPType: + type: string + description: any of enumrated value + enum: + - CSEPP + - PSEPP + SupportedFunc: + type: object + properties: + function: + type: string + policy: + type: string + SupportedFuncList: + type: array + items: + $ref: '#/components/schemas/SupportedFunc' + CommModelType: + type: string + description: any of enumrated value + enum: + - DIRECT_COMMUNICATION_WO_NRF + - DIRECT_COMMUNICATION_WITH_NRF + - INDIRECT_COMMUNICATION_WO_DEDICATED_DISCOVERY + - INDIRECT_COMMUNICATION_WITH_DEDICATED_DISCOVERY + CommModel: + type: object + properties: + groupId: + type: integer + commModelType: + $ref: '#/components/schemas/CommModelType' + targetNFServiceList: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + commModelConfiguration: + type: string + CommModelList: + type: array + items: + $ref: '#/components/schemas/CommModel' + CapabilityList: + type: array + items: + type: string + FiveQiDscpMapping: + type: object + properties: + fiveQIValues: + type: array + items: + type: integer + dscp: + type: integer + NetworkSliceInfo: + type: object + properties: + sNSSAI: + $ref: 'nrNrm.yaml#/components/schemas/Snssai' + cNSIId: + $ref: '#/components/schemas/CNSIId' + networkSliceRef: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + NetworkSliceInfoList: + type: array + items: + $ref: '#/components/schemas/NetworkSliceInfo' + + + PacketErrorRate: + type: object + properties: + scalar: + type: integer + exponent: + type: integer + + + + GtpUPathDelayThresholdsType: + type: object + properties: + n3AveragePacketDelayThreshold: + type: integer + n3MinPacketDelayThreshold: + type: integer + n3MaxPacketDelayThreshold: + type: integer + n9AveragePacketDelayThreshold: + type: integer + n9MinPacketDelayThreshold: + type: integer + n9MaxPacketDelayThreshold: + type: integer + QFPacketDelayThresholdsType: + type: object + properties: + thresholdDl: + type: integer + thresholdUl: + type: integer + thresholdRtt: + type: integer + + QosData: + type: object + properties: + qosId: + type: string + fiveQIValue: + type: integer + maxbrUl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxbrDl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrUl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrDl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/BitRateRm' + arp: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Arp' + qosNotificationControl: + type: boolean + reflectiveQos: + type: boolean + sharingKeyDl: + type: string + sharingKeyUl: + type: string + maxPacketLossRateDl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPacketLossRateUl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + extMaxDataBurstVol: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + + QosDataList: + type: array + items: + $ref: '#/components/schemas/QosData' + + SteeringMode: + type: object + properties: + steerModeValue: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteerModeValue' + active: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessType' + standby: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessTypeRm' + threeGLoad: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Uinteger' + prioAcc: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessType' + + TrafficControlData: + type: object + properties: + tcId: + type: string + flowStatus: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus' + redirectInfo: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' + addRedirectInfo: + type: array + items: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' + minItems: 1 + muteNotif: + type: boolean + trafficSteeringPolIdDl: + type: string + nullable: true + trafficSteeringPolIdUl: + type: string + nullable: true + routeToLocs: + type: array + items: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + traffCorreInd: + type: boolean + upPathChgEvent: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' + steerFun: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringFunctionality' + steerModeDl: + $ref: '#/components/schemas/SteeringMode' + steerModeUl: + $ref: '#/components/schemas/SteeringMode' + mulAccCtrl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/MulticastAccessControl' + + TrafficControlDataList: + type: array + items: + $ref: '#/components/schemas/TrafficControlData' + + PccRule: + type: object + properties: + pccRuleId: + type: string + description: Univocally identifies the PCC rule within a PDU session. + flowInfoList: + type: array + items: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' + applicationId: + type: string + appDescriptor: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ApplicationDescriptor' + contentVersion: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' + precedence: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/Uinteger' + afSigProtocol: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' + isAppRelocatable: + type: boolean + isUeAddrPreserved: + type: boolean + qosData: + type: array + items: + $ref: '#/components/schemas/QosDataList' + altQosParams: + type: array + items: + $ref: '#/components/schemas/QosDataList' + trafficControlData: + type: array + items: + $ref: '#/components/schemas/TrafficControlDataList' + conditionData: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ConditionData' + tscaiInputDl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + + SnssaiInfo: + type: object + properties: + plmnInfo: + $ref: 'nrNrm.yaml#/components/schemas/PlmnInfo' + administrativeState: + $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' + + NsacfInfoSnssai: + type: object + properties: + SnssaiInfo: + $ref: '#/components/schemas/SnssaiInfo' + isSubjectToNsac: + type: boolean + maxNumberofUEs: + type: integer + eACMode: + type: string + enum: + - INACTIVE + - ACTIVE + activeEacThreshhold: + type: integer + deactiveEacThreshhold: + type: integer + numberofUEs: + type: integer + uEIdList: + type: array + items: + type: string + + +#-------- Definition of concrete IOCs -------------------------------------------- + + SubNetwork-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + ExternalAmfFunction: + $ref: '#/components/schemas/ExternalAmfFunction-Multiple' + ExternalNrfFunction: + $ref: '#/components/schemas/ExternalNrfFunction-Multiple' + ExternalNssfFunction: + $ref: '#/components/schemas/ExternalNssfFunction-Multiple' + AmfSet: + $ref: '#/components/schemas/AmfSet-Multiple' + AmfRegion: + $ref: '#/components/schemas/AmfRegion-Multiple' + Configurable5QISet: + $ref: '#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '#/components/schemas/Dynamic5QISet-Multiple' + + ManagedElement-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' + - type: object + properties: + AmfFunction: + $ref: '#/components/schemas/AmfFunction-Multiple' + SmfFunction: + $ref: '#/components/schemas/SmfFunction-Multiple' + UpfFunction: + $ref: '#/components/schemas/UpfFunction-Multiple' + N3iwfFunction: + $ref: '#/components/schemas/N3iwfFunction-Multiple' + PcfFunction: + $ref: '#/components/schemas/PcfFunction-Multiple' + AusfFunction: + $ref: '#/components/schemas/AusfFunction-Multiple' + UdmFunction: + $ref: '#/components/schemas/UdmFunction-Multiple' + UdrFunction: + $ref: '#/components/schemas/UdrFunction-Multiple' + UdsfFunction: + $ref: '#/components/schemas/UdsfFunction-Multiple' + NrfFunction: + $ref: '#/components/schemas/NrfFunction-Multiple' + NssfFunction: + $ref: '#/components/schemas/NssfFunction-Multiple' + SmsfFunction: + $ref: '#/components/schemas/SmsfFunction-Multiple' + LmfFunction: + $ref: '#/components/schemas/LmfFunction-Multiple' + NgeirFunction: + $ref: '#/components/schemas/NgeirFunction-Multiple' + SeppFunction: + $ref: '#/components/schemas/SeppFunction-Multiple' + NwdafFunction: + $ref: '#/components/schemas/NwdafFunction-Multiple' + ScpFunction: + $ref: '#/components/schemas/ScpFunction-Multiple' + NefFunction: + $ref: '#/components/schemas/NefFunction-Multiple' + Configurable5QISet: + $ref: '#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '#/components/schemas/Dynamic5QISet-Multiple' + + AmfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + amfIdentifier: + $ref: '#/components/schemas/AmfIdentifier' + sBIFqdn: + type: string + weightFactor: + $ref: '#/components/schemas/WeightFactor' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + amfSet: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N2: + $ref: '#/components/schemas/EP_N2-Multiple' + EP_N8: + $ref: '#/components/schemas/EP_N8-Multiple' + EP_N11: + $ref: '#/components/schemas/EP_N11-Multiple' + EP_N12: + $ref: '#/components/schemas/EP_N12-Multiple' + EP_N14: + $ref: '#/components/schemas/EP_N14-Multiple' + EP_N15: + $ref: '#/components/schemas/EP_N15-Multiple' + EP_N17: + $ref: '#/components/schemas/EP_N17-Multiple' + EP_N20: + $ref: '#/components/schemas/EP_N20-Multiple' + EP_N22: + $ref: '#/components/schemas/EP_N22-Multiple' + EP_N26: + $ref: '#/components/schemas/EP_N26-Multiple' + EP_NLS: + $ref: '#/components/schemas/EP_NLS-Multiple' + EP_NLG: + $ref: '#/components/schemas/EP_NLG-Multiple' + AmfSet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + amfSetId: + $ref: '#/components/schemas/AmfSetId' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + AmfRegion-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + amfRegionId: + $ref: '#/components/schemas/AmfRegionId' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + SmfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + configurable5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + EP_N7: + $ref: '#/components/schemas/EP_N7-Multiple' + EP_N10: + $ref: '#/components/schemas/EP_N10-Multiple' + EP_N11: + $ref: '#/components/schemas/EP_N11-Multiple' + EP_N16: + $ref: '#/components/schemas/EP_N16-Multiple' + EP_S5C: + $ref: '#/components/schemas/EP_S5C-Multiple' + FiveQiDscpMappingSet: + $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' + GtpUPathQoSMonitoringControl: + $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' + QFQoSMonitoringControl: + $ref: '#/components/schemas/QFQoSMonitoringControl-Single' + PredefinedPccRuleSet: + $ref: '#/components/schemas/PredefinedPccRuleSet-Single' + + UpfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N3: + $ref: '#/components/schemas/EP_N3-Multiple' + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + EP_N6: + $ref: '#/components/schemas/EP_N6-Multiple' + EP_N9: + $ref: '#/components/schemas/EP_N9-Multiple' + EP_S5U: + $ref: '#/components/schemas/EP_S5U-Multiple' + N3iwfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N3: + $ref: '#/components/schemas/EP_N3-Multiple' + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + PcfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + configurable5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N5: + $ref: '#/components/schemas/EP_N5-Multiple' + EP_N7: + $ref: '#/components/schemas/EP_N7-Multiple' + EP_N15: + $ref: '#/components/schemas/EP_N15-Multiple' + EP_N16: + $ref: '#/components/schemas/EP_N16-Multiple' + EP_Rx: + $ref: '#/components/schemas/EP_Rx-Multiple' + PredefinedPccRuleSet: + $ref: '#/components/schemas/PredefinedPccRuleSet-Single' + + AusfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N12: + $ref: '#/components/schemas/EP_N12-Multiple' + EP_N13: + $ref: '#/components/schemas/EP_N13-Multiple' + UdmFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N8: + $ref: '#/components/schemas/EP_N8-Multiple' + EP_N10: + $ref: '#/components/schemas/EP_N10-Multiple' + EP_N13: + $ref: '#/components/schemas/EP_N13-Multiple' + UdrFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + UdsfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + NrfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + nFProfileList: + $ref: '#/components/schemas/NFProfileList' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N27: + $ref: '#/components/schemas/EP_N27-Multiple' + NssfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + nFProfileList: + $ref: '#/components/schemas/NFProfileList' + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N22: + $ref: '#/components/schemas/EP_N22-Multiple' + EP_N31: + $ref: '#/components/schemas/EP_N31-Multiple' + SmsfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N20: + $ref: '#/components/schemas/EP_N20-Multiple' + EP_N21: + $ref: '#/components/schemas/EP_N21-Multiple' + EP_MAP_SMSC: + $ref: '#/components/schemas/EP_MAP_SMSC-Multiple' + LmfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_NLS: + $ref: '#/components/schemas/EP_NLS-Multiple' + NgeirFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N17: + $ref: '#/components/schemas/EP_N17-Multiple' + SeppFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnId: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + sEPPType: + $ref: '#/components/schemas/SEPPType' + sEPPId: + type: integer + fqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N32: + $ref: '#/components/schemas/EP_N32-Multiple' + NwdafFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + networkSliceInfoList: + $ref: '#/components/schemas/NetworkSliceInfoList' + + ScpFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + supportedFuncList: + $ref: '#/components/schemas/SupportedFuncList' + address: + $ref: 'genericNrm.yaml#/components/schemas/HostAddr' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + NefFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + sBIFqdn: + type: string + snssaiList: + $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + capabilityList: + $ref: '#/components/schemas/CapabilityList' + isCAPIFSup: + type: boolean + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N33: + $ref: '#/components/schemas/EP_N33-Multiple' + NsacfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + nsacfInfoSnssai: + type: array + items: + $ref: '#/components/schemas/NsacfInfoSnssai' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N60: + $ref: '#/components/schemas/EP_N60-Multiple' + + DDNMFFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnId: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N64: + $ref: '#/components/schemas/EP_N64-Multiple' + EP_N65: + $ref: '#/components/schemas/EP_N65-Multiple' + EP_N66: + $ref: '#/components/schemas/EP_N66-Multiple' + + ExternalAmfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + amfIdentifier: + $ref: '#/components/schemas/AmfIdentifier' + ExternalNrfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + ExternalNssfFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + ExternalSeppFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnId: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + sEPPId: + type: integer + fqdn: + $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + + + EP_N2-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N3-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + epTransportRefs: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + EP_N4-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N5-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N6-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N7-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N8-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N9-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N10-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N11-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N12-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N13-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N14-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N15-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N16-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N17-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N20-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N21-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N22-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N26-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N27-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + + EP_N31-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N32-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + remotePlmnId: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + remoteSeppAddress: + $ref: 'genericNrm.yaml#/components/schemas/HostAddr' + remoteSeppId: + type: integer + n32cParas: + type: string + n32fPolicy: + type: string + withIPX: + type: boolean + EP_N33-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_S5C-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_S5U-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_Rx-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_MAP_SMSC-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_NLS-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_NLG-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N60-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N64-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N65-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + EP_N66-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' + + FiveQiDscpMappingSet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + FiveQiDscpMappingList: + type: array + items: + $ref: '#/components/schemas/FiveQiDscpMapping' + + FiveQICharacteristics-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - type: object + properties: + fiveQIValue: + type: integer + resourceType: + type: string + enum: + - GBR + - NonGBR + priorityLevel: + type: integer + packetDelayBudget: + type: integer + packetErrorRate: + $ref: '#/components/schemas/PacketErrorRate' + averagingWindow: + type: integer + maximumDataBurstVolume: + type: integer + FiveQICharacteristics-Multiple: + type: array + items: + $ref: '#/components/schemas/FiveQICharacteristics-Single' + Configurable5QISet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + configurable5QIs: + type: array + items: + $ref: '#/components/schemas/FiveQICharacteristics-Multiple' + + Dynamic5QISet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + dynamic5QIs: + type: array + items: + $ref: '#/components/schemas/FiveQICharacteristics-Multiple' + + GtpUPathQoSMonitoringControl-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + gtpUPathQoSMonitoringState: + type: string + enum: + - ENABLED + - DISABLED + gtpUPathMonitoredSNSSAIs: + type: array + items: + $ref: 'nrNrm.yaml#/components/schemas/Snssai' + monitoredDSCPs: + type: array + items: + type: integer + minimum: 0 + maximum: 255 + isEventTriggeredGtpUPathMonitoringSupported: + type: boolean + isPeriodicGtpUMonitoringSupported: + type: boolean + isImmediateGtpUMonitoringSupported: + type: boolean + gtpUPathDelayThresholds: + $ref: '#/components/schemas/GtpUPathDelayThresholdsType' + gtpUPathMinimumWaitTime: + type: integer + gtpUPathMeasurementPeriod: + type: integer + + QFQoSMonitoringControl-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + qFQoSMonitoringState: + type: string + enum: + - ENABLED + - DISABLED + qFMonitoredSNSSAIs: + type: array + items: + $ref: 'nrNrm.yaml#/components/schemas/Snssai' + qFMonitored5QIs: + type: array + items: + type: integer + minimum: 0 + maximum: 255 + isEventTriggeredQFMonitoringSupported: + type: boolean + isPeriodicQFMonitoringSupported: + type: boolean + isSessionReleasedQFMonitoringSupported: + type: boolean + qFPacketDelayThresholds: + $ref: '#/components/schemas/QFPacketDelayThresholdsType' + qFMinimumWaitTime: + type: integer + qFMeasurementPeriod: + type: integer + + PredefinedPccRuleSet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + predefinedPccRules: + type: array + items: + $ref: '#/components/schemas/PccRule' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + ManagedElement-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedElement-Single' + AmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfFunction-Single' + SmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SmfFunction-Single' + UpfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UpfFunction-Single' + N3iwfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/N3iwfFunction-Single' + PcfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/PcfFunction-Single' + AusfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AusfFunction-Single' + UdmFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdmFunction-Single' + UdrFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdrFunction-Single' + UdsfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdsfFunction-Single' + NrfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NrfFunction-Single' + NssfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NssfFunction-Single' + SmsfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SmsfFunction-Single' + LmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/LmfFunction-Single' + NgeirFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NgeirFunction-Single' + SeppFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SeppFunction-Single' + NwdafFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NwdafFunction-Single' + ScpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ScpFunction-Single' + NefFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NefFunction-Single' + + NsacfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NsacfFunction-Single' + + ExternalAmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalAmfFunction-Single' + ExternalNrfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalNrfFunction-Single' + ExternalNssfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalNssfFunction-Single' + ExternalSeppFunction-Nultiple: + type: array + items: + $ref: '#/components/schemas/ExternalSeppFunction-Single' + + AmfSet-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfSet-Single' + AmfRegion-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfRegion-Single' + + EP_N2-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N2-Single' + EP_N3-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N3-Single' + EP_N4-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N4-Single' + EP_N5-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N5-Single' + EP_N6-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N6-Single' + EP_N7-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N7-Single' + EP_N8-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N8-Single' + EP_N9-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N9-Single' + EP_N10-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N10-Single' + EP_N11-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N11-Single' + EP_N12-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N12-Single' + EP_N13-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N13-Single' + EP_N14-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N14-Single' + EP_N15-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N15-Single' + EP_N16-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N16-Single' + EP_N17-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N17-Single' + + EP_N20-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N20-Single' + EP_N21-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N21-Single' + EP_N22-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N22-Single' + + EP_N26-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N26-Single' + EP_N27-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N27-Single' + + EP_N31-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N31-Single' + EP_N32-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N32-Single' + EP_N33-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N33-Single' + EP_S5C-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_S5C-Single' + EP_S5U-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_S5U-Single' + EP_Rx-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Rx-Single' + EP_MAP_SMSC-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_MAP_SMSC-Single' + EP_NLS-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NLS-Single' + EP_NLG-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NLG-Single' + EP_N60-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N60-Single' + EP_N64-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N64-Single' + EP_N65-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N65-Single' + EP_N66-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N66-Single' + Configurable5QISet-Multiple: + type: array + items: + $ref: '#/components/schemas/Configurable5QISet-Single' + Dynamic5QISet-Multiple: + type: array + items: + $ref: '#/components/schemas/Dynamic5QISet-Single' + + + +#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- + + resources-5gcNrm: + oneOf: + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' + - $ref: '#/components/schemas/AmfFunction-Single' + - $ref: '#/components/schemas/SmfFunction-Single' + - $ref: '#/components/schemas/UpfFunction-Single' + - $ref: '#/components/schemas/N3iwfFunction-Single' + - $ref: '#/components/schemas/PcfFunction-Single' + - $ref: '#/components/schemas/AusfFunction-Single' + - $ref: '#/components/schemas/UdmFunction-Single' + - $ref: '#/components/schemas/UdrFunction-Single' + - $ref: '#/components/schemas/UdsfFunction-Single' + - $ref: '#/components/schemas/NrfFunction-Single' + - $ref: '#/components/schemas/NssfFunction-Single' + - $ref: '#/components/schemas/SmsfFunction-Single' + - $ref: '#/components/schemas/LmfFunction-Single' + - $ref: '#/components/schemas/NgeirFunction-Single' + - $ref: '#/components/schemas/SeppFunction-Single' + - $ref: '#/components/schemas/NwdafFunction-Single' + - $ref: '#/components/schemas/ScpFunction-Single' + - $ref: '#/components/schemas/NefFunction-Single' + - $ref: '#/components/schemas/NsacfFunction-Single' + + - $ref: '#/components/schemas/ExternalAmfFunction-Single' + - $ref: '#/components/schemas/ExternalNrfFunction-Single' + - $ref: '#/components/schemas/ExternalNssfFunction-Single' + - $ref: '#/components/schemas/ExternalSeppFunction-Single' + + - $ref: '#/components/schemas/AmfSet-Single' + - $ref: '#/components/schemas/AmfRegion-Single' + - $ref: '#/components/schemas/QFQoSMonitoringControl-Single' + - $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' + + - $ref: '#/components/schemas/EP_N2-Single' + - $ref: '#/components/schemas/EP_N3-Single' + - $ref: '#/components/schemas/EP_N4-Single' + - $ref: '#/components/schemas/EP_N5-Single' + - $ref: '#/components/schemas/EP_N6-Single' + - $ref: '#/components/schemas/EP_N7-Single' + - $ref: '#/components/schemas/EP_N8-Single' + - $ref: '#/components/schemas/EP_N9-Single' + - $ref: '#/components/schemas/EP_N10-Single' + - $ref: '#/components/schemas/EP_N11-Single' + - $ref: '#/components/schemas/EP_N12-Single' + - $ref: '#/components/schemas/EP_N13-Single' + - $ref: '#/components/schemas/EP_N14-Single' + - $ref: '#/components/schemas/EP_N15-Single' + - $ref: '#/components/schemas/EP_N16-Single' + - $ref: '#/components/schemas/EP_N17-Single' + + - $ref: '#/components/schemas/EP_N20-Single' + - $ref: '#/components/schemas/EP_N21-Single' + - $ref: '#/components/schemas/EP_N22-Single' + + - $ref: '#/components/schemas/EP_N26-Single' + - $ref: '#/components/schemas/EP_N27-Single' + + - $ref: '#/components/schemas/EP_N31-Single' + - $ref: '#/components/schemas/EP_N32-Single' + - $ref: '#/components/schemas/EP_N33-Single' + - $ref: '#/components/schemas/EP_N60-Single' + + - $ref: '#/components/schemas/EP_S5C-Single' + - $ref: '#/components/schemas/EP_S5U-Single' + - $ref: '#/components/schemas/EP_Rx-Single' + - $ref: '#/components/schemas/EP_MAP_SMSC-Single' + - $ref: '#/components/schemas/EP_NLS-Single' + - $ref: '#/components/schemas/EP_NLG-Single' + - $ref: '#/components/schemas/Configurable5QISet-Single' + - $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' + - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' + - $ref: '#/components/schemas/Dynamic5QISet-Single' diff --git a/OpenAPI/PerDataFileReportMnS.yaml b/OpenAPI/PerDataFileReportMnS.yaml new file mode 100644 index 000000000..83fd77acb --- /dev/null +++ b/OpenAPI/PerDataFileReportMnS.yaml @@ -0,0 +1,13 @@ +openapi: 3.0.1 +info: + title: TS 28.532 File data reporting Service + version: 16.6.0 + description: >- + OAS 3.0.1 specification of the File data reporting Management Service © 2020, + 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All + rights reserved. +externalDocs: + description: 3GPP TS 28.532 V16.5.0; Generic management services + url: 'http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/' +paths: {} + diff --git a/OpenAPI/PerMeasJobCtlMnS.yaml b/OpenAPI/PerMeasJobCtlMnS.yaml new file mode 100644 index 000000000..b6abe58b2 --- /dev/null +++ b/OpenAPI/PerMeasJobCtlMnS.yaml @@ -0,0 +1,280 @@ +openapi: 3.0.1 +info: + title: TS 28.550 Performance Measurement Job Control Service + version: 16.5.0 + description: >- + OAS 3.0.1 specification of the Performance Measurement Job Control Service + @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.550 V16.5.0; Performance assurance + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.550/ +servers: + - url: 'http://{URI-DN-prefix}/{root}/PerfMeasJobCtrlMnS/v1650/{LDN-first-part}' + variables: + URI-DN-prefix: + description: See subclause 4.4 of TS 32.158 + default: example.com + root: + description: See subclause 4.4 of TS 32.158 + default: 3GPPManagement + LDN-first-part: + description: See subclause 4.4 of TS 32.158 + default: '' +paths: + /measJobs: + post: + summary: Create a measurement job + description: To create a measurement job the representation of the measurement job is POSTed on the /measJobs collection resource. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/measJobCreation-RequestType' + responses: + '201': + description: Success case ("201 Created"). The representation of the newly created measurement job resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/measJobCreation-ResponseType' + '202': + description: Partial success case ("202 Partically created"). The representation of the newly created measurement job resource with unsupported list shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/measJobCreation-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + get: + summary: Read resources of measurement jobs + description: 'With HTTP GET, resources of measurement jobs are read. The resources to be read are identified with the path component (base resource) and the query component (jobIdList) of the URI. The fields query component allows to select the resource properties to be returned.' + parameters: + - name: jobIdList + in: query + description: This parameter identifies the list of jobId to select the resources from the collection resources identified with the path component of the URI. + required: true + schema: + type: array + items: + type: string + responses: + '200': + description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.' + content: + application/json: + schema: + $ref: '#/components/schemas/measJobsRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + '/measJobs/{jobId}': + get: + summary: Read resource of a single measurement job + description: 'With HTTP GET, resource of a measurement job is read. The resource to be read is identified with the path component of the URI.' + parameters: + - name: jobId + in: path + description: Identifies the measurement job to be read. + required: true + schema: + $ref: '#/components/schemas/uri-Type' + responses: + '200': + description: 'Success case ("200 OK"). The resource identified in the path for retrieval is returned in the response message body. ' + content: + application/json: + schema: + $ref: '#/components/schemas/measJobsRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + delete: + summary: Delete a single measurement job + description: The measurement job is deleted by deleting the corresponding measurement job resource. The resource to be deleted is identified with the path component of the URI. + parameters: + - name: jobId + in: path + description: Identifies the measurement job to be deleted. + required: true + schema: + $ref: '#/components/schemas/uri-Type' + responses: + '204': + description: Success case ("204 No Content"). The measurement job resource has been deleted. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' +components: + schemas: + dateTime-Type: + type: string + format: date-Time + uri-Type: + type: string + measJobCreation-RequestType: + type: object + properties: + iOCName: + type: string + iOCInstanceList: + type: array + items: + $ref: '#/components/schemas/uri-Type' + measurementCategoryList: + type: array + items: + type: string + reportingMethod: + $ref: '#/components/schemas/reportingMethod-Type' + granularityPeriod: + type: integer + reportingPeriod: + type: integer + startTime: + $ref: '#/components/schemas/dateTime-Type' + stopTime: + $ref: '#/components/schemas/dateTime-Type' + schedule: + $ref: '#/components/schemas/schedule-Type' + streamTarget: + type: string + priority: + $ref: '#/components/schemas/priority-Type' + reliability: + type: string + measJobCreation-ResponseType: + type: object + properties: + unsupportedList: + type: array + items: + $ref: '#/components/schemas/unsupportedMeas-Type' + measJobsRetrieval-ResponseType: + type: object + properties: + jobInfoList: + type: array + items: + $ref: '#/components/schemas/measJobInfo-ResourceType' + error-ResponseType: + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + measJobInfo-ResourceType: + type: object + properties: + href: + $ref: '#/components/schemas/uri-Type' + iOCName: + type: string + iOCInstanceList: + type: array + items: + $ref: '#/components/schemas/uri-Type' + measurementCategoryList: + type: array + items: + type: string + reportingMethod: + $ref: '#/components/schemas/reportingMethod-Type' + granularityPeriod: + type: integer + reportingPeriod: + type: integer + startTime: + $ref: '#/components/schemas/dateTime-Type' + stopTime: + $ref: '#/components/schemas/dateTime-Type' + schedule: + $ref: '#/components/schemas/schedule-Type' + streamTarget: + type: string + priority: + $ref: '#/components/schemas/priority-Type' + reliability: + type: string + schedule-Type: + type: object + properties: + scheduleOption: + $ref: '#/components/schemas/scheduleOption-Type' + dailySchedule: + type: array + items: + $ref: '#/components/schemas/timeInterval-Type' + weeklySchedule: + type: array + items: + $ref: '#/components/schemas/scheduleOfDay-Type' + timeInterval-Type: + type: object + properties: + intervalStart: + type: string + format: Time + intervalEnd: + type: string + format: Time + scheduleOfDay-Type: + type: object + properties: + dayOfWeek: + $ref: '#/components/schemas/dayOfWeek-Type' + intervalsOfDay: + type: array + items: + $ref: '#/components/schemas/timeInterval-Type' + unsupportedMeas-Type: + type: object + properties: + iOCInstance: + $ref: '#/components/schemas/uri-Type' + measurementTypeName: + type: string + reason: + type: string + reportingMethod-Type: + type: string + enum: + - file + - streaming + priority-Type: + type: string + enum: + - low + - medium + - high + scheduleOption-Type: + type: string + enum: + - daily + - weekly + dayOfWeek-Type: + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday diff --git a/OpenAPI/PerThresMonMnS.yaml b/OpenAPI/PerThresMonMnS.yaml new file mode 100644 index 000000000..923640a11 --- /dev/null +++ b/OpenAPI/PerThresMonMnS.yaml @@ -0,0 +1,102 @@ +openapi: 3.0.1 +info: + title: TS 28.532 Performance Threshold Monitoring Service + version: 16.4.0 + description: OAS 3.0.1 specification of the Performance Threshold Monitoring Service +servers: + - url: 'http://{monitoringNotifTarget}' + variables: + monitoringNotifTarget: + description: >- + The open API server of the performance threshold monitoring service is + located in the consumer side, see monitoringNotifTarget attribute of + the IOC ThresholdMonitor defined in 3GPP TS 28.622 [11]. + default: example.com +paths: + /notificationSink: + post: + summary: Send notifications about performance threshold crossing + description: To send a notifyThresholdCrossing notification + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/notifyThresholdCrossing-NotifType' + responses: + '204': + description: >- + Success case ("204 No Content"). The notification is successfully + delivered. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' +components: + schemas: + dateTime-Type: + type: string + format: date-Time + uri-Type: + type: string + long-Type: + type: string + format: long + thresholdLevel-Type: + type: integer + measurementTypeName-Type: + type: string + measurementValue-Type: + type: string + additionalText-Type: + type: string + error-ResponseType: + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + header-Type: + description: Header used in notifications as notification header + type: object + properties: + uri: + $ref: '#/components/schemas/uri-Type' + notificationId: + $ref: '#/components/schemas/notificationId-Type' + notificationType: + $ref: '#/components/schemas/notificationType-Type' + eventTime: + $ref: '#/components/schemas/dateTime-Type' + notificationId-Type: + $ref: '#/components/schemas/long-Type' + notificationType-Type: + type: string + enum: + - notifyThresholdCrossing + notifyThresholdCrossing-NotifType: + type: object + properties: + header: + $ref: '#/components/schemas/header-Type' + body: + type: object + properties: + startOfMonitoringGP: + $ref: '#/components/schemas/dateTime-Type' + endOfMonitoringGP: + $ref: '#/components/schemas/dateTime-Type' + monitoredObjectInstance: + $ref: '#/components/schemas/uri-Type' + thresholdLevel: + $ref: '#/components/schemas/thresholdLevel-Type' + measurementTypeName: + $ref: '#/components/schemas/measurementTypeName-Type' + measurementValue: + $ref: '#/components/schemas/measurementValue-Type' + additionalText: + $ref: '#/components/schemas/additionalText-Type' diff --git a/OpenAPI/PerfDataStreamingMnS.yaml b/OpenAPI/PerfDataStreamingMnS.yaml new file mode 100644 index 000000000..e040e14c8 --- /dev/null +++ b/OpenAPI/PerfDataStreamingMnS.yaml @@ -0,0 +1,363 @@ +openapi: 3.0.1 +info: + title: TS 28.550 Performance Data Streaming Service + version: 16.3.0 + description: OAS 3.0.1 specification of the Performance Data Streaming Service +servers: + - url: 'http://{streamTarget}/PerfDataStreamMnS/v1630' + description: This URL is used for posting the set of information about streams supported on the connection between the producer and the consumer. + variables: + streamTarget: + description: 'The open API server of the performance data streaming service is located in the consumer side,and the “streamTarget” part corresponds to the streamTarget parameter provided in the createMeasurementJob operation (see clause 6.1.1.2) or the streamTarget attribute of the MOI of MeasurementControlor MeasurementReader, see 3GPP TS 28.622 [5]).' + default: example.com + - url: 'wss://{streamTarget}/PerfDataStreamMnS/v1630/streamingConnection' + description: This URL is used for establishing the WebSocket connection for the performance data streaming service. + variables: + streamTarget: + description: 'The open API server of the performance data streaming service is located in the consumer side,and the “streamTarget” part corresponds to the streamTarget parameter provided in the createMeasurementJob operation (see clause 6.1.1.2) or the streamTarget attribute of the MOI of MeasurementControlor MeasurementReader, see 3GPP TS 28.622 [5]).' + default: example.com +paths: + /streamInfoList: + post: + summary: The set of information about the streams sent from the producer to the consumer + description: To send the streamInfoList from the producer to the consumer + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoListPost-RequestType' + responses: + '201': + description: Success case ("201 Posted"). The streamInfoList is successfully posted. + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoListPost-ResponseType' + '202': + description: Partial success case ("202 Partially posted"). The representation of the posted resource on stream information. + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoListPost-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + get: + summary: Read resources of stream information from the streaming consumer + description: 'With HTTP GET, resources of stream information are read. The resources to be read are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be returned.' + parameters: + - name: streamIdList + in: query + description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. + required: true + schema: + type: array + items: + type: integer + responses: + '200': + description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.' + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' + '202': + description: Partial success case ("202 Partially retrieved"). The representation of the retrieved resources on stream information. + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + patch: + summary: Update resources of stream information to the streaming consumer + description: 'With HTTP PATCH, resources of stream information are to be updated. The resources to be updated are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be updated.' + parameters: + - name: streamIdList + in: query + description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. + required: true + schema: + type: array + items: + type: integer + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoToUpdate-RequestType' + responses: + '200': + description: Success case ("200 OK"). The resources selected by the query parameter are updated and returned in the response message body. + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoUpdate-ResponseType' + '202': + description: Partial success case ("202 Partially updated"). The representation of the updated resources on stream information + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoUpdate-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + delete: + summary: The information of streams to be deleted by the producer to the consumer + description: 'With HTTP DELETE, resources of stream information are to be deleted. The resources to be deleted are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be deleted.' + parameters: + - name: streamIdList + in: query + description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. + required: true + schema: + type: array + items: + type: integer + responses: + '204': + description: Success case ("204 No Content"). The stream information resource has been deleted. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + '/streamInfoList/{streamId}': + get: + summary: Read resource of the stream information from the streaming consumer + description: 'With HTTP GET, resource of stream information is read. The resource to be read is identified with the path component the URI.' + parameters: + - name: streamId + in: path + description: Identifies the stream for which the information is to be retrieved. + required: true + schema: + $ref: '#/components/schemas/uri-Type' + responses: + '200': + description: Success case ("200 OK"). The resource identified in the request for retrieval is returned in the response message body. + content: + application/json: + schema: + $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + patch: + summary: Update the resource of stream information to the streaming consumer + description: 'With HTTP PATCH, resource of stream information is to be updated. The resource to be updated is identified by the path component of the URI. ' + parameters: + - name: streamId + in: path + description: Identifies the stream for which the information is to be updated. + required: true + schema: + $ref: '#/components/schemas/uri-Type' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoToUpdate-RequestType' + responses: + '200': + description: Success case ("200 OK"). The resources identified by the path of the URI is updated and returned in the response message body. + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoUpdate-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + delete: + summary: The stream information to be deleted by the producer to the consumer + description: 'With HTTP DELETE, resource of stream information identified by the path component of the URI is to be deleted.' + parameters: + - name: streamId + in: path + description: Identifies the stream for which the information is to be deleted + required: true + schema: + $ref: '#/components/schemas/uri-Type' + responses: + '204': + description: Success case ("204 No Content"). The stream information resource has been deleted. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + /streamConnection: + get: + summary: The connection for streaming from the producer to the consumer + description: To establish the WebSocket connection between the producer and the consumer. The HTTP version of this operation shall not be earlier than HTTP/1.1 + parameters: + - in: header + name: Upgrade + required: true + schema: + $ref: '#/components/schemas/Upgrade-HeaderType' + - in: header + name: Connection + required: true + schema: + $ref: '#/components/schemas/Connection-HeaderType' + - in: header + name: Sec-WebSocket-Key + required: true + schema: + $ref: '#/components/schemas/Sec-WebSocket-Key-HeaderType' + - in: header + name: Sec-WebSocket-Version + required: true + schema: + $ref: '#/components/schemas/Sec-WebSocket-Version-HeaderType' + responses: + '101': + description: Success case ("101 Switching Protocols "). The connection has been successfully switched to WebSocket. The response message body is absent. + headers: + Upgrade: + schema: + $ref: '#/components/schemas/Upgrade-HeaderType' + Connection: + schema: + $ref: '#/components/schemas/Connection-HeaderType' + Sec-WebSocket-Accept-HeaderType: + schema: + $ref: '#/components/schemas/Sec-WebSocket-Accept-HeaderType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' +components: + schemas: + uri-Type: + type: string + streamInfoIn-Type: + type: object + properties: + streamId: + type: integer + iOCInstance: + $ref: '#/components/schemas/uri-Type' + measTypes: + type: array + items: + type: string + streamInfoOut-Type: + type: object + properties: + streamId: + $ref: '#/components/schemas/uri-Type' + iOCInstance: + $ref: '#/components/schemas/uri-Type' + measTypes: + type: array + items: + type: string + error-ResponseType: + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + streamInfoListPost-RequestType: + type: object + properties: + streamInfoList: + type: array + items: + $ref: '#/components/schemas/streamInfoIn-Type' + streamInfoListPost-ResponseType: + type: object + properties: + streamInfoListPosted: + type: array + items: + $ref: '#/components/schemas/streamInfoOut-Type' + streamInfoRetrieval-ResponseType: + type: object + properties: + streamInfoOut: + $ref: '#/components/schemas/streamInfoOut-Type' + listOfStreamInfoRetrieval-ResponseType: + type: object + properties: + listOfStreamInfoOut: + type: array + items: + $ref: '#/components/schemas/streamInfoOut-Type' + streamInfoToUpdatePropertyType: + type: object + properties: + iOCInstance: + description: 'The updated measured object instance, empty value means no update.' + allOf: + - $ref: '#/components/schemas/uri-Type' + measTypes: + description: 'The updated list of measurement type, empty value means no update.' + type: array + items: + type: string + streamInfoToUpdate-RequestType: + type: object + properties: + streamInfoToUpdate: + $ref: '#/components/schemas/streamInfoToUpdatePropertyType' + listOfStreamInfoToUpdate-RequestType: + type: object + properties: + listOfStreamInfoToUpdate: + type: array + items: + $ref: '#/components/schemas/streamInfoToUpdatePropertyType' + streamInfoUpdate-ResponseType: + type: object + properties: + streamInfoUpdated: + $ref: '#/components/schemas/streamInfoOut-Type' + listOfStreamInfoUpdate-ResponseType: + type: object + properties: + listOfStreamInfoUpdated: + type: array + items: + $ref: '#/components/schemas/streamInfoOut-Type' + Upgrade-HeaderType: + type: string + enum: + - websocket + Connection-HeaderType: + type: string + enum: + - Upgrade + Sec-WebSocket-Key-HeaderType: + type: string + Sec-WebSocket-Version-HeaderType: + type: string + Sec-WebSocket-Accept-HeaderType: + type: string diff --git a/OpenAPI/comDefs.yaml b/OpenAPI/comDefs.yaml new file mode 100644 index 000000000..04ab65161 --- /dev/null +++ b/OpenAPI/comDefs.yaml @@ -0,0 +1,84 @@ +openapi: 3.0.1 +info: + title: Common Type Definitions + version: 16.3.0 + description: >- + OAS 3.0.1 specification of common type definitions in the Generic NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623 V16.3.0; Generic NRM, Common Type Definitions + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: + Long: + type: string + format: long + Float: + type: string + format: float + DateTime: + type: string + format: date-Time + Dn: + type: string + Uri: + type: string + AttributeNameValuePairSet: + type: object + minProperties: 1 + AttributeValueChangeSet: + description: >- + The key in this map is the attribute name. The value of each key is an array. + When only one item is present in the array, it carries the new attribute + value. If two items are present, then the first item carries the old value + and the second item the new value. The items can be of any type including null. + type: object + additionalProperties: + type: array + minItems: 1 + maxItems: 2 + items: + nullable: true + Filter: + type: string + SystemDN: + type: string + NotificationId: + type: integer + NotificationHeader: + description: >- + Header used for all notifications types + type: object + required: + - uri + - notificationId + - notificationType + - eventTime + - systemDn + properties: + uri: + $ref: '#/components/schemas/Uri' + notificationId: + $ref: '#/components/schemas/NotificationId' + notificationType: + oneOf: + - $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes' + #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes' + # more to be added + eventTime: + $ref: '#/components/schemas/DateTime' + systemDN: + $ref: '#/components/schemas/SystemDN' + ErrorResponse: + description: >- + Default schema for the response message body in case the request + is not successful. + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string diff --git a/OpenAPI/coslaNrm.yaml b/OpenAPI/coslaNrm.yaml new file mode 100644 index 000000000..e6a0ef13a --- /dev/null +++ b/OpenAPI/coslaNrm.yaml @@ -0,0 +1,168 @@ +openapi: 3.0.2 + +info: + title: coslaNrm + version: 16.4.0 + description: + OAS 3.0.1 specification of the Cosla NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 28.536 V16.4.0; Cosla NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.536/ + +paths: {} + +components: + + schemas: + +#------------ Type definitions --------------------------------------------------- + + ControlLoopLifeCyclePhase: + type: string + enum: + - PREPARATION + - COMMISSIONING + - OPERATION + - DECOMMISSIONING + + ObservationTime: + type: integer + + AssuranceGoalStatusObserved: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceGoalStatusPredicted: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceTargetStatusObserved: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceTargetStatusPredicted: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceTarget: + type: object + properties: + assuranceTargetName: + type: string + assuranceTargetValue: + type: string + assuranceTargetStatusObserved: + $ref: '#/components/schemas/AssuranceTargetStatusObserved' + assuranceTargetStatusPredicted: + $ref: '#/components/schemas/AssuranceTargetStatusPredicted' + + AssuranceTargetList: + type: array + items: + $ref: '#/components/schemas/AssuranceTarget' + + +#-------- Definition of concrete IOCs -------------------------------------------- + + SubNetwork-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + AssuranceClosedControlLoop: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' + + ManagedElement-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' + - type: object + properties: + AssuranceClosedControlLoop: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' + + AssuranceClosedControlLoop-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + operationalState: + $ref: 'genericNrm.yaml#/components/schemas/OperationalState' + administrativeState: + $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' + controlLoopLifeCyclePhase: + $ref: '#/components/schemas/ControlLoopLifeCyclePhase' + AssuranceGoal: + $ref: '#/components/schemas/AssuranceGoal-Multiple' + + AssuranceGoal-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + observationTime: + $ref: '#/components/schemas/ObservationTime' + assuranceTargetList: + $ref: '#/components/schemas/AssuranceTargetList' + assuranceGoalStatusObserved: + $ref: '#/components/schemas/AssuranceGoalStatusObserved' + assuranceGoalStatusPredicted: + $ref: '#/components/schemas/AssuranceGoalStatusPredicted' + serviceProfileId: + type: string + sliceProfileId: + type: string + networkSliceRef: + $ref: 'comDefs.yaml#/components/schemas/Dn' + networkSliceSubnetRef: + $ref: 'comDefs.yaml#/components/schemas/Dn' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + AssuranceClosedControlLoop-Multiple: + type: array + items: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' + + AssuranceGoal-Multiple: + type: array + items: + $ref: '#/components/schemas/AssuranceGoal-Single' + +#------------ Definitions in TS 28.536 for TS 28.623 ----------------------------- + + resources-coslaNrm: + oneOf: + - $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' + - $ref: '#/components/schemas/AssuranceGoal-Single' + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' \ No newline at end of file diff --git a/OpenAPI/faultMnS.yaml b/OpenAPI/faultMnS.yaml new file mode 100644 index 000000000..499123b90 --- /dev/null +++ b/OpenAPI/faultMnS.yaml @@ -0,0 +1,1144 @@ +openapi: 3.0.1 +info: + title: Fault Supervision MnS + version: 16.4.0 + description: >- + OAS 3.0.1 definition of the Fault Supervision MnS + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.532 V16.4.0; Generic management services + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ +servers: + - url: '{MnSRoot}/FaultSupervisionMnS/{version}' + variables: + MnSRoot: + description: See subclause 4.4.3 of TS 32.158 + default: http://example.com/3GPPManagement + version: + description: Versi on number of the OpenAPI definition + default: XXX +paths: + /alarms: + get: + summary: Retrieve multiple alarms + description: >- + Retrieves the alarms identified by alarmAckState, baseObjectInstance + and filter. + parameters: + - name: alarmAckState + in: query + required: false + schema: + $ref: '#/components/schemas/AlarmAckState' + - name: baseObjectInstance + in: query + required: false + schema: + $ref: '#/components/schemas/Dn' + - name: filter + in: query + required: false + schema: + $ref: '#/components/schemas/Filter' + responses: + '200': + description: >- + Success case ("200 OK"). + Returns the alarms identified in the request. The alarmId is the key + of the map. + content: + application/json: + schema: + type: object + additionalProperties: + type: object + allOf: + - type: object + properties: + lastNotificationHeader: + $ref: '#/components/schemas/NotificationHeader' + - $ref: '#/components/schemas/AlarmRecord' + - type: object + properties: + comments: + $ref: '#/components/schemas/Comments' + default: + description: Response in case of error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + patch: + summary: 'Clear, acknowledge or unacknowledge multiple alarms' + description: >- + Clears, acknowledges or unacknowledges multiple alarms using patch. Depending + on which action is to be performed, different merge patch documents need + to be used. + requestBody: + description: >- + Patch documents for acknowledging and unacknowledging, or clearing multiple + alarms. The keys in the map are the alarmIds to be patched. + content: + application/merge-patch+json: + schema: + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/MergePatchAcknowledgeAlarm' + - type: object + additionalProperties: + $ref: '#/components/schemas/MergePatchClearAlarm' + responses: + '204': + description: >- + Success case ("204 No content"). + The response message body is empty. + default: + description: Response in case of error. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FailedAlarm' + /alarms/alarmCount: + get: + summary: Get the alarm count per perceived severity + parameters: + - name: alarmAckState + in: query + required: false + schema: + $ref: '#/components/schemas/AlarmAckState' + - name: filter + in: query + required: false + schema: + type: string + responses: + '200': + description: >- + Success case ("200 OK"). + The alarm count per perceived severity is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AlarmCount' + default: + description: Response in case of error. The error case needs rework. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /alarms/{alarmId}: + patch: + summary: 'Clear, acknowledge or unacknowledge a single alarm' + description: >- + Clears, acknowledges or uncknowldeges a single alarm by patching the alarm + information. A conditional acknowledge request based on the perceived + severity is not supported. + parameters: + - name: alarmId + in: path + description: Identifies the alarm to be patched. + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + oneOf: + - $ref: '#/components/schemas/MergePatchAcknowledgeAlarm' + - $ref: '#/components/schemas/MergePatchClearAlarm' + responses: + '204': + description: >- + Success case (204 No content). + The response message body is absent. + default: + description: Response in case of error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /alarms/{alarmId}/comments: + post: + summary: Add a comment to a single alarm + description: >- + Adds a comment to an alarm identified by alarmId. The id of the new comment + is allocated by the producer. + parameters: + - name: alarmId + in: path + description: Identifies the alarm to which the comment shall be added. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + responses: + '201': + description: >- + Success case (201 Created). + The representation of the newly created comment resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + headers: + Location: + description: URI of the newly created comment resource. + required: true + schema: + type: string + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /subscriptions: + post: + summary: Create a subscription + description: >- + To create a subscription the representation of the subscription is + POSTed on the /subscriptions collection resource. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + responses: + '201': + description: >- + Success case ("201 Created"). + The representation of the newly created subscription resource shall + be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + headers: + Location: + description: URI of the newly created subscription resource + required: true + schema: + type: string + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + callbacks: + notifyNewAlarm: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/NotifyNewAlarm' + - $ref: '#/components/schemas/NotifyNewSecAlarm' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyClearedAlarm: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyClearedAlarm' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyChangedAlarm: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyChangedAlarm' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyChangedAlarmGeneral: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/NotifyChangedAlarmGeneral' + - $ref: '#/components/schemas/NotifyChangedSecAlarmGeneral' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyCorrelatedNotificationChanged: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyCorrelatedNotificationChanged' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyAckStateChanged: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyAckStateChanged' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyComments: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyComments' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyPotentialFaultyAlarmList: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyPotentialFaultyAlarmList' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + notifyAlarmListRebuilt: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyAlarmListRebuilt' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /subscriptions/{subscriptionId}: + delete: + summary: Delete a subscription + description: >- + The subscription is deleted by deleting the corresponding subscription + resource. The resource to be deleted is identified with the path + component of the URI. + parameters: + - name: subscriptionId + in: path + description: Identifies the subscription to be deleted. + required: true + schema: + type: string + responses: + '204': + description: >- + Success case ("204 No Content"). + The subscription resource has been deleted. The response message body + is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + +components: + schemas: + + #---- Definitions to be moved to comDefs.yaml --------------------------------------# + + Long: + type: string + format: long + Float: + type: string + format: float + DateTime: + type: string + format: date-Time + + Dn: + type: string + Uri: + type: string + + AttributeNameValuePairSet: + type: object + minProperties: 1 + AttributeValueChangeSet: + description: >- + The key in this map is the attribute name. The value of each key is an array. + When only one item is present in the array, it carries the new attribute + value. If two items are present, then the first item carries the old value + and the second item the new value. The items can be of any type including null. + type: object + additionalProperties: + type: array + minItems: 1 + maxItems: 2 + items: + nullable: true + + Filter: + type: string + SystemDN: + type: string + + NotificationId: + type: integer + NotificationHeader: + description: >- + Header used for all notification types + type: object + required: + - href + - notificationId + - notificationType + - eventTime + - systemDN + properties: + uri: + $ref: '#/components/schemas/Uri' + notificationId: + $ref: '#/components/schemas/NotificationId' + notificationType: + oneOf: + - $ref: '#/components/schemas/AlarmNotificationTypes' + #- $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes' + #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes' + # more to be added + eventTime: + $ref: '#/components/schemas/DateTime' + systemDN: + $ref: '#/components/schemas/SystemDN' + + ErrorResponse: + description: >- + Default schema for the response message body in case the request is not + successful. + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + + #---- End of definitions to be moved to comDefs.yaml -------------------------------# + + #---- Definition of AlarmRecord ----------------------------------------------------# + + AlarmId: + type: string + AlarmType: + type: string + enum: + - COMMUNICATIONS_ALARM + - QUALITY_OF_SERVICE_ALARM + - PROCESSING_ERROR_ALARM + - EQUIPMENT_ALARM + - ENVIRONMENTAL_ALARM + - INTEGRITY_VIOLATION + - OPERATIONAL_VIOLATION + - PHYSICAL_VIOLATION + - SECURITY_SERVICE_OR_MECHANISM_VIOLATION + - TIME_DOMAIN_VIOLATION + ProbableCause: + description: >- + The value of the probable cause may be a specific standardized string, or any + vendor provided string. Probable cause strings are not standardized in the + present document. They may be added in a future version. Up to then the + mapping of the generic probable cause strings "PROBABLE_CAUSE_001" to + "PROBABLE_CAUSE_005" is vendor specific. + The value of the probable cause may also be an integer. The mapping of integer + values to probable causes is vendor specific. + oneOf: + - anyOf: + - type: string + enum: + - PROBABLE_CAUSE_001 + - PROBABLE_CAUSE_002 + - PROBABLE_CAUSE_003 + - PROBABLE_CAUSE_004 + - PROBABLE_CAUSE_005 + - type: string + - type: integer + SpecificProblem: + oneOf: + - type: string + - type: integer + PerceivedSeverity: + type: string + enum: + - INDETERMINATE + - CRITICAL + - MAJOR + - MINOR + - WARNING + - CLEARED + TrendIndication: + type: string + enum: + - MORE_SEVERE + - NO_CHANGE + - LESS_SEVERE + ThresholdHysteresis: + type: object + required: + - high + properties: + high: + oneOf: + - type: integer + - $ref: '#/components/schemas/Float' + low: + $ref: '#/components/schemas/Float' + ThresholdLevelInd: + type: object + required: + - up + properties: + up: + $ref: '#/components/schemas/ThresholdHysteresis' + low: + $ref: '#/components/schemas/ThresholdHysteresis' + ThresholdInfo: + type: object + required: + - observedMeasurement + - observedValue + properties: + observedMeasurement: + type: string + observedValue: + oneOf: + - type: integer + - $ref: '#/components/schemas/Float' + thresholdLevelInd: + $ref: '#/components/schemas/ThresholdLevelInd' + armTime: + $ref: '#/components/schemas/DateTime' + CorrelatedNotification: + type: object + required: + - source + - notificationId + properties: + sourceObjectInstance: + $ref: '#/components/schemas/Dn' + notificationIds: + type: array + items: + $ref: '#/components/schemas/NotificationId' + CorrelatedNotifications: + type: array + items: + $ref: '#/components/schemas/CorrelatedNotification' + AckState: + type: string + enum: + - ACKNOWLEDGED + - UNACKNOWLEDGED + + AlarmRecord: + description: >- + The alarmId is not a property of an alarm record. It is used as key + in the map of alarm records instead. + type: object + properties: + # alarmId: + # $ref: '#/components/schemas/AlarmId' + objectInstance: + $ref: '#/components/schemas/Dn' + notificationId: + $ref: '#/components/schemas/NotificationId' + alarmRaisedTime: + $ref: '#/components/schemas/DateTime' + alarmChangedTime: + $ref: '#/components/schemas/DateTime' + alarmClearedTime: + $ref: '#/components/schemas/DateTime' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + specificProblem: + $ref: '#/components/schemas/SpecificProblem' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + backedUpStatus: + type: boolean + backUpObject: + $ref: '#/components/schemas/Dn' + trendIndication: + $ref: '#/components/schemas/TrendIndication' + thresholdinfo: + $ref: '#/components/schemas/ThresholdInfo' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + stateChangeDefinition: + $ref: '#/components/schemas/AttributeValueChangeSet' + monitoredAttributes: + $ref: '#/components/schemas/AttributeNameValuePairSet' + proposedRepairActions: + type: string + additionalText: + type: string + additionalInformation: + $ref: '#/components/schemas/AttributeNameValuePairSet' + + rootCauseIndicator: + type: boolean + + ackTime: + $ref: '#/components/schemas/DateTime' + ackUserId: + type: string + ackSystemId: + type: string + ackState: + $ref: '#/components/schemas/AckState' + + clearUserId: + type: string + clearSystemId: + type: string + serviceUser: + type: string + serviceProvider: + type: string + securityAlarmDetector: + type: string + + #---- Definition of alarm notifications --------------------------------------------# + + AlarmNotificationTypes: + type: string + enum: + - notifyNewAlarm + - notifyChangedAlarm + - notifyChangedAlarmGeneral + - notifyAckStateChanged + - notifyCorrelatedNotificationChanged + - notifyComments + - notifyClearedAlarm + - notifyAlarmListRebuiltAlarm + - notifyPotentialFaultyAlarmList + AlarmListAlignmentRequirement: + type: string + enum: + - ALIGNMENT_REQUIRED + - ALIGNMENT_NOT_REQUIRED + + NotifyNewAlarm: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + specificProblem: + $ref: '#/components/schemas/SpecificProblem' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + backedUpStatus: + type: boolean + backUpObject: + $ref: '#/components/schemas/Dn' + trendIndication: + $ref: '#/components/schemas/TrendIndication' + thresholdInfo: + $ref: '#/components/schemas/ThresholdInfo' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + stateChangeDefinition: + $ref: '#/components/schemas/AttributeValueChangeSet' + monitoredAttributes: + $ref: '#/components/schemas/AttributeNameValuePairSet' + proposedRepairActions: + type: string + additionalText: + type: string + additionalInformation: + $ref: '#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + NotifyNewSecAlarm: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - serviceUser + - serviceProvider + - securityAlarmDetector + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + additionalText: + type: string + additionalInformation: + $ref: '#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + serviceUser: + type: string + serviceProvider: + type: string + securityAlarmDetector: + type: string + NotifyClearedAlarm: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + clearUserId: + type: string + clearSystemId: + type: string + NotifyChangedAlarm: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + NotifyChangedAlarmGeneral: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - changedAlarmAttributes + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + specificProblem: + $ref: '#/components/schemas/SpecificProblem' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + backedUpStatus: + type: boolean + backUpObject: + $ref: '#/components/schemas/Dn' + trendIndication: + $ref: '#/components/schemas/TrendIndication' + thresholdInfo: + $ref: '#/components/schemas/ThresholdInfo' + stateChangeDefinition: + $ref: '#/components/schemas/AttributeValueChangeSet' + monitoredAttributes: + $ref: '#/components/schemas/AttributeNameValuePairSet' + proposedRepairActions: + type: string + additionalText: + type: string + additionalInformation: + $ref: '#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + changedAlarmAttributes: + $ref: '#/components/schemas/AttributeNameValuePairSet' + NotifyChangedSecAlarmGeneral: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - serviceUser + - serviceProvider + - securityAlarmDetector + - changedAlarmAttributes + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + additionalText: + type: string + additionalInformation: + $ref: '#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + serviceUser: + type: string + serviceProvider: + type: string + securityAlarmDetector: + type: string + changedAlarmAttributes: + $ref: '#/components/schemas/AttributeNameValuePairSet' + NotifyCorrelatedNotificationChanged: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - correlatedNotifications + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + rootCauseIndicator: + type: boolean + NotifyAckStateChanged: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - ackState + - ackUserId + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + ackState: + $ref: '#/components/schemas/AckState' + ackUserId: + type: string + ackSystemId: + type: string + NotifyComments: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - comments + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + comments: + $ref: '#/components/schemas/Comments' + NotifyPotentialFaultyAlarmList: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - reason + properties: + reason: + type: string + NotifyAlarmListRebuilt: + allOf: + - $ref: '#/components/schemas/NotificationHeader' + - type: object + required: + - reason + properties: + reason: + type: string + alarmListAlignmentRequirement: + $ref: '#/components/schemas/AlarmListAlignmentRequirement' + + #---- Definition of query parameters -----------------------------------------------# + + AlarmAckState: + type: string + enum: + - ALL_ALARMS + - ALL_ACTIVE_ALARMS + - ALL_ACTIVE_AND_ACKNOWLEDGED_ALARMS + - ALL_ACTIVE_AND_UNACKNOWLEDGED_ALARMS + - ALL_CLEARED_AND_UNACKNOWLEDGED_ALARMS + - ALL_UNACKNOWLEDGED_ALARMS + + #---- Definition of patch documents ------------------------------------------------# + + MergePatchAcknowledgeAlarm: + description: >- + Patch document acknowledging or unacknowledging a single alarm. For + acknowleding an alarm the value of ackState is ACKNOWLEDGED, for unacknowleding + an alarm the value of ackState is UNACKNOWLEDGED. + type: object + required: + - ackUserId + - ackState + properties: + ackUserId: + type: string + ackSystemId: + type: string + ackState: + $ref: '#/components/schemas/AckState' + MergePatchClearAlarm: + description: Patch document for clearing a single alarm + type: object + required: + - clearUserId + - perceivedSeverity + properties: + clearUserId: + type: string + clearSystemId: + type: string + perceivedSeverity: + type: string + enum: + - CLEARED + + #---- Definition of method responses -----------------------------------------------# + + FailedAlarm: + type: object + required: + - alarmId + - failureReason + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + failureReason: + type: string + + #---- Definition of resources ------------------------------------------------------# + + AlarmCount: + type: object + required: + - criticalCount + - majorCount + - minorCount + - warningCount + - indeterminateCount + - clearedCount + properties: + criticalCount: + type: integer + majorCount: + type: integer + minorCount: + type: integer + warningCount: + type: integer + indeterminateCount: + type: integer + clearedCount: + type: integer + Comment: + type: object + properties: + commentTime: + $ref: '#/components/schemas/DateTime' + commentUserId: + type: string + commentSystemId: + type: string + commentText: + type: string + Comments: + description: >- + Collection of comments. The comment identifiers are allocated by the + MnS producer and used as key in the map. + type: object + additionalProperties: + $ref: '#/components/schemas/Comment' + Subscription: + type: object + properties: + consumerReference: + $ref: '#/components/schemas/Uri' + timeTick: + $ref: '#/components/schemas/Long' + filter: + $ref: '#/components/schemas/Filter' diff --git a/OpenAPI/genericNrm.yaml b/OpenAPI/genericNrm.yaml new file mode 100644 index 000000000..0911920a2 --- /dev/null +++ b/OpenAPI/genericNrm.yaml @@ -0,0 +1,1606 @@ +openapi: 3.0.1 +info: + title: Generic NRM + version: 16.4.0 + description: >- + OAS 3.0.1 specification of the Generic NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623 V16.4.0; Generic NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + DateTime: + type: string + format: date-time + Dn: + type: string + maxLength: 400 + DnList: + type: array + items: + $ref: '#/components/schemas/Dn' + Mcc: + type: string + pattern: '^[0-9]{3}$' + Mnc: + type: string + pattern: '^[0-9]{2,3}$' + AdministrativeState: + type: string + enum: + - LOCKED + - UNLOCKED + OperationalState: + type: string + enum: + - ENABLED + - DISABLED + UsageState: + type: string + enum: + - IDEL + - ACTIVE + - BUSY + RegistrationState: + type: string + enum: + - REGISTERED + - DEREGISTERED + SetOfMcc: + type: array + items: + $ref: '#/components/schemas/Mcc' + ManagedElementType: + type: string + ManagedElementTypeList: + type: array + items: + $ref: '#/components/schemas/ManagedElementType' + VnfParameter: + type: object + properties: + vnfInstanceId: + type: string + vnfdId: + type: string + flavourId: + type: string + autoScalable: + type: boolean + VnfParametersList: + type: array + items: + $ref: '#/components/schemas/VnfParameter' + SiteLatitude: + type: number + format: float + minimum: -90 + maximum: 90 + SiteLongitude: + type: number + format: float + minimum: -180 + maximum: 180 + PeeParameter: + type: object + properties: + siteIdentification: + type: string + siteDescription: + type: string + siteLatitude: + $ref: '#/components/schemas/SiteLatitude' + siteLongitude: + $ref: '#/components/schemas/SiteLongitude' + equipmentType: + type: string + environmentType: + type: string + powerInterface: + type: string + PeeParametersList: + type: array + items: + $ref: '#/components/schemas/PeeParameter' + MonitoringGPList: + type: array + items: + type: integer + ThresholdInfoList: + type: array + items: + $ref: '#/components/schemas/ThresholdInfo' + ThresholdInfo: + type: object + properties: + measurementType: + type: string + direction: + $ref: '#/components/schemas/Direction' + thresholdPack: + $ref: '#/components/schemas/ThresholdPack' + Direction: + enum: + - Increasing + - Decreasing + ThresholdPack: + type: array + items: + $ref: '#/components/schemas/ThresholdPackElement' + ThresholdPackElement: + type: object + properties: + thresholdLevel: + type: integer + thresholdValue: + type: number + hysteresis: + type: number + Operation: + type: object + properties: + name: + type: string + allowedNFTypes: + $ref: '#/components/schemas/NFType' + operationSemantics: + $ref: '#/components/schemas/OperationSemantics' + OperationList: + type: array + items: + $ref: '#/components/schemas/Operation' + NFType: + type: string + description: ' NF name defined in TS 23.501' + enum: + - NRF + - UDM + - AMF + - SMF + - AUSF + - NEF + - PCF + - SMSF + - NSSF + - UDR + - LMF + - GMLC + - 5G_EIR + - SEPP + - UPF + - N3IWF + - AF + - UDSF + - DN + Fqdn: + type: string + OperationSemantics: + type: string + enum: + - REQUEST_RESPONSE + - SUBSCRIBE_NOTIFY + SAP: + type: object + properties: + host: + $ref: '#/components/schemas/HostAddr' + port: + type: integer + NFServiceType: + type: string + enum: + - Namf_Communication + - Namf_EventExposure + - Namf_MT + - Namf_Location + - Nsmf_PDUSession + - Nsmf_EventExposure + - Others + HostAddr: + oneOf: + - $ref: '#/components/schemas/Ipv4Addr' + - $ref: '#/components/schemas/Ipv6Addr' + - $ref: '#/components/schemas/Fqdn' + Ipv4Addr: + type: string + pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$' + example: '198.51.100.1' + Ipv4AddrRm: + type: string + pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$' + example: '198.51.100.1' + nullable: true + Ipv6Addr: + type: string + allOf: + - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' + example: '2001:db8:85a3::8a2e:370:7334' + Ipv6AddrRm: + type: string + allOf: + - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' + example: '2001:db8:85a3::8a2e:370:7334' + nullable: true + Ipv6Prefix: + type: string + allOf: + - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$' + example: '2001:db8:abcd:12::0/64' + Uri: + type: string + TransportProtocol: + anyOf: + - type: string + enum: + - TCP + - type: string + SupportedPerfMetricGroup: + type: object + properties: + performanceMetrics: + type: array + items: + type: string + granularityPeriods: + type: array + items: + type: integer + minimum: 1 + reportingMethods: + type: array + items: + type: string + enum: + - FILE_BASED_LOC_SET_BY_PRODUCER + - FILE_BASED_LOC_SET_BY_CONSUMER + - STREAM_BASED + ReportingCtrl: + oneOf: + - type: object + properties: + fileReportingPeriod: + type: integer + - type: object + properties: + fileReportingPeriod: + type: integer + fileLocation: + $ref: '#/components/schemas/Uri' + - type: object + properties: + streamTarget: + $ref: '#/components/schemas/Uri' + Scope: + type: object + properties: + scopeType: + type: string + enum: + - BASE_ONLY + - BASE_ALL + - BASE_NTH_LEVEL + - BASE_SUBTREE + scopeLevel: + type: integer + NotificationType: + type: string + enum: + - notifyMOICreation + - notifyMOIDeletion + - notifyMOIAttributeValueChanges + - notifyEvent + - notifyNewAlarm + - notifyChangedAlarm + - notifyAckStateChanged + - notifyComments + - notifyCorrelatedNotificationChanged + - notifyChangedAlarmGeneral + - notifyAlarmListRebuilt + - notifyPotentialFaultyAlarmList + - notifyFileReady + - notifyFilePreparationError + - notifyThresholdCrossing + NotificationTypes: + type: array + items: + $ref: '#/components/schemas/NotificationType' + +#-------- Definition of types used in Trace control NRM fragment------------------ + + tjJobType-Type: + type: string + description: Specifies whether the TraceJob represents only MDT, Logged MBSFN MDT, Trace or a combined Trace and MDT job. Applicable for Trace, MDT, RCEF and RLF reporting. See 3GPP TS 32.422 clause 5.9a for additional details. + enum: + - IMMEDIATE_MDT_ONLY + - LOGGED_MDT_ONLY + - TRACE_ONLY + - IMMEDIATE_MDT AND TRACE + - RLF_REPORT_ONLY + - RCEF_REPORT_ONLY + - LOGGED_MBSFN_MDT + + tjListOfInterfaces-Type: + description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details. + type: object + properties: + MSCServerInterfaces: + type: array + items: + type: string + enum: + - A + - Iu-CS + - Mc + - MAP-G + - MAP-B + - MAP-E + - MAP-F + - MAP-D + - MAP-C + - CAP + MGWInterfaces: + type: array + items: + type: string + enum: + - Mc + - Nb-UP + - Iu-UP + RNCInterfaces: + type: array + items: + type: string + enum: + - Iu-CS + - Iu-PS + - Iur + - Iub + - Uu + SGSNInterfaces: + type: array + items: + type: string + enum: + - Gb + - Iu-PS + - Gn + - MAP-Gr + - MAP-Gd + - MAP-Gf + - Ge + - Gs + - S6d + - S4 + - S3 + - S13 + GGSNInterfaces: + type: array + items: + type: string + enum: + - Gn + - Gi + - Gmb + S-CSCFInterfaces: + type: array + items: + type: string + enum: + - Mw + - Mg + - Mr + - Mi + P-CSCFInterfaces: + type: array + items: + type: string + enum: + - Gm + - Mw + I-CSCFInterfaces: + type: array + items: + type: string + enum: + - Cx + - Dx + - Mg + - Mw + MRFCInterfaces: + type: array + items: + type: string + enum: + - Mp + - Mr + MGCFInterfaces: + type: array + items: + type: string + enum: + - Mg + - Mj + - Mn + IBCFInterfaces: + type: array + items: + type: string + enum: + - Ix + - Mx + E-CSCFInterfaces: + type: array + items: + type: string + enum: + - Mw + - Ml + - Mm + - Mi/Mg + BGCFInterfaces: + type: array + items: + type: string + enum: + - Mi + - Mj + - Mk + ASInterfaces: + type: array + items: + type: string + enum: + - Dh + - Sh + - ISC + - Ut + HSSInterfaces: + type: array + items: + type: string + enum: + - MAP-C + - MAP-D + - Gc + - Gr + - Cx + - S6d + - S6a + - Sh + EIRInterfaces: + type: array + items: + type: string + enum: + - MAP-F + - S13 + - MAP-Gf + BM-SCInterfaces: + type: array + items: + type: string + enum: + - Gmb + MMEInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - S3 + - S6a + - S10 + - S11 + - S13 + SGWInterfaces: + type: array + items: + type: string + enum: + - S4 + - S5 + - S8 + - S11 + - Gxc + PDN_GWInterfaces: + type: array + items: + type: string + enum: + - S2a + - S2b + - S2c + - S5 + - S6b + - Gx + - S8 + - SGi + eNBInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - X2 + en-gNBInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - X2 + - Uu + - F1-C + - E1 + AMFInterfaces: + type: array + items: + type: string + enum: + - N1 + - N2 + - N8 + - N11 + - N12 + - N14 + - N15 + - N20 + - N22 + - N26 + AUSFInterfaces: + type: array + items: + type: string + enum: + - N12 + - N13 + NEFInterfaces: + type: array + items: + type: string + enum: + - N29 + - N30 + - N33 + NRFInterfaces: + type: array + items: + type: string + enum: + - N27 + NSSFInterfaces: + type: array + items: + type: string + enum: + - N22 + - N31 + PCFInterfaces: + type: array + items: + type: string + enum: + - N5 + - N7 + - N15 + SMFInterfaces: + type: array + items: + type: string + enum: + - N4 + - N7 + - N10 + - N11 + - S5-C + SMSFInterfaces: + type: array + items: + type: string + enum: + - N20 + - N21 + UDMInterfaces: + type: array + items: + type: string + enum: + - N8 + - N10 + - N13 + - N21 + UPFInterfaces: + type: array + items: + type: string + enum: + - N4 + ng-eNBInterfaces: + type: array + items: + type: string + enum: + - NG-C + - Xn-C + - Uu + gNB-CU-CPInterfaces: + type: array + items: + type: string + enum: + - NG-C + - Xn-C + - Uu + - F1-C + - E1 + - X2-C + gNB-CU-UPInterfaces: + type: array + items: + type: string + enum: + - E1 + gNB-DUInterfaces: + type: array + items: + type: string + enum: + - F1-C + + tjListOfNeTypes-Type: + description: The Network Element types where Trace Session activation is needed. See 3GPP TS 32.422 clause 5.4 for additional details. + type: array + items: + type: string + enum: + - MSC_SERVER + - SGSN + - MGW + - GGSN + - RNC + - BM_SC + - MME + - SGW + - PGW + - ENB + - EN_GNB + - GNB_CU_CP + - GNB_CU_UP + - GNB_DU + + tjPLMNTaget-Type: + type: object + description: The PLMN for which sessions shall be selected in the Trace Session in case of management based activation when several PLMNs are supported in the RAN (this means that shared cells and not shared cells are allowed for the specified PLMN. Note that the PLMN Target might differ from the PLMN specified in the Trace Reference, as that specifies the PLMN that is containing the management system requesting the Trace Session from the NE. See 3GPP TS 32.422 clause 5.9b for additional details. + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + required: + - mcc + - mnc + + tjStreamingTraceConsumerURI-Type: + type: string + description: The URI of the Trace Reporting MnS consumer (see 3GPP TS 28.532) to which the Trace records shall be sent. See 3GPP TS 32.422 clause 5.9 for additional details. + format: uri + + tjTraceCollectionEntityAddress-Type: + description: The IP address to which the Trace records shall be transferred. See 3GPP TS 32.422 clause 5.9 for additional details. + oneOf: + - $ref: '#/components/schemas/Ipv4Addr' + - $ref: '#/components/schemas/Ipv6Addr' + + tjTraceDepth-Type: + description: Specifies how detailed information should be recorded in the Network Element. The Trace Depth is a paremeter for Trace Session level, i.e., the Trace Depth is the same for all of the NEs to be traced in the same Trace Session. See 3GPP TS 32.422 clause 5.3 for additional details. + type: string + enum: + - MINIMUM + - MEDIUM + - MAXIMUM + - VENDORMINIMUM + - VENDORMEDIUM + - VENDORMAXIMUM + + tjTraceReference-Type: + type: object + description: The Trace Reference parameter shall be globally unique, therefore the Trace Reference shall compose as follows - MCC+MNC+Trace ID, where the MCC and MNC are coming with the Trace activation request from the management system to identify one PLMN containing the management system, and Trace ID is a 3 byte Octet String. See 3GPP TS 32.422 clause 5.6 for additional details. + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + traceId: + type: integer + required: + - mcc + - mnc + - traceId + + tjTraceReportingFormat-Type: + type: string + description: Specifies whether file-based or streaming reporting shall be used for this Trace Session. See 3GPP TS 32.422 clause 5.11 for additional details. + enum: + - FILE-BASED + - STREAMING + + tjTraceTarget-Type: + type: string + description: Type of trace target. For additional details see 3GPP TS 32.422. + enum: + - IMSI + - IMEI + - IMEISV + - PUBLIC_ID + - UTRAN_CELL + - E-UTRAN_CELL + - NG-RAN_CELL + - eNB + - RNC + - gNB + + tjTriggeringEvent-Type: + type: object + description: Specifies when to start a Trace Recording Session and which message shall be recorded first, when to stop a Trace Recording Session and which message shall be recorded last respectively. See 3GPP TS 32.422 clause 5.1 for additional detials. + properties: + NetworkElement: + type: string + enum: + - MSC_SERVER + - SGSN + - MGW + - GGSN + - BM_SC + - MME + - SGW + - PGW + - AMF + - SMF + - PCF + - UPF + EventBitmap: + type: integer + required: + - NetworkElement + - EventBitmap + + tjMDTAnonymizationOfData-Type: + description: Specifies level of MDT anonymization. For additional details see 3GPP TS 32.422 clause 5.10.12. + type: string + enum: + - NO_IDENTITY + - TAC_OF_IMEI + + tjMDTAreaConfigurationForNeighCell-Type: + description: Used for logged NR MDT and defines the area for which UE is requested to perform measurement logging for neighbour cells which have list of frequencies. For additional details see 3GPP TS 32.422 clause 5.10.26. + type: array + items: + type: object + properties: + frequency: + type: string + cell: + type: string + + tjMDTAreaScope-Type: + description: defines the area in terms or Cells or Tracking Area/Routing Area/Location Area where the MDT data collection shall take place. For additional details see 3GPP TS 32.422 clause 5.10.2. + allOf: + - $ref: '#/components/schemas/DnList' + + tjMDTCollectionPeriodRrmLte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.20. + type: string + enum: + - 250ms + - 500ms + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + - 8000ms + - 12000ms + - 16000ms + - 20000ms + - 24000ms + - 28000ms + - 32000ms + - 64000ms + + tjMDTCollectionPeriodRrmUmts-Type: + description: See details in 3GPP TS 32.422 clause 5.10.21. + type: string + enum: + - 1024ms + - 1280ms + - 2048ms + - 2560ms + - 5120ms + - 10240ms + - 1min + + tjMDTEventListForTriggeredMeasurement-Type: + description: See details in 3GPP TS 32.422 clause 5.10.28. + type: string + enum: + - OUT_OF_COVERAGE + - A2_EVENT + + tjMDTEventThreshold-Type: + description: See details in 3GPP TS 32.422 clause 5.10.7, 5.10.7a, 5.10.13 and 5.10.14. + type: object + properties: + EventThresholdRSRP: + type: integer + minimum: 0 + maximum: 97 + EventThresholdRSRQ: + type: integer + minimum: 0 + maximum: 34 + EventThreshold1F: + type: object + properties: + CPICH_RSCP: + type: integer + minimum: -120 + maximum: 25 + CPICH_EcNo: + type: integer + minimum: -24 + maximum: 0 + PathLoss: + type: integer + minimum: 30 + maximum: 165 + EventThreshold1I: + type: integer + minimum: -120 + maximum: 25 + + tjMDTListOfMeasurements-Type: + description: See details in 3GPP TS 32.422 clause 5.10.3 for details. + type: object + properties: + UMTS: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M6_DL + - M6_UL + - M7_DL + - M7_UL + LTE: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M1_EVENT_TRIGGERED + - M6 + - M7 + - M8 + - M9 + NR: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M6 + - M7 + - M8 + - M9 + + tjMDTLoggingDuration-Type: + description: See details in 3GPP TS 32.422 clause 5.10.9. + type: string + enum: + - 600s + - 1200s + - 2400s + - 3600s + - 5400s + - 7200s + + tjMDTLoggingInterval-Type: + description: See details in 3GPP TS 32.422 clause 5.10.8. + type: string + enum: + - 1.28s + - 2.56s + - 5.12s + - 10.24s + - 20.48s + - 30.72s + - 40.96s + - 61.44s + + tjMDTMBSFNAreaList-Type: + description: See details in 3GPP TS 32.422 clause 5.10.25. + type: array + items: + type: object + properties: + mbsfnAreaId: + type: integer + minimum: 1 + earfcn: + type: integer + minimum: 1 + required: + - mbsfnAreaId + - earfcn + + tjMDTMeasurementPeriodLTE-Type: + description: See details in 3GPP TS 32.422 clause 5.10.23. + type: string + enum: + - 1024ms + - 1280ms + - 2048ms + - 2560ms + - 5120ms + - 10240ms + - 1min + + tjMDTMeasurementPeriodUMTS-Type: + description: See details in 3GPP TS 32.422 clause 5.10.22. + type: string + enum: + - 250ms + - 500ms + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + - 8000ms + - 12000ms + - 16000ms + - 20000ms + - 24000ms + - 28000ms + - 32000ms + - 64000ms + + tjMDTMeasurementQuantity-Type: + description: See details in 3GPP TS 32.422 clause 5.10.15. + type: string + enum: + - CPICH_EcNo + - CPICH_RSCP + - PathLoss + + tjMDTPLMList-Type: + description: See details in 3GPP TS 32.422 clause 5.10.24. + type: array + items: + type: object + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + required: + - mcc + - mnc + maxItems: 16 + + tjMDTPositioningMethod-Type: + description: See details in 3GPP TS 32.422 clause 5.10.19. + type: string + enum: + - GNSS + - E-CELL_ID + + tjMDTReportAmount-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + tjMDTReportingTrigger-Type: + description: See details in 3GPP TS 32.422 clause 5.10.4. + type: array + items: + type: string + enum: + - PERIODICAL + - A2_FOR_LTE + - 1F_FOR_UMTS + - 1I_FOR_UMTS_MCPS_TDD + - A2_TRIGGERED_PERIODIC_FOR_LTE + - ALL_CONFIGURED_RRM_FOR_LTE + - ALL_CONFIGURED_RRM_FOR_UMTS + + tjMDTReportInterval-Type: + description: See details in 3GPP TS 32.422 clause 5.10.5. + type: string + enum: + - 250ms + - 500ms + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + - 8000ms + - 12000ms + - 16000ms + - 20000ms + - 24000ms + - 28000ms + - 32000ms + - 64000ms + - 120ms + - 240ms + - 480ms + - 640ms + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 60000ms + - 360000ms + - 720000ms + - 1800000ms + - 3600000ms + + tjMDTReportType-Type: + description: Report type for logged NR MDT. See details in 3GPP TS 32.422 clause 5.10.27. + type: string + enum: + - PERIODICAL + - EVENT_TRIGGERED + + tjMDTSensorInformation-Type: + description: See details in 3GPP TS 32.422 clause 5.10.29. + type: array + items: + type: string + enum: + - BAROMETRIC_PRESSURE + - UE_SPEED + - UE_ORIENTATION + + tjMDTTraceCollectionEntityID-Type: + description: See details in 3GPP TS 32.422 clause 5.10.11. Only tceID value may be sent over the air to the UE being configured for Logged MDT. + type: object + properties: + tceID: + type: integer + tcePLMN: + type: object + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + required: + - mcc + - mnc + tceAddress: + oneOf: + - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' + - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' + required: + - tceID + - tcePLMN + - tceAddress + + +#-------- end of Definition of types used in Trace control NRM fragment ---------- + + +#-------- Definition of abstract IOC Top ----------------------------------------- + + Top-Attr: + # This definition will be deprecated, when all occurances of Top-Attr + # are replaced by Top. + type: object + properties: + id: + type: string + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + Top: + type: object + properties: + id: + type: string + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + +#-------- Definition of IOCs with new name-containments defined in other TS ------ + + SubNetwork-Attr: + type: object + properties: + dnPrefix: + type: string + userLabel: + type: string + userDefinedNetworkType: + type: string + setOfMcc: + $ref: '#/components/schemas/SetOfMcc' + priorityLabel: + type: integer + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + ManagedElement-Attr: + type: object + properties: + dnPrefix: + type: string + managedElementTypeList: + $ref: '#/components/schemas/ManagedElementTypeList' + userLabel: + type: string + locationName: + type: string + managedBy: + $ref: '#/components/schemas/DnList' + vendorName: + type: string + userDefinedState: + type: string + swVersion: + type: string + priorityLabel: + type: integer + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + + SubNetwork-ncO: + type: object + properties: + ManagementNode: + $ref: '#/components/schemas/ManagementNode-Multiple' + MeContext: + $ref: '#/components/schemas/MeContext-Multiple' + PerfMetricJob: + $ref: '#/components/schemas/PerfMetricJob-Multiple' + ThresholdMonitor: + $ref: '#/components/schemas/ThresholdMonitor-Multiple' + ThresholdMonitoringCapability: + $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' + NtfSubscriptionControl: + $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' + TraceJob: + $ref: '#/components/schemas/TraceJob-Multiple' + AlarmList: + $ref: '#/components/schemas/AlarmList-Single' + MnsRegistry: + type: array + items: + $ref: '#/components/schemas/MnsRegistry' + ManagedElement-ncO: + type: object + properties: + PerfMetricJob: + $ref: '#/components/schemas/PerfMetricJob-Multiple' + ThresholdMonitor: + $ref: '#/components/schemas/ThresholdMonitor-Multiple' + ThresholdMonitoringCapability: + $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' + NtfSubscriptionControl: + $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' + TraceJob: + $ref: '#/components/schemas/TraceJob-Multiple' + AlarmList: + $ref: '#/components/schemas/AlarmList-Single' + +#-------- Definition of abstract IOCs -------------------------------------------- + + ManagedFunction-Attr: + type: object + properties: + userLabel: + type: string + vnfParametersList: + $ref: '#/components/schemas/VnfParametersList' + peeParametersList: + $ref: '#/components/schemas/PeeParametersList' + priorityLabel: + type: integer + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + EP_RP-Attr: + type: object + properties: + userLabel: + type: string + farEndEntity: + type: string + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + + TraceJob-Attr: + type: object + description: abstract class used as a container of all TraceJob attributes + properties: + tjJobType: + $ref: '#/components/schemas/tjJobType-Type' + tjListOfInterfaces: + $ref: '#/components/schemas/tjListOfInterfaces-Type' + tjListOfNeTypes: + $ref: '#/components/schemas/tjListOfNeTypes-Type' + tjPLMNTarget: + $ref: '#/components/schemas/tjPLMNTaget-Type' + tjTraceConsumer: + oneOf: + - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' + - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' + tjTraceDepth: + $ref: '#/components/schemas/tjTraceDepth-Type' + tjTraceReference: + $ref: '#/components/schemas/tjTraceReference-Type' + tjTraceReportingFormat: + $ref: '#/components/schemas/tjTraceReportingFormat-Type' + tjTraceTarget: + $ref: '#/components/schemas/tjTraceTarget-Type' + tjTriggeringEvent: + $ref: '#/components/schemas/tjTriggeringEvent-Type' + tjMDTAnonymizationOfData: + $ref: '#/components/schemas/tjMDTAnonymizationOfData-Type' + tjMDTAreaConfigurationForNeighCell: + $ref: '#/components/schemas/tjMDTAreaConfigurationForNeighCell-Type' + tjMDTAreaScope: + $ref: '#/components/schemas/tjMDTAreaScope-Type' + tjMDTCollectionPeriodRrmLte: + $ref: '#/components/schemas/tjMDTCollectionPeriodRrmLte-Type' + tjMDTCollectionPeriodRrmUmts: + $ref: '#/components/schemas/tjMDTCollectionPeriodRrmUmts-Type' + tjMDTEventListForTriggeredMeasurement: + $ref: '#/components/schemas/tjMDTEventListForTriggeredMeasurement-Type' + tjMDTEventThreshold: + $ref: '#/components/schemas/tjMDTEventThreshold-Type' + tjMDTListOfMeasurements: + $ref: '#/components/schemas/tjMDTListOfMeasurements-Type' + tjMDTLoggingDuration: + $ref: '#/components/schemas/tjMDTLoggingDuration-Type' + tjMDTLoggingInterval: + $ref: '#/components/schemas/tjMDTLoggingInterval-Type' + tjMDTMBSFNAreaList: + $ref: '#/components/schemas/tjMDTMBSFNAreaList-Type' + tjMDTMeasurementPeriodLTE: + $ref: '#/components/schemas/tjMDTMeasurementPeriodLTE-Type' + tjMDTMeasurementPeriodUMTS: + $ref: '#/components/schemas/tjMDTMeasurementPeriodUMTS-Type' + tjMDTMeasurementQuantity: + $ref: '#/components/schemas/tjMDTMeasurementQuantity-Type' + tjMDTPLMList: + $ref: '#/components/schemas/tjMDTPLMList-Type' + tjMDTPositioningMethod: + $ref: '#/components/schemas/tjMDTPositioningMethod-Type' + tjMDTReportAmount: + $ref: '#/components/schemas/tjMDTReportAmount-Type' + tjMDTReportingTrigger: + $ref: '#/components/schemas/tjMDTReportingTrigger-Type' + tjMDTReportInterval: + $ref: '#/components/schemas/tjMDTReportInterval-Type' + tjMDTReportType: + $ref: '#/components/schemas/tjMDTReportType-Type' + tjMDTSensorInformation: + $ref: '#/components/schemas/tjMDTSensorInformation-Type' + tjMDTTraceCollectionEntityID: + $ref: '#/components/schemas/tjMDTTraceCollectionEntityID-Type' + required: + - tjJobType + - tjTraceReference + - tjTraceConsumer + - tjTraceReportingFormat + - tjTraceTarget + + ManagedFunction-ncO: + type: object + properties: + PerfMetricJob: + $ref: '#/components/schemas/PerfMetricJob-Multiple' + ThresholdMonitor: + $ref: '#/components/schemas/ThresholdMonitor-Multiple' + ThresholdMonitoringCapability: + $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' + ManagedNFService: + $ref: '#/components/schemas/ManagedNFService-Multiple' + TraceJob: + $ref: '#/components/schemas/TraceJob-Multiple' + + MnsRegistry: + type: object + properties: + mnsLabel: + type: string + mnsType: + type: string + mnsVersion: + type: string + mnsAddress: + type: string + +#-------- Definition of concrete IOCs -------------------------------------------- + + VsDataContainer-Single: + type: object + properties: + id: + type: string + attributes: + type: object + properties: + vsDataType: + type: string + vsDataFormatVersion: + type: string + vsData: + nullable: true + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + ManagedNFService-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + userLabel: + type: string + nFServiceType: + $ref: '#/components/schemas/NFServiceType' + sAP: + $ref: '#/components/schemas/SAP' + operations: + $ref: '#/components/schemas/OperationList' + administrativeState: + $ref: '#/components/schemas/AdministrativeState' + operationalState: + $ref: '#/components/schemas/OperationalState' + usageState: + $ref: '#/components/schemas/UsageState' + registrationState: + $ref: '#/components/schemas/RegistrationState' + ManagementNode-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + userLabel: + type: string + managedElements: + $ref: '#/components/schemas/DnList' + vendorName: + type: string + userDefinedState: + type: string + locationName: + type: string + swVersion: + type: string + MeContext-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + dnPrefix: + type: string + PerfMetricJob-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + administrativeState: + $ref: '#/components/schemas/AdministrativeState' + operationalState: + $ref: '#/components/schemas/OperationalState' + perfMetricJobGroupId: + type: string + performanceMetrics: + type: array + items: + type: string + granularityPeriod: + type: integer + minimum: 1 + objectInstances: + $ref: '#/components/schemas/DnList' + rootObjectInstances: + $ref: '#/components/schemas/DnList' + reportingCtrl: + $ref: '#/components/schemas/ReportingCtrl' + ThresholdMonitoringCapability-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + supportedMonitoringGPs: + $ref: '#/components/schemas/MonitoringGPList' + ThresholdMonitor-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + thresholdInfoList: + $ref: '#/components/schemas/ThresholdInfoList' + monitoringGP: + type: integer + monitoringNotifTarget: + type: string + monitoredIOCName: + type: string + monitoredObjectDNs: + $ref: '#/components/schemas/DnList' + NtfSubscriptionControl-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + notificationRecipientAddress: + $ref: '#/components/schemas/Uri' + notificationTypes: + $ref: '#/components/schemas/NotificationTypes' + scope: + $ref: '#/components/schemas/Scope' + notificationFilter: + type: string + HeartbeatControl: + $ref: '#/components/schemas/HeartbeatControl-Single' + HeartbeatControl-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + heartbeatNtfPeriod: + type: integer + triggerHeartbeatNtf: + type: boolean + TraceJob-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + $ref: '#/components/schemas/TraceJob-Attr' + + AlarmList-Single: + allOf: + - $ref: '#/components/schemas/Top-Attr' + - type: object + properties: + attributes: + type: object + properties: + administrativeState: + $ref: '#/components/schemas/AdministrativeState' + operationalState: + $ref: '#/components/schemas/OperationalState' + numOfAlarmRecords: + type: integer + lastModification: + $ref: '#/components/schemas/DateTime' + alarmRecords: + description: >- + This resource represents a map of alarm records. + The alarmIds are used as keys in the map. + type: object + additionalProperties: + $ref: 'faultMnS.yaml#/components/schemas/AlarmRecord' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + VsDataContainer-Multiple: + type: array + items: + $ref: '#/components/schemas/VsDataContainer-Single' + ManagedNFService-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedNFService-Single' + ManagementNode-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagementNode-Single' + MeContext-Multiple: + type: array + items: + $ref: '#/components/schemas/MeContext-Single' + PerfMetricJob-Multiple: + type: array + items: + $ref: '#/components/schemas/PerfMetricJob-Single' + ThresholdMonitor-Multiple: + type: array + items: + $ref: '#/components/schemas/ThresholdMonitor-Single' + NtfSubscriptionControl-Multiple: + type: array + items: + $ref: '#/components/schemas/NtfSubscriptionControl-Single' + TraceJob-Multiple: + type: array + items: + $ref: '#/components/schemas/TraceJob-Single' + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + + resources-genericNrm: + oneOf: + + - $ref: '#/components/schemas/VsDataContainer-Single' + + - $ref: '#/components/schemas/ManagementNode-Single' + - $ref: '#/components/schemas/MeContext-Single' + + - $ref: '#/components/schemas/ManagedNFService-Single' + + - $ref: '#/components/schemas/PerfMetricJob-Single' + + - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' + - $ref: '#/components/schemas/ThresholdMonitor-Single' + + - $ref: '#/components/schemas/NtfSubscriptionControl-Single' + - $ref: '#/components/schemas/HeartbeatControl-Single' + - $ref: '#/components/schemas/TraceJob-Single' + + - $ref: '#/components/schemas/AlarmList-Single' diff --git a/OpenAPI/heartbeatNtf.yaml b/OpenAPI/heartbeatNtf.yaml new file mode 100644 index 000000000..afde5066d --- /dev/null +++ b/OpenAPI/heartbeatNtf.yaml @@ -0,0 +1,23 @@ +openapi: 3.0.1 +info: + title: Heartbeat notification + version: 16.3.0 + description: >- + OAS 3.0.1 specification of the heartbeat notification + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.532 V16.3.0; Heartbeat notification + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.6532/ +paths: {} +components: + schemas: + hearbeatNtfPeriod-Type: + type: integer + notifyHeartbeat-NotifType: + allOf: + - $ref: 'provMnS.yaml#/components/schemas/header-Type' + - type: object + properties: + heartbeatNtfPeriod: + $ref: '#/components/schemas/hearbeatNtfPeriod-Type' diff --git a/OpenAPI/nrNrm.yaml b/OpenAPI/nrNrm.yaml new file mode 100644 index 000000000..850106631 --- /dev/null +++ b/OpenAPI/nrNrm.yaml @@ -0,0 +1,1905 @@ +openapi: 3.0.1 +info: + title: NR NRM + version: 17.4.0 + description: >- + OAS 3.0.1 specification of the NR NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.541; 5G NRM, NR NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + GnbId: + type: string + GnbIdLength: + type: integer + minimum: 22 + maximum: 32 + GnbName: + type: string + maxLength: 150 + GnbDuId: + type: number + minimum: 0 + maximum: 68719476735 + GnbCuUpId: + type: number + minimum: 0 + maximum: 68719476735 + + Sst: + type: integer + maximum: 255 + Snssai: + type: object + properties: + sst: + $ref: '#/components/schemas/Sst' + sd: + type: string + SnssaiList: + type: array + items: + $ref: '#/components/schemas/Snssai' + + Mnc: + type: string + pattern: '[0-9]{3}|[0-9]{2}' + PlmnId: + type: object + properties: + mcc: + $ref: 'genericNrm.yaml#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + PlmnIdList: + type: array + items: + $ref: '#/components/schemas/PlmnId' + PlmnInfo: + type: object + properties: + plmnId": + $ref: '#/components/schemas/PlmnId' + snssai: + $ref: '#/components/schemas/Snssai' + PlmnInfoList: + type: array + items: + $ref: '#/components/schemas/PlmnInfo' + cagId: + type: string + nid: + type: string + NpnIdentity: + type: object + properties: + plmnId": + $ref: '#/components/schemas/PlmnId' + cagidList: + $ref: '#/components/schemas/cagId' + nidList: + $ref: '#/components/schemas/nid' + NpnIdentityList: + type: array + items: + $ref: '#/components/schemas/NpnIdentity' + GGnbId: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}-(22|23|24|25|26|27|28|29|30|31|32)-[0-9]{1,10}' + GEnbId: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}-(18|20|21|22)-[0-9]{1,7}' + + GGnbIdList: + type: array + items: + $ref: '#/components/schemas/GGnbId' + + GEnbIdList: + type: array + items: + $ref: '#/components/schemas/GEnbId' + + NrPci: + type: integer + maximum: 503 + NrTac: + type: integer + maximum: 16777215 + Tai: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + nrTac: + $ref: '#/components/schemas/NrTac' + + BackhaulAddress: + type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + tai: + $ref: "#/components/schemas/Tai" + MappingSetIDBackhaulAddress: + type: object + properties: + setID: + type: integer + backhaulAddress: + $ref: '#/components/schemas/BackhaulAddress' + IntraRatEsActivationOriginalCellLoadParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + IntraRatEsActivationCandidateCellsLoadParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + IntraRatEsDeactivationCandidateCellsLoadParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + EsNotAllowedTimePeriod: + type: object + properties: + startTimeandendTime: + type: string + periodOfDay: + type: string + daysOfWeekList: + type: string + listoftimeperiods: + type: string + InterRatEsActivationOriginalCellParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + InterRatEsActivationCandidateCellParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + InterRatEsDeactivationCandidateCellParameters: + type: object + properties: + loadThreshold: + type: integer + timeDuration: + type: integer + + UeAccProbilityDist: + type: object + properties: + targetProbability: + type: integer + numberofpreamblessent: + type: integer + + UeAccDelayProbilityDist: + type: object + properties: + targetProbability: + type: integer + accessdelay: + type: integer + + NRPciList: + type: object + properties: + NRPci: + type: integer + + CSonPciList: + type: object + properties: + NRPci: + type: integer + + MaximumDeviationHoTrigger: + type: integer + minimum: -20 + maximum: 20 + + MinimumTimeBetweenHoTriggerChange: + type: integer + minimum: 0 + maximum: 604800 + + TstoreUEcntxt: + type: integer + minimum: 0 + maximum: 1023 + + CellState: + type: string + enum: + - IDLE + - INACTIVE + - ACTIVE + CyclicPrefix: + type: string + enum: + - '15' + - '30' + - '60' + - '120' + TxDirection: + type: string + enum: + - DL + - UL + - DL and UL + BwpContext: + type: string + enum: + - DL + - UL + - SUL + IsInitialBwp: + type: string + enum: + - INITIAL + - OTHER + - SUL + QuotaType: + type: string + enum: + - STRICT + - FLOAT + IsESCoveredBy: + type: string + enum: + - NO + - PARTIAL + - FULL + RrmPolicyMember: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + snssai: + $ref: '#/components/schemas/Snssai' + RrmPolicyMemberList: + type: array + items: + $ref: '#/components/schemas/RrmPolicyMember' + AddressWithVlan: + type: object + properties: + ipv4Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + ipv6Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + vlanId: + type: integer + minimum: 0 + maximum: 4096 + LocalAddress: + type: object + properties: + addressWithVlan: + $ref: '#/components/schemas/AddressWithVlan' + port: + type: integer + minimum: 0 + maximum: 65535 + RemoteAddress: + type: object + properties: + ipv4Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + ipv6Address: + $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + + CellIndividualOffset: + type: object + properties: + rsrpOffsetSSB: + type: integer + rsrqOffsetSSB: + type: integer + sinrOffsetSSB: + type: integer + rsrpOffsetCSI-RS: + type: integer + rsrqOffsetCSI-RS: + type: integer + sinrOffsetCSI-RS: + type: integer + QOffsetRange: + type: integer + enum: + - -24 + - -22 + - -20 + - -18 + - -16 + - -14 + - -12 + - -10 + - -8 + - -6 + - -5 + - -4 + - -3 + - -2 + - -1 + - 0 + - 24 + - 22 + - 20 + - 18 + - 16 + - 14 + - 12 + - 10 + - 8 + - 6 + - 5 + - 4 + - 3 + - 2 + - 1 + QOffsetRangeList: + type: object + properties: + rsrpOffsetSSB: + $ref: '#/components/schemas/QOffsetRange' + rsrqOffsetSSB: + $ref: '#/components/schemas/QOffsetRange' + sinrOffsetSSB: + $ref: '#/components/schemas/QOffsetRange' + rsrpOffsetCSI-RS: + $ref: '#/components/schemas/QOffsetRange' + rsrqOffsetCSI-RS: + $ref: '#/components/schemas/QOffsetRange' + sinrOffsetCSI-RS: + $ref: '#/components/schemas/QOffsetRange' + QOffsetFreq: + type: number + TReselectionNRSf: + type: integer + enum: + - 25 + - 50 + - 75 + - 100 + SsbPeriodicity: + type: integer + enum: + - 5 + - 10 + - 20 + - 40 + - 80 + - 160 + SsbDuration: + type: integer + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + SsbSubCarrierSpacing: + type: integer + enum: + - 15 + - 30 + - 120 + - 240 + CoverageShape: + type: integer + maximum: 65535 + DigitalTilt: + type: integer + minimum: -900 + maximum: 900 + DigitalAzimuth: + type: integer + minimum: -1800 + maximum: 1800 + + RSSetId: + type: integer + maximum: 4194303 + + RSSetType: + type: string + enum: + - RS1 + - RS2 + + FrequencyDomainPara: + type: object + properties: + rimRSSubcarrierSpacing: + type: integer + rIMRSBandwidth: + type: integer + nrofGlobalRIMRSFrequencyCandidates: + type: integer + rimRSCommonCarrierReferencePoint: + type: integer + rimRSStartingFrequencyOffsetIdList: + type: array + items: + type: integer + + SequenceDomainPara: + type: object + properties: + nrofRIMRSSequenceCandidatesofRS1: + type: integer + rimRSScrambleIdListofRS1: + type: array + items: + type: integer + nrofRIMRSSequenceCandidatesofRS2: + type: integer + rimRSScrambleIdListofRS2: + type: array + items: + type: integer + enableEnoughNotEnoughIndication: + type: string + enum: + - ENABLE + - DISABLE + RIMRSScrambleTimerMultiplier: + type: integer + RIMRSScrambleTimerOffset: + type: integer + + TimeDomainPara: + type: object + properties: + dlULSwitchingPeriod1: + type: string + enum: + - MS0P5 + - MS0P625 + - MS1 + - MS1P25 + - MS2 + - MS2P5 + - MS3 + - MS4 + - MS5 + - MS10 + - MS20 + symbolOffsetOfReferencePoint1: + type: integer + dlULSwitchingPeriod2: + type: string + enum: + - MS0P5 + - MS0P625 + - MS1 + - MS1P25 + - MS2 + - MS2P5 + - MS3 + - MS4 + - MS5 + - MS10 + - MS20 + symbolOffsetOfReferencePoint2: + type: integer + totalnrofSetIdofRS1: + type: integer + totalnrofSetIdofRS2: + type: integer + nrofConsecutiveRIMRS1: + type: integer + nrofConsecutiveRIMRS2: + type: integer + consecutiveRIMRS1List: + type: array + items: + type: integer + consecutiveRIMRS2List: + type: array + items: + type: integer + enablenearfarIndicationRS1: + type: string + enum: + - ENABLE + - DISABLE + enablenearfarIndicationRS2: + type: string + enum: + - ENABLE + - DISABLE + + RimRSReportInfo: + type: object + properties: + detectedSetID: + type: integer + propagationDelay: + type: integer + functionalityOfRIMRS: + type: string + enum: + - RS1 + - RS2 + - RS1forEnoughMitigation + - RS1forNotEnoughMitigation + + RimRSReportConf: + type: object + properties: + reportIndicator: + type: string + enum: + - ENABLE + - DISABLE + reportInterval: + type: integer + nrofRIMRSReportInfo: + type: integer + maxPropagationDelay: + type: integer + rimRSReportInfoList: + type: array + items: + $ref: '#/components/schemas/RimRSReportInfo' + TceMappingInfo: + type: object + properties: + TceIPAddress: + oneOf: + - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + TceID: + type: integer + PlmnTarget: + $ref: '#/components/schemas/PlmnId' + TceMappingInfoList: + type: array + items: + $ref: '#/components/schemas/TceMappingInfo' + + +#-------- Definition of abstract IOCs -------------------------------------------- + + RrmPolicy_-Attr: + type: object + properties: + resourceType: + type: string + rRMPolicyMemberList: + $ref: '#/components/schemas/RrmPolicyMemberList' + + +#-------- Definition of concrete IOCs -------------------------------------------- + + SubNetwork-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + NRFrequency: + $ref: '#/components/schemas/NRFrequency-Multiple' + ExternalGnbCuCpFunction: + $ref: '#/components/schemas/ExternalGnbCuCpFunction-Multiple' + ExternalENBFunction: + $ref: '#/components/schemas/ExternalENBFunction-Multiple' + EUtranFrequency: + $ref: '#/components/schemas/EUtranFrequency-Multiple' + DESManagementFunction: + $ref: '#/components/schemas/DESManagementFunction-Single' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + DMROFunction: + $ref: '#/components/schemas/DMROFunction-Single' + DPCIConfigurationFunction: + $ref: '#/components/schemas/DPCIConfigurationFunction-Single' + CPCIConfigurationFunction: + $ref: '#/components/schemas/CPCIConfigurationFunction-Single' + CESManagementFunction: + $ref: '#/components/schemas/CESManagementFunction-Single' + Configurable5QISet: + $ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' + RimRSGlobal: + $ref: '#/components/schemas/RimRSGlobal-Single' + Dynamic5QISet: + $ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' + + ManagedElement-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' + - type: object + properties: + GnbDuFunction: + $ref: '#/components/schemas/GnbDuFunction-Multiple' + GnbCuUpFunction: + $ref: '#/components/schemas/GnbCuUpFunction-Multiple' + GnbCuCpFunction: + $ref: '#/components/schemas/GnbCuCpFunction-Multiple' + DESManagementFunction: + $ref: '#/components/schemas/DESManagementFunction-Single' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + DMROFunction: + $ref: '#/components/schemas/DMROFunction-Single' + DPCIConfigurationFunction: + $ref: '#/components/schemas/DPCIConfigurationFunction-Single' + CPCIConfigurationFunction: + $ref: '#/components/schemas/CPCIConfigurationFunction-Single' + CESManagementFunction: + $ref: '#/components/schemas/CESManagementFunction-Single' + Configurable5QISet: + $ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' + + GnbDuFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + gnbDuId: + $ref: '#/components/schemas/GnbDuId' + gnbDuName: + $ref: '#/components/schemas/GnbName' + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + rimRSReportConf: + $ref: '#/components/schemas/RimRSReportConf' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + RRMPolicyRatio: + $ref: '#/components/schemas/RRMPolicyRatio-Multiple' + NrCellDu: + $ref: '#/components/schemas/NrCellDu-Multiple' + Bwp-Multiple: + $ref: '#/components/schemas/Bwp-Multiple' + NrSectorCarrier-Multiple: + $ref: '#/components/schemas/NrSectorCarrier-Multiple' + EP_F1C: + $ref: '#/components/schemas/EP_F1C-Single' + EP_F1U: + $ref: '#/components/schemas/EP_F1U-Multiple' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + GnbCuUpFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + gnbCuUpId: + $ref: '#/components/schemas/GnbCuUpId' + plmnInfoList: + $ref: '#/components/schemas/PlmnInfoList' + configurable5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + RRMPolicyRatio: + $ref: '#/components/schemas/RRMPolicyRatio-Multiple' + EP_E1: + $ref: '#/components/schemas/EP_E1-Single' + EP_XnU: + $ref: '#/components/schemas/EP_XnU-Multiple' + EP_F1U: + $ref: '#/components/schemas/EP_F1U-Multiple' + EP_NgU: + $ref: '#/components/schemas/EP_NgU-Multiple' + EP_X2U: + $ref: '#/components/schemas/EP_X2U-Multiple' + EP_S1U: + $ref: '#/components/schemas/EP_S1U-Multiple' + GnbCuCpFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + gnbCuName: + $ref: '#/components/schemas/GnbName' + plmnId: + $ref: '#/components/schemas/PlmnId' + x2BlackList: + $ref: '#/components/schemas/GGnbIdList' + xnBlackList: + $ref: '#/components/schemas/GGnbIdList' + x2WhiteList: + $ref: '#/components/schemas/GGnbIdList' + xnWhiteList: + $ref: '#/components/schemas/GGnbIdList' + x2XnHOBlackList: + $ref: '#/components/schemas/GEnbIdList' + mappingSetIDBackhaulAddress: + $ref: '#/components/schemas/MappingSetIDBackhaulAddress' + tceMappingInfoList: + $ref: '#/components/schemas/TceMappingInfoList' + configurable5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + RRMPolicyRatio: + $ref: '#/components/schemas/RRMPolicyRatio-Multiple' + NrCellCu: + $ref: '#/components/schemas/NrCellCu-Multiple' + EP_XnC: + $ref: '#/components/schemas/EP_XnC-Multiple' + EP_E1: + $ref: '#/components/schemas/EP_E1-Multiple' + EP_F1C: + $ref: '#/components/schemas/EP_F1C-Multiple' + EP_NgC: + $ref: '#/components/schemas/EP_NgC-Multiple' + EP_X2C: + $ref: '#/components/schemas/EP_X2C-Multiple' + DANRManagementFunction: + $ref: '#/components/schemas/DANRManagementFunction-Single' + DESManagementFunction: + $ref: '#/components/schemas/DESManagementFunction-Single' + DMROFunction: + $ref: '#/components/schemas/DMROFunction-Single' + + NrCellCu-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + cellLocalId: + type: integer + plmnInfoList: + $ref: '#/components/schemas/PlmnInfoList' + nRFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + RRMPolicyRatio: + $ref: '#/components/schemas/RRMPolicyRatio-Multiple' + NRCellRelation: + $ref: '#/components/schemas/NRCellRelation-Multiple' + EUtranCellRelation: + $ref: '#/components/schemas/EUtranCellRelation-Multiple' + NRFreqRelation: + $ref: '#/components/schemas/NRFreqRelation-Multiple' + EUtranFreqRelation: + $ref: '#/components/schemas/EUtranFreqRelation-Multiple' + DESManagementFunction: + $ref: '#/components/schemas/DESManagementFunction-Single' + DMROFunction: + $ref: '#/components/schemas/DMROFunction-Single' + CESManagementFunction: + $ref: '#/components/schemas/CESManagementFunction-Single' + DPCIConfigurationFunction: + $ref: '#/components/schemas/DPCIConfigurationFunction-Single' + + NrCellDu-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + administrativeState: + $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'genericNrm.yaml#/components/schemas/OperationalState' + cellLocalId: + type: integer + cellState: + $ref: '#/components/schemas/CellState' + plmnInfoList: + $ref: '#/components/schemas/PlmnInfoList' + npnIdentityList: + $ref: '#/components/schemas/NpnIdentityList' + nrPci: + $ref: '#/components/schemas/NrPci' + nrTac: + $ref: '#/components/schemas/NrTac' + arfcnDL: + type: integer + arfcnUL: + type: integer + arfcnSUL: + type: integer + bSChannelBwDL: + type: integer + bSChannelBwUL: + type: integer + bSChannelBwSUL: + type: integer + ssbFrequency: + type: integer + minimum: 0 + maximum: 3279165 + ssbPeriodicity: + $ref: '#/components/schemas/SsbPeriodicity' + ssbSubCarrierSpacing: + $ref: '#/components/schemas/SsbSubCarrierSpacing' + ssbOffset: + type: integer + minimum: 0 + maximum: 159 + ssbDuration: + $ref: '#/components/schemas/SsbDuration' + nrSectorCarrierRef: + type: array + items: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + bwpRef: + type: array + items: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + rimRSMonitoringStartTime: + type: string + rimRSMonitoringStopTime: + type: string + rimRSMonitoringWindowDuration: + type: integer + rimRSMonitoringWindowStartingOffset: + type: integer + rimRSMonitoringWindowPeriodicity: + type: integer + rimRSMonitoringOccasionInterval: + type: integer + rimRSMonitoringOccasionStartingOffset: + type: integer + nRFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + victimSetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + aggressorSetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + RRMPolicyRatio: + $ref: '#/components/schemas/RRMPolicyRatio-Multiple' + CPCIConfigurationFunction: + $ref: '#/components/schemas/CPCIConfigurationFunction-Single' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + + NRFrequency-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + absoluteFrequencySSB: + type: integer + minimum: 0 + maximum: 3279165 + ssbSubCarrierSpacing: + $ref: '#/components/schemas/SsbSubCarrierSpacing' + multiFrequencyBandListNR: + type: integer + minimum: 1 + maximum: 256 + EUtranFrequency-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + earfcnDL: + type: integer + minimum: 0 + maximum: 262143 + multiBandInfoListEutra: + type: integer + minimum: 1 + maximum: 256 + + NrSectorCarrier-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + txDirection: + $ref: '#/components/schemas/TxDirection' + configuredMaxTxPower: + type: integer + arfcnDL: + type: integer + arfcnUL: + type: integer + bSChannelBwDL: + type: integer + bSChannelBwUL: + type: integer + sectorEquipmentFunctionRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + CommonBeamformingFunction: + $ref: '#/components/schemas/CommonBeamformingFunction-Single' + Bwp-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + bwpContext: + $ref: '#/components/schemas/BwpContext' + isInitialBwp: + $ref: '#/components/schemas/IsInitialBwp' + subCarrierSpacing: + type: integer + cyclicPrefix: + $ref: '#/components/schemas/CyclicPrefix' + startRB: + type: integer + numberOfRBs: + type: integer + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + CommonBeamformingFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + coverageShape: + $ref: '#/components/schemas/CoverageShape' + digitalAzimuth: + $ref: '#/components/schemas/DigitalAzimuth' + digitalTilt: + $ref: '#/components/schemas/DigitalTilt' + - type: object + properties: + Beam: + $ref: '#/components/schemas/Beam-Multiple' + Beam-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + beamIndex: + type: integer + beamType: + type: string + enum: + - SSB-BEAM + beamAzimuth: + type: integer + minimum: -1800 + maximum: 1800 + beamTilt: + type: integer + minimum: -900 + maximum: 900 + beamHorizWidth: + type: integer + minimum: 0 + maximum: 3599 + beamVertWidth: + type: integer + minimum: 0 + maximum: 1800 + RRMPolicyRatio-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: '#/components/schemas/RrmPolicy_-Attr' + - type: object + properties: + rRMPolicyMaxRatio: + type: integer + rRMPolicyMinRatio: + type: integer + rRMPolicyDedicatedRatio: + type: integer + + NRCellRelation-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + nRTCI: + type: integer + cellIndividualOffset: + $ref: '#/components/schemas/CellIndividualOffset' + adjacentNRCellRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + nRFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + isRemoveAllowed: + type: boolean + isHOAllowed: + type: boolean + isESCoveredBy: + $ref: '#/components/schemas/IsESCoveredBy' + isENDCAllowed: + type: boolean + isMLBAllowed: + type: boolean + EUtranCellRelation-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + adjacentEUtranCellRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + NRFreqRelation-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + offsetMO: + $ref: '#/components/schemas/QOffsetRangeList' + blackListEntry: + type: array + items: + type: integer + minimum: 0 + maximum: 1007 + blackListEntryIdleMode: + type: integer + cellReselectionPriority: + type: integer + cellReselectionSubPriority: + type: number + minimum: 0.2 + maximum: 0.8 + multipleOf: 0.2 + pMax: + type: integer + minimum: -30 + maximum: 33 + qOffsetFreq: + $ref: '#/components/schemas/QOffsetFreq' + qQualMin: + type: number + qRxLevMin: + type: integer + minimum: -140 + maximum: -44 + threshXHighP: + type: integer + minimum: 0 + maximum: 62 + threshXHighQ: + type: integer + minimum: 0 + maximum: 31 + threshXLowP: + type: integer + minimum: 0 + maximum: 62 + threshXLowQ: + type: integer + minimum: 0 + maximum: 31 + tReselectionNr: + type: integer + minimum: 0 + maximum: 7 + tReselectionNRSfHigh: + $ref: '#/components/schemas/TReselectionNRSf' + tReselectionNRSfMedium: + $ref: '#/components/schemas/TReselectionNRSf' + nRFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + EUtranFreqRelation-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + cellIndividualOffset: + $ref: '#/components/schemas/CellIndividualOffset' + blackListEntry: + type: array + items: + type: integer + minimum: 0 + maximum: 1007 + blackListEntryIdleMode: + type: integer + cellReselectionPriority: + type: integer + cellReselectionSubPriority: + type: number + minimum: 0.2 + maximum: 0.8 + multipleOf: 0.2 + pMax: + type: integer + minimum: -30 + maximum: 33 + qOffsetFreq: + $ref: '#/components/schemas/QOffsetFreq' + qQualMin: + type: number + qRxLevMin: + type: integer + minimum: -140 + maximum: -44 + threshXHighP: + type: integer + minimum: 0 + maximum: 62 + threshXHighQ: + type: integer + minimum: 0 + maximum: 31 + threshXLowP: + type: integer + minimum: 0 + maximum: 62 + threshXLowQ: + type: integer + minimum: 0 + maximum: 31 + tReselectionEutran: + type: integer + minimum: 0 + maximum: 7 + tReselectionNRSfHigh: + $ref: '#/components/schemas/TReselectionNRSf' + tReselectionNRSfMedium: + $ref: '#/components/schemas/TReselectionNRSf' + eUTranFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + DANRManagementFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + intrasystemANRManagementSwitch: + type: boolean + intersystemANRManagementSwitch: + type: boolean + + DESManagementFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + desSwitch: + type: boolean + intraRatEsActivationOriginalCellLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + intraRatEsActivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationCandidateCellsLoadParameters" + intraRatEsDeactivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsDeactivationCandidateCellsLoadParameters" + esNotAllowedTimePeriod: + $ref: "#/components/schemas/EsNotAllowedTimePeriod" + interRatEsActivationOriginalCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsActivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsDeactivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + isProbingCapable: + type: string + enum: + - yes + - no + energySavingState: + type: string + enum: + - isNotEnergySaving + - isEnergySaving + + DRACHOptimizationFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + drachOptimizationControl: + type: boolean + ueAccProbilityDist: + $ref: "#/components/schemas/UeAccProbilityDist" + ueAccDelayProbilityDist: + $ref: "#/components/schemas/UeAccDelayProbilityDist" + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + + DMROFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + dmroControl: + type: boolean + maximumDeviationHoTrigger: + $ref: '#/components/schemas/MaximumDeviationHoTrigger' + minimumTimeBetweenHoTriggerChange: + $ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange' + tstoreUEcntxt: + $ref: '#/components/schemas/TstoreUEcntxt' + + DPCIConfigurationFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + dPciConfigurationControl: + type: boolean + nRPciList: + $ref: "#/components/schemas/NRPciList" + + CPCIConfigurationFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + cPciConfigurationControl: + type: boolean + cSonPciList: + $ref: "#/components/schemas/CSonPciList" + + CESManagementFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + cesSwitch: + type: boolean + intraRatEsActivationOriginalCellLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + intraRatEsActivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationCandidateCellsLoadParameters" + intraRatEsDeactivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsDeactivationCandidateCellsLoadParameters" + esNotAllowedTimePeriod: + $ref: "#/components/schemas/EsNotAllowedTimePeriod" + interRatEsActivationOriginalCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsActivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsDeactivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + energySavingControl: + type: string + enum: + - toBeEnergySaving + - toBeNotEnergySaving + energySavingState: + type: string + enum: + - isNotEnergySaving + - isEnergySaving + + RimRSGlobal-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + frequencyDomainPara: + $ref: '#/components/schemas/FrequencyDomainPara' + sequenceDomainPara: + $ref: '#/components/schemas/SequenceDomainPara' + timeDomainPara: + $ref: '#/components/schemas/TimeDomainPara' + RimRSSet: + $ref: '#/components/schemas/RimRSSet-Multiple' + + RimRSSet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + setId: + $ref: '#/components/schemas/RSSetId' + setType: + $ref: '#/components/schemas/RSSetType' + nRCellDURefs: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + + ExternalGnbDuFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_F1C: + $ref: '#/components/schemas/EP_F1C-Multiple' + EP_F1U: + $ref: '#/components/schemas/EP_F1U-Multiple' + ExternalGnbCuUpFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_E1: + $ref: '#/components/schemas/EP_E1-Multiple' + EP_F1U: + $ref: '#/components/schemas/EP_F1U-Multiple' + EP_XnU: + $ref: '#/components/schemas/EP_XnU-Multiple' + ExternalGnbCuCpFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: >- + genericNrm.yaml#/components/schemas/ManagedFunction-Attr + - type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + plmnId: + $ref: '#/components/schemas/PlmnId' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + ExternalNrCellCu: + $ref: '#/components/schemas/ExternalNrCellCu-Multiple' + EP_XnC: + $ref: '#/components/schemas/EP_XnC-Multiple' + EP_E1: + $ref: '#/components/schemas/EP_E1-Multiple' + EP_F1C: + $ref: '#/components/schemas/EP_F1C-Multiple' + ExternalNrCellCu-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + cellLocalId: + type: integer + nrPci: + $ref: '#/components/schemas/NrPci' + plmnIdList: + $ref: '#/components/schemas/PlmnIdList' + nRFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + ExternalENBFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + eNBId: + type: integer + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + ExternalEUTranCell: + $ref: '#/components/schemas/ExternalEUTranCell-Multiple' + ExternalEUTranCell-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + EUtranFrequencyRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + + EP_XnC-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_E1-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_F1C-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_NgC-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_X2C-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_XnU-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_F1U-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + epTransportRefs: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + + EP_NgU-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + epTransportRefs: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + + EP_X2U-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + EP_S1U-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: '#/components/schemas/LocalAddress' + remoteAddress: + $ref: '#/components/schemas/RemoteAddress' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + ManagedElement-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedElement-Single' + GnbDuFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/GnbDuFunction-Single' + GnbCuUpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/GnbCuUpFunction-Single' + GnbCuCpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/GnbCuCpFunction-Single' + + NrCellDu-Multiple: + type: array + items: + $ref: '#/components/schemas/NrCellDu-Single' + NrCellCu-Multiple: + type: array + items: + $ref: '#/components/schemas/NrCellCu-Single' + + NRFrequency-Multiple: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/NRFrequency-Single' + EUtranFrequency-Multiple: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/EUtranFrequency-Single' + + NrSectorCarrier-Multiple: + type: array + items: + $ref: '#/components/schemas/NrSectorCarrier-Single' + Bwp-Multiple: + type: array + items: + $ref: '#/components/schemas/Bwp-Single' + Beam-Multiple: + type: array + items: + $ref: '#/components/schemas/Beam-Single' + RRMPolicyRatio-Multiple: + type: array + items: + $ref: '#/components/schemas/RRMPolicyRatio-Single' + + NRCellRelation-Multiple: + type: array + items: + $ref: '#/components/schemas/NRCellRelation-Single' + EUtranCellRelation-Multiple: + type: array + items: + $ref: '#/components/schemas/EUtranCellRelation-Single' + NRFreqRelation-Multiple: + type: array + items: + $ref: '#/components/schemas/NRFreqRelation-Single' + EUtranFreqRelation-Multiple: + type: array + items: + $ref: '#/components/schemas/EUtranFreqRelation-Single' + + RimRSSet-Multiple: + type: array + items: + $ref: '#/components/schemas/RimRSSet-Single' + + ExternalGnbDuFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalGnbDuFunction-Single' + ExternalGnbCuUpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalGnbCuUpFunction-Single' + ExternalGnbCuCpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalGnbCuCpFunction-Single' + ExternalNrCellCu-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalNrCellCu-Single' + + ExternalENBFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalENBFunction-Single' + ExternalEUTranCell-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalEUTranCell-Single' + + EP_E1-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_E1-Single' + EP_XnC-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_XnC-Single' + EP_F1C-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_F1C-Single' + EP_NgC-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NgC-Single' + EP_X2C-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_X2C-Single' + EP_XnU-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_XnU-Single' + EP_F1U-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_F1U-Single' + EP_NgU-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NgU-Single' + EP_X2U-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_X2U-Single' + EP_S1U-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_S1U-Single' + +#-------- Definitions in TS 28.541 for TS 28.532 --------------------------------- + + resources-nrNrm: + oneOf: + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' + + - $ref: '#/components/schemas/GnbDuFunction-Single' + - $ref: '#/components/schemas/GnbCuUpFunction-Single' + - $ref: '#/components/schemas/GnbCuCpFunction-Single' + + - $ref: '#/components/schemas/NrCellCu-Single' + - $ref: '#/components/schemas/NrCellDu-Single' + + - $ref: '#/components/schemas/NRFrequency-Single' + - $ref: '#/components/schemas/EUtranFrequency-Single' + + - $ref: '#/components/schemas/NrSectorCarrier-Single' + - $ref: '#/components/schemas/Bwp-Single' + - $ref: '#/components/schemas/CommonBeamformingFunction-Single' + - $ref: '#/components/schemas/Beam-Single' + - $ref: '#/components/schemas/RRMPolicyRatio-Single' + + - $ref: '#/components/schemas/NRCellRelation-Single' + - $ref: '#/components/schemas/EUtranCellRelation-Single' + - $ref: '#/components/schemas/NRFreqRelation-Single' + - $ref: '#/components/schemas/EUtranFreqRelation-Single' + + - $ref: '#/components/schemas/DANRManagementFunction-Single' + - $ref: '#/components/schemas/DESManagementFunction-Single' + - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + - $ref: '#/components/schemas/DMROFunction-Single' + - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' + - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' + - $ref: '#/components/schemas/CESManagementFunction-Single' + + - $ref: '#/components/schemas/RimRSGlobal-Single' + - $ref: '#/components/schemas/RimRSSet-Single' + + - $ref: '#/components/schemas/ExternalGnbDuFunction-Single' + - $ref: '#/components/schemas/ExternalGnbCuUpFunction-Single' + - $ref: '#/components/schemas/ExternalGnbCuCpFunction-Single' + - $ref: '#/components/schemas/ExternalNrCellCu-Single' + - $ref: '#/components/schemas/ExternalENBFunction-Single' + - $ref: '#/components/schemas/ExternalEUTranCell-Single' + + - $ref: '#/components/schemas/EP_XnC-Single' + - $ref: '#/components/schemas/EP_E1-Single' + - $ref: '#/components/schemas/EP_F1C-Single' + - $ref: '#/components/schemas/EP_NgC-Single' + - $ref: '#/components/schemas/EP_X2C-Single' + - $ref: '#/components/schemas/EP_XnU-Single' + - $ref: '#/components/schemas/EP_F1U-Single' + - $ref: '#/components/schemas/EP_NgU-Single' + - $ref: '#/components/schemas/EP_X2U-Single' + - $ref: '#/components/schemas/EP_S1U-Single' diff --git a/OpenAPI/provMnS.yaml b/OpenAPI/provMnS.yaml new file mode 100644 index 000000000..b2f84a4d2 --- /dev/null +++ b/OpenAPI/provMnS.yaml @@ -0,0 +1,579 @@ +openapi: 3.0.1 +info: + title: Provisioning MnS + version: 16.4.0 + description: >- + OAS 3.0.1 definition of the Provisioning MnS + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.532 V16.4.0; Generic management services + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ +servers: + - url: 'http://{URI-DN-prefix}/{root}/ProvMnS/v1640/{LDN-first-part}' + variables: + URI-DN-prefix: + description: See subclause 4.4 of TS 32.158 + default: example.com + root: + description: See subclause 4.4 of TS 32.158 + default: 3GPPManagement + LDN-first-part: + description: See subclause 4.4 of TS 32.158 + default: '' +paths: + '/{className}={id}': + parameters: + - name: className + in: path + required: true + schema: + $ref: '#/components/schemas/className-PathType' + - name: id + in: path + required: true + schema: + $ref: '#/components/schemas/id-PathType' + put: + summary: Replaces a complete single resource or creates it if it does not exist + description: >- + With HTTP PUT a complete resource is replaced or created if it does not + exist. The target resource is identified by the target URI. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/resourcePut-RequestType' + responses: + '200': + description: >- + Success case ("200 OK"). + This status code shall be returned when the resource is replaced, and + when the replaced resource representation is not identical to the resource + representation in the request. + This status code may be retourned when the resource is updated and when the + updated resource representation is identical to the resource representation + in the request. + The representation of the updated resource is returned in the response + message body. + content: + application/json: + schema: + $ref: '#/components/schemas/resourceUpdate-ResponseType' + '201': + description: >- + Success case ("201 Created"). + This status code shall be returned when the resource is created. + The representation of the created resource is returned in the response + message body. + content: + application/json: + schema: + $ref: '#/components/schemas/resourceCreation-ResponseType' + '204': + description: >- + Success case ("204 No Content"). + This status code may be returned only when the replaced resource + representation is identical to the representation in the request. + The response has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + callbacks: + notifyMOICreation: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/notifyMOICreation-NotifType' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + notifyMOIDeletion: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/notifyMOIDeletion-NotifType' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + notifyMOIAttributeValueChange: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/notifyMOIAttributeValueChange-NotifType' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + notifyMOIChanges: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/notifyMOIChanges-NotifType' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + get: + summary: Reads one or multiple resources + description: >- + With HTTP GET resources are read. The resources to be retrieved are + identified with the target URI. The attributes and fields parameter + of the query components allow to select the resource properties to be returned. + parameters: + - name: scope + in: query + description: >- + This parameter extends the set of targeted resources beyond the base + resource identified with the path component of the URI. No scoping + mechanism is specified in the present document. + required: false + schema: + $ref: '#/components/schemas/scope-QueryType' + style: form + explode: true + - name: filter + in: query + description: >- + This parameter reduces the targeted set of resources by applying a + filter to the scoped set of resource representations. Only resource + representations for which the filter construct evaluates to "true" + are targeted. No filter language is specified in the present + document. + required: false + schema: + $ref: '#/components/schemas/filter-QueryType' + - name: attributes + in: query + description: >- + This parameter specifies the attributes of the scoped resources that + are returned. + required: true + schema: + $ref: '#/components/schemas/attributes-QueryType' + style: form + explode: false + - name: fields + in: query + description: >- + This parameter specifies the attribute field of the scoped resources + that are returned. + required: false + schema: + $ref: '#/components/schemas/fields-QueryType' + style: form + explode: false + responses: + '200': + description: >- + Success case ("200 OK"). + The resources identified in the request for retrieval are returned + in the response message body. In case the attributes or fields query + parameters are used, only the selected attributes or sub-attributes are + returned. The response message body is constructed according to the + hierarchical response construction method (TS 32.158 [15]). + content: + application/json: + schema: + $ref: '#/components/schemas/resourceRetrieval-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + patch: + summary: Patches one or multiple resources + description: >- + With HTTP PATCH resources are created, updated or deleted. The resources + to be modified are identified with the target URI (base resource) and + the patch document included in the request message body. + requestBody: + description: >- + The request body describes changes to be made to the target resources. + The following patch media types are available + - "application/merge-patch+json" (RFC 7396) + - "application/3gpp-merge-patch+json" (TS 32.158) + - "application/json-patch+json" (RFC 6902) + - "application/3gpp-json-patch+json" (TS 32.158) + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/jsonMergePatch-RequestType' + application/3gpp-merge-patch+json: + schema: + $ref: '#/components/schemas/3gppJsonMergePatch-RequestType' + application/json-patch+json: + schema: + $ref: '#/components/schemas/jsonPatch-RequestType' + application/3gpp-json-patch+json: + schema: + $ref: '#/components/schemas/3gppJsonPatch-RequestType' + responses: + '200': + description: >- + Success case ("200 OK"). + This status code is returned when the updated the resource representations + shall be returned for some reason. + The resource representations are returned in the response message body. The + response message body is constructed according to the hierarchical response + construction method (TS 32.158 [15]) + content: + application/json: + schema: + $ref: '#/components/schemas/resourceUpdate-ResponseType' + '204': + description: >- + Success case ("204 No Content"). + This status code is returned when there is no need to return the updated + resource representations. + The response message body is empty. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' + delete: + summary: Deletes one or multiple resources + description: >- + With HTTP DELETE resources are deleted. The resources to be deleted are + identified with the target URI. + parameters: + - name: scope + in: query + description: >- + This parameter extends the set of targeted resources beyond the base + resource identified with the path component of the URI. No scoping + mechanism is specified in the present document. + required: false + schema: + $ref: '#/components/schemas/scope-QueryType' + - name: filter + in: query + description: >- + This parameter reduces the targeted set of resources by applying a + filter to the scoped set of resource representations. Only resources + representations for which the filter construct evaluates to "true" + are returned. No filter language is specified in the present + document. + required: false + schema: + $ref: '#/components/schemas/filter-QueryType' + responses: + '200': + description: >- + Success case ("200 OK"). + This status code shall be returned, when query parameters are present in + the request and one or multiple resources are deleted. + The URIs of the deleted resources are returned in the response message body. + '204': + description: >- + Success case ("204 No Content"). + This status code shall be returned, when no query parameters are present in + the request and only one resource is deleted. + The message body is empty. + content: + application/json: + schema: + $ref: '#/components/schemas/resourceDeletion-ResponseType' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/error-ResponseType' +components: + schemas: + dateTime-Type: + type: string + format: date-time + long-Type: + type: integer + format: int64 + uri-Type: + type: string + correlatedNotification-Type: + type: object + properties: + source: + $ref: '#/components/schemas/uri-Type' + notificationIds: + type: array + items: + $ref: '#/components/schemas/notificationId-Type' + notificationId-Type: + $ref: '#/components/schemas/long-Type' + notificationType-Type: + type: string + enum: + - notifyMOICreation + - notifyMOIDeletion + - notifyMOIAttributeValueChange + systemDN-Type: + type: string + additionalText-Type: + type: string + sourceIndicator-Type: + type: string + enum: + - resourceOperation + - mangementOperation + - sONOperation + - unknown + header-Type: + type: object + properties: + href: + $ref: '#/components/schemas/uri-Type' + notificationId: + $ref: '#/components/schemas/notificationId-Type' + notificationType: + $ref: '#/components/schemas/notificationType-Type' + eventTime: + $ref: '#/components/schemas/dateTime-Type' + systemDN: + $ref: '#/components/schemas/systemDN-Type' + required: + - href + - notificationId + - notificationType + - eventTime + - systemDN + scopeType-Type: + type: string + enum: + - BASE_ONLY + - BASE_NTH_LEVEL + - BASE_SUBTREE + - BASE_ALL + scopeLevel-Type: + type: integer + className-PathType: + type: string + id-PathType: + type: string + attributes-QueryType: + type: array + items: + type: string + fields-QueryType: + type: array + items: + type: string + filter-QueryType: + type: string + scope-QueryType: + type: object + properties: + scopeType: + $ref: '#/components/schemas/scopeType-Type' + scopeLevel: + $ref: '#/components/schemas/scopeLevel-Type' + + resourcePut-RequestType: + $ref: '#/components/schemas/resourceRepresentation-Type' + jsonMergePatch-RequestType: + $ref: '#/components/schemas/resourceRepresentation-Type' + 3gppJsonMergePatch-RequestType: + $ref: '#/components/schemas/resourceRepresentation-Type' + jsonPatch-RequestType: + type: array + items: + type: object + 3gppJsonPatch-RequestType: + type: array + items: + type: object + + error-ResponseType: + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + resourceRetrieval-ResponseType: + $ref: '#/components/schemas/resourceRepresentation-Type' + resourceCreation-ResponseType: + $ref: '#/components/schemas/resourceRepresentation-Type' + resourceUpdate-ResponseType: + $ref: '#/components/schemas/resourceRepresentation-Type' + resourceDeletion-ResponseType: + type: array + items: + $ref: '#/components/schemas/uri-Type' + + resourceRepresentation-Type: + oneOf: + - type: object + properties: + id: + type: string + attributes: + type: object + additionalProperties: + type: array + items: + type: object + - anyOf: + - $ref: 'genericNrm.yaml#/components/schemas/resources-genericNrm' + - $ref: 'nrNrm.yaml#/components/schemas/resources-nrNrm' + - $ref: '5gcNrm.yaml#/components/schemas/resources-5gcNrm' + - $ref: 'sliceNrm.yaml#/components/schemas/resources-sliceNrm' + + mOIChange-Type: + type: object + properties: + notificationId: + $ref: '#/components/schemas/notificationId-Type' + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/correlatedNotification-Type' + additionalText: + $ref: '#/components/schemas/additionalText-Type' + sourceIndicator: + $ref: '#/components/schemas/sourceIndicator-Type' + path: + $ref: '#/components/schemas/uri-Type' + operation: + type: string + enum: + - CREATE + - DELETE + - REPLACE + value: + oneOf: + - type: object + additionalProperties: + nullable: true + - type: array + items: + type: object + minItems: 1 + maxItems: 2 + + notifyMOICreation-NotifType: + allOf: + - $ref: '#/components/schemas/header-Type' + - type: object + properties: + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/correlatedNotification-Type' + additionalText: + $ref: '#/components/schemas/additionalText-Type' + sourceIndicator: + $ref: '#/components/schemas/sourceIndicator-Type' + attributeList: + type: object + additionalProperties: + nullable: true + notifyMOIDeletion-NotifType: + allOf: + - $ref: '#/components/schemas/header-Type' + - type: object + properties: + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/correlatedNotification-Type' + additionalText: + $ref: '#/components/schemas/additionalText-Type' + sourceIndicator: + $ref: '#/components/schemas/sourceIndicator-Type' + attributeList: + type: object + additionalProperties: true + notifyMOIAttributeValueChange-NotifType: + allOf: + - $ref: '#/components/schemas/header-Type' + - type: object + properties: + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/correlatedNotification-Type' + additionalText: + $ref: '#/components/schemas/additionalText-Type' + sourceIndicator: + $ref: '#/components/schemas/sourceIndicator-Type' + attributeValueChange: + type: object + additionalProperties: + type: array + minItems: 1 + maxItems: 2 + items: + nullable: true + required: + - attributeValueChange + notifyMOIChanges-NotifType: + allOf: + - $ref: '#/components/schemas/header-Type' + - type: object + properties: + mOIChanges: + type: array + items: + $ref: '#/components/schemas/mOIChange-Type' + required: + - mOIChanges diff --git a/OpenAPI/sliceNrm.yaml b/OpenAPI/sliceNrm.yaml new file mode 100644 index 000000000..bf6b4d71c --- /dev/null +++ b/OpenAPI/sliceNrm.yaml @@ -0,0 +1,632 @@ +openapi: 3.0.1 +info: + title: Slice NRM + version: 17.4.0 + description: >- + OAS 3.0.1 specification of the Slice NRM + @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.541; 5G NRM, Slice NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ +paths: {} +components: + schemas: + +#------------ Type definitions --------------------------------------------------- + + Float: + type: number + format: float + MobilityLevel: + type: string + enum: + - STATIONARY + - NOMADIC + - RESTRICTED MOBILITY + - FULLY MOBILITY + SynAvailability: + type: string + enum: + - NOT SUPPORTED + - BETWEEN BS AND UE + - BETWEEN BS AND UE & UE AND UE + PositioningAvailability: + type: array + items: + type: string + enum: + - CIDE-CID + - OTDOA + - RF FINGERPRINTING + - AECID + - HYBRID POSITIONING + - NET-RTK + Predictionfrequency: + type: string + enum: + - PERSEC + - PERMIN + - PERHOUR + SharingLevel: + type: string + enum: + - SHARED + - NON-SHARED + + NetworkSliceSharingIndicator: + type: string + enum: + - SHARED + - NON-SHARED + + ServiceType: + type: string + enum: + - eMBB + - RLLC + - MIoT + - V2X + SliceSimultaneousUse: + type: string + enum: + - ZERO + - ONE + - TWO + - THREE + - FOUR + Category: + type: string + enum: + - CHARACTER + - SCALABILITY + Tagging: + type: array + items: + type: string + enum: + - PERFORMANCE + - FUNCTION + - OPERATION + Exposure: + type: string + enum: + - API + - KPI + ServAttrCom: + type: object + properties: + category: + $ref: '#/components/schemas/Category' + tagging: + $ref: '#/components/schemas/Tagging' + exposure: + $ref: '#/components/schemas/Exposure' + Support: + type: string + enum: + - NOT SUPPORTED + - SUPPORTED + DelayTolerance: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + support: + $ref: '#/components/schemas/Support' + DeterministicComm: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + availability: + $ref: '#/components/schemas/Support' + periodicityList: + type: string + XLThpt: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + guaThpt: + $ref: '#/components/schemas/Float' + maxThpt: + $ref: '#/components/schemas/Float' + MaxPktSize: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + maxsize: + type: integer + MaxNumberofPDUSessions: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + nOofPDUSessions: + type: integer + KPIMonitoring: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + kPIList: + type: string + NBIoT: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + support: + $ref: '#/components/schemas/Support' + RadioSpectrum: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + nROperatingBands: + type: string + Synchronicity: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + availability: + $ref: '#/components/schemas/SynAvailability' + accuracy: + $ref: '#/components/schemas/Float' + SynchronicityRANSubnet: + type: object + properties: + availability: + $ref: '#/components/schemas/SynAvailability' + accuracy: + $ref: '#/components/schemas/Float' + Positioning: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + availability: + $ref: '#/components/schemas/PositioningAvailability' + predictionfrequency: + $ref: '#/components/schemas/Predictionfrequency' + accuracy: + $ref: '#/components/schemas/Float' + PositioningRANSubnet: + type: object + properties: + availability: + $ref: '#/components/schemas/PositioningAvailability' + predictionfrequency: + $ref: '#/components/schemas/Predictionfrequency' + accuracy: + $ref: '#/components/schemas/Float' + UserMgmtOpen: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + support: + $ref: '#/components/schemas/Support' + V2XCommModels: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + v2XMode: + $ref: '#/components/schemas/Support' + TermDensity: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + density: + type: integer + NsInfo: + type: object + properties: + nsInstanceId: + type: string + nsName: + type: string + EmbbEEPerfReq: + type: integer + UrllcEEPerfReq: + type: integer + MIoTEEPerfReq: + type: object + properties: + KpiType: + type: string + enum: + - MAXREGSUBS + - MEANACTIVEUES + Req: + type: integer + EEPerfReq: + oneOf: + - $ref: '#/components/schemas/EmbbEEPerfReq' + - $ref: '#/components/schemas/UrllcEEPerfReq' + - $ref: '#/components/schemas/MIoTEEPerfReq' + EnergyEfficiency: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + performance: + $ref: '#/components/schemas/EEPerfReq' + CNSliceSubnetProfile: + type: object + properties: + maxNumberofUEs: + type: integer + latency: + type: integer + dLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + maxNumberOfPDUSessions: + type: integer + coverageAreaTAList: + type: integer + resourceSharingLevel: + $ref: '#/components/schemas/SharingLevel' + dLMaxPktSize: + type: integer + uLMaxPktSize: + type: integer + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + synchronicity: + $ref: '#/components/schemas/SynchronicityRANSubnet' + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + reliability: + type: string + energyEfficiency: + type: integer + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + survivalTime: + type: string + RANSliceSubnetProfile: + type: object + properties: + coverageAreaTAList: + type: integer + uEMobilityLevel: + $ref: '#/components/schemas/MobilityLevel' + resourceSharingLevel: + $ref: '#/components/schemas/SharingLevel' + maxNumberofUEs: + type: integer + activityFactor: + type: integer + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uESpeed: + type: integer + reliability: + type: string + serviceType: + $ref: '#/components/schemas/ServiceType' + dLMaxPktSize: + type: integer + uLMaxPktSize: + type: integer + nROperatingBands: + type: string + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + positioning: + $ref: '#/components/schemas/PositioningRANSubnet' + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + energyEfficiency: + type: integer + termDensity: + $ref: '#/components/schemas/TermDensity' + survivalTime: + type: string + synchronicity: + $ref: '#/components/schemas/SynchronicityRANSubnet' + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + TopSliceSubnetProfile: + type: object + properties: + latency: + type: integer + maxNumberofUEs: + type: integer + dLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + dLMaxPktSize: + type: integer + uLMaxPktSize: + type: integer + maxNumberOfPDUSessions: + type: integer + nROperatingBands: + type: string + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + energyEfficiency: + type: integer + synchronicity: + $ref: '#/components/schemas/Synchronicity' + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + positioning: + $ref: '#/components/schemas/Positioning' + termDensity: + $ref: '#/components/schemas/TermDensity' + activityFactor: + type: integer + coverageAreaTAList: + type: integer + resourceSharingLevel: + $ref: '#/components/schemas/SharingLevel' + uEMobilityLevel: + $ref: '#/components/schemas/MobilityLevel' + uESpeed: + type: integer + reliability: + type: string + serviceType: + $ref: '#/components/schemas/ServiceType' + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + survivalTime: + type: string + + ServiceProfile: + type: object + properties: + serviceProfileId: + type: string + plmnInfoList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList' + maxNumberofUEs: + type: number + latency: + type: number + uEMobilityLevel: + $ref: '#/components/schemas/MobilityLevel' + sst: + $ref: 'nrNrm.yaml#/components/schemas/Sst' + networkSliceSharingIndicator: + $ref: '#/components/schemas/NetworkSliceSharingIndicator' + availability: + type: number + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + dLThptPerSlice: + $ref: '#/components/schemas/XLThpt' + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerSlice: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + dLMaxPktSize: + $ref: '#/components/schemas/MaxPktSize' + uLMaxPktSize: + $ref: '#/components/schemas/MaxPktSize' + maxNumberofPDUSessions: + $ref: '#/components/schemas/MaxNumberofPDUSessions' + kPIMonitoring: + $ref: '#/components/schemas/KPIMonitoring' + nBIoT: + $ref: '#/components/schemas/NBIoT' + radioSpectrum: + $ref: '#/components/schemas/RadioSpectrum' + synchronicity: + $ref: '#/components/schemas/Synchronicity' + positioning: + $ref: '#/components/schemas/Positioning' + userMgmtOpen: + $ref: '#/components/schemas/UserMgmtOpen' + v2XModels: + $ref: '#/components/schemas/V2XCommModels' + coverageArea: + type: string + termDensity: + $ref: '#/components/schemas/TermDensity' + activityFactor: + $ref: '#/components/schemas/Float' + uESpeed: + type: integer + jitter: + type: integer + survivalTime: + type: string + reliability: + type: string + maxDLDataVolume: + type: string + maxULDataVolume: + type: string + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + energyEfficiency: + $ref: '#/components/schemas/EnergyEfficiency' + SliceProfile: + type: object + properties: + serviceProfileId: + type: string + plmnInfoList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList' + cNSliceSubnetProfile: + $ref: '#/components/schemas/CNSliceSubnetProfile' + rANSliceSubnetProfile: + $ref: '#/components/schemas/RANSliceSubnetProfile' + topSliceSubnetProfile: + $ref: '#/components/schemas/TopSliceSubnetProfile' + + IpAddress: + oneOf: + - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + + LogicInterfaceInfo: + type: object + properties: + logicalInterfceType: + type: string + enum: + - VLAN + - MPLS + - Segment + logicalInterfceId: + type: string + + ServiceProfileList: + type: array + items: + $ref: '#/components/schemas/ServiceProfile' + + SliceProfileList: + type: array + items: + $ref: '#/components/schemas/SliceProfile' + +#------------ Definition of concrete IOCs ---------------------------------------- + SubNetwork-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + NetworkSlice: + $ref: '#/components/schemas/NetworkSlice-Multiple' + NetworkSliceSubnet: + $ref: '#/components/schemas/NetworkSliceSubnet-Multiple' + EP_Transport: + $ref: '#/components/schemas/EP_Transport-Multiple' + + NetworkSlice-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + networkSliceSubnetRef: + $ref: 'genericNrm.yaml#/components/schemas/Dn' + operationalState: + $ref: 'genericNrm.yaml#/components/schemas/OperationalState' + administrativeState: + $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' + serviceProfileList: + $ref: '#/components/schemas/ServiceProfileList' + + NetworkSliceSubnet-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + managedFunctionRefList: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + networkSliceSubnetRefList: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + operationalState: + $ref: 'genericNrm.yaml#/components/schemas/OperationalState' + administrativeState: + $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' + nsInfo: + $ref: '#/components/schemas/NsInfo' + sliceProfileList: + $ref: '#/components/schemas/SliceProfileList' + epTransportRefList: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + priorityLabel: + type: integer + + EP_Transport-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + ipAddress: + $ref: '#/components/schemas/IpAddress' + logicInterfaceInfo: + $ref: '#/components/schemas/LogicInterfaceInfo' + nextHopInfo: + type: string + qosProfile: + type: string + epApplicationRefs: + $ref: 'genericNrm.yaml#/components/schemas/DnList' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + + NetworkSlice-Multiple: + type: array + items: + $ref: '#/components/schemas/NetworkSlice-Single' + + NetworkSliceSubnet-Multiple: + type: array + items: + $ref: '#/components/schemas/NetworkSliceSubnet-Single' + + EP_Transport-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Transport-Single' + +#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- + + resources-sliceNrm: + oneOf: + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/NetworkSlice-Single' + - $ref: '#/components/schemas/NetworkSliceSubnet-Single' + - $ref: '#/components/schemas/EP_Transport-Single' diff --git a/OpenAPI/streamingDataMnS.yaml b/OpenAPI/streamingDataMnS.yaml new file mode 100644 index 000000000..ab7f71d4a --- /dev/null +++ b/OpenAPI/streamingDataMnS.yaml @@ -0,0 +1,453 @@ +openapi: 3.0.1 +info: + title: TS 28.532 Streaming data reporting service + version: 16.4.0 + description: OAS 3.0.1 specification for the Streaming data reporting service (Streaming MnS) +servers: + - url: '{protocol}://{root}/StreamingDataReportingMnS/{version}' + variables: + protocol: + description: Protocol used + enum: + - http + - https + - wss + default: https + root: + description: Indicates the host name and optional port, and an optional sequence of path segments that together represent a prefix path. + default: example.com + version: + description: Indicates the current version of the specification + default: 16.4.0 +paths: + '/connections': + post: + summary: Inform consumer about reporting streams to be carried by the new connection and receive a new connection id. + description: Exchange of meta-data (producer informs consumer about its own identity and the nature of the data to be reported via streaming) phase of the connection establishement by streaming data reporting producer to the streaming data reporting consumer (i.e. streaming target). + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/connectionRequest-Type' + responses: + '201': + description: Success case (201 Created). + headers: + Location: + description: Location of the created connection resource. + schema: + $ref: '#/components/schemas/connectionId-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/failedConnectionResponse-Type' + get: + summary: Obtain information about connections. + description: Enables the streaming data reporting service producer to obtain information about one or more streaming connections. + parameters: + - name: connectionIdList + in: query + description: The list of connectionId for which the connection information is to be returned. + required: false + schema: + type: array + items: + $ref: '#/components/schemas/connectionId-Type' + responses: + '200': + description: Success case (200 OK). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/connectionInfo-Type' + '202': + description: Partial success case (202 Partially retrieved). Subset of the resources identified in the request for retrieval are returned in the response message body. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/connectionInfo-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' + '/connections/{connectionId}': + get: + summary: Obtain information about a connection. + description: Enables the streaming data reporting service producer to obtain information about one streaming connection. + parameters: + - name: connectionId + in: path + description: Indicate the ID (URI) of the connection for which the information is being retrieved + required: true + schema: + $ref: '#/components/schemas/connectionId-Type' + - name: Connection + in: header + schema: + $ref: '#/components/schemas/websocketHeaderConnection-Type' + - name: Sec-WebSocket-Extensions + in: header + schema: + $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Extensions-Type' + - name: Sec-WebSocket-Key + in: header + schema: + $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Key-Type' + - name: Sec-WebSocket-Protocol + in: header + schema: + $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Protocol-Type' + - name: Sec-WebSocket-Version + in: header + schema: + $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Version-Type' + responses: + '101': + description: Success case (101 Switching Protocols). The connection has been successfully switched to WebSocket. The response message body is absent. + headers: + Upgrade: + schema: + $ref: '#/components/schemas/websocketHeaderUpgrade-Type' + Connection: + schema: + $ref: '#/components/schemas/websocketHeaderConnection-Type' + Sec-WebSocket-Accept: + schema: + $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Accept-Type' + '200': + description: Success case (200 OK). The resource identified in the request for retrieval returned in the response message body. + content: + application/json: + schema: + $ref: '#/components/schemas/connectionInfo-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' + '/connections/{connectionId}/streams': + post: + summary: Inform consumer about new reporting streams on an existing connection. + description: Allows the producer to add one or more reporting streams to an already established streaming connection. + parameters: + - name: connectionId + in: path + description: Indicate the ID (URI) of the connection for which the reporting stream information is being added. + required: true + schema: + $ref: '#/components/schemas/connectionId-Type' + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/streamInfo-Type' + responses: + '201': + description: Success case (201 Posted). + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/streamInfo-Type' + '202': + description: Partial success case (202 Posted). + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/streamInfo-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' + delete: + summary: Remove reporting streams from an existing connection + description: Allows the producer to remove one or more reporting streams from an already established streaming connection. + parameters: + - name: connectionId + in: path + description: Indicate the ID (URI) of the connection for which the reporting stream information is being removed. + required: true + schema: + $ref: '#/components/schemas/connectionId-Type' + - name: streamIds + in: query + description: The list of streamId for the stream(s) to be deleted. + required: true + schema: + type: array + items: + $ref: '#/components/schemas/streamId-Type' + responses: + '204': + description: Success case (204 No Content). The stream information resource has been deleted. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' + get: + summary: Obtain information about streams. + description: Enables the streaming data reporting service producer to obtain information about one or more reporting streams. + parameters: + - name: connectionId + in: path + description: Indicate the ID (URI) of the connection for which the information is being retrieved + required: true + schema: + $ref: '#/components/schemas/connectionId-Type' + - name: streamIds + in: query + description: The list of streamId for which the stream information is to be retrieved. + required: true + schema: + type: array + items: + $ref: '#/components/schemas/streamId-Type' + responses: + '200': + description: Success case (200 OK). + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/streamInfoWithReporters-Type' + '202': + description: Partial success case (202 Partially retrieved). + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/streamInfoWithReporters-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' + '/connections/{connectionId}/streams/{streamId}': + get: + summary: Obtain information about stream + description: Enables the streaming data reporting service producer to obtain information about a reporting stream. + parameters: + - name: connectionId + in: path + description: Indicate the ID (URI) of the connection for which the information is being retrieved + required: true + schema: + $ref: '#/components/schemas/connectionId-Type' + - name: streamId + in: path + description: Indicate the ID of the reporting stream for which the information is being retrieved + required: true + schema: + $ref: '#/components/schemas/streamId-Type' + responses: + '200': + description: Success case (200 OK). + content: + application/json: + schema: + $ref: '#/components/schemas/streamInfoWithReporters-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: '#/components/schemas/errorResponse-Type' +components: + schemas: + analyticsInfo-Type: + description: Information specific to analytics reporting. + type: object + properties: + activityDetails: + type: string + connectionId-Type: + $ref: '#/components/schemas/uri-Type' + connectionInfo-Type: + type: object + properties: + connection: + $ref: '#/components/schemas/connectionId-Type' + producer: + $ref: '#/components/schemas/producerId-Type' + streams: + type: array + items: + $ref: '#/components/schemas/streamId-Type' + connectionRequest-Type: + type: object + properties: + producer: + $ref: '#/components/schemas/producerId-Type' + streams: + type: array + items: + $ref: '#/components/schemas/streamInfo-Type' + errorResponse-Type: + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string + failedConnectionResponse-Type: + type: object + properties: + error: + type: array + items: + type: object + properties: + streamId: + $ref: '#/components/schemas/streamId-Type' + errorReason: + type: string + measObjDn-Type: + description: DN of the measured object instance (see 3GPP TS 28.550) + allOf: + - $ref: '#/components/schemas/systemDN-Type' + measTypes-Type: + description: an ordered list of measurement type or KPI whose measurement values or KPI result values are to be reported by the Performance Data Stream Units (see Annex C of TS 28.550) via this stream + type: array + items: + type: string + performanceInfo-Type: + description: Information specific to performance data reporting + type: object + properties: + measObjDn: + $ref: '#/components/schemas/measObjDn-Type' + measTypes: + $ref: '#/components/schemas/measTypes-Type' + measurementReaderId: + $ref: '#/components/schemas/systemDN-Type' + jobId: + type: string + required: + - measObjDn + - measTypes + producerId-Type: + description: DN of the streaming data reporting MnS producer. + allOf: + - $ref: '#/components/schemas/systemDN-Type' + serializationFormat-Type: + type: string + enum: + - GPB + - ASN1 + streamId-Type: + description: globally unique stream identifier + type: string + example: '26F452550021' + streamInfo-Type: + description: Reporting stream meta-data. + type: object + properties: + streamType: + $ref: '#/components/schemas/streamType-Type' + serializationFormat: + $ref: '#/components/schemas/serializationFormat-Type' + streamId: + oneOf: + - $ref: '#/components/schemas/streamId-Type' + - $ref: '#/components/schemas/traceReference-Type' + additionalInfo: + oneOf: + - $ref: '#/components/schemas/traceInfo-Type' + - $ref: '#/components/schemas/performanceInfo-Type' + - $ref: '#/components/schemas/analyticsInfo-Type' + - $ref: '#/components/schemas/vsDataContainer-Type' + required: + - streamType + - serializationFormat + - streamId + streamInfoWithReporters-Type: + description: Reporting stream meta-data with added information about reporters. + type: object + properties: + streamInfo: + $ref: '#/components/schemas/streamInfo-Type' + reporters: + type: array + items: + $ref: '#/components/schemas/producerId-Type' + systemDN-Type: + description: See 3GPP TS 32.300 for details + type: string + example: 'SubNetwork=ABCNetwork,SubNetwork=MUC01,GNBDUFunction=XYZ0100' + streamType-Type: + type: string + enum: + - TRACE + - PERFORMANCE + - ANALYTICS + - PROPRIETARY + traceInfo-Type: + description: Information specific to trace data reporting + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/TraceJob-Attr' + traceReference-Type: + description: Trace Reference (see clause 5.6 of 3GPP TS 32.422) as stream identifier for streaming trace data reporting + type: string + example: '4358070034D7' + uri-Type: + description: Resource URI + type: string + vsDataContainer-Type: + description: container for vendor specific data (see 3GPP TS 28.622) + type: object + properties: + vsDataType: + type: string + vsData: + type: string + vsDataFormatVersion: + type: string + websocketHeaderConnection-Type: + description: Header value for the upgrade request and response. + type: string + enum: + - Upgrade + websocketHeaderUpgrade-Type: + description: Header value for the upgrade to WebSocket request and response. + type: string + enum: + - websocket + websocketHeader-Sec-WebSocket-Accept-Type: + description: Header value for secure WebSocket response. Carries hash. + type: string + websocketHeader-Sec-WebSocket-Extensions-Type: + description: Header value for secure WebSocket request. Carries protocol extensions. + type: string + websocketHeader-Sec-WebSocket-Key-Type: + description: Header value for secure WebSocket request. Provides information to the server which is needed in order to confirm that the client is entitled to request an upgrade to WebSocket. + type: string + websocketHeader-Sec-WebSocket-Protocol-Type: + description: Header value for secure WebSocket request. Carries a comma-separated list of subprotocol names, in the order of preference. + type: string + websocketHeader-Sec-WebSocket-Version-Type: + description: Header value for secure WebSocket request and response. Carries the WebSocket protocol version to be used. + type: string -- GitLab From 21691d3b813af39b0d4a6358ccfdbf98c804550f Mon Sep 17 00:00:00 2001 From: "U-ERICSSON\\ETHBLL" Date: Sun, 2 Jan 2022 19:57:51 +0100 Subject: [PATCH 12/21] S5-216039 CR-0607 --- yang-models/_3gpp-common-yang-types.yang | 8 + yang-models/_3gpp-nr-nrm-gnbdufunction.yang | 136 +++++- yang-models/_3gpp-nr-nrm-nrcelldu.yang | 239 +++++++++- yang-models/_3gpp-nr-nrm-rimrsset.yang | 497 ++++++++++++++++++++ 4 files changed, 846 insertions(+), 34 deletions(-) create mode 100755 yang-models/_3gpp-nr-nrm-rimrsset.yang diff --git a/yang-models/_3gpp-common-yang-types.yang b/yang-models/_3gpp-common-yang-types.yang index d5371e347..9100fd619 100755 --- a/yang-models/_3gpp-common-yang-types.yang +++ b/yang-models/_3gpp-common-yang-types.yang @@ -13,6 +13,7 @@ module _3gpp-common-yang-types { network slicing."; reference "3GPP TS 28.541"; + revision 2021-11-01 { reference "CR-0141"; } revision 2021-09-30 { description "Added Longitude, Latitude, TenthOfDegrees, OnOff."; reference "CR-0138"; @@ -42,6 +43,13 @@ module _3gpp-common-yang-types { reference "Initial version."; } + typedef EnabledDisabled { + type enumeration { + enum DISABLED ; + enum ENABLED ; + } + } + typedef TenthOfDegrees { type uint16 { range 0..3600; diff --git a/yang-models/_3gpp-nr-nrm-gnbdufunction.yang b/yang-models/_3gpp-nr-nrm-gnbdufunction.yang index f69c62299..c52250c6d 100755 --- a/yang-models/_3gpp-nr-nrm-gnbdufunction.yang +++ b/yang-models/_3gpp-nr-nrm-gnbdufunction.yang @@ -7,30 +7,131 @@ module _3gpp-nr-nrm-gnbdufunction { import _3gpp-common-managed-element { prefix me3gpp; } import _3gpp-common-top { prefix top3gpp; } import _3gpp-nr-nrm-rrmpolicy { prefix nrrrmpolicy3gpp; } + import _3gpp-common-yang-types { prefix types3gpp; } organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "Defines the YANG mapping of the GNBDUFunction Information Object Class (IOC) that is part of the NR Network Resource Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-10-28 { reference CR-0607 ; } revision 2021-04-30 { reference CR-0490 ; } revision 2020-10-02 { reference CR-0384 ; } revision 2020-03-12 { reference "SP-200233 S5-201547" ; } revision 2020-02-14 { reference S5-20XXXX ; } revision 2019-10-28 { reference S5-193518 ; } - revision 2019-08-21 { - description "Initial revision."; - } + revision 2019-08-21 {reference "Initial revision."; } feature DRACHOptimizationFunction { - description "Classs representing D-SON function of RACH optimization -feature"; + description "Class representing D-SON function of RACH optimization + feature"; + } + + grouping RimRSReportInfoGrp { + description "This data type defines necessary reporting information + derived from the detected RIM-RS, including + 1) The detected set ID; + 2) Propagation delay in number of OFDM symbols + 3) Functionality of the RS (RS-1 or RS-2, Enough or Not enough + mitigation for RS-1). + + RS-1 is equivalent to RIM-RS type 1 (see 38.211, subclause 7.4.1.6). + RS-2 is equivalent to RIM-RS type 2 (see 38.211, subclause 7.4.1.6). + Enough mitigation for RS-1 means 'Enough' / 'Not enough' indication + functionality is enabled for RIM RS-1 and RIM-RS type 1 is used to + indicate 'enough mitigation' functionality. + Not enough mitigation for RS-1 means 'Enough' / 'Not enough' indication + functionality is enabled for RIM RS-1 and RIM-RS type 1 is used to + indicate 'Not enough mitigation' functionality."; + + leaf detectedSetID { + type uint32 ; + description "Set ID of the detected RIM-RS + allowedValues: 0,1...max{totalnrofSetIdofRS1, totalnrofSetIdofRS2}"; + } + + leaf propagationDelay { + type uint32 ; + must '. <= ../../maxPropagationDelay' { + error-message "allowedValues: 0, 1.. maxPropagationDelay"; + } + description "This attribute indicates the propagation delay of the + detected RIM-RS, in number of OFDM symbol."; + } + + leaf functionalityOfRIMRS { + type enumeration { + enum RS1; + enum RS2; + enum RS1_FOR_ENOUGH_MITIGATION; + enum RS1_FOR_NOT_ENOUGH_MITIGATION; + } + mandatory true; + description "Indicates the functionality of the detected RIM-RS. + If the indication of enableEnoughNotEnoughIndication is 'enabled', + valid values are {RS2, RS1forEnoughMitigation, + RS1forNotEnoughMitigation}; + If the indication of enableEnoughNotEnoughIndication is 'disabled', + valid values are {RS1, RS2}. + + RS1forEnoughMitigation means RIM-RS type 1 is used to indicate + 'enough mitigation' functionality. + RS1forNotEnoughMitigation means RIM-RS type 1 is used to indicate + 'Not enough mitigation' functionality."; + } + } + + grouping RimRSReportConfGrp { + description "Defines RIM-RS reporting configuration"; + + leaf reportIndicator { + type types3gpp:EnabledDisabled; + default DISABLED; + description "Used to enable or disable the RS report on a gNB. + If the indication is 'enable', the gNB starts to periodically report + necessary information derived from the detected RIM-RS to OAM. + If the indication is 'disable', the gNB stops reporting."; + } + + leaf reportInterval { + type uint32; + mandatory true; + units ms; + description "Used to define reporting interval of a gNB in ms."; + } + + leaf nrofRIMRSReportInfo { + type uint32; + mandatory true; + description "Used to define the maximum number of RIMRSReportInfo in + a single report."; + } + + leaf maxPropagationDelay { + type uint32 { + range "0..327679"; + } + mandatory true; + description "Used to define the maximum reported OFDM symbol number for + the propagation delay of the detected RIM-RS in each RIMRSReportInfo. + + allowedValues: 0, 1..20**2*maxNrofSymbols-1, where maxNrofSymbols=14."; + } + + list RimRSReportInfoList { + key detectedSetID; + description "Represents a list (the length of the list is + nrofRIMRSReportInfo) of necessary information derived from the + detected RIM-RS."; + uses RimRSReportInfoGrp; + } } grouping GNBDUFunctionGrp { description "Represents the GNBDUFunction IOC."; reference "3GPP TS 28.541"; - uses mf3gpp:ManagedFunctionGrp; + uses mf3gpp:ManagedFunctionGrp; uses nrrrmpolicy3gpp:RRMPolicy_Grp; leaf gNBId { @@ -54,26 +155,21 @@ feature"; description "Uniquely identifies the DU at least within a gNB."; reference "3GPP TS 38.473"; } - + leaf gNBDUName { type string { length "1..150"; } description "Identifies the Distributed Unit of an NR node"; reference "3GPP TS 38.473"; - } - - leaf aggressorSetID { - type uint32 { range "0..4194304"; } - config false; - description "Indicates the associated aggressor gNB Set ID of the cell - Valid when Remote Interference Management function is supported."; - reference "3GPP TS 38.211 subclause 7.4.1.6"; } - leaf victimSetID { - type uint32 { range "0..4194304"; } + + list rimRSReportConf { + key reportInterval; config false; - description "Indicates the associated victim gNB Set ID of the cell - Valid when Remote Interference Management function is supported."; - reference "3GPP TS 38.211 subclause 7.4.1.6"; + min-elements 1; + max-elements 1; + description "Used to configure gNBs to report the all necessary + information derived from the detected RIM-RS to OAM."; + uses RimRSReportConfGrp; } } diff --git a/yang-models/_3gpp-nr-nrm-nrcelldu.yang b/yang-models/_3gpp-nr-nrm-nrcelldu.yang index 7869934b1..0cb6dce0c 100755 --- a/yang-models/_3gpp-nr-nrm-nrcelldu.yang +++ b/yang-models/_3gpp-nr-nrm-nrcelldu.yang @@ -10,6 +10,7 @@ module _3gpp-nr-nrm-nrcelldu { import _3gpp-nr-nrm-gnbdufunction { prefix gnbdu3gpp; } import _3gpp-nr-nrm-rrmpolicy { prefix nrrrmpolicy3gpp; } import _3gpp-5g-common-yang-types { prefix types5g3gpp; } + import ietf-yang-types { prefix yang; } organization "3GPP SA5"; @@ -18,6 +19,7 @@ module _3gpp-nr-nrm-nrcelldu { Class (IOC) that is part of the NR Network Resource Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-10-28 { reference CR-0607 ; } revision 2021-01-25 { reference CR-0454 ; } revision 2020-11-25 { reference CR-0386 ; } revision 2020-11-05 { reference CR-0412 ; } @@ -37,6 +39,45 @@ module _3gpp-nr-nrm-nrcelldu { PCI configuration feature"; } + grouping NPNIdentityGrp { + description "Represents the NPN supported by the <> using this + <> as one of its attributes in case of the cell is a + NPN-only cell."; + + list plmnid { + key "mcc mnc"; + min-elements 1; + description "PLMNId"; + uses types3gpp:PLMNId; + } + + leaf cAGIdList { + type string; + mandatory true; + description "It identifies a CAG list containing up to 12 CAG-identifiers + per PLMN Identity, see TS 38.331. + + CAG is used for the PNI-NPNs to prevent UE(s), which are not allowed + to access the NPN via the associated cell(s), from automatically + selecting and accessing the associated CAG cell(s). + + CAG ID is used to combine with PLMN ID to identify a PNI-NPN. + + Exist if the cell is a NPN-only cell see TS 38.331"; + } + + leaf nIDList { + type string; + mandatory true; + description "It identifies a list of NIDs containing up to 12 NIDs per + PLMN Identity, see TS 38.331. + + NID is used to combine with PLMN ID to identify an SNPN. + + Exist if the cell is a NPN-only cell see TS 38.331"; + } + } + grouping NRCellDUGrp { description "Represents the NRCellDU IOC."; reference "3GPP TS 28.541"; @@ -90,6 +131,18 @@ module _3gpp-nr-nrm-nrcelldu { uses types5g3gpp:PLMNInfo; } + list nPNIdentityList { + key idx ; + min-elements 1; + ordered-by user; + description "It defines which NPNs that can be served by the NR cell, + and which CAG IDs or NIDs can be supported by the NR cell for + corresponding PNI-NPN or SNPN in case of the cell is NPN-only cell."; + reference "3GPP TS 38.331"; + leaf idx { type uint32 ; } + uses NPNIdentityGrp; + } + leaf nRPCI { description "The Physical Cell Identity (PCI) of the NR cell."; reference "3GPP TS 36.211"; @@ -132,19 +185,122 @@ module _3gpp-nr-nrm-nrcelldu { units MHz; } - leaf bSChannelBwUL { - description "Base station channel bandwidth for uplink."; - reference "3GPP TS 38.104"; - type int32; - units MHz; - } + leaf rimRSMonitoringStartTime { + type yang:date-and-time ; + mandatory true; + description "Configures the UTC time when the gNB attempts to start + RIM-RS monitoring."; + } + + leaf rimRSMonitoringStopTime { + type yang:date-and-time ; + mandatory true; + description "Configures the UTC time when the gNB stops RIM-RS + monitoring."; + } + + leaf rimRSMonitoringWindowDuration { + type uint32 { + range 1..16384 ; + } + mandatory true; + description "Configures a duration of the monitoring window in which + gNB monitors the RIM-RS, in unit of P_t, where P_t is the RIM-RS + transmission periodicity in units of uplink-downlink switching period ( + see 38.211 subclause 7.4.1.6). - leaf bSChannelBwSUL { - description "Base station channel bandwidth for supplementary uplink."; - reference "3GPP TS 38.104"; - type int32; - units MHz; - } + This field is configured together with rimRSMonitoringInterval, + rimRSMonitoringWindowStartingOffset, rimRSMonitoringOccasionInterval + and rimRSMonitoringOccasionStartingOffset. + The duration of the monitoring window is expected to be larger than + or equal to M*P_t, where M is the interval between adjacent monitoring + occasions within the monitoring window + (configured by rimRSMonitoringInterval). + The absolute duration of the monitoring window is not expected to be + larger than the periodicity of the monitoring window (configured by + rimRSMonitoringWindowPeriodicity). + + See 3GPP TS 28.541 attribute descrition rimRSMonitoringWindowDuration + for the exact math formulas. + + Only the earliest N_T consecutive detection durations in each RIM-RS + transmission periodicity (P_t) in the monitoring window are taken as + valid time for monitoring potential interference, and they are + consecutively monitored in the monitoring window, while the residual + part of each RIM-RS transmission periodicity is not used for + discovering potential interference, where, a consecutive detection + duration spans P1*R1 (if only P1 is configured) or ((P1+P2))/2*R1 ( + if both P1 and P2 are configured), where, + R1 is the number of consecutive uplink-downlinkswitching periods + for RS-1 (configured by nrofConsecutiveRIMRS1), + P1 is the first uplink-downlinkswitching period (configured by + dlULSwitchingPeriod1), + P2 is the second uplink-downlink switching period (configured by + dlULSwitchingPeriod2), and + N_T= + ((N_setID # RIM,1)/(N_f # RI N_s # RIM,1) + if enableEnoughNotEnoughIndication is 'disable' + + (2N_setID # RIM,1)/(N_f # RIM N_s # RIM,1) + if enableEnoughNotEnoughIndication is 'enable' + + N_setID # 'RIM,1' is the total number of set IDs for RIM RS-1 + (configured by totalnrofSetIdofRS1), + N_f # RIM is the number of candidate frequency resources in the whole + network (configured by nrofGlobalRIMRSFrequencyCandidates), and + N_s # 'RIM,1' is the number of candidate sequences assigned for + RIM RS-1 (configured by nrofRIMRSSequenceCandidatesofRS1)."; + } + + leaf rimRSMonitoringWindowStartingOffset { + type uint8 { + range 0..23 ; + } + mandatory true; + units hours; + description "Configures the start offset of the first monitoring window + within one day, in unit of hours."; + } + + leaf rimRSMonitoringWindowPeriodicity { + type uint8 { + range 1|2|3|4|6|8|12|24 ; + } + units hours; + mandatory true; + description "Configures the periodicity of the monitoring window, in + unit of hours"; + } + + leaf rimRSMonitoringOccasionInterval { + type uint32 { + range 1..max ; + } + mandatory true; + description "Configures the interval between adjacent monitoring + occasions (M) within the monitoring window, in unit of consecutive + detection duration. + M is expected to be prime to N_T, where N_T is given in above + attribute rimRSMonitoringWindowDuration. + allowedValues: 1,2..N_T-1"; + } + + leaf rimRSMonitoringOccasionStartingOffset { + type uint32 ; + mandatory true; + description "Configures the start offset of the first monitoring occasions + within the monitoring window (S_M), in unit of consecutive detection + duration. + gNB starts monitoring potential interference from the S_M-th consecutive + detection duration in the first complete RIM-RS transmission + periodicity (P_t) within the monitoring window. + + allowedValues: 0,1,2..M-1 + + where M is the the interval between adjacent monitoring occasions + within the monitoring window + (configured by rimRSMonitoringOccasionInterval)"; + } leaf ssbFrequency { description "Indicates cell defining SSB frequency domain position. @@ -193,6 +349,20 @@ module _3gpp-nr-nrm-nrcelldu { units "subframes (ms)"; } + leaf bSChannelBwUL { + description "Base station channel bandwidth for uplink."; + reference "3GPP TS 38.104"; + type int32; + units MHz; + } + + leaf bSChannelBwSUL { + description "Base station channel bandwidth for supplementary uplink."; + reference "3GPP TS 38.104"; + type int32; + units MHz; + } + leaf-list nRSectorCarrierRef { description "Reference to corresponding NRSectorCarrier instance."; min-elements 1; @@ -208,13 +378,54 @@ module _3gpp-nr-nrm-nrcelldu { description "Reference to corresponding NRFrequency instance."; type types3gpp:DistinguishedName; } + + leaf victimSetRef { + type types3gpp:DistinguishedName; + mandatory true; + description "DN of a victim Set (RimRSSet) + Implemented if RIM feature is supported"; + } + + leaf aggressorSetRef { + type types3gpp:DistinguishedName; + mandatory true; + description "DN of an aggressor Set (RimRSSet)"; + } } augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction" { list NRCellDU { - description "Represents the information of a cell known by DU."; - reference "3GPP TS 28.541"; + description "This IOC represents the part of NR cell information that + describes s the specific resources instances. + + An NR cell transmits SS/PBCH block and always requires downlink + transmission at a certain carrier frequency with a certain channel + bandwidth. Transmission may be performed from multiple sector-carriers + using different transmission points, and these may be configured with + different carrier frequencies and channel bandwidths, as long as they + are aligned to the cell's downlink resource grids as defined in + subclause 4.4 in TS 38.211. The values of arfcnDL and bSChannelBwDL + attributes define the resource grids which each sector-carrier needs to + be aligned to. See subclauses 5.3 and 5.4.2 of TS 38.104 for definitions + of BS channel bandwidth and NR-ARFCN, respectively. + + An NR cell requires an uplink in order to provide initial access. In + case of TDD, the values of arfcnUL and bSChannelBwUL have to always be + set to the same values as for the corresponding DL attributes. For both + FDD and TDD, the arfcnUL and bSChannelBwUL define uplink resource grids + to which each sector-carrier needs to align to. + + An NR cell can in addition be configured with a supplementary uplink, + which has its own arfcnSUL and bSChannelBwSUL, which define resource + grids for supplementary uplink sector-carriers. + + Each of downlink, uplink and supplementary uplink (if configured) need + an initial bandwidth part (BWP), which defines resources to be used by + UEs during and immediately after initial access. Additional BWPs can be + either configured or calculated by gNB internally and be applied to UEs + dynamically by gNB based on e.g. UE capability and bandwidth need of + each UE."; key id; uses top3gpp:Top_Grp; container attributes { diff --git a/yang-models/_3gpp-nr-nrm-rimrsset.yang b/yang-models/_3gpp-nr-nrm-rimrsset.yang new file mode 100755 index 000000000..9f285a623 --- /dev/null +++ b/yang-models/_3gpp-nr-nrm-rimrsset.yang @@ -0,0 +1,497 @@ +module _3gpp-nr-nrm-rimrsset { + yang-version 1.1; + namespace "urn:3gpp:sa5:_3gpp-nr-nrm-rimrsset"; + prefix "rrsset3gpp"; + + import _3gpp-common-subnetwork { prefix subnet3gpp; } + import _3gpp-common-top { prefix top3gpp; } + import _3gpp-common-yang-types { prefix types3gpp; } + + organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines the YANG mapping of the RimRSSet Information Object + Class (IOC) that is part of the NR Network Resource Model (NRM)."; + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + + revision 2021-10-28 { reference CR-0607 ; } + + grouping FrequencyDomainParaGrp { + description "Configuration parameters of frequency domain resource to + support RIM RS. "; + + leaf rimRSSubcarrierSpacing { + type uint8 { + range 0|1 ; + } + mandatory true; + description + "It is the subcarrier spacing configuration (u) for the RIM-RS. + Subcarrier spacing delta-f=2^u*15 kHz. (see 38.211 subclause 5.3.3)."; + } + + leaf rIMRSBandwidth { + type uint8 { + range 1..96 ; + } + mandatory true; + description "It is the bandwidth of the RIM-RS in resource blocks + (see 38.211 subclause 5.3.3). + For carrier bandwidth larger than 20MHz, this attribute should be + 96 if subcarrier spacing is15kHz + 48 or 96 if subcarrier spacing is 30kHz + For carrier bandwidth smaller than or equal to 20MHz, this attribute + should be + Minimum of {96 , bandwidth of downlink carrier in number of PRBs} if + subcarrier spacing is15kHz + Minimum of {48, bandwidth of downlink carrier in number of PRBs } if + subcarrier spacing is 30kHz"; + } + + leaf nrofGlobalRIMRSFrequencyCandidates { + type uint8 { + range 1|2|4 ; + } + mandatory true; + description "The number of candidate frequency resources in the whole + network (N_f^RIM ) (see 38.211 subclause 7.4.1.6)."; + } + + leaf-list rimRSCommonCarrierReferencePoint { + type int32 ; + } + + leaf rimRSStartingFrequencyOffsetIdList { + type uint32 { + range 0..550; + } + must 'count(.) = ../nrofGlobalRIMRSFrequencyCandidates' { + error-message + "The multiplicity must be equal to nrofGlobalRIMRSFrequencyCandidates"; + } + description "List of configured frequency offsets in units of resource + blocks, where each element is the frequency offset relative to a + configured reference point for RIM-RS. The size of the list is + nrofGlobalRIMRSFrequencyCandidates and the resulting frequency resource + blocks of RIM-RS corresponding to different configured frequency offset + have no overlapping bandwidth. (see 38.211 subclause 7.4.1.6). + + allowedValues: 0..maxNrofPhysicalResourceBlocks-1 where + maxNrofPhysicalResourceBlocks = 550"; + } + } + + grouping SequenceDomainParaGrp { + description "Configuration parameters of sequence domain resource to + support RIM RS. "; + + leaf nrofRIMRSSequenceCandidatesofRS1 { + type uint8 { + range 1..8 ; + } + mandatory true; + description "The number of candidate sequences assigned for RIM RS-1 + (N_s^RIM,1) (see 38.211 [subclause 7.4.1.6). It should be even when + enableEnoughNotEnoughIndication for RS-1 is ON"; + } + + leaf-list rimRSScrambleIdListofRS1 { + type uint32 { + range 0..1023 ; + } + must 'count(.) = ../nrofRIMRSSequenceCandidatesofRS1' { + error-message + "The multiplicity must be equal to nrofRIMRSSequenceCandidatesofRS1"; + } + description "List of configured scrambling identities for RIM RS-1 ( + see 38.211 [subclause 7.4.1.6). The size of the list is + nrofRIMRSSequenceCandidatesofRS1."; + } + + leaf nrofRIMRSSequenceCandidatesofRS2 { + type uint8 { + range 1..8 ; + } + mandatory true; + description "The number of candidate sequences assigned for RIM RS-2 + (N_s^RIM,2) (see 38.211 subclause 7.4.1.6)."; + } + + leaf rimRSScrambleIdListofRS2 { + type uint32 { + range 0..1023 ; + } + must 'count(.) = ../nrofRIMRSSequenceCandidatesofRS2' { + error-message + "The multiplicity must be equal to nrofRIMRSSequenceCandidatesofRS2"; + } + description "List of configured scrambling identities for RIM RS-2 ( + see 38.211 subclause 7.4.1.6). + The size of the list is nrofRIMRSSequenceCandidatesofRS2."; + } + + leaf enableEnoughNotEnoughIndication { + type types3gpp:EnabledDisabled; + default DISABLED; + description "It is indication of whether 'Enough'/'Not enough' indication + functionality is enabled for RIM RS-1 (see 38.211 subclause 7.4.1.6). + + If the indication is 'ENABLED', the first half of + nrofRIMRSSequenceCandidatesofRS1 sequences indicates 'Not enough + mitigation', and the second half indicates 'Enough mitigation', where, + 'Enough mitigation' indicates that IoT going back to certain level at + victim side and/or no further interference mitigation actions are + needed at aggressor side + 'Not enough mitigation' indicates that IoT exceeding certain level at + victim side and/or further interference mitigation actions are needed + at aggressor side + + enableEnoughNotEnoughIndication is equivalent to EnoughIndication + (see 38.211 subclause 7.4.1.6)"; + } + + leaf RIMRSScrambleTimerMultiplier { + type uint32 { + range 0..2147483647; + } + mandatory true; + description "It is parameter multiplier factor gamma for initialization + seed of the pseudo-random sequence c~(i) + (see 38.211 subclause 7.4.1.6.2). + allowedValues: 0,1...2^31-1"; + } + + leaf RIMRSScrambleTimerOffset { + type uint32 { + range 0..2147483647; + } + mandatory true; + description "It is parameter offset delta for initialization seed of + the pseudo-random sequence c~(i) (see 38.211 subclause 7.4.1.6.2). + allowedValues: 0,1...2^31-1"; + } + } + + grouping TimeDomainParaGrp { + description "Configuration parameters of time domain resource to + support RIM RS. "; + + leaf dlULSwitchingPeriod1 { + type enumeration { + enum MS0P5; + enum MS0P625; + enum MS1; + enum MS1P25; + enum MS2; + enum MS2P5; + enum MS3; + enum MS4; + enum MS5; + enum MS10; + enum MS20; + } + mandatory true; + description "This attribute is used to configure the first uplink-downlink + switching period (P1) for RIM RS transmission in the network, where one + RIM RS is configured in one uplink-downlink switching period. + (see 38.211 subclause 7.4.1.6). + + When only one TDD-UL-DL-Pattern is configured, only + dl-UL-SwitchingPeriod1 is configured, where P1 equals to the + transmission periodicity of the TDD-UL-DL-Pattern. + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources is configured only in one of the TDD patterns, only + dl-UL-SwitchingPeriod1 is configured, where P1 equals to the addition + of the concatenated transmission periodicity of the two + TDD-UL-DL-Patterns. + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources are configured in both TDD patterns, both + dl-UL-SwitchingPeriod1 and dl-UL-SwitchingPeriod2 are configured, + where P1 equals to the transmission periodicity of the first + TDD-UL-DL-Pattern. + + P1 is equivalent to T_(per,1)^RIM (see 38.211, subclause 7.4.1.6). + + allowedValues: + MS0P5, MS0P625, MS1, MS1P25, MS2, MS2P5, MS4, MS5, MS10, MS20, + if a single uplink-downlink period is configured for RIM-RS purposes; + MS0P5, MS0P625, MS1, MS1P25, MS2, MS2P5, MS3, MS4, MS5, MS10, MS20, + if two uplink-downlink periods are configured for RIM-RS purposes."; + } + + leaf symbolOffsetOfReferencePoint1 { + type uint32 { + range 2..327679 ; + } + mandatory true; + description "This attribute is used to configure the reference point in + the first uplink-downlink switching period, which is the symbols offset + of the reference point after the starting boundary of the first + uplink-downlink switching period. It's Configured together with + dl-UL-SwitchingPeriod1 (see 38.211 subclause 7.4.1.6). + + When only one TDD-UL-DL-Pattern is configured, the reference point + configured for the first uplink-downlink switching period is the DL + transmission boundary of the TDD-UL-DL-Pattern. + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources is configured only in one of the TDD patterns, the reference + point configured for the first uplink-downlink switching period is the + DL transmission boundary of the TDD-UL-DL-Pattern where the RIM-RS + resource is configured. + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources are configured in both TDD patterns, the reference points + configured for first uplink-downlink switching period is the DL + transmission boundary of the first TDD-UL-DL-Pattern. + + allowedValues: 2, 3..20*2*maxNrofSymbols-1, where maxNrofSymbols=14"; + } + + leaf dlULSwitchingPeriod2 { + type enumeration { + enum MS0P5; + enum MS0P625; + enum MS1; + enum MS1P25; + enum MS2; + enum MS2P5; + enum MS3; + enum MS4; + enum MS5; + enum MS10; + } + mandatory true; + description "Used to configure the second uplink-downlink switching + period (P2) for RIM RS transmission in the network, where one RIM RS is + configured in one uplink-downlink switching period + (see 38.211 subclause 7.4.1.6). + + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources are configured in both TDD patterns, both + dl-UL-SwitchingPeriod1 and dl-UL-SwitchingPeriod2 are configured, + where P2 equals to the transmission periodicity of the second + TDD-UL-DL-Pattern, and where (P1 + P2) divides 20 ms. + + allowedValues: MS0P5, MS0P625, MS1, MS1P25, MS2, MS2P5, MS3, MS4, MS5, + MS10 + + P2 is equivalent to T_(per,2)^RIM (see 38.211 subclause 7.4.1.6)"; + } + + leaf symbolOffsetOfReferencePoint2 { + type uint32 { + range 2..327679 ; + } + mandatory true; + description "This attribute is used to configure the reference point in + the second uplink-downlink switching period, which is the symbol offset + of the reference point after starting boundary of the second + uplink-downlink switching period. Configured together with + dl-UL-SwitchingPeriod2 (see 38.211 subclause 7.4.1.6). + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources are configured in both TDD patterns, the reference points + configured for second uplink-downlink switching period is the + DL transmission boundary of the second TDD-UL-DL-Pattern. + + allowedValues: 2, 3..20*2*maxNrofSymbols-1, where maxNrofSymbols=14"; + } + + leaf totalnrofSetIdofRS1 { + type uint32 { + range 0..4194303 ; + } + mandatory true; + description "It is the total number of set IDs for RIM RS-1 + (N_setID ^RIM,1) (see 38.211 subclause 7.4.1.6). + + allowedValues: 0,1...2^22-1"; + } + + leaf totalnrofSetIdofRS2 { + type uint32 { + range 0..4194304 ; + } + mandatory true; + description "It is the total number of set IDs for RIM RS-2 + (N_setID^RIM,2) (see 38.211 subclause 7.4.1.6). + + allowedValues: 0,1...2^22"; + } + + leaf nrofConsecutiveRIMRS1 { + type uint8 { + range 1|2|4|8 ; + } + mandatory true; + description "It is the number of consecutive uplink-downlink switching + periods for RS-1 (R1) for repetition/near-far indication:. + (see 38.211 subclause 7.4.1.6). + + allowedValues: 1,2,4,8"; + } + + leaf nrofConsecutiveRIMRS2 { + type uint8 { + range 1|2|4|8 ; + } + mandatory true; + description "It is the number of consecutive uplink-downlink switching + periods for RS-2 (R2) for repetition/near-far indication. + (see 38.211 subclause 7.4.1.6). + + allowedValues: 1,2,4,8"; + } + + leaf-list consecutiveRIMRS1List { + type uint32 { + range 2..327679 ; + } + description "It is used to configure the OFDM symbol position(s) of RIM + RS-1 within the uplink-downlink switching period. It is a list of symbol + offset of RIM RS-1 (N_symb,ref^(RIM,1)) before the reference point. + The size of the list is nrofConsecutiveRIMRS1 + (see 38.211 subclause 7.4.1.6). + The resulting RIM RS-1 symbols and its reference point shall belong to + the same 10ms frame. + + allowedValues: 2,3..20*2**maxNrofSymbols-1, where maxNrofSymbols=14"; + } + + leaf-list consecutiveRIMRS2List { + type uint32 { + range 2..327679 ; + } + description "It is used to configure the OFDM symbol position(s) of + RIM RS-2 within the uplink-downlink switching period. It is a list of + symbol offset of RIM RS-2 (N_symb,ref^(RIM,2)) before the reference + point. The size of the list is nrofConsecutiveRIMRS2 + (see 38.211 subclause 7.4.1.6). + The resulting RIM RS-2 symbols and its reference point shall belong to + the same 10ms frame. + + allowedValues: 2,3..20*2**maxNrofSymbols-1, where maxNrofSymbols=14"; + } + + leaf enablenearfarIndicationRS1 { + type types3gpp:EnabledDisabled; + default DISABLED; + description "It is indication of whether near-far functionality is enabled + for RIM RS1. + + If the indication is 'ENABLED', + the first half of nrofConsecutiveRIMRS1 (R1) consecutive uplink-downlink + switching period is for 'Near' indication with R1/2 repetitions, + the second half of R1 consecutive uplink-downlink switching period is + for 'Far' indication with R1/2 repetitions."; + } + + leaf enablenearfarIndicationRS2 { + type types3gpp:EnabledDisabled; + default DISABLED; + description "It is indication of whether near-far functionality is enabled + for RIM RS2. + + If the indication is 'enable', + the first half of nrofConsecutiveRIMRS2 (R2) consecutive uplink-downlink + switching period is for 'Near' indication with R2/2 repetitions, + the second half of R2 consecutive uplink-downlink switching period is + for 'Far' indication with R2/2 repetitions."; + } + } + + grouping RimRSGlobalGrp { + description "Represents the RimRSGlobal IOC."; + + list frequencyDomainPara { + key rimRSSubcarrierSpacing; + min-elements 1; + max-elements 1; + description "Configuration parameters of frequency domain resource to + support RIM RS. "; + uses FrequencyDomainParaGrp; + } + + list sequenceDomainPara { + key nrofRIMRSSequenceCandidatesofRS1; + min-elements 1; + max-elements 1; + description "Configuration parameters of sequence domain resource to + support RIM RS. "; + uses SequenceDomainParaGrp; + } + + list timeDomainPara { + key dlULSwitchingPeriod1; + min-elements 1; + max-elements 1; + description "Configuration parameters of time domain resource to + support RIM RS. "; + uses TimeDomainParaGrp; + } + } + + grouping RimRSSetGrp { + description "Represents the RimRSSet IOC."; + + leaf setId { + type uint32 { + range 0..4194303 ; + } + mandatory true; + description "This specifies the set ID of a victim Set (RIM-RS1 Set) or + aggressor Set (RIM-RS2 set). (See subclause 7.4.1.6 in TS 38.211). + + allowedValues: The bit length of the set ID is maximum 22bit."; + } + + leaf setType { + type enumeration { + enum RS1; + enum RS2; + } + mandatory true; + description "The attribute specifies type of a RIM-RS Set . + RIM RS1 is generated and transmitted by victim to indicate its suffering + remote interference, and RIM RS2 is generated and transmitted by + aggressor to measure if Remote Interference still exist + + If the attribute value is 'RS1', the RIM-RS Set is victim set. + If the attribute value is 'RS2', the RIM-RS Set is aggressor set."; + } + + leaf-list nRCellDURef { + type types3gpp:DistinguishedName; + config false; + description "This attribute contains the DN of a NR Cell (NRCellDU)"; + } + } + + augment "/subnet3gpp:SubNetwork" { + list RimRSGlobal { + description "Represents global/common Remote Interference Management (RIM) + Reference Signal (RS) resource allocated for the whole network. + Resource for RIM-RS transmission is defined by Sequence domain resource, + Time domain resource and Frequency resource. The configure parameters + of the RIM RS resource are applied to all Sets of RIM RS Resource + across gNBs/cells in the network."; + key id; + max-elements 1; + uses top3gpp:Top_Grp; + container attributes { + uses RimRSGlobalGrp; + } + + list RimRSSet { + description "Represents aggressor or victim Set organized by OAM. + The RIM RS Resource is assigned to each Set, which is identified by + triple indices set of +