diff --git a/OpenAPI/5gcNrm.yaml b/OpenAPI/5gcNrm.yaml index 91383acfebb60d137e03bdaccbce47da7c271d18..623d9bdc3e2784373c6dcb8ea86c770bd9fc7cd8 100755 --- a/OpenAPI/5gcNrm.yaml +++ b/OpenAPI/5gcNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: 3GPP 5GC NRM - version: 17.5.0 + version: 17.6.0 description: >- OAS 3.0.1 specification of the 5GC NRM © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -562,7 +562,64 @@ components: type: array items: type: string - + + DnnSmfInfoItem: + type: object + properties: + dnn: + type: string + dnaiList: + type: array + items: + type: string + + SNssaiSmfInfoItem: + type: object + properties: + sNSSAI: + $ref: 'nrNrm.yaml#/components/schemas/Snssai' + dnnSmfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnSmfInfoItem' + + IpAddr: + type: object + properties: + ipv4Addr: + type: string + ipv6Addr: + type: string + ipv6Prefix: + type: string + + 5GCNfConnEcmInfoList: + type: array + items: + $ref: '#/components/schemas/5GCNfConnEcmInfo' + 5GCNfConnEcmInfo: + type: object + description: 'Store the 5GC NF connection information' + properties: + 5GCNFType: + type: string + enum: + - PCF + - NEF + - SCEF + 5GCNFIpAddress: + type: string + 5GCNFRef: + $ref: 'comDefs.yaml#/components/schemas/Dn' + + UPFConnectionInfo: + type: object + properties: + uPFIpAddress: + type: string + uPFRef: + $ref: 'comDefs.yaml#/components/schemas/Dn' + #-------- Definition of concrete IOCs -------------------------------------------- SubNetwork-Single: @@ -594,6 +651,8 @@ components: $ref: '#/components/schemas/Configurable5QISet-Multiple' Dynamic5QISet: $ref: '#/components/schemas/Dynamic5QISet-Multiple' + EcmConnectionInfo: + $ref: '#/components/schemas/EcmConnectionInfo-Multiple' ManagedElement-Single: allOf: @@ -646,6 +705,8 @@ components: $ref: '#/components/schemas/Configurable5QISet-Multiple' Dynamic5QISet: $ref: '#/components/schemas/Dynamic5QISet-Multiple' + EcmConnectionInfo: + $ref: '#/components/schemas/EcmConnectionInfo-Multiple' AmfFunction-Single: allOf: @@ -666,21 +727,29 @@ components: interPlmnFQDN: type: string taiList: - $ref: 'nrNrm.yaml#/components/schemas/Tai' + $ref: 'nrNrm.yaml#/components/schemas/TaiList' taiRangeList: - $ref: 'nrNrm.yaml#/components/schemas/TaiRange' + type: array + items: + $ref: 'nrNrm.yaml#/components/schemas/TaiRange' weightFactor: $ref: '#/components/schemas/WeightFactor' snssaiList: $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' cNSIIdList: $ref: '#/components/schemas/CNSIIdList' - gUAMIdList: - $ref: '#/components/schemas/GUAMInfo' + gUAMIdList: + type: array + items: + $ref: '#/components/schemas/GUAMInfo' backupInfoAmfFailure: - $ref: '#/components/schemas/GUAMInfo' + type: array + items: + $ref: '#/components/schemas/GUAMInfo' backupInfoAmfRemoval: - $ref: '#/components/schemas/GUAMInfo' + type: array + items: + $ref: '#/components/schemas/GUAMInfo' amfSetRef: $ref: 'comDefs.yaml#/components/schemas/Dn' managedNFProfile: @@ -766,14 +835,42 @@ components: - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' + pLMNInfoList: + $ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList' nRTACList: $ref: '#/components/schemas/TACList' sBIFqdn: type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' + sNssaiSmfInfoList: + type: array + items: + $ref: '#/components/schemas/SNssaiSmfInfoItem' + taiList: + type: array + items: + $ref: 'nrNrm.yaml#/components/schemas/Tai' + taiRangeList: + type: array + items: + $ref: 'nrNrm.yaml#/components/schemas/TaiRange' + pwgFqdn: + type: string + pgwAddrList: + type: array + items: + $ref: '#/components/schemas/IpAddr' + accessType: + $ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessType' + priority: + type: integer + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + vsmfSupportInd: + type: boolean + pwgFqdnList: + type: array + items: + type: string managedNFProfile: $ref: '#/components/schemas/ManagedNFProfile' commModelList: @@ -1248,7 +1345,7 @@ components: DDNMFFunction-Single: allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1300,6 +1397,40 @@ components: EP_Nxx: $ref: '#/components/schemas/EP_Nxx-Multiple' + EcmConnectionInfo-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + eASServiceArea: + $ref: 'EdgeNRM.yaml#/components/schemas/ServingLocation' + eESServiceArea: + $ref: 'EdgeNRM.yaml#/components/schemas/ServingLocation' + eDNServiceArea: + $ref: 'EdgeNRM.yaml#/components/schemas/ServingLocation' + eASIpAddress: + type: string + eESIpAddress: + type: string + eCSIpAddress: + type: string + ednIdentifier: + type: string + ecmConnectionType: + type: string + enum: + - USERPLANE + - CONTROLPLANE + - BOTH + 5GCNfConnEcmInfoList: + $ref: '#/components/schemas/5GCNfConnEcmInfoList' + uPFConnectionInfo: + $ref: '#/components/schemas/UPFConnectionInfo' + ExternalAmfFunction-Single: allOf: @@ -1696,7 +1827,7 @@ components: type: boolean EP_N33-Single: allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1809,7 +1940,7 @@ components: $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' EP_Npc4-Single: allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1823,7 +1954,7 @@ components: $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' EP_Npc6-Single: allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1837,7 +1968,7 @@ components: $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' EP_Npc7-Single: allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1851,7 +1982,7 @@ components: $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' EP_Npc8-Single: allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1895,7 +2026,7 @@ components: FiveQICharacteristics-Single: allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - $ref: 'genericNrm.yaml#/components/schemas/Top' - type: object properties: fiveQIValue: @@ -2304,6 +2435,11 @@ components: type: array items: $ref: '#/components/schemas/Dynamic5QISet-Single' + EcmConnectionInfo-Multiple: + type: array + items: + $ref: '#/components/schemas/EcmConnectionInfo-Single' + @@ -2332,6 +2468,7 @@ components: - $ref: '#/components/schemas/ScpFunction-Single' - $ref: '#/components/schemas/NefFunction-Single' - $ref: '#/components/schemas/NsacfFunction-Single' + - $ref: '#/components/schemas/DDNMFFunction-Single' - $ref: '#/components/schemas/ExternalAmfFunction-Single' - $ref: '#/components/schemas/ExternalNrfFunction-Single' @@ -2373,6 +2510,11 @@ components: - $ref: '#/components/schemas/EP_N60-Single' - $ref: '#/components/schemas/EP_Nxx-Single' + - $ref: '#/components/schemas/EP_Npc4-Single' + - $ref: '#/components/schemas/EP_Npc6-Single' + - $ref: '#/components/schemas/EP_Npc7-Single' + - $ref: '#/components/schemas/EP_Npc8-Single' + - $ref: '#/components/schemas/EP_S5C-Single' - $ref: '#/components/schemas/EP_S5U-Single' - $ref: '#/components/schemas/EP_Rx-Single' @@ -2384,3 +2526,5 @@ components: - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' - $ref: '#/components/schemas/Dynamic5QISet-Single' - $ref: '#/components/schemas/EASDFFunction-Single' + - $ref: '#/components/schemas/EcmConnectionInfo-Single' + diff --git a/OpenAPI/EdgeNRM.yaml b/OpenAPI/EdgeNRM.yaml new file mode 100644 index 0000000000000000000000000000000000000000..d811e1e5ae4f86f698b41501b8321319e744c05f --- /dev/null +++ b/OpenAPI/EdgeNRM.yaml @@ -0,0 +1,228 @@ +openapi: 3.0.1 +info: + title: 3GPP Edge NRM + version: 17.0.0 + description: >- + OAS 3.0.1 specification of the Edge NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.538; Edge NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.538/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + ServingLocation: + type: object + properties: + geographicalLocation: + $ref: '#/components/schemas/GeoLoc' + topologicalLocation: + $ref: '#/components/schemas/TopologicalServiceArea' + TopologicalServiceArea: + type: object + properties: + cellIdList: + type: integer + trackingAreaIdList: + $ref: 'nrNrm.yaml#/components/schemas/Tai' + servingPLMN: + $ref: 'nrNrm.yaml#/components/schemas/PlmnId' + GeoLoc: + type: object + properties: + geographicalCoordinates: + $ref: '#/components/schemas/GeographicalCoordinates' + civicLocation: + type: string + GeographicalCoordinates: + type: object + properties: + lattitude: + type: integer + longitude: + type: integer + EDNConnectionInfo: + type: object + properties: + dNN: + type: string + eDNServiceArea: + $ref: '#/components/schemas/ServingLocation' + AffinityAntiAffinity: + type: object + properties: + affinityEAS: + type: string + antiAffinityEAS: + type: string + VirtualResource: + type: object + properties: + virtualMemory: + type: integer + virtualDisk: + type: integer + SoftwareImageInfo: + type: object + properties: + minimumDisk: + type: integer + minimumRAM: + type: integer + swImageRef: + 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' + - type: object + properties: + Subnetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ECSFunction: + $ref: '#/components/schemas/ECSFunction-Multiple' + EdgeDataNetwork: + $ref: '#/components/schemas/EdgeDataNetwork-Multiple' + - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' + + EdgeDataNetwork-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + ednIdentifier: + type: string + eDNConnectionInfo: + $ref: '#/components/schemas/EDNConnectionInfo' + - type: object + properties: + EASFunction: + $ref: '#/components/schemas/EASFunction-Multiple' + EESFunction: + $ref: '#/components/schemas/EESFunction-Multiple' + + EASFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + eASIdentifier: + type: string + eESAddress: + type: string + eASRequirementsRef: + $ref: 'comDefs.yaml#/components/schemas/Dn' + eASAddress: + type: string + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + EESFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + eESIdentifier: + type: string + eESServingLocation: + $ref: '#/components/schemas/ServingLocation' + eESAddress: + type: string + softwareImageInfo: + $ref: '#/components/schemas/SoftwareImageInfo' + serviceContinuitySupport: + type: boolean + eASFunctonRef: + $ref: 'comDefs.yaml#/components/schemas/DnList' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + + ECSFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + eCSAddress: + type: string + providerIdentifier: + type: string + edgeDataNetworkRef: + $ref: 'comDefs.yaml#/components/schemas/DnList' + eESFuncitonRef: + $ref: 'comDefs.yaml#/components/schemas/Dn' + softwareImageInfo: + $ref: '#/components/schemas/SoftwareImageInfo' + - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' + + EASRequirements-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + requiredEASservingLocation: + $ref: '#/components/schemas/ServingLocation' + affinityAntiAffinity: + $ref: '#/components/schemas/AffinityAntiAffinity' + serviceContinuity: + type: boolean + virtualResource: + $ref: '#/components/schemas/VirtualResource' + softwareImageInfo: + $ref: '#/components/schemas/SoftwareImageInfo' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + EASFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/EASFunction-Single' + ECSFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ECSFunction-Single' + EESFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/EESFunction-Single' + EdgeDataNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/EdgeDataNetwork-Single' + +#--------------------------------- Definition ------------------------------------ + + resources-edgeNrm: + oneOf: + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/EASFunction-Single' + - $ref: '#/components/schemas/ECSFunction-Single' + - $ref: '#/components/schemas/EESFunction-Single' + - $ref: '#/components/schemas/EdgeDataNetwork-Single' + - $ref: '#/components/schemas/EASRequirements-Single' diff --git a/OpenAPI/genericNrm.yaml b/OpenAPI/genericNrm.yaml index 7d4778a6fe4f5b0a2561de45e3b01a08c5b5262f..8e30150998f0dda37d6c13a2b5b8ddad9de33348 100755 --- a/OpenAPI/genericNrm.yaml +++ b/OpenAPI/genericNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: Generic NRM - version: 17.0.0 + version: 17.1.0 description: >- OAS 3.0.1 definition of the Generic NRM - © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: 3GPP TS 28.623; Generic NRM @@ -42,6 +42,9 @@ components: $ref: 'comDefs.yaml#/components/schemas/Latitude' siteLongitude: $ref: 'comDefs.yaml#/components/schemas/Longitude' + siteAltitude: + type: number + format: float equipmentType: type: string environmentType: @@ -181,6 +184,80 @@ components: - BASE_SUBTREE scopeLevel: type: integer + ProcessMonitor: + description: >- + This data type is the "ProcessMonitor" data type without specialisations. + type: object + properties: + jobId: + type: string + status: + type: string + enum: + - NOT_STARTED + - RUNNING + - FINSHED + - FAILED + - PARTIALLY_FAILED + - CANCELLING + - CANCELLED + progressPercentage: + type: integer + minimum: 0 + maximum: 100 + progressStateInfo: + type: string + resultStateInfo: + type: string + startTime: + $ref: 'comDefs.yaml#/components/schemas/DateTime' + endTime: + $ref: 'comDefs.yaml#/components/schemas/DateTime' + timer: + type: integer + FileDownloadJobProcessMonitor: + description: >- + This data type is the "ProcessMonitor" data type with specialisations + for usage in the "FileDownloadJob". + type: object + properties: + jobId: + type: string + status: + type: string + enum: + - NOT_STARTED + - RUNNING + - FINSHED + - FAILED + - CANCELLING + - CANCELLED + progressPercentage: + type: integer + minimum: 0 + maximum: 100 + progressStateInfo: + type: string + resultStateInfo: + oneOf: + - type: string + enum: + - NULL + - UNKNOWN + - NO_STORAGE + - LOW_MEMROY + - NO_CONNECTION_TO_REMOTE_SERVER + - FILE_NOT_AVAILABLE + - DNS_CANNOT_BE_RESOLVED + - TIMER_EXPIRED + - OTHER + - type: string + startTime: + $ref: 'comDefs.yaml#/components/schemas/DateTime' + endTime: + $ref: 'comDefs.yaml#/components/schemas/DateTime' + timer: + type: integer AreaScope: oneOf: - type: array @@ -729,6 +806,10 @@ components: - NO_IDENTITY - TAC_OF_IMEI + tjMDTBeamLevelMeasurement-Type: + description: Determines whether beam level measurements shall be included in case of immediate MDT M1 measurement in NR. For additional details see 3GPP TS 32.422 clause 5.10.40. + type: boolean + tjMDTCollectionPeriodRrmLte-Type: description: See details in 3GPP TS 32.422 clause 5.10.20. type: string @@ -1278,6 +1359,10 @@ components: $ref: '#/components/schemas/TraceJob-Multiple' AlarmList: $ref: '#/components/schemas/AlarmList-Single' + FileDownloadJob: + $ref: '#/components/schemas/FileDownloadJob-Multiple' + Files: + $ref: '#/components/schemas/Files-Multiple' MnsRegistry: $ref: '#/components/schemas/MnsRegistry-Single' ManagedElement-ncO: @@ -1295,6 +1380,10 @@ components: $ref: '#/components/schemas/TraceJob-Multiple' AlarmList: $ref: '#/components/schemas/AlarmList-Single' + FileDownloadJob: + $ref: '#/components/schemas/FileDownloadJob-Multiple' + Files: + $ref: '#/components/schemas/Files-Multiple' #-------- Definition of abstract IOCs -------------------------------------------- @@ -1351,6 +1440,8 @@ components: $ref: '#/components/schemas/tjTraceReference-Type' tjTraceRecordSessionReference: type: string + jobId: + type: string tjTraceReportingFormat: $ref: '#/components/schemas/tjTraceReportingFormat-Type' tjTraceTarget: @@ -1365,6 +1456,8 @@ components: type: array items: $ref: '#/components/schemas/AreaScope' + tjMDTBeamLevelMeasurement: + $ref: '#/components/schemas/tjMDTBeamLevelMeasurement-Type' tjMDTCollectionPeriodRrmLte: $ref: '#/components/schemas/tjMDTCollectionPeriodRrmLte-Type' tjMDTCollectionPeriodM6Lte: @@ -1556,6 +1649,8 @@ components: $ref: 'comDefs.yaml#/components/schemas/DnList' reportingCtrl: $ref: '#/components/schemas/ReportingCtrl' + Files: + $ref: '#/components/schemas/Files-Multiple' ThresholdMonitor-Single: allOf: - $ref: '#/components/schemas/Top' @@ -1623,7 +1718,8 @@ components: properties: attributes: $ref: '#/components/schemas/TraceJob-Attr' - + Files: + $ref: '#/components/schemas/Files-Multiple' AlarmList-Single: allOf: - $ref: '#/components/schemas/Top' @@ -1647,7 +1743,74 @@ components: type: object additionalProperties: $ref: 'faultMnS.yaml#/components/schemas/AlarmRecord' - + FileDownloadJob-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + fileLocation: + type: string + notificationRecipientAddress: + $ref: 'comDefs.yaml#/components/schemas/Uri' + cancelJob: + type: string + enum: + - TRUE + - FALSE + jobMonitor: + $ref: '#/components/schemas/FileDownloadJobProcessMonitor' + Files-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + numberOfFiles: + type: integer + jobRef: + $ref: 'comDefs.yaml#/components/schemas/Dn' + jobId: + type: string + File: + $ref: '#/components/schemas/File-Multiple' + File-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + fileLocation: + $ref: 'comDefs.yaml#/components/schemas/Uri' + fileCompression: + type: string + fileSize: + type: integer + fileDataType: + type: string + enum: + - PERFORMANCE + - TRACE + - ANALYTICS + - PROPRIETARY + fileFormat: + type: string + fileReadyTime: + $ref: 'comDefs.yaml#/components/schemas/DateTime' + fileExpirationTime: + $ref: 'comDefs.yaml#/components/schemas/DateTime' + fileContent: + type: string + jobRef: + $ref: 'comDefs.yaml#/components/schemas/Dn' + jobId: + type: string MnsInfo-Single: type: object properties: @@ -1665,6 +1828,11 @@ components: mnsAddress: description: Resource URI as defined in the relevant Technical Specification $ref: 'comDefs.yaml#/components/schemas/Uri' + mnsScope: + description: List of top level addresses (Root DN) of the 3GPP models supported by the MnS + type: array + items: + $ref: 'comDefs.yaml#/components/schemas/Dn' #-------- Definition of YAML arrays for name-contained IOCs ---------------------- @@ -1704,6 +1872,18 @@ components: type: array items: $ref: '#/components/schemas/NtfSubscriptionControl-Single' + FileDownloadJob-Multiple: + type: array + items: + $ref: '#/components/schemas/FileDownloadJob-Single' + Files-Multiple: + type: array + items: + $ref: '#/components/schemas/Files-Single' + File-Multiple: + type: array + items: + $ref: '#/components/schemas/File-Single' MnsInfo-Multiple: type: array items: @@ -1730,5 +1910,10 @@ components: - $ref: '#/components/schemas/HeartbeatControl-Single' - $ref: '#/components/schemas/AlarmList-Single' + + - $ref: '#/components/schemas/FileDownloadJob-Single' + - $ref: '#/components/schemas/Files-Single' + - $ref: '#/components/schemas/File-Single' + - $ref: '#/components/schemas/MnsRegistry-Single' - $ref: '#/components/schemas/MnsInfo-Single' diff --git a/OpenAPI/intentNrm.yaml b/OpenAPI/intentNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..5c28cc77a3e7548188796fbef3192eae93ed6920 --- /dev/null +++ b/OpenAPI/intentNrm.yaml @@ -0,0 +1,383 @@ +openapi: 3.0.2 +info: + title: Intent NRM + description: OAS 3.0.1 specification of the Intent NRM + version: 17.0.0 +paths: {} +components: + schemas: + + Intent-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + userLabel: + type: string + intentExpectations: + type: array + items: + $ref: "#/components/schemas/IntentExpectation" + intentContexts: + type: array + items: + $ref: "#/components/schemas/IntentContext" + intentFulfilStatus: + $ref: "#/components/schemas/IntentFulfilStatus" + IntentExpectation: + type: object + properties: + expectationId: + type: string + expectationObjects: + type: array + items: + $ref: "#/components/schemas/ExpectationObject" + expectationTargets: + type: array + items: + $ref: "#/components/schemas/ExpectationTarget" + expectationContexts: + type: array + items: + $ref: "#/components/schemas/ExpectationContext" + + ExpectationObject: + type: object + properties: + objectType: + type: string + enum: + - RAN_SubNetwrok #--value for Radio Network Expectation--# + - TBD #-This will be added based on defined scenario specfic intent expectation-# + objectInstance: + $ref: "comDefs.yaml#/components/schemas/Dn" + objectContexts: + type: array + items: + $ref: "#/components/schemas/ObjectContext" + + ExpectationTarget: + oneOf: + #--ExpectationTargets defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)- # + - $ref: "#/components/schemas/WeakRSRPRatioTarget" + - $ref: "#/components/schemas/LowSINRRatioTarget" + - $ref: "#/components/schemas/AveULRANUEThptTarget" + - $ref: "#/components/schemas/AveDLRANUEThptTarget" + - $ref: "#/components/schemas/LowULRANUEThptRatioTarget" + - $ref: "#/components/schemas/LowDLRANUEThptRatioTarget" + #--ExpectationTargets defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)- # + + #--ExpectationTargets defind for other Scenario specific Expectation-----TBD---------------# + #--ExpectationTargets defind for other Scenario specific Expectation-----TBD---------------# + + + ObjectContext: + oneOf: + #--ObjectContext defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)-------# + - $ref: "#/components/schemas/CoverageAreaPolygonContext" + - $ref: "#/components/schemas/CoverageTACContext" + - $ref: "#/components/schemas/PLMNContext" + - $ref: "#/components/schemas/NRFqBandContext" + - $ref: "#/components/schemas/RATContext" + #--ObjectContext defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)------# + + #--ObjectContext defind for other Scenario specific Expectation -----------TBD------------# + #--ObjectContext defind for other Scenario specific Expectation -----------TBD------------# + + + + ExpectationContext: + type: object + properties: + contextAttribute: + type: string + contextCondition: + $ref: "#/components/schemas/Condition" + contextValueRange: + type: array + items: + type: number + + IntentContext: + type: object + properties: + contextAttribute: + type: string + contextCondition: + $ref: "#/components/schemas/Condition" + contextValueRange: + type: array + items: + type: number + Condition: + type: string + enum: + - Is_equal_to + - Is_less_than + - Is_greater_than + - Is_within_the_range + + IntentFulfilStatus: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + #-------Definition of the concrete ExpectationTarget dataType----------# + WeakRSRPRatioTarget: + type: object + properties: + targetName: + type: string + enum: + - WeakRSRPRatio + targetCondition: + type: string + enum: + - Is_less_than + targetValueRange: + type: integer + minimum: 0 + maximum: 100 + targetContexts: + $ref: "#/components/schemas/WeakRSRPContext" + + WeakRSRPContext: + type: object + properties: + contextAttribute: + type: string + enum: + - WeakRSRPThreshold + contextCondition: + type: string + enum: + - Is_less_than + contextValueRange: + type: number + + LowSINRRatioTarget: + type: object + properties: + targetName: + type: string + enum: + - LowSINRRatio + targetCondition: + type: string + enum: + - Is_less_than + targetValueRange: + type: integer + minimum: 0 + maximum: 100 + targetContexts: + $ref: "#/components/schemas/LowSINRContext" + + LowSINRContext: + type: object + properties: + contextAttribute: + type: string + enum: + - LowSINRThreshold + contextCondition: + type: string + enum: + - Is_less_than + contextValueRange: + type: integer + + AveULRANUEThptTarget: + type: object + properties: + targetName: + type: string + enum: + - AveULRANUEThpt + targetCondition: + type: string + enum: + - Is_greater_than + targetValueRange: + type: integer + + AveDLRANUEThptTarget: + type: object + properties: + targetName: + type: string + enum: + - AveDLRANUEThpt + targetCondition: + type: string + enum: + - Is_greater_than + targetValueRange: + type: integer + + LowULRANUEThptRatioTarget: + type: object + properties: + targetName: + type: string + enum: + - LowULRANUEThptRatio + targetCondition: + type: string + enum: + - Is_less_than + targetValueRange: + type: integer + minimum: 0 + maximum: 100 + targetContexts: + $ref: "#/components/schemas/LowULRANUEThptContext" + + LowULRANUEThptContext: + type: object + properties: + contextAttribute: + type: string + enum: + - LowULRANUEThptThreshold + contextCondition: + type: string + enum: + - Is_less_than + contextValueRange: + type: number + + LowDLRANUEThptRatioTarget: + type: object + properties: + targetName: + type: string + enum: + - LowDLRANUEThptRatio + targetCondition: + type: string + enum: + - Is_less_than + targetValueRange: + type: integer + minimum: 0 + maximum: 100 + targetContexts: + $ref: "#/components/schemas/LowDLRANUEThptContext" + + LowDLRANUEThptContext: + type: object + properties: + contextAttribute: + type: string + enum: + - LowDLRANUEThptThreshold + contextCondition: + type: string + enum: + - Is_less_than + contextValueRange: + type: number + #-------Definition of the concrete ExpectationTarget dataType----------# + + #-------Definition of the concrete ObjectTarget dataType----------------# + CoverageAreaPolygonContext: + type: object + properties: + contextAttribute: + type: string + enum: + - CoverageAreaPolygon + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + $ref: "#/components/schemas/CoverageArea" + CoverageArea: + type: string + CoverageTACContext: + type: object + properties: + contextAttribute: + type: string + enum: + - CoverageAreaTac + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + $ref: "nrNrm.yaml#/components/schemas/NrTac" + + PLMNContext: + type: object + properties: + contextAttribute: + type: string + enum: + - PLMN + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + $ref: "nrNrm.yaml#/components/schemas/PlmnId" + + NRFqBandContext: + type: object + properties: + contextAttribute: + type: string + enum: + - NRFqBand + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + type: string + + RATContext: + type: object + properties: + contextAttribute: + type: string + enum: + - RAT + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + type: string + enum: + - UTRAN + - EUTRAN + - NR + #-------Definition of the concrete ObjectTarget dataType----------------# + + #------Definition of JSON arrays for name-contained IOCs ---------------# + + Intent-Multiple: + type: array + items: + $ref: '#/components/schemas/Intent-Single' + #------Definition of JSON arrays for name-contained IOCs --------------# + + #----- Definitions in TS 28.312 for TS 28.532 --------------------------# + resources-intentNrm: + oneOf: + - $ref: '#/components/schemas/Intent-Single' + #----- Definitions in TS 28.312 for TS 28.532 --------------------------# diff --git a/OpenAPI/nrNrm.yaml b/OpenAPI/nrNrm.yaml index 5ef76d4309711d80180bf75fd09e5d38e3e67931..ed8431de414ce6c86b50010a419971511b276d09 100755 --- a/OpenAPI/nrNrm.yaml +++ b/OpenAPI/nrNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: NR NRM - version: 17.5.0 + version: 17.6.0 description: >- OAS 3.0.1 specification of the NR NRM © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -260,6 +260,16 @@ components: minimum: -20 maximum: 20 + MaximumDeviationHoTriggerLow: + type: integer + minimum: -20 + maximum: 20 + + MaximumDeviationHoTriggerHigh: + type: integer + minimum: -20 + maximum: 20 + MinimumTimeBetweenHoTriggerChange: type: integer minimum: 0 @@ -629,7 +639,13 @@ components: - PRB_DL - RRC - DRB - + ParameterRange: + type: object + properties: + maxValue: + type: integer + minValue: + type: integer #-------- Definition of abstract IOCs -------------------------------------------- RrmPolicy_-Attr: @@ -685,7 +701,8 @@ components: $ref: '#/components/schemas/RimRSGlobal-Single' Dynamic5QISet: $ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' - + CCOFunction: + $ref: '#/components/schemas/CCOFunction-Single' ManagedElement-Single: allOf: - $ref: 'genericNrm.yaml#/components/schemas/Top' @@ -1017,6 +1034,8 @@ components: properties: cellLocalId: type: integer + administrativeState: + $ref: 'comDefs.yaml#/components/schemas/AdministrativeState' plmnInfoList: $ref: '#/components/schemas/PlmnInfoList' nrTac: @@ -1415,8 +1434,10 @@ components: properties: dmroControl: type: boolean - maximumDeviationHoTrigger: - $ref: '#/components/schemas/MaximumDeviationHoTrigger' + maximumDeviationHoTriggerLow: + $ref: '#/components/schemas/MaximumDeviationHoTriggerLow' + maximumDeviationHoTriggerHigh: + $ref: '#/components/schemas/MaximumDeviationHoTriggerHigh' minimumTimeBetweenHoTriggerChange: $ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange' tstoreUEcntxt: @@ -1797,6 +1818,57 @@ components: $ref: '#/components/schemas/LocalAddress' remoteAddress: $ref: '#/components/schemas/RemoteAddress' + CCOFunction-Single: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + cCOControl: + type: boolean + cCOWeakCoverageParameters: + $ref: '#/components/schemas/CCOWeakCoverageParameters-Single' + cCOPilotPollutionParameters: + $ref: '#/components/schemas/CCOPilotPollutionParameters-Single' + cCOOvershootCoverageParameters-Single: + $ref: '#/components/schemas/CCOOvershootCoverageParameters-Single' + CCOParameters-Attr: + allOf: + - $ref: 'genericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + coverageShapeList: + type: integer + downlinkTransmitPowerRange: + $ref: '#/components/schemas/ParameterRange' + antennaTiltRange: + $ref: '#/components/schemas/ParameterRange' + antennaAzimuthRange: + $ref: '#/components/schemas/ParameterRange' + digitalTiltRange: + $ref: '#/components/schemas/ParameterRange' + digitalAzimuthRange: + $ref: '#/components/schemas/ParameterRange' + + CCOWeakCoverageParameters-Single: + allOf: + - $ref: '#/components/schemas/CCOParameters-Attr' + - type: object + + CCOPilotPollutionParameters-Single: + allOf: + - $ref: '#/components/schemas/CCOParameters-Attr' + - type: object + + CCOOvershootCoverageParameters-Single: + allOf: + - $ref: '#/components/schemas/CCOParameters-Attr' + - type: object #-------- Definition of JSON arrays for name-contained IOCs ---------------------- @@ -2016,3 +2088,7 @@ components: - $ref: '#/components/schemas/EP_NgU-Single' - $ref: '#/components/schemas/EP_X2U-Single' - $ref: '#/components/schemas/EP_S1U-Single' + - $ref: '#/components/schemas/CCOFunction-Single' + - $ref: '#/components/schemas/CCOWeakCoverageParameters-Single' + - $ref: '#/components/schemas/CCOPilotPollutionParameters-Single' + - $ref: '#/components/schemas/CCOOvershootCoverageParameters-Single' diff --git a/OpenAPI/sliceNrm.yaml b/OpenAPI/sliceNrm.yaml index 0fc9a4f805736efd07e35be5cca2350c08b62198..ed6dfb941a96bb59d4508b50d3e702059e9fe1fe 100755 --- a/OpenAPI/sliceNrm.yaml +++ b/OpenAPI/sliceNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Slice NRM - version: 17.5.0 + version: 17.6.0 description: >- OAS 3.0.1 specification of the Slice NRM @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -232,19 +232,35 @@ components: nsName: type: string EmbbEEPerfReq: - type: integer + type: object + properties: + kpiType: + type: string + enum: + - NUMOFBITS + - NUMOFBITS_RANBASED + req: + type: number UrllcEEPerfReq: - type: integer + type: object + properties: + kpiType: + type: string + enum: + - INVOFLATENCY + - NUMOFBITS_MULTIPLIED_INVOFLATENCY + req: + type: number MIoTEEPerfReq: type: object properties: - KpiType: + kpiType: type: string enum: - MAXREGSUBS - MEANACTIVEUES - Req: - type: integer + req: + type: number EEPerfReq: oneOf: - $ref: '#/components/schemas/EmbbEEPerfReq' @@ -321,7 +337,7 @@ components: reliability: type: string energyEfficiency: - type: integer + type: number dLDeterministicComm: $ref: '#/components/schemas/DeterministicComm' uLDeterministicComm: @@ -349,8 +365,12 @@ components: type: integer activityFactor: type: integer + dLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' dLThptPerUE: $ref: '#/components/schemas/XLThpt' + uLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' uLThptPerUE: $ref: '#/components/schemas/XLThpt' uESpeed: @@ -372,7 +392,7 @@ components: sliceSimultaneousUse: $ref: '#/components/schemas/SliceSimultaneousUse' energyEfficiency: - type: integer + type: number termDensity: $ref: '#/components/schemas/TermDensity' survivalTime: @@ -411,7 +431,7 @@ components: sliceSimultaneousUse: $ref: '#/components/schemas/SliceSimultaneousUse' energyEfficiency: - type: integer + $ref: '#/components/schemas/EnergyEfficiency' synchronicity: $ref: '#/components/schemas/Synchronicity' delayTolerance: