diff --git a/OpenAPI/TS28538_EdgeNrm.yaml b/OpenAPI/TS28538_EdgeNrm.yaml deleted file mode 100644 index a87137ee007f16a000630a3bff41ddd971a645a6..0000000000000000000000000000000000000000 --- a/OpenAPI/TS28538_EdgeNrm.yaml +++ /dev/null @@ -1,452 +0,0 @@ -openapi: 3.0.1 -info: - title: 3GPP Edge NRM - version: 18.8.0 - description: >- - OAS 3.0.1 specification of the Edge NRM - © 2024, 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: array - items: - type: integer - trackingAreaIdList: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/TaiList' - servingPLMN: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - GeoLoc: - type: object - properties: - geographicalCoordinates: - $ref: '#/components/schemas/GeographicalCoordinates' - civicLocation: - type: string - GeographicalCoordinates: - type: object - properties: - latitude: - type: integer - longitude: - type: integer - EDNConnectionInfo: - type: object - properties: - dNN: - type: string - eDNServiceArea: - $ref: '#/components/schemas/ServingLocation' - AffinityAntiAffinity: - type: object - properties: - affinityEAS: - type: array - items: - type: string - antiAffinityEAS: - type: array - items: - type: string - VirtualResource: - type: object - properties: - virtualMemory: - type: integer - virtualDisk: - type: integer - virtualCPU: - type: string - vnfdId: - type: string - SoftwareImageInfo: - type: object - properties: - minimumDisk: - type: integer - minimumRAM: - type: integer - discFormat: - type: string - operatingSystem: - type: string - swImageRef: - type: string - RegistrationInfo: - type: object - properties: - registrationExpiry: - type: string - readOnly: true - registrationID: - type: string - readOnly: true - secCredential: - type: string - Duration: - type: object - properties: - startTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - endTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - EASServicePermission: - type: string - description: any of enumerated value - enum: - - TRIAL - - SILVER - - GOLD - EASFeature: - type: string - EASStatus: - type: string - description: any of enumerated value - enum: - - ENABLED - - DISABLED - ResourceReservationRequirement: - type: object - properties: - computeRequirement: - type: string - storageRequirement: - type: string - networkingRequirement: - type: integer - - ResourceReservationStatus: - type: object - properties: - resourceId: - type: string - reservationStatus: - type: string - description: any of enumrated value - enum: - - RESERVED - - USEd - RelocationTriggerInfo: - type: object - properties: - triggerType: - type: string - description: any of enumrated value - enum: - - IMMEDIATE - - FUTURE - futuristicTriggerTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - AvailableEDNList: - type: object - properties: - resourceQuota: - $ref: '#/components/schemas/VirtualResource' - FederatedECSInfo: - type: object - properties: - federateECSIdentifier: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - federatedECSProfile: - type: integer - servedEASList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - servedEESList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - -#-------- Definition of types for name-containments ------ - SubNetwork-ncO-EdgeNrm: - type: object - properties: - ECSFunction: - $ref: '#/components/schemas/ECSFunction-Multiple' - EdgeDataNetwork: - $ref: '#/components/schemas/EdgeDataNetwork-Multiple' - -#-------- Definition of concrete IOCs -------------------------------------------- - - EdgeDataNetwork-Single: - allOf: - - $ref: 'TS28623_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' - availableEdgeVirtualResources: - type: string - - EASFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - eASIdentifier: - type: string - eESAddress: - type: array - items: - type: string - registrationInfo: - $ref: '#/components/schemas/RegistrationInfo' - eASRequirementsRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - eASAddress: - type: array - items: - type: string - relocationTriggerInfo: - $ref: '#/components/schemas/RelocationTriggerInfo' - relocationRejectByASP: - type: boolean - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - EASProfile-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - aCID: - type: string - eASProvider: - type: string - eASdescription: - type: string - eASSchedule: - $ref: '#/components/schemas/Duration' - eASGeographicalServiceArea: - $ref: '#/components/schemas/GeoLoc' - eASTopologicalServiceArea: - $ref: '#/components/schemas/TopologicalServiceArea' - eASServicePermissionLevel: - $ref: '#/components/schemas/EASServicePermission' - eASFeature: - $ref: '#/components/schemas/EASFeature' - eASServiceContinuitySupport: - type: boolean - eASDNAI: - type: string - eASAvailabilityReportingPeriod: - type: integer - eASStatus: - $ref: '#/components/schemas/EASStatus' - EESFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - eESIdentifier: - type: string - eESServingLocation: - type: array - items: - $ref: '#/components/schemas/ServingLocation' - eESAddress: - type: array - items: - type: string - softwareImageInfo: - $ref: '#/components/schemas/SoftwareImageInfo' - serviceContinuitySupport: - type: boolean - eASFunctionRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - registrationInfo: - $ref: '#/components/schemas/RegistrationInfo' - - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - ECSFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - eCSAddress: - type: string - providerIdentifier: - type: string - edgeDataNetworkRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - eESFuncitonRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - softwareImageInfo: - $ref: '#/components/schemas/SoftwareImageInfo' - sharedECSInfo: - $ref: '#/components/schemas/FederatedECSInfo' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - EASRequirements-Single: - allOf: - - $ref: 'TS28623_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' - eASSchedule: - $ref: '#/components/schemas/Duration' - eASFeature: - $ref: '#/components/schemas/EASFeature' - relocationPolicy: - type: string - description: any of enumrated value - enum: - - YES - - NO - - YESwNOTIFY - federationID: - type: string - eASDeploymentMonitor: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ProcessMonitor' - reservationJobRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - EASResourceReservationJob-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - reservationLocation: - $ref: '#/components/schemas/ServingLocation' - resourceReservationRequirement: - type: array - items: - $ref: '#/components/schemas/ResourceReservationRequirement' - requestedReservationExpiration: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - resourceReservationStatus: - type: array - items: - $ref: '#/components/schemas/ResourceReservationStatus' - EdgeFederation-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - participatingOPiD: - type: string - leadingOPiD: - type: string - federatedECSInfo: - $ref: '#/components/schemas/FederatedECSInfo' - - OperatorEdgeFederation-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - federationID: - type: string - FederationExpiry: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - leadingOPiD: - type: string - avaibleEDNList: - $ref: '#/components/schemas/AvailableEDNList' - acceptedEDN: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - OperatorEdgeDataNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - availableEASResource: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - edgeDataNetworkRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - 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' - EASProfile-Multiple: - type: array - items: - $ref: '#/components/schemas/EASProfile-Single' - EdgeFederation-Multiple: - type: array - items: - $ref: '#/components/schemas/EASProfile-Single' - OperatorEdgeFederation-Multiple: - type: array - items: - $ref: '#/components/schemas/OperatorEdgeFederation-Single' - OperatorEdgeDataNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/OperatorEdgeDataNetwork-Single' - - -#--------------------------------- Definition ------------------------------------ - - resources-edgeNrm: - oneOf: - - $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' - - $ref: '#/components/schemas/EASProfile-Single' - - $ref: '#/components/schemas/EdgeFederation-Single' - - $ref: '#/components/schemas/OperatorEdgeFederation-Single' - - $ref: '#/components/schemas/OperatorEdgeDataNetwork-Single' - - $ref: '#/components/schemas/EASResourceReservationJob-Single' diff --git a/OpenAPI/TS28541_NrNrm.yaml b/OpenAPI/TS28541_NrNrm.yaml deleted file mode 100644 index 11e810bb7e0eaab5b340e93b73a25b3fc9d0ccbc..0000000000000000000000000000000000000000 --- a/OpenAPI/TS28541_NrNrm.yaml +++ /dev/null @@ -1,2281 +0,0 @@ -openapi: 3.0.1 -info: - title: NR NRM - version: 18.9.0 - description: >- - OAS 3.0.1 specification of the NR NRM - © 2024, 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: integer - minimum: 0 - maximum: 4294967295 - GnbIdLength: - type: integer - minimum: 22 - maximum: 32 - GnbName: - type: string - maxLength: 150 - GnbDuId: - type: integer - minimum: 0 - maximum: 68719476735 - GnbCuUpId: - type: integer - minimum: 0 - maximum: 68719476735 - - Sst: - type: integer - minimum: 0 - maximum: 255 - Snssai: - type: object - properties: - sst: - $ref: '#/components/schemas/Sst' - sd: - type: string - pattern: '^[A-Fa-f0-9]{6}$' - - PlmnIdList: - type: array - items: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - PlmnInfo: - type: object - properties: - plmnId: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - snssai: - $ref: '#/components/schemas/Snssai' - sliceExpiryTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - PlmnInfoList: - type: array - items: - $ref: '#/components/schemas/PlmnInfo' - NpnIdentityList: - type: array - items: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/NpnId-Type' - 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: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Tac' - NrTacList: - type: array - items: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Tac' - TaiList: - type: array - items: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Tai' - BackhaulAddress: - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - tai: - $ref: "TS28623_GenericNrm.yaml#/components/schemas/Tai" - MappingSetIDBackhaulAddress: - type: object - properties: - setID: - type: integer - backhaulAddress: - $ref: '#/components/schemas/BackhaulAddress' - LoadTimeThreshold: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer - IntraRatEsActivationOriginalCellLoadParameters: - $ref: '#/components/schemas/LoadTimeThreshold' - IntraRatEsActivationCandidateCellsLoadParameters: - $ref: '#/components/schemas/LoadTimeThreshold' - IntraRatEsDeactivationCandidateCellsLoadParameters: - $ref: '#/components/schemas/LoadTimeThreshold' - EsNotAllowedTimePeriod: - type: object - properties: - startTime: - type: string - description: >- - Time of day is in HH:MM or H:MM 24-hour format per UTC time zone. - Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC). - endTime: - type: string - description: >- - Time of day is in HH:MM or H:MM 24-hour format per UTC time zone. - Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC). - daysOfWeek: - type: string - enum: - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - InterRatEsActivationOriginalCellParameters: - $ref: '#/components/schemas/LoadTimeThreshold' - InterRatEsActivationCandidateCellParameters: - $ref: '#/components/schemas/LoadTimeThreshold' - InterRatEsDeactivationCandidateCellParameters: - $ref: '#/components/schemas/LoadTimeThreshold' - - UeAccProbabilityDist: - type: array - items: - $ref: '#/components/schemas/UeAccProbability' - UeAccProbability: - type: object - properties: - targetProbability: - type: integer - minimum: 0 - maximum: 100 - numberOfPreamblesSent: - type: integer - minimum: 0 - maximum: 200 - - UeAccDelayProbabilityDist: - type: array - items: - $ref: '#/components/schemas/UeAccDelayProbability' - - UeAccDelayProbability: - type: object - properties: - targetProbability: - type: integer - minimum: 0 - maximum: 100 - accessDelay: - type: integer - minimum: 10 - maximum: 560 - - NRPciList: - type: array - items: - $ref: '#/components/schemas/NrPci' - minItems: 0 - maxItems: 1007 - - CSonPciList: - type: array - items: - $ref: '#/components/schemas/NrPci' - minItems: 1 - maxItems: 100 - - MaximumDeviationHoTrigger: - type: integer - minimum: -20 - maximum: 20 - - MaximumDeviationHoTriggerLow: - type: integer - minimum: -20 - maximum: 20 - - MaximumDeviationHoTriggerHigh: - 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 - - IsESCoveredBy: - type: string - enum: - - NO - - PARTIAL - - FULL - RrmPolicyMember: - type: object - properties: - plmnId: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - snssai: - $ref: '#/components/schemas/Snssai' - RrmPolicyMemberList: - type: array - items: - $ref: '#/components/schemas/RrmPolicyMember' - AddressWithVlan: - type: object - properties: - ipv4Address: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' - ipv6Address: - $ref: 'TS28623_ComDefs.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: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' - ipv6Address: - $ref: 'TS28623_ComDefs.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 - minimum: 0 - maximum: 3279165 - - 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 - - RS1_FOR_ENOUGH_MITIGATION - - RS1_FOR_NOT_ENOUGH_MITIGATION - - 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: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' - TceID: - type: integer - PlmnTarget: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - TceMappingInfoList: - type: array - items: - $ref: '#/components/schemas/TceMappingInfo' - ResourceType: - type: string - enum: - - PRB - - PRB_UL - - PRB_DL - - RRC_CONNECTED_USERS - - DRB - ParameterRange: - type: object - properties: - maxValue: - type: integer - minValue: - type: integer - - NTNTAClist: - type: array - items: - $ref: '#/components/schemas/NrTac' - - Ephemeris: - type: object - oneOf: - - required: [ positionVelocity ] - - required: [ orbital ] - required: - - satelliteId - - epochTime - properties: - satelliteId: - type: string - pattern: '^[0-9]{5}$' - epochTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - positionVelocity: - $ref: '#/components/schemas/PositionVelocity' - orbital: - $ref: '#/components/schemas/Orbital' - - EphemerisInfos: - type: array - items: - $ref: '#/components/schemas/Ephemeris' - - PositionVelocity: - type: object - properties: - positionX: - type: integer - minimum: 0 - maximum: 604800 - positionY: - type: integer - minimum: 0 - maximum: 604800 - positionZ: - type: integer - minimum: 0 - maximum: 604800 - velocityVX: - type: integer - minimum: -131072 - maximum: 131071 - velocityVY: - type: integer - minimum: -131072 - maximum: 131071 - velocityVZ: - type: integer - minimum: -131072 - maximum: 131071 - - Orbital: - type: object - properties: - semiMajorAxis: - type: integer - minimum: 0 - maximum: 8589934591 - eccentricity: - type: integer - minimum: -524288 - maximum: 524287 - periapsis: - type: integer - minimum: 0 - maximum: 16777215 - longitude: - type: integer - minimum: 0 - maximum: 2097151 - inclination: - type: integer - minimum: -524288 - maximum: 524287 - meanAnomaly: - type: integer - minimum: 0 - maximum: 16777215 - - MappedCellIdInfo: - type: object - properties: - ntnGeoArea: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea' - mappedCellId: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Ncgi' - MappedCellIdInfoList: - type: array - items: - $ref: '#/components/schemas/MappedCellIdInfo' - QceIdMappingInfo: - type: object - properties: - qoECollectionEntityAddress: - oneOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' - qoECollectionEntityIdentity: - type: string - pLMNTarget: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - QceIdMappingInfoList: - type: array - items: - $ref: '#/components/schemas/QceIdMappingInfo' - MdtUserConsentReqList: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M6 - - M7 - - M8 - - M9 - - MDT_UE_LOCATION - -#-------- Definition of types for name-containments ------ - SubNetwork-ncO-NrNrm: - type: object - properties: - NRFrequency: - $ref: '#/components/schemas/NRFrequency-Multiple' - ExternalGnbCuCpFunction: - $ref: '#/components/schemas/ExternalGnbCuCpFunction-Multiple' - ExternalGnbCuUpFunction: - $ref: '#/components/schemas/ExternalGnbCuUpFunction-Multiple' - ExternalGnbDuFunction: - $ref: '#/components/schemas/ExternalGnbDuFunction-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' - DLBOFunction: - $ref: '#/components/schemas/DLBOFunction-Single' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - CPCIConfigurationFunction: - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - CESManagementFunction: - $ref: '#/components/schemas/CESManagementFunction-Single' - Configurable5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' - RimRSGlobal: - $ref: '#/components/schemas/RimRSGlobal-Single' - Dynamic5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' - CCOFunction: - $ref: '#/components/schemas/CCOFunction-Single' - - ManagedElement-ncO-NrNrm: - 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' - DLBOFunction: - $ref: '#/components/schemas/DLBOFunction-Single' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - CPCIConfigurationFunction: - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - CESManagementFunction: - $ref: '#/components/schemas/CESManagementFunction-Single' - Configurable5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' - -#-------- Definition of abstract IOCs -------------------------------------------- - - RrmPolicy_-Attr: - type: object - properties: - resourceType: - $ref: '#/components/schemas/ResourceType' - rRMPolicyMemberList: - $ref: '#/components/schemas/RrmPolicyMemberList' - -#-------- Definition of concrete IOCs -------------------------------------------- - - GnbDuFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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' - configurable5QISetRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - dynamic5QISetRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - $ref: 'TS28623_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' - OperatorDU: - $ref: '#/components/schemas/OperatorDu-Multiple' - BWPSet: - $ref: '#/components/schemas/BWPSet-Multiple' - Configurable5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' - - OperatorDu-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - - type: object - properties: - EP_F1C: - $ref: '#/components/schemas/EP_F1C-Single' - EP_F1U: - $ref: '#/components/schemas/EP_F1U-Multiple' - configurable5QISetRef: - description: This attribute is condition optional. The condition is NG-RAN Multi-Operator Core Network (NG-RAN MOCN) network sharing with operator specific 5QI is supported. - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - dynamic5QISetRef: - description: This attribute is condition optional. The condition is NG-RAN Multi-Operator Core Network (NG-RAN MOCN) network sharing with operator specific 5QI is supported. - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - NrOperatorCellDu: - $ref: '#/components/schemas/NrOperatorCellDu-Multiple' - GnbCuUpFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - dynamic5QISetRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - $ref: 'TS28623_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' - Configurable5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' - - GnbCuCpFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - x2BlockList: - $ref: '#/components/schemas/GGnbIdList' - xnBlockList: - $ref: '#/components/schemas/GGnbIdList' - x2AllowList: - $ref: '#/components/schemas/GGnbIdList' - xnAllowList: - $ref: '#/components/schemas/GGnbIdList' - x2HOBlockList: - $ref: '#/components/schemas/GEnbIdList' - xnHOBlackList: - $ref: '#/components/schemas/GGnbIdList' - mappingSetIDBackhaulAddress: - $ref: '#/components/schemas/MappingSetIDBackhaulAddress' - tceMappingInfoList: - $ref: '#/components/schemas/TceMappingInfoList' - configurable5QISetRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - dynamic5QISetRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - ephemerisInfoSetRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - dCHOControl: - type: boolean - dDAPSHOControl: - type: boolean - mappedCellIdInfoList: - $ref: '#/components/schemas/MappedCellIdInfoList' - qceIdMappingInfoList: - $ref: '#/components/schemas/QceIdMappingInfoList' - mdtUserConsentReqList: - $ref: '#/components/schemas/MdtUserConsentReqList' - - $ref: 'TS28623_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' - DLBOFunction: - $ref: '#/components/schemas/DLBOFunction-Single' - Configurable5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' - NRNetwork: - $ref: '#/components/schemas/NRNetwork-Single' - EUtranNetwork: - $ref: '#/components/schemas/EUtraNetwork-Single' - - NrCellCu-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - cellLocalId: - type: integer - plmnInfoList: - $ref: '#/components/schemas/PlmnInfoList' - nRFrequencyRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - $ref: 'TS28623_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' - DLBOFunction: - $ref: '#/components/schemas/DLBOFunction-Single' - CESManagementFunction: - $ref: '#/components/schemas/CESManagementFunction-Single' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - - NrCellDu-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - administrativeState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' - operationalState: - $ref: 'TS28623_ComDefs.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: 'TS28623_GenericNrm.yaml#/components/schemas/Tac' - 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: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - bwpRef: - description: "Condition is BWP sets are not supported" - type: array - items: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - bwpSetRef: - description: "Condition is BWP sets are supported" - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - rimRSMonitoringStartTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - rimRSMonitoringStopTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - rimRSMonitoringWindowDuration: - type: integer - rimRSMonitoringWindowStartingOffset: - type: integer - rimRSMonitoringWindowPeriodicity: - type: integer - rimRSMonitoringOccasionInterval: - type: integer - rimRSMonitoringOccasionStartingOffset: - type: integer - nRFrequencyRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - victimSetRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - aggressorSetRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - $ref: 'TS28623_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' - - BWPSet-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - bWPlist: - type: array - items: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - maxItems: 12 - - - NrOperatorCellDu-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - cellLocalId: - type: integer - administrativeState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' - plmnInfoList: - $ref: '#/components/schemas/PlmnInfoList' - nrTac: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Tac' - - NRFrequency-Single: - allOf: - - $ref: 'TS28623_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: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - CommonBeamformingFunction: - $ref: '#/components/schemas/CommonBeamformingFunction-Single' - Bwp-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - CommonBeamformingFunction-Single: - allOf: - - $ref: 'TS28623_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: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: '#/components/schemas/RrmPolicy_-Attr' - - type: object - properties: - rRMPolicyMaxRatio: - type: integer - default: 100 - minimum: 0 - maximum: 100 - rRMPolicyMinRatio: - type: integer - default: 0 - minimum: 0 - maximum: 100 - rRMPolicyDedicatedRatio: - type: integer - default: 0 - minimum: 0 - maximum: 100 - - NRCellRelation-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - nRTCI: - type: integer - cellIndividualOffset: - $ref: '#/components/schemas/CellIndividualOffset' - adjacentNRCellRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - nRFreqRelationRef: - $ref: 'TS28623_ComDefs.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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - adjacentEUtranCellRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - NRFreqRelation-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - offsetMO: - $ref: '#/components/schemas/QOffsetRangeList' - blockListEntry: - type: array - items: - type: integer - minimum: 0 - maximum: 1007 - blockListEntryIdleMode: - 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: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - EUtranFreqRelation-Single: - allOf: - - $ref: 'TS28623_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: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - DANRManagementFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - intrasystemANRManagementSwitch: - type: boolean - intersystemANRManagementSwitch: - type: boolean - - DESManagementFunction-Single: - allOf: - - $ref: 'TS28623_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/InterRatEsActivationOriginalCellParameters" - interRatEsActivationCandidateCellParameters: - $ref: "#/components/schemas/InterRatEsActivationCandidateCellParameters" - interRatEsDeactivationCandidateCellParameters: - $ref: "#/components/schemas/InterRatEsDeactivationCandidateCellParameters" - isProbingCapable: - type: string - enum: - - YES - - NO - energySavingState: - type: string - enum: - - IS_NOT_ENERGY_SAVING - - IS_ENERGY_SAVING - mLModelRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - aIMLInferenceFunctionRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - DRACHOptimizationFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - drachOptimizationControl: - type: boolean - ueAccProbabilityDist: - $ref: "#/components/schemas/UeAccProbabilityDist" - ueAccDelayProbabilityDist: - $ref: "#/components/schemas/UeAccDelayProbabilityDist" - - DMROFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - dmroControl: - type: boolean - maximumDeviationHoTriggerLow: - $ref: '#/components/schemas/MaximumDeviationHoTriggerLow' - maximumDeviationHoTriggerHigh: - $ref: '#/components/schemas/MaximumDeviationHoTriggerHigh' - minimumTimeBetweenHoTriggerChange: - $ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange' - tstoreUEcntxt: - $ref: '#/components/schemas/TstoreUEcntxt' - mLModelRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - aIMLInferenceFunctionRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - DLBOFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - dlboControl: - type: boolean - maximumDeviationHoTrigger: - $ref: '#/components/schemas/MaximumDeviationHoTrigger' - minimumTimeBetweenHoTriggerChange: - $ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange' - mLModelRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - aIMLInferenceFunctionRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - DPCIConfigurationFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - dPciConfigurationControl: - type: boolean - nRPciList: - $ref: "#/components/schemas/NRPciList" - - CPCIConfigurationFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - cPciConfigurationControl: - type: boolean - cSonPciList: - $ref: "#/components/schemas/CSonPciList" - - CESManagementFunction-Single: - allOf: - - $ref: 'TS28623_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: - - TO_BE_ENERGY_SAVING - - TO_BE_NOT_ENERGY_SAVING - energySavingState: - type: string - enum: - - IS_NOT_ENERGY_SAVING - - IS_ENERGY_SAVING - - RimRSGlobal-Single: - allOf: - - $ref: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - setId: - $ref: '#/components/schemas/RSSetId' - setType: - $ref: '#/components/schemas/RSSetType' - nRCellDURefs: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - - ExternalGnbDuFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - - $ref: 'TS28623_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' - NRNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - NRFrequency: - $ref: '#/components/schemas/NRFrequency-Multiple' - ExternalGnbCuCpFunction: - $ref: '#/components/schemas/ExternalGnbCuCpFunction-Multiple' - ExternalGnbCuUpFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - - $ref: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: >- - TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr - - type: object - properties: - gnbId: - $ref: '#/components/schemas/GnbId' - gnbIdLength: - $ref: '#/components/schemas/GnbIdLength' - plmnId: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - - $ref: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - cellLocalId: - type: integer - nrPci: - $ref: '#/components/schemas/NrPci' - plmnIdList: - $ref: '#/components/schemas/PlmnIdList' - nRFrequencyRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - EUtraNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - EUtranFrequency: - $ref: '#/components/schemas/EUtranFrequency-Multiple' - ExternalENBFunction: - $ref: '#/components/schemas/ExternalENBFunction-Multiple' - ExternalENBFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - eNBId: - type: integer - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - ExternalEUTranCell: - $ref: '#/components/schemas/ExternalEUTranCell-Multiple' - ExternalEUTranCell-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - EUtranFrequencyRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - EP_XnC-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - epTransportRefs: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - - EP_NgU-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - epTransportRefs: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - - EP_X2U-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_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: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: '#/components/schemas/LocalAddress' - remoteAddress: - $ref: '#/components/schemas/RemoteAddress' - CCOFunction-Single: - allOf: - - $ref: 'TS28623_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: 'TS28623_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 - - NTNFunction-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - nTNpLMNInfoList: - $ref: '#/components/schemas/PlmnInfoList' - nTNTAClist: - $ref: '#/components/schemas/NrTacList' - ephemerisInfoSet: - $ref: '#/components/schemas/EphemerisInfoSet-Multiple' - - EphemerisInfoSet-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - ephemerisInfos: - $ref: '#/components/schemas/EphemerisInfos' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - GnbDuFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/GnbDuFunction-Single' - OperatorDu-Multiple: - type: array - items: - $ref: '#/components/schemas/OperatorDu-Single' - GnbCuUpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/GnbCuUpFunction-Single' - GnbCuCpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/GnbCuCpFunction-Single' - BWPSet-Multiple: - type: array - items: - $ref: '#/components/schemas/BWPSet-Single' - - NrCellDu-Multiple: - type: array - items: - $ref: '#/components/schemas/NrCellDu-Single' - - NrOperatorCellDu-Multiple: - type: array - items: - $ref: '#/components/schemas/NrOperatorCellDu-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' - EphemerisInfoSet-Multiple: - type: array - items: - $ref: '#/components/schemas/EphemerisInfoSet-Single' - -#-------- Definitions in TS 28.541 for TS 28.532 --------------------------------- - - resources-nrNrm: - oneOf: - - $ref: '#/components/schemas/GnbDuFunction-Single' - - $ref: '#/components/schemas/GnbCuUpFunction-Single' - - $ref: '#/components/schemas/GnbCuCpFunction-Single' - - $ref: '#/components/schemas/OperatorDu-Single' - - - $ref: '#/components/schemas/NrCellCu-Single' - - $ref: '#/components/schemas/NrCellDu-Single' - - $ref: '#/components/schemas/NrOperatorCellDu-Single' - - - $ref: '#/components/schemas/NRNetwork-Single' - - $ref: '#/components/schemas/EUtraNetwork-Single' - - - $ref: '#/components/schemas/NRFrequency-Single' - - $ref: '#/components/schemas/EUtranFrequency-Single' - - - $ref: '#/components/schemas/NrSectorCarrier-Single' - - $ref: '#/components/schemas/Bwp-Single' - - $ref: '#/components/schemas/BWPSet-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/DLBOFunction-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' - - $ref: '#/components/schemas/CCOFunction-Single' - - $ref: '#/components/schemas/CCOWeakCoverageParameters-Single' - - $ref: '#/components/schemas/CCOPilotPollutionParameters-Single' - - $ref: '#/components/schemas/CCOOvershootCoverageParameters-Single' - - $ref: '#/components/schemas/NTNFunction-Single' - - $ref: '#/components/schemas/EphemerisInfoSet-Single' - diff --git a/OpenAPI/TS28541_SliceNrm.yaml b/OpenAPI/TS28541_SliceNrm.yaml deleted file mode 100644 index 121dc8f67f4d2c3a97d27200e1c9a19d54ea757b..0000000000000000000000000000000000000000 --- a/OpenAPI/TS28541_SliceNrm.yaml +++ /dev/null @@ -1,1081 +0,0 @@ -openapi: 3.0.1 -info: - title: Slice NRM - version: 18.8.0 - description: >- - OAS 3.0.1 specification of the Slice NRM - @ 2024, 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 - - FULL_MOBILITY - SynAvailability: - type: string - enum: - - NOT_SUPPORTED - - BETWEEN_BS_AND_UE - - BETWEEN_BS_AND_UE_AND_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 - - SliceSimultaneousUse: - type: integer - minimum: 0 - maximum: 4 - 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' - NonIPSupport: - 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: array - items: - type: integer - 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: array - items: - 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: array - items: - type: string - Synchronicity: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - 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' - 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 - description: - type: string - EmbbEEPerfReq: - type: object - properties: - kpiType: - type: string - enum: - - NUMOFBITS - - NUMOFBITS_RANBASED - req: - type: number - UrllcEEPerfReq: - type: object - properties: - kpiType: - type: string - enum: - - INVOFLATENCY - - NUMOFBITS_MULTIPLIED_INVOFLATENCY - req: - type: number - MIoTEEPerfReq: - type: object - properties: - kpiType: - type: string - enum: - - MAXREGSUBS - - MEANACTIVEUES - req: - type: number - 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' - NSSAASupport: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - support: - $ref: '#/components/schemas/Support' - SecFunc: - type: object - properties: - secFunId: - type: string - secFunType: - type: string - secRules: - type: array - items: - type: string - N6Protection: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - secFuncList: - type: array - items: - $ref: '#/components/schemas/SecFunc' - DataNetwork: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - dnnList: - type: array - items: - type: string - DataAccess: - type: object - properties: - dataNetworkName: - type: string - dataAccessUsed: - type: string - enum: - - DIRECT_INTERNET_ACCESS - - TERM_PVT_NETWORK - - LOCAL_TRAFFIC - TunnellingMechanism: - type: object - properties: - dataNetworkName: - type: string - tunellingMechanismUsed: - type: string - enum: - - L2TP_TUNNEL - - GRE_TUNNEL - - VPN_TUNNEL - - LABEL_BASED_ROUTING - - 802.1Q_VLAN - - SRV6 - - OTHER - LboAllowed: - type: object - properties: - dataNetworkName: - type: string - localBreakoutAllowed: - type: string - enum: - - YES - - NO - DataNetworkAccess: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - dataAccessList: - type: array - items: - $ref: '#/components/schemas/DataAccess' - tunnellingMechanismList: - type: array - items: - $ref: '#/components/schemas/TunnellingMechanism' - localBreakoutAllowedList: - type: array - items: - $ref: '#/components/schemas/LboAllowed' - - CNSliceSubnetProfile: - type: object - properties: - maxNumberofUEs: - type: integer - dLLatency: - type: number - uLLatency: - type: number - dLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - dLThptPerUE: - $ref: '#/components/schemas/XLThpt' - uLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - uLThptPerUE: - $ref: '#/components/schemas/XLThpt' - maxNumberOfPDUSessions: - type: integer - coverageAreaTAList: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/TaiList' - resourceSharingLevel: - $ref: '#/components/schemas/SharingLevel' - dLMaxPktSize: - type: integer - uLMaxPktSize: - type: integer - delayTolerance: - $ref: '#/components/schemas/DelayTolerance' - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - dLReliability: - type: number - uLReliability: - type: number - energyEfficiency: - type: number - dLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - uLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - survivalTime: - type: number - nssaaSupport: - $ref: '#/components/schemas/NSSAASupport' - n6Protection: - $ref: '#/components/schemas/N6Protection' - nonIPSupport: - $ref: '#/components/schemas/NonIPSupport' - availability: - type: number - maxDLDataVolume: - type: number - maxULDataVolume: - type: number - supportedDataNetworks: - $ref: '#/components/schemas/DataNetwork' - dataNetworkAccess: - $ref: '#/components/schemas/DataNetworkAccess' - dLPktDelayVariation: - $ref: '#/components/schemas/Float' - uLPktDelayVariation: - $ref: '#/components/schemas/Float' - sliceSubnetAvailability: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SchedulingTime' - - RANSliceSubnetProfile: - type: object - properties: - coverageAreaTAList: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/TaiList' - dLLatency: - type: number - uLLatency: - type: number - uEMobilityLevel: - $ref: '#/components/schemas/MobilityLevel' - resourceSharingLevel: - $ref: '#/components/schemas/SharingLevel' - maxNumberofUEs: - 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: - type: integer - dLReliability: - type: number - uLReliability: - type: number - dLMaxPktSize: - type: integer - uLMaxPktSize: - type: integer - nROperatingBands: - type: array - items: - type: string - delayTolerance: - $ref: '#/components/schemas/DelayTolerance' - positioning: - $ref: '#/components/schemas/Positioning' - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - energyEfficiency: - type: number - termDensity: - $ref: '#/components/schemas/TermDensity' - survivalTime: - type: number - synchronicity: - $ref: '#/components/schemas/Synchronicity' - dLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - uLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - nonIPSupport: - $ref: '#/components/schemas/NonIPSupport' - availability: - type: number - maxDLDataVolume: - type: number - maxULDataVolume: - type: number - kPIMonitoring: - $ref: '#/components/schemas/KPIMonitoring' - dLPktDelayVariation: - $ref: '#/components/schemas/Float' - uLPktDelayVariation: - $ref: '#/components/schemas/Float' - - TopSliceSubnetProfile: - type: object - properties: - dLLatency: - type: integer - uLLatency: - 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: array - items: - type: string - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - energyEfficiency: - $ref: '#/components/schemas/EnergyEfficiency' - synchronicity: - $ref: '#/components/schemas/Synchronicity' - delayTolerance: - $ref: '#/components/schemas/DelayTolerance' - positioning: - $ref: '#/components/schemas/Positioning' - termDensity: - $ref: '#/components/schemas/TermDensity' - activityFactor: - type: integer - coverageAreaTAList: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/TaiList' - resourceSharingLevel: - $ref: '#/components/schemas/SharingLevel' - uEMobilityLevel: - $ref: '#/components/schemas/MobilityLevel' - uESpeed: - type: integer - dLReliability: - type: number - uLReliability: - type: number - dLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - uLDeterministicComm: - $ref: '#/components/schemas/DeterministicComm' - survivalTime: - type: number - nssaaSupport: - $ref: '#/components/schemas/NSSAASupport' - n6Protection: - $ref: '#/components/schemas/N6Protection' - nonIPSupport: - $ref: '#/components/schemas/NonIPSupport' - availability: - type: number - maxDLDataVolume: - type: number - maxULDataVolume: - type: number - kPIMonitoring: - $ref: '#/components/schemas/KPIMonitoring' - supportedDataNetworks: - $ref: '#/components/schemas/DataNetwork' - dataNetworkAccess: - $ref: '#/components/schemas/DataNetworkAccess' - dLPktDelayVariation: - $ref: '#/components/schemas/Float' - uLPktDelayVariation: - $ref: '#/components/schemas/Float' - sliceSubnetAvailability: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SchedulingTime' - - ServiceProfile: - type: object - properties: - serviceProfileId: - type: string - plmnInfoList: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' - maxNumberofUEs: - type: number - dLLatency: - type: number - uLLatency: - type: number - uEMobilityLevel: - $ref: '#/components/schemas/MobilityLevel' - sst: - $ref: 'TS28541_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' - v2XCommModels: - $ref: '#/components/schemas/V2XCommModels' - coverageArea: - type: array - items: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea' - termDensity: - $ref: '#/components/schemas/TermDensity' - activityFactor: - $ref: '#/components/schemas/Float' - uESpeed: - type: integer - survivalTime: - type: number - dLReliability: - type: number - uLReliability: - type: number - maxDLDataVolume: - type: number - maxULDataVolume: - type: number - sliceSimultaneousUse: - $ref: '#/components/schemas/SliceSimultaneousUse' - energyEfficiency: - $ref: '#/components/schemas/EnergyEfficiency' - nssaaSupport: - $ref: '#/components/schemas/NSSAASupport' - n6Protection: - $ref: '#/components/schemas/N6Protection' - nonIPSupport: - $ref: '#/components/schemas/NonIPSupport' - supportedDataNetworks: - $ref: '#/components/schemas/DataNetwork' - dataNetworkAccess: - $ref: '#/components/schemas/DataNetworkAccess' - dLPktDelayVariation: - $ref: '#/components/schemas/Float' - uLPktDelayVariation: - $ref: '#/components/schemas/Float' - sliceAvailability: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SchedulingTime' - - SliceProfile: - type: object - properties: - sliceProfileId: - type: string - plmnInfoList: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' - cNSliceSubnetProfile: - $ref: '#/components/schemas/CNSliceSubnetProfile' - rANSliceSubnetProfile: - $ref: '#/components/schemas/RANSliceSubnetProfile' - topSliceSubnetProfile: - $ref: '#/components/schemas/TopSliceSubnetProfile' - - IpAddress: - oneOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' - - LogicalInterfaceInfo: - type: object - properties: - logicalInterfaceType: - type: string - enum: - - VLAN - - MPLS - - SEGMENT - logicalInterfaceId: - type: string - systemName: - type: string - portName: - type: string - routingProtocol: - type: string - enum: - - RIP - - IGMP - - OSPF - - EGP - - EIGRP - - BGP - - IS_IS - - STATIC - - ConnectionPointInfo: - type: object - properties: - connectionPointId: - type: string - connectionPointIdType: - type: string - enum: - - VLAN - - MPLS - - SEGMENT - - IPV4 - - IPV6 - - ATTACHMENT_CIRCUIT - - ServiceProfileList: - type: array - items: - $ref: '#/components/schemas/ServiceProfile' - - SliceProfileList: - type: array - items: - $ref: '#/components/schemas/SliceProfile' - FeasibilityResult: - description: >- - An attribute which specifies the feasibility check result for the feasibility check and reservation job. - type: string - enum: - - FEASIBLE - - INFEASIBLE - InFeasibleReason: - description: >- - An attribute that specifies the additional reason information if the feasibility check result is infeasible.The detailed ENUM value is FFS. - type: string - RecommendationRequest: - description: >- - An attribute represents MnS consumer's request for recommended network slice related requirements. - type: boolean - RecommendedRequirements: - description: >- - An attribute that specifies the recommended network slicing related requirements (i.e. ServiceProfile and SliceProfile information) which can be supported by the MnS producer.. - type: string - ResourceReservation: - description: >- - An attribute represents MnS consumer's requirements for resource reservation. - type: boolean - RequestedReservationExpiration: - description: >- - An attribute which specifies MnS consuner's requirements for the validity period of the resource reservation. - $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' - ResourceReservationStatus: - description: >- - An attribute which specifies the resource reservation result for the feasibility check job. - type: string - enum: - - RESERVED - - UNRESERVED - - USED - ReservationExpiration: - description: >- - An attribute which specifies the actual validity period of the resource reservation.. - $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' - ReservationFailureReason: - description: >- - An attribute that specifies the additional reason information if the reservation is failed. - type: string - - ResourceIsolationRule: - type: object - properties: - resourceType: - type: string - enum: - - MANAGED_FUNCTION - - NETWORK_SERVICE - isolationRule: - type: string - enum: - - DEDICATED - - SHARED - - NetworkSlicingApplicability: - type: string - enum: - - NETWORKSLICE - - NETWORKSLICESUBNET - -#-------- Definition of types for name-containments ------ - SubNetwork-ncO-SliceNrm: - type: object - properties: - NetworkSlice: - $ref: '#/components/schemas/NetworkSlice-Multiple' - NetworkSliceSubnet: - $ref: '#/components/schemas/NetworkSliceSubnet-Multiple' - EP_Transport: - $ref: '#/components/schemas/EP_Transport-Multiple' - NetworkSliceSubnetProviderCapabilities: - $ref: '#/components/schemas/NetworkSliceSubnetProviderCapabilities-Multiple' - FeasibilityCheckAndReservationJob: - $ref: '#/components/schemas/FeasibilityCheckAndReservationJob-Multiple' - NetworkSliceController: - $ref: '#/components/schemas/NetworkSliceController-Multiple' - NetworkSliceSubnetController: - $ref: '#/components/schemas/NetworkSliceSubnetController-Multiple' - IsolationProfile: - $ref: '#/components/schemas/IsolationProfile-Multiple' - -#------------ Definition of concrete IOCs ---------------------------------------- - - NetworkSlice-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - networkSliceSubnetRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - operationalState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' - serviceProfileList: - $ref: '#/components/schemas/ServiceProfileList' - networkSliceControllerRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - isolationProfileRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - NetworkSliceSubnet-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - managedFunctionRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - networkSliceSubnetRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - operationalState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' - nsInfo: - $ref: '#/components/schemas/NsInfo' - sliceProfileList: - $ref: '#/components/schemas/SliceProfileList' - epTransportRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - priorityLabel: - type: integer - networkSliceSubnetType: - type: string - enum: - - TOP_SLICESUBNET - - RAN_SLICESUBNET - - CN_SLICESUBNET - networkSliceSubnetControllerRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - isolationProfileRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - EP_Transport-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - ipAddress: - $ref: '#/components/schemas/IpAddress' - localLogicalInterfaceInfo: - $ref: '#/components/schemas/LogicalInterfaceInfo' - qosProfile: - type: string - epApplicationRefs: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - connectionPointRefList: - type: array - items: - $ref: '#/components/schemas/ConnectionPointInfo' - - NetworkSliceSubnetProviderCapabilities-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - dLlatency: - type: integer - uLlatency: - type: integer - dLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - uLThptPerSliceSubnet: - $ref: '#/components/schemas/XLThpt' - coverageAreaTAList: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/TaiList' - FeasibilityCheckAndReservationJob-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - profile: - oneOf: - - $ref: '#/components/schemas/SliceProfile' - - $ref: '#/components/schemas/ServiceProfile' - resourceReservation: - $ref: '#/components/schemas/ResourceReservation' - recommendationRequest: - $ref: '#/components/schemas/RecommendationRequest' - requestedReservationExpiration: - $ref: '#/components/schemas/RequestedReservationExpiration' - feasibilityTimeWindow: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' - processMonitor: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ProcessMonitor' - feasibilityResult: - $ref: '#/components/schemas/FeasibilityResult' - inFeasibleReason: - $ref: '#/components/schemas/InFeasibleReason' - resourceReservationStatus: - $ref: '#/components/schemas/ResourceReservationStatus' - reservationFailureReason: - $ref: '#/components/schemas/ReservationFailureReason' - - reservationExpiration: - $ref: '#/components/schemas/ReservationExpiration' - recommendedRequirements: - $ref: '#/components/schemas/RecommendedRequirements' - - NetworkSliceController-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - inputServiceProfile: - $ref: '#/components/schemas/ServiceProfile' - serviceProfileId: - type: string - operationalState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' - availabilityStatus: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AvailabilityStatus' - processMonitor: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ProcessMonitor' - networkSliceRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - NetworkSliceSubnetController-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - inputSliceProfile: - $ref: '#/components/schemas/SliceProfile' - sliceProfileId: - type: string - operationalState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' - availabilityStatus: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AvailabilityStatus' - processMonitor: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ProcessMonitor' - networkSliceSubnetRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - IsolationProfile-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - networkSlicingApplicability: - $ref: '#/components/schemas/NetworkSlicingApplicability' - resourceIsolationRuleList: - type: array - items: - $ref: '#/components/schemas/ResourceIsolationRule' - networkSliceRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - networkSliceSubnetRefList: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - 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' - - NetworkSliceSubnetProviderCapabilities-Multiple: - type: array - items: - $ref: '#/components/schemas/NetworkSliceSubnetProviderCapabilities-Single' - FeasibilityCheckAndReservationJob-Multiple: - type: array - items: - $ref: '#/components/schemas/FeasibilityCheckAndReservationJob-Single' - - NetworkSliceController-Multiple: - type: array - items: - $ref: '#/components/schemas/NetworkSliceController-Single' - - NetworkSliceSubnetController-Multiple: - type: array - items: - $ref: '#/components/schemas/NetworkSliceSubnetController-Single' - - IsolationProfile-Multiple: - type: array - items: - $ref: '#/components/schemas/IsolationProfile-Single' - -#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- - - resources-sliceNrm: - oneOf: - - $ref: '#/components/schemas/NetworkSlice-Single' - - $ref: '#/components/schemas/NetworkSliceSubnet-Single' - - $ref: '#/components/schemas/EP_Transport-Single' - - $ref: '#/components/schemas/NetworkSliceSubnetProviderCapabilities-Single' - - $ref: '#/components/schemas/FeasibilityCheckAndReservationJob-Single' - - $ref: '#/components/schemas/NetworkSliceController-Single' - - $ref: '#/components/schemas/NetworkSliceSubnetController-Single' - - $ref: '#/components/schemas/IsolationProfile-Single' - diff --git a/OpenAPI/TS28623_ComDefs.yaml b/OpenAPI/TS28623_ComDefs.yaml deleted file mode 100644 index f5985b380d3b5e0fe042a76a134ec72c1e6251dc..0000000000000000000000000000000000000000 --- a/OpenAPI/TS28623_ComDefs.yaml +++ /dev/null @@ -1,415 +0,0 @@ -openapi: 3.0.1 -info: - title: Common Type Definitions - version: 18.7.0 - description: >- - OAS 3.0.1 specification of common type definitions in the Generic NRM - © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.623; Generic NRM; Common type definitions - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ -paths: {} -components: - schemas: - - Float: - type: number - format: float - DateTime: - type: string - format: date-time - FullTime: - type: string - description: format (e.g., full-time) is from RFC 3339 - format: full-time - DateMonth: - type: string - format: date-month - DateMonthDay: - type: string - format: date-mday - DayInYear: - type: object - properties: - month: - $ref: '#/components/schemas/DateMonth' - monthDay: - $ref: '#/components/schemas/DateMonthDay' - Latitude: - type: number - format: float - minimum: -90 - maximum: 90 - Longitude: - type: number - format: float - minimum: -180 - maximum: 180 - - Dn: - type: string - DnList: - type: array - items: - $ref: '#/components/schemas/Dn' - - Mcc: - type: string - pattern: '^[0-9]{3}$' - Mnc: - type: string - pattern: '^[0-9]{2,3}$' - Nid: - type: string - pattern: '^[A-Fa-f0-9]{11}$' - PlmnId: - type: object - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - Tac: - type: string - pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' - UtraCellId: - type: integer - EutraCellId: - type: string - pattern: '^[A-Fa-f0-9]{7}$' - NrCellId: - type: string - pattern: '^[A-Fa-f0-9]{9}$' - TimeWindow: - oneOf: - - type: object - properties: - startTime: - $ref: '#/components/schemas/DateTime' - endTime: - $ref: '#/components/schemas/DateTime' - - type: object - properties: - startTime: - $ref: '#/components/schemas/DateTime' - - type: object - properties: - endTime: - $ref: '#/components/schemas/DateTime' - GeoCoordinate: - type: object - properties: - latitude: - $ref: '#/components/schemas/Latitude' - longitude: - $ref: '#/components/schemas/Longitude' - altitude: - $ref: '#/components/schemas/Float' - ConvexGeoPolygon: - type: array - items: - $ref: '#/components/schemas/GeoCoordinate' - minItems: 3 - GeoArea: - type: object - properties: - convexGeoPolygon: - $ref: '#/components/schemas/ConvexGeoPolygon' - GeoAreaToCellMapping: - type: object - properties: - geoArea: - $ref: '#/components/schemas/GeoArea' - associationThreshold: - type: integer - AreaOfInterest: - oneOf: - - type: array - items: - $ref: '#/components/schemas/GeoAreaToCellMapping' - - type: array - items: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Tai' - - type: array - items: - $ref: '#/components/schemas/NrCellId' - - type: array - items: - $ref: '#/components/schemas/EutraCellId' - - type: array - items: - $ref: '#/components/schemas/UtraCellId' - - Fqdn: - type: string - 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' - 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' - 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' - IpAddr: - oneOf: - - $ref: '#/components/schemas/Ipv4Addr' - - $ref: '#/components/schemas/Ipv6Addr' - - $ref: '#/components/schemas/Ipv6Prefix' - HostAddr: - # This definition will be deprecated, when all occurances of HostAddr - # are replaced by Host. - oneOf: - - $ref: '#/components/schemas/Ipv4Addr' - - $ref: '#/components/schemas/Ipv6Addr' - - $ref: '#/components/schemas/Fqdn' - Host: - oneOf: - - $ref: '#/components/schemas/IpAddr' - - $ref: '#/components/schemas/Fqdn' - Uri: - type: string - - TimeInterval: - type: object - properties: - intervalStart: - $ref: '#/components/schemas/FullTime' - intervalEnd: - $ref: '#/components/schemas/FullTime' - - AdministrativeState: - type: string - enum: - - LOCKED - - UNLOCKED - default: LOCKED - OperationalState: - type: string - enum: - - ENABLED - - DISABLED - default: DISABLED - UsageState: - type: string - enum: - - IDLE - - ACTIVE - - BUSY - AvailabilityStatus: - type: string - enum: - - IN_TEST - - FAILED - - POWER_OFF - - OFF_LINE - - OFF_DUTY - - DEPENDENCY - - DEGRADED - - NOT_INSTALLED - - LOG_FULL - - AttributeNameValuePairSet: - description: >- - The key of this map is the attribute name, and the value the attribute value. - type: object - minProperties: 1 - additionalProperties: - nullable: true - AttributeValueChangeSet: - description: >- - The first array item contains the attribute name value pairs with the new values, - and the second array item the attribute name value pairs with the optional old values. - type: array - items: - $ref: '#/components/schemas/AttributeNameValuePairSet' - minItems: 1 - maxItems: 2 - - Filter: - description: >- - The filter format shall be compliant to Jex (TS 32.161). - type: string - SystemDN: - type: string - - NotificationId: - type: integer - NotificationType: - oneOf: - - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/AlarmNotificationTypes' - - $ref: 'TS28532_ProvMnS.yaml#/components/schemas/CmNotificationTypes' - - $ref: 'TS28532_PerfMnS.yaml#/components/schemas/PerfNotificationTypes' - - $ref: 'TS28532_HeartbeatNtf.yaml#/components/schemas/HeartbeatNotificationTypes' - - $ref: 'TS28532_FileDataReportingMnS.yaml#/components/schemas/FileNotificationTypes' - NotificationHeader: - type: object - properties: - href: - $ref: '#/components/schemas/Uri' - notificationId: - $ref: '#/components/schemas/NotificationId' - notificationType: - $ref: '#/components/schemas/NotificationType' - eventTime: - $ref: '#/components/schemas/DateTime' - systemDN: - $ref: '#/components/schemas/SystemDN' - required: - - href - - notificationId - - notificationType - - eventTime - - 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 - Subscription: - type: object - properties: - consumerReference: - $ref: '#/components/schemas/Uri' - timeTick: - type: integer - filter: - $ref: '#/components/schemas/Filter' - - ErrorResponseGet: - description: >- - Default schema for the response message body in case the Get - is not successful. - type: object - properties: - status: - type: string - type: - type: string - reason: - type: string - title: - type: string - badQueryParams: - type: array - items: - type: string - otherProblems: - type: array - items: - type: object - properties: - status: - type: string - type: - type: string - reason: - type: string - title: - type: string - badQueryParams: - type: array - items: - type: string - required: - - type - required: - - type - - ErrorResponseDefault: - type: object - properties: - status: - type: string - type: - type: string - reason: - type: string - title: - type: string - badAttributes: - type: array - items: - type: string - badObjects: - type: array - items: - type: string - otherProblems: - type: array - items: - type: object - properties: - status: - type: string - type: - type: string - reason: - type: string - title: - type: string - badAttributes: - type: array - items: - type: string - badObjects: - type: array - items: - type: string - required: - - type - required: - - type - - ErrorResponsePatch: - description: >- - Default schema for the response message body in case the patch - is not successful. - type: object - properties: - status: - type: string - type: - type: string - reason: - type: string - title: - type: string - badOP: - type: string - otherProblems: - type: array - items: - type: object - properties: - status: - type: string - type: - type: string - reason: - type: string - title: - type: string - badOp: - type: string - required: - - type - - badOp - required: - - type - - badOp diff --git a/OpenAPI/TS29512_Npcf_SMPolicyControl.yaml b/OpenAPI/TS29512_Npcf_SMPolicyControl.yaml deleted file mode 100644 index 0f68f95a786942e439f5a9e5f9dcc802a84f8868..0000000000000000000000000000000000000000 --- a/OpenAPI/TS29512_Npcf_SMPolicyControl.yaml +++ /dev/null @@ -1,3279 +0,0 @@ -openapi: 3.0.0 - -info: - title: Npcf_SMPolicyControl API - version: 1.3.1 - description: | - Session Management Policy Control Service - © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. - -externalDocs: - description: 3GPP TS 29.512 V18.7.0; 5G System; Session Management Policy Control Service. - url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.512/' - -security: - - {} - - oAuth2ClientCredentials: - - npcf-smpolicycontrol - -servers: - - url: '{apiRoot}/npcf-smpolicycontrol/v1' - variables: - apiRoot: - default: https://example.com - description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 - -paths: - /sm-policies: - post: - summary: Create a new Individual SM Policy. - operationId: CreateSMPolicy - tags: - - SM Policies (Collection) - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SmPolicyContextData' - responses: - '201': - description: Created - content: - application/json: - schema: - $ref: '#/components/schemas/SmPolicyDecision' - headers: - Location: - description: Contains the URI of the newly created resource. - required: true - schema: - type: string - '308': - description: Permanent Redirect - headers: - Location: - description: > - Contains the URI of the PCF within the existing PCF binding information stored in - the BSF for the same UE ID, S-NSSAI and DNN combination. - required: true - schema: - type: string - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - callbacks: - SmPolicyUpdateNotification: - '{$request.body#/notificationUri}/update': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SmPolicyNotification' - responses: - '200': - description: > - OK. The current applicable values corresponding to the policy control request - trigger is reported. - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/UeCampingRep' - - type: array - items: - $ref: '#/components/schemas/PartialSuccessReport' - minItems: 1 - - type: array - items: - $ref: '#/components/schemas/PolicyDecisionFailureCode' - minItems: 1 - '204': - description: No Content, Notification was succesfull - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - description: Bad Request. - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorReport' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - SmPolicyControlTerminationRequestNotification: - '{$request.body#/notificationUri}/terminate': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TerminationNotification' - responses: - '204': - description: No Content, Notification was successful - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - /sm-policies/{smPolicyId}: - get: - summary: Read an Individual SM Policy - operationId: GetSMPolicy - tags: - - Individual SM Policy (Document) - parameters: - - name: smPolicyId - in: path - description: Identifier of a policy association. - required: true - schema: - type: string - responses: - '200': - description: OK. Resource representation is returned. - content: - application/json: - schema: - $ref: '#/components/schemas/SmPolicyControl' - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '406': - $ref: 'TS29571_CommonData.yaml#/components/responses/406' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - /sm-policies/{smPolicyId}/update: - post: - summary: Update an existing Individual SM Policy - operationId: UpdateSMPolicy - tags: - - Individual SM Policy (Document) - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SmPolicyUpdateContextData' - parameters: - - name: smPolicyId - in: path - description: Identifier of a policy association. - required: true - schema: - type: string - responses: - '200': - description: OK. Updated policies are returned - content: - application/json: - schema: - $ref: '#/components/schemas/SmPolicyDecision' - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - /sm-policies/{smPolicyId}/delete: - post: - summary: Delete an existing Individual SM Policy. - operationId: DeleteSMPolicy - tags: - - Individual SM Policy (Document) - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SmPolicyDeleteData' - parameters: - - name: smPolicyId - in: path - description: Identifier of a policy association. - required: true - schema: - type: string - responses: - '204': - description: No content - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - -components: - securitySchemes: - oAuth2ClientCredentials: - type: oauth2 - flows: - clientCredentials: - tokenUrl: '{nrfApiRoot}/oauth2/token' - scopes: - npcf-smpolicycontrol: Access to the Npcf_SMPolicyControl API - - schemas: - SmPolicyControl: - description: > - Contains the parameters used to request the SM policies and the SM policies authorized by - the PCF. - type: object - properties: - context: - $ref: '#/components/schemas/SmPolicyContextData' - policy: - $ref: '#/components/schemas/SmPolicyDecision' - required: - - context - - policy - - SmPolicyContextData: - description: Contains the parameters used to create an Individual SM policy resource. - type: object - properties: - accNetChId: - $ref: '#/components/schemas/AccNetChId' - chargEntityAddr: - $ref: '#/components/schemas/AccNetChargingAddress' - gpsi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - supi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - invalidSupi: - type: boolean - description: > - When this attribute is included and set to true, it indicates that the supi attribute - contains an invalid value.This attribute shall be present if the SUPI is not available - in the SMF or the SUPI is unauthenticated. When present it shall be set to true for an - invalid SUPI and false (default) for a valid SUPI. - interGrpIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' - minItems: 1 - pduSessionId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' - pduSessionType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' - chargingcharacteristics: - type: string - dnn: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - dnnSelMode: - $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/DnnSelectionMode' - notificationUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' - accessType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' - ratType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' - addAccessInfo: - $ref: '#/components/schemas/AdditionalAccessInfo' - servingNetwork: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' - userLocationInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' - ueTimeZone: - $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' - pei: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' - ipv4Address: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' - ipv6AddressPrefix: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' - ipDomain: - type: string - description: Indicates the IPv4 address domain - subsSessAmbr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' - authProfIndex: - type: string - description: Indicates the DN-AAA authorization profile index - subsDefQos: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos' - vplmnQos: - $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/VplmnQos' - numOfPackFilter: - type: integer - description: Contains the number of supported packet filter for signalled QoS rules. - online: - type: boolean - description: > - If it is included and set to true, the online charging is applied to the PDU session. - offline: - type: boolean - description: > - If it is included and set to true, the offline charging is applied to the PDU session. - 3gppPsDataOffStatus: - type: boolean - description: > - If it is included and set to true, the 3GPP PS Data Off is activated by the UE. - refQosIndication: - type: boolean - description: If it is included and set to true, the reflective QoS is supported by the UE. - traceReq: - $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' - sliceInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - altSliceInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - qosFlowUsage: - $ref: '#/components/schemas/QosFlowUsage' - servNfId: - $ref: '#/components/schemas/ServingNfIdentity' - suppFeat: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - smfId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - recoveryTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - maPduInd: - $ref: '#/components/schemas/MaPduIndication' - atsssCapab: - $ref: '#/components/schemas/AtsssCapability' - ipv4FrameRouteList: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrMask' - minItems: 1 - ipv6FrameRouteList: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' - minItems: 1 - satBackhaulCategory: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' - pcfUeInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' - pvsInfo: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo' - minItems: 1 - onboardInd: - type: boolean - description: > - If it is included and set to true, it indicates that the PDU session is used for - UE Onboarding. - nwdafDatas: - type: array - items: - $ref: '#/components/schemas/NwdafData' - minItems: 1 - urspEnfInfo: - $ref: '#/components/schemas/UrspEnforcementInfo' - sscMode: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' - ueReqDnn: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - ueReqPduSessionType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' - hrsboInd: - type: boolean - description: > - HR-SBO support indication. If present and set to "true", it indicates that the HR-SBO is - supported. Default value is "false" if omitted. - uePolFailReport: - $ref: 'TS29525_Npcf_UEPolicyControl.yaml#/components/schemas/UePolicyTransferFailureCause' - required: - - supi - - pduSessionId - - pduSessionType - - dnn - - notificationUri - - sliceInfo - - SmPolicyDecision: - description: Contains the SM policies authorized by the PCF. - type: object - properties: - sessRules: - type: object - additionalProperties: - $ref: '#/components/schemas/SessionRule' - minProperties: 1 - description: > - A map of Sessionrules with the content being the SessionRule as described in - clause 5.6.2.7. The key used in this map for each entry is the sessRuleId - attribute of the corresponding SessionRule. - pccRules: - type: object - additionalProperties: - $ref: '#/components/schemas/PccRule' - minProperties: 1 - description: > - A map of PCC rules with the content being the PCCRule as described in - clause 5.6.2.6. The key used in this map for each entry is the pccRuleId - attribute of the corresponding PccRule. - nullable: true - pcscfRestIndication: - type: boolean - description: > - If it is included and set to true, it indicates the P-CSCF Restoration is requested. - qosDecs: - type: object - additionalProperties: - $ref: '#/components/schemas/QosData' - minProperties: 1 - description: > - Map of QoS data policy decisions. The key used in this map for each entry is the qosId - attribute of the corresponding QosData. - chgDecs: - type: object - additionalProperties: - $ref: '#/components/schemas/ChargingData' - minProperties: 1 - description: > - Map of Charging data policy decisions. The key used in this map for each entry - is the chgId attribute of the corresponding ChargingData. - nullable: true - chargingInfo: - $ref: '#/components/schemas/ChargingInformation' - traffContDecs: - type: object - additionalProperties: - $ref: '#/components/schemas/TrafficControlData' - minProperties: 1 - description: > - Map of Traffic Control data policy decisions. The key used in this map for each entry - is the tcId attribute of the corresponding TrafficControlData. - umDecs: - type: object - additionalProperties: - $ref: '#/components/schemas/UsageMonitoringData' - minProperties: 1 - description: > - Map of Usage Monitoring data policy decisions. The key used in this map for each entry - is the umId attribute of the corresponding UsageMonitoringData. - nullable: true - qosChars: - type: object - additionalProperties: - $ref: '#/components/schemas/QosCharacteristics' - minProperties: 1 - description: > - Map of QoS characteristics for non standard 5QIs. This map uses the 5QI values as keys. - qosMonDecs: - type: object - additionalProperties: - $ref: '#/components/schemas/QosMonitoringData' - minProperties: 1 - description: > - Map of QoS Monitoring data policy decisions. The key used in this map for each entry - is the qmId attribute of the corresponding QosMonitoringData. - nullable: true - reflectiveQoSTimer: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - conds: - type: object - additionalProperties: - $ref: '#/components/schemas/ConditionData' - minProperties: 1 - description: > - A map of condition data with the content being as described in clause 5.6.2.9. The key - used in this map for each entry is the condId attribute of the corresponding - ConditionData. - nullable: true - revalidationTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - offline: - type: boolean - description: > - Indicates the offline charging is applicable to the PDU session when it is included and - set to true. - online: - type: boolean - description: > - Indicates the online charging is applicable to the PDU session when it is included and - set to true. - offlineChOnly: - type: boolean - default: false - description: > - Indicates that the online charging method shall never be used for any PCC rule activated - during the lifetime of the PDU session. - policyCtrlReqTriggers: - type: array - items: - $ref: '#/components/schemas/PolicyControlRequestTrigger' - minItems: 1 - description: Defines the policy control request triggers subscribed by the PCF. - nullable: true - lastReqRuleData: - type: array - items: - $ref: '#/components/schemas/RequestedRuleData' - minItems: 1 - description: Defines the last list of rule control data requested by the PCF. - lastReqUsageData: - $ref: '#/components/schemas/RequestedUsageData' - praInfos: - type: object - additionalProperties: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfoRm' - minProperties: 1 - description: > - Map of PRA information. The praId attribute within the PresenceInfo data type is the key - of the map. - nullable: true - ipv4Index: - $ref: 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex' - ipv6Index: - $ref: 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex' - qosFlowUsage: - $ref: '#/components/schemas/QosFlowUsage' - relCause: - $ref: '#/components/schemas/SmPolicyAssociationReleaseCause' - suppFeat: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - tsnBridgeManCont: - $ref: '#/components/schemas/BridgeManagementContainer' - tsnPortManContDstt: - $ref: '#/components/schemas/PortManagementContainer' - tsnPortManContNwtts: - type: array - items: - $ref: '#/components/schemas/PortManagementContainer' - minItems: 1 - tscNotifUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' - tscNotifCorreId: - type: string - description: > - Correlation identifier for TSC management information notifications. - redSessIndication: - type: boolean - description: > - Indicates whether the PDU session is a redundant PDU session. If absent it means the PDU - session is not a redundant PDU session. - uePolCont: - $ref: '#/components/schemas/UePolicyContainer' - sliceUsgCtrlInfo: - $ref: '#/components/schemas/SliceUsgCtrlInfo' - vplmnOffloadInfos: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnOffloadingInfo' - minItems: 1 - description: List of VPLMN Specific offloading information. - nullable: true - vplmnDlAmbr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnDlAmbr' - - SmPolicyNotification: - description: Represents a notification on the update of the SM policies. - type: object - properties: - resourceUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' - smPolicyDecision: - $ref: '#/components/schemas/SmPolicyDecision' - - PccRule: - description: Contains a PCC rule information. - type: object - properties: - flowInfos: - type: array - items: - $ref: '#/components/schemas/FlowInformation' - minItems: 1 - description: An array of IP flow packet filter information. - appId: - type: string - description: A reference to the application detection filter configured at the UPF. - appDescriptor: - $ref: '#/components/schemas/ApplicationDescriptor' - contVer: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' - protoDescDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescription' - protoDescUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescription' - pccRuleId: - type: string - description: Univocally identifies the PCC rule within a PDU session. - precedence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - afSigProtocol: - $ref: '#/components/schemas/AfSigProtocol' - appReloc: - type: boolean - description: Indication of application relocation possibility. - easRedisInd: - type: boolean - description: Indicates the EAS rediscovery is required. - refQosData: - type: array - items: - type: string - minItems: 1 - maxItems: 1 - description: > - A reference to the QosData policy decision type. It is the qosId described in - clause 5.6.2.8. - refAltQosParams: - type: array - items: - type: string - minItems: 1 - description: > - A Reference to the QosData policy decision type for the Alternative QoS parameter sets - of the service data flow. - refTcData: - type: array - items: - type: string - minItems: 1 - maxItems: 1 - description: > - A reference to the TrafficControlData policy decision type. It is the tcId described in - clause 5.6.2.10. - refChgData: - type: array - items: - type: string - minItems: 1 - maxItems: 1 - description: > - A reference to the ChargingData policy decision type. It is the chgId described in - clause 5.6.2.11. - nullable: true - refChgN3gData: - type: array - items: - type: string - minItems: 1 - maxItems: 1 - description: > - A reference to the ChargingData policy decision type only applicable to Non-3GPP access - if "ATSSS" feature is supported. It is the chgId described in clause 5.6.2.11. - nullable: true - refUmData: - type: array - items: - type: string - minItems: 1 - maxItems: 1 - description: > - A reference to UsageMonitoringData policy decision type. It is the umId described in - clause 5.6.2.12. - nullable: true - refUmN3gData: - type: array - items: - type: string - minItems: 1 - maxItems: 1 - description: > - A reference to UsageMonitoringData policy decision type only applicable to Non-3GPP - access if "ATSSS" feature is supported. It is the umId described in clause 5.6.2.12. - nullable: true - refCondData: - type: string - description: > - A reference to the condition data. It is the condId described in clause 5.6.2.9. - nullable: true - refQosMon: - type: array - items: - type: string - minItems: 1 - description: > - A reference to the QosMonitoringData policy decision type. It is the qmId described in - clause 5.6.2.40. - nullable: true - addrPreserInd: - type: boolean - nullable: true - tscaiInputDl: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' - tscaiInputUl: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' - tscaiTimeDom: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - capBatAdaptation: - type: boolean - description: > - Indicates the capability for AF to adjust the burst sending time, when it is provided - and set to "true". The default value is "false" if omitted. - ddNotifCtrl: - $ref: '#/components/schemas/DownlinkDataNotificationControl' - ddNotifCtrl2: - $ref: '#/components/schemas/DownlinkDataNotificationControlRm' - disUeNotif: - type: boolean - nullable: true - packFiltAllPrec: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - nscSuppFeats: - type: object - additionalProperties: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - minProperties: 1 - description: > - Identifies a list of Network Function Service Consumer supported per service. The key - used in this map for each entry is the ServiceName value as defined in - 3GPP TS 29.510[29]. - callInfo: - $ref: '#/components/schemas/CallInfo' - traffParaData: - $ref: '#/components/schemas/TrafficParaData' - required: - - pccRuleId - nullable: true - - SessionRule: - description: Contains session level policy information. - type: object - properties: - authSessAmbr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' - authDefQos: - $ref: '#/components/schemas/AuthorizedDefaultQos' - sessRuleId: - type: string - description: Univocally identifies the session rule within a PDU session. - refUmData: - type: string - description: > - A reference to UsageMonitoringData policy decision type. It is the umId described in - clause 5.6.2.12. - nullable: true - refUmN3gData: - type: string - description: > - A reference to UsageMonitoringData policy decision type to apply for Non-3GPP access. It - is the umId described in clause 5.6.2.12. - nullable: true - refCondData: - type: string - description: > - A reference to the condition data. It is the condId described in clause 5.6.2.9. - nullable: true - required: - - sessRuleId - nullable: true - - QosData: - description: Contains the QoS parameters. - type: object - properties: - qosId: - type: string - description: Univocally identifies the QoS control policy data within a PDU session. - 5qi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' - maxbrUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' - maxbrDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' - gbrUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' - gbrDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' - arp: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' - qnc: - type: boolean - description: > - Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer - (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow. - priorityLevel: - $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevelRm' - averWindow: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' - maxDataBurstVol: - $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVolRm' - reflectiveQos: - type: boolean - description: > - Indicates whether the QoS information is reflective for the corresponding service data - flow. - sharingKeyDl: - type: string - description: > - Indicates, by containing the same value, what PCC rules may share resource in downlink - direction. - sharingKeyUl: - type: string - description: > - Indicates, by containing the same value, what PCC rules may share resource in uplink - direction. - maxPacketLossRateDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' - maxPacketLossRateUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' - defQosFlowIndication: - type: boolean - description: > - Indicates that the dynamic PCC rule shall always have its binding with the QoS Flow - associated with the default QoS rule - extMaxDataBurstVol: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' - packetDelayBudget: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' - packetErrorRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' - pduSetQosDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm' - pduSetQosUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm' - required: - - qosId - nullable: true - - ConditionData: - description: Contains conditions of applicability for a rule. - type: object - properties: - condId: - type: string - description: Uniquely identifies the condition data within a PDU session. - activationTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' - deactivationTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' - accessType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' - ratType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' - required: - - condId - nullable: true - - TrafficControlData: - description: > - Contains parameters determining how flows associated with a PCC Rule are treated (e.g. - blocked, redirected, etc). - type: object - properties: - tcId: - type: string - description: Univocally identifies the traffic control policy data within a PDU session. - l4sInd: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/UplinkDownlinkSupport' - flowStatus: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus' - redirectInfo: - $ref: '#/components/schemas/RedirectInformation' - addRedirectInfo: - type: array - items: - $ref: '#/components/schemas/RedirectInformation' - minItems: 1 - muteNotif: - type: boolean - description: Indicates whether applicat'on's start or stop notification is to be muted. - trafficSteeringPolIdDl: - type: string - description: > - Reference to a pre-configured traffic steering policy for downlink traffic at the SMF. - nullable: true - trafficSteeringPolIdUl: - type: string - description: > - Reference to a pre-configured traffic steering policy for uplink traffic at the SMF. - nullable: true - metadata: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Metadata' - routeToLocs: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' - minItems: 1 - description: A list of location which the traffic shall be routed to for the AF request - nullable: true - maxAllowedUpLat: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' - easIpReplaceInfos: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/EasIpReplacementInfo' - minItems: 1 - description: Contains EAS IP replacement information. - nullable: true - traffCorreInd: - type: boolean - tfcCorreInfo: - $ref: 'TS29519_Application_Data.yaml#/components/schemas/TrafficCorrelationInfo' - simConnInd: - type: boolean - description: > - Indicates whether simultaneous connectivity should be temporarily maintained for the - source and target PSA. - simConnTerm: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - upPathChgEvent: - $ref: '#/components/schemas/UpPathChgEvent' - steerFun: - $ref: '#/components/schemas/SteeringFunctionality' - transMode: - $ref: '#/components/schemas/TransportMode' - steerModeDl: - $ref: '#/components/schemas/SteeringMode' - steerModeUl: - $ref: '#/components/schemas/SteeringMode' - mulAccCtrl: - $ref: '#/components/schemas/MulticastAccessControl' - candDnaiInd: - type: boolean - description: > - Indication of reporting candidate DNAI(s). If it is included and set to "true", the - candidate DNAI(s) for the PDU session need to be reported. Otherwise set to "false" or - omitted. - datEndMarkInd: - type: boolean - description: > - The data burst end marking is enabled if it is set to "true". Default value is "false" if - omitted. - required: - - tcId - nullable: true - - ChargingData: - description: Contains charging related parameters. - type: object - properties: - chgId: - type: string - description: Univocally identifies the charging control policy data within a PDU session. - meteringMethod: - $ref: '#/components/schemas/MeteringMethod' - offline: - type: boolean - description: > - Indicates the offline charging is applicable to the PCC rule when it is included and set - to true. - online: - type: boolean - description: > - Indicates the online charging is applicable to the PCC rule when it is included and set - to true. - sdfHandl: - type: boolean - description: > - Indicates whether the service data flow is allowed to start while the SMF is waiting for - the response to the credit request. - ratingGroup: - $ref: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup' - reportingLevel: - $ref: '#/components/schemas/ReportingLevel' - serviceId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceId' - sponsorId: - type: string - description: Indicates the sponsor identity. - appSvcProvId: - type: string - description: Indicates the application service provider identity. - afChargingIdentifier: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' - afChargId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationChargingId' - required: - - chgId - nullable: true - - UsageMonitoringData: - description: Contains usage monitoring related control information. - type: object - properties: - umId: - type: string - description: Univocally identifies the usage monitoring policy data within a PDU session. - volumeThreshold: - $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' - volumeThresholdUplink: - $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' - volumeThresholdDownlink: - $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' - timeThreshold: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' - monitoringTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' - nextVolThreshold: - $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' - nextVolThresholdUplink: - $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' - nextVolThresholdDownlink: - $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' - nextTimeThreshold: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' - inactivityTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' - exUsagePccRuleIds: - type: array - items: - type: string - minItems: 1 - description: > - Contains the PCC rule identifier(s) which corresponding service data flow(s) shall be - excluded from PDU Session usage monitoring. It is only included in the - UsageMonitoringData instance for session level usage monitoring. - nullable: true - required: - - umId - nullable: true - - RedirectInformation: - description: Contains the redirect information. - type: object - properties: - redirectEnabled: - type: boolean - description: Indicates the redirect is enable. - redirectAddressType: - $ref: '#/components/schemas/RedirectAddressType' - redirectServerAddress: - type: string - description: > - Indicates the address of the redirect server. If "redirectAddressType" attribute - indicates the IPV4_ADDR, the encoding is the same as the Ipv4Addr data type defined in - 3GPP TS 29.571.If "redirectAddressType" attribute indicates the IPV6_ADDR, the encoding - is the same as the Ipv6Addr data type defined in 3GPP TS 29.571.If "redirectAddressType" - attribute indicates the URL or SIP_URI, the encoding is the same as the Uri data type - defined in 3GPP TS 29.571. - - FlowInformation: - description: Contains the flow information. - type: object - properties: - flowDescription: - $ref: '#/components/schemas/FlowDescription' - ethFlowDescription: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' - packFiltId: - type: string - description: An identifier of packet filter. - packetFilterUsage: - type: boolean - description: The packet shall be sent to the UE. - tosTrafficClass: - type: string - description: > - Contains the Ipv4 Type-of-Service and mask field or the Ipv6 Traffic-Class field and - mask field. - nullable: true - spi: - type: string - description: the security parameter index of the IPSec packet. - nullable: true - flowLabel: - type: string - description: the Ipv6 flow label header field. - nullable: true - flowDirection: - $ref: '#/components/schemas/FlowDirectionRm' - - SmPolicyDeleteData: - description: > - Contains the parameters to be sent to the PCF when an individual SM policy is deleted. - type: object - properties: - userLocationInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' - ueTimeZone: - $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' - servingNetwork: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' - userLocationInfoTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - ranNasRelCauses: - type: array - items: - $ref: '#/components/schemas/RanNasRelCause' - minItems: 1 - description: Contains the RAN and/or NAS release cause. - accuUsageReports: - type: array - items: - $ref: '#/components/schemas/AccuUsageReport' - minItems: 1 - description: Contains the usage report - pduSessRelCause: - $ref: '#/components/schemas/PduSessionRelCause' - - QosCharacteristics: - description: Contains QoS characteristics for a non-standardized or a non-configured 5QI. - type: object - properties: - 5qi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' - resourceType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/QosResourceType' - priorityLevel: - $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel' - packetDelayBudget: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' - packetErrorRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' - averagingWindow: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' - maxDataBurstVol: - $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVol' - extMaxDataBurstVol: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol' - required: - - 5qi - - resourceType - - priorityLevel - - packetDelayBudget - - packetErrorRate - - ChargingInformation: - description: Contains the addresses of the charging functions. - type: object - properties: - primaryChfAddress: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' - secondaryChfAddress: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' - primaryChfSetId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' - primaryChfInstanceId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - secondaryChfSetId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' - secondaryChfInstanceId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - required: - - primaryChfAddress - - AccuUsageReport: - description: Contains the accumulated usage report information. - type: object - properties: - refUmIds: - type: string - description: > - An id referencing UsageMonitoringData objects associated with this usage report. - volUsage: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - volUsageUplink: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - volUsageDownlink: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - timeUsage: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - nextVolUsage: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - nextVolUsageUplink: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - nextVolUsageDownlink: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - nextTimeUsage: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - required: - - refUmIds - - SmPolicyUpdateContextData: - description: > - Contains the policy control request trigger(s) that were met and the corresponding new - value(s) or the error report of the policy enforcement. - type: object - properties: - repPolicyCtrlReqTriggers: - type: array - items: - $ref: '#/components/schemas/PolicyControlRequestTrigger' - minItems: 1 - description: The policy control reqeust trigges which are met. - accNetChIds: - type: array - items: - $ref: '#/components/schemas/AccNetChId' - minItems: 1 - description: > - Indicates the access network charging identifier for the PCC rule(s) or whole PDU - session. - accessType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' - ratType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' - addAccessInfo: - $ref: '#/components/schemas/AdditionalAccessInfo' - relAccessInfo: - $ref: '#/components/schemas/AdditionalAccessInfo' - servingNetwork: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' - userLocationInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' - ueTimeZone: - $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' - relIpv4Address: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' - ipv4Address: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' - ipDomain: - type: string - description: Indicates the IPv4 address domain - ipv6AddressPrefix: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' - relIpv6AddressPrefix: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' - addIpv6AddrPrefixes: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' - addRelIpv6AddrPrefixes: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' - multiIpv6Prefixes: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' - minItems: 1 - description: The multiple allocated IPv6 prefixes of the served UE. - multiRelIpv6Prefixes: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' - minItems: 1 - description: The multiple released IPv6 prefixes of the served UE. - relUeMac: - $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' - ueMac: - $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' - subsSessAmbr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' - authProfIndex: - type: string - description: Indicates the DN-AAA authorization profile index - subsDefQos: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos' - vplmnQos: - $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/VplmnQos' - vplmnQosNotApp: - type: boolean - description: > - If it is included and set to true, indicates that the QoS constraints in the VPLMN are - not applicable. - numOfPackFilter: - type: integer - description: Contains the number of supported packet filter for signalled QoS rules. - accuUsageReports: - type: array - items: - $ref: '#/components/schemas/AccuUsageReport' - minItems: 1 - description: Contains the usage report - 3gppPsDataOffStatus: - type: boolean - description: > - If it is included and set to true, the 3GPP PS Data Off is activated by the UE. - appDetectionInfos: - type: array - items: - $ref: '#/components/schemas/AppDetectionInfo' - minItems: 1 - description: > - Report the start/stop of the application traffic and detected SDF descriptions - if applicable. - ruleReports: - type: array - items: - $ref: '#/components/schemas/RuleReport' - minItems: 1 - description: Used to report the PCC rule failure. - sessRuleReports: - type: array - items: - $ref: '#/components/schemas/SessionRuleReport' - minItems: 1 - description: Used to report the session rule failure. - qncReports: - type: array - items: - $ref: '#/components/schemas/QosNotificationControlInfo' - minItems: 1 - description: QoS Notification Control information. - qosMonReports: - type: array - items: - $ref: '#/components/schemas/QosMonitoringReport' - minItems: 1 - description: QoS Monitoring reporting information. - qosMonDatRateReps: - type: array - items: - $ref: '#/components/schemas/QosMonitoringReport' - minItems: 1 - qosMonCongReps: - type: array - items: - $ref: '#/components/schemas/QosMonitoringReport' - minItems: 1 - userLocationInfoTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - repPraInfos: - type: object - additionalProperties: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' - minProperties: 1 - description: > - Reports the changes of presence reporting area. The praId attribute within the - PresenceInfo data type is the key of the map. - ueInitResReq: - $ref: '#/components/schemas/UeInitiatedResourceRequest' - refQosIndication: - type: boolean - description: > - If it is included and set to true, the reflective QoS is supported by the UE. If it is - included and set to false, the reflective QoS is revoked by the UE. - qosFlowUsage: - $ref: '#/components/schemas/QosFlowUsage' - creditManageStatus: - $ref: '#/components/schemas/CreditManagementStatus' - servNfId: - $ref: '#/components/schemas/ServingNfIdentity' - traceReq: - $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' - maPduInd: - $ref: '#/components/schemas/MaPduIndication' - atsssCapab: - $ref: '#/components/schemas/AtsssCapability' - tsnBridgeInfo: - $ref: '#/components/schemas/TsnBridgeInfo' - tsnBridgeManCont: - $ref: '#/components/schemas/BridgeManagementContainer' - tsnPortManContDstt: - $ref: '#/components/schemas/PortManagementContainer' - tsnPortManContNwtts: - type: array - items: - $ref: '#/components/schemas/PortManagementContainer' - minItems: 1 - tscNotifUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' - tscNotifCorreId: - type: string - description: > - Correlation identifier for TSC management information notifications. - mulAddrInfos: - type: array - items: - $ref: '#/components/schemas/IpMulticastAddressInfo' - minItems: 1 - policyDecFailureReports: - type: array - items: - $ref: '#/components/schemas/PolicyDecisionFailureCode' - minItems: 1 - description: Contains the type(s) of failed policy decision and/or condition data. - invalidPolicyDecs: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/InvalidParam' - minItems: 1 - description: > - Indicates the invalid parameters for the reported type(s) of the failed policy decision - and/or condition data. - trafficDescriptors: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' - minItems: 1 - pccRuleId: - type: string - description: > - Contains the identifier of the PCC rule which is used for traffic detection of event. - typesOfNotif: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' - minItems: 1 - interGrpIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' - minItems: 1 - satBackhaulCategory: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' - pcfUeInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' - nwdafDatas: - type: array - items: - $ref: '#/components/schemas/NwdafData' - minItems: 1 - nullable: true - anGwStatus: - type: boolean - description: > - When it is included and set to true, it indicates that the AN-Gateway has failed and - that the PCF should refrain from sending policy decisions to the SMF until it is - informed that the AN-Gateway has been recovered. - uePolCont: - $ref: '#/components/schemas/UePolicyContainer' - uePolFailReport: - $ref: 'TS29525_Npcf_UEPolicyControl.yaml#/components/schemas/UePolicyTransferFailureCause' - urspEnfInfo: - $ref: '#/components/schemas/UrspEnforcementInfo' - sscMode: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' - ueReqDnn: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - ueReqPduSessionType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' - l4sReports: - type: array - items: - $ref: '#/components/schemas/L4sSupportInfo' - minItems: 1 - description: ECN marking for L4S support availability in 5GS. - altSliceInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - batOffsetInfo: - $ref: '#/components/schemas/BatOffsetInfoPcc' - hrsboInd: - type: boolean - description: > - HR-SBO support indication. If present and set to "true", it indicates that the HR-SBO is - supported. If present and set to "false", it indicates that the HR-SBO is not supported. - ueReachStatus: - $ref: '#/components/schemas/UeReachabilityStatus' - retryAfter: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - allOf: - - not: - required: [multiIpv6Prefixes, ipv6AddressPrefix] - - not: - required: [multiIpv6Prefixes, addIpv6AddrPrefixes] - - not: - required: [multiRelIpv6Prefixes, relIpv6AddressPrefix] - - not: - required: [multiRelIpv6Prefixes, relAddIpv6AddrPrefixes] - - UpPathChgEvent: - description: Contains the UP path change event subscription from the AF. - type: object - properties: - notificationUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' - notifCorreId: - type: string - description: > - It is used to set the value of Notification Correlation ID in the notification sent by - the SMF. - dnaiChgType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' - afAckInd: - type: boolean - required: - - notificationUri - - notifCorreId - - dnaiChgType - nullable: true - - TerminationNotification: - description: Represents a Termination Notification. - type: object - properties: - resourceUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' - cause: - $ref: '#/components/schemas/SmPolicyAssociationReleaseCause' - required: - - resourceUri - - cause - - AppDetectionInfo: - description: Contains the detected application's traffic information. - type: object - properties: - appId: - type: string - description: A reference to the application detection filter configured at the UPF - instanceId: - type: string - description: > - Identifier sent by the SMF in order to allow correlation of application Start and Stop - events to the specific service data flow description, if service data flow descriptions - are deducible. - sdfDescriptions: - type: array - items: - $ref: '#/components/schemas/FlowInformation' - minItems: 1 - description: Contains the detected service data flow descriptions if they are deducible. - required: - - appId - - AccNetChId: - description: > - Contains the access network charging identifier for the PCC rule(s) or for the whole - PDU session. - type: object - properties: - accNetChaIdValue: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' - accNetChargId: - type: string - description: A character string containing the access network charging id. - refPccRuleIds: - type: array - items: - type: string - minItems: 1 - description: > - Contains the identifier of the PCC rule(s) associated to the provided Access Network - Charging Identifier. - sessionChScope: - type: boolean - description: > - When it is included and set to true, indicates the Access Network Charging Identifier - applies to the whole PDU Session - oneOf: - - required: [accNetChaIdValue] - - required: [accNetChargId] - - AccNetChargingAddress: - description: Describes the network entity within the access network performing charging - type: object - anyOf: - - required: [anChargIpv4Addr] - - required: [anChargIpv6Addr] - properties: - anChargIpv4Addr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' - anChargIpv6Addr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' - - RequestedRuleData: - description: > - Contains rule data requested by the PCF to receive information associated with PCC rule(s). - type: object - properties: - refPccRuleIds: - type: array - items: - type: string - minItems: 1 - description: > - An array of PCC rule id references to the PCC rules associated with the control data. - reqData: - type: array - items: - $ref: '#/components/schemas/RequestedRuleDataType' - minItems: 1 - description: > - Array of requested rule data type elements indicating what type of rule data is - requested for the corresponding referenced PCC rules. - required: - - refPccRuleIds - - reqData - - RequestedUsageData: - description: > - Contains usage data requested by the PCF requesting usage reports for the corresponding - usage monitoring data instances. - type: object - properties: - refUmIds: - type: array - items: - type: string - minItems: 1 - description: > - An array of usage monitoring data id references to the usage monitoring data instances - for which the PCF is requesting a usage report. This attribute shall only be provided - when allUmIds is not set to true. - allUmIds: - type: boolean - description: > - This boolean indicates whether requested usage data applies to all usage monitoring data - instances. When it's not included, it means requested usage data shall only apply to the - usage monitoring data instances referenced by the refUmIds attribute. - - UeCampingRep: - description: > - Contains the current applicable values corresponding to the policy control request triggers. - type: object - properties: - accessType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' - ratType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' - servNfId: - $ref: '#/components/schemas/ServingNfIdentity' - servingNetwork: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' - userLocationInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' - ueTimeZone: - $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' - netLocAccSupp: - $ref: '#/components/schemas/NetLocAccessSupport' - satBackhaulCategory: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' - urspEnfInfo: - $ref: '#/components/schemas/UrspEnforcementInfo' - sscMode: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' - ueReqDnn: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - ueReqPduSessionType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' - - RuleReport: - description: Reports the status of PCC. - type: object - properties: - pccRuleIds: - type: array - items: - type: string - minItems: 1 - description: Contains the identifier of the affected PCC rule(s). - ruleStatus: - $ref: '#/components/schemas/RuleStatus' - contVers: - type: array - items: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' - minItems: 1 - description: Indicates the version of a PCC rule. - failureCode: - $ref: '#/components/schemas/FailureCode' - retryAfter: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - finUnitAct: - $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/FinalUnitAction' - ranNasRelCauses: - type: array - items: - $ref: '#/components/schemas/RanNasRelCause' - minItems: 1 - description: indicates the RAN or NAS release cause code information. - altQosParamId: - type: string - description: > - Indicates the alternative QoS parameter set that the NG-RAN can guarantee. It is - included during the report of successfull resource allocation and indicates that NG-RAN - used an alternative QoS profile because the requested QoS could not be allocated.. - required: - - pccRuleIds - - ruleStatus - - RanNasRelCause: - description: Contains the RAN/NAS release cause. - type: object - properties: - ngApCause: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' - 5gMmCause: - $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' - 5gSmCause: - $ref: '#/components/schemas/5GSmCause' - epsCause: - $ref: '#/components/schemas/EpsRanNasRelCause' - - UeInitiatedResourceRequest: - description: Indicates that a UE requests specific QoS handling for the selected SDF. - type: object - properties: - pccRuleId: - type: string - ruleOp: - $ref: '#/components/schemas/RuleOperation' - precedence: - type: integer - packFiltInfo: - type: array - items: - $ref: '#/components/schemas/PacketFilterInfo' - minItems: 1 - reqQos: - $ref: '#/components/schemas/RequestedQos' - required: - - ruleOp - - packFiltInfo - - PacketFilterInfo: - description: > - Contains the information from a single packet filter sent from the SMF to the PCF. - type: object - properties: - packFiltId: - type: string - description: An identifier of packet filter. - packFiltCont: - $ref: '#/components/schemas/PacketFilterContent' - tosTrafficClass: - type: string - description: > - Contains the Ipv4 Type-of-Service and mask field or the Ipv6 Traffic-Class field and - mask field. - spi: - type: string - description: The security parameter index of the IPSec packet. - flowLabel: - type: string - description: The Ipv6 flow label header field. - flowDirection: - $ref: '#/components/schemas/FlowDirection' - - RequestedQos: - description: Contains the QoS information requested by the UE. - type: object - properties: - 5qi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' - gbrUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - gbrDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - required: - - 5qi - - QosNotificationControlInfo: - description: Contains the QoS Notification Control Information. - type: object - properties: - refPccRuleIds: - type: array - items: - type: string - minItems: 1 - description: > - An array of PCC rule id references to the PCC rules associated with the QoS notification - control info. - notifType: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosNotifType' - contVer: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' - altQosParamId: - type: string - description: > - Indicates the alternative QoS parameter set the NG-RAN can guarantee. When it is omitted - and the notifType attribute is set to NOT_GUAARANTEED it indicates that the lowest - priority alternative QoS profile could not be fulfilled. - altQosNotSuppInd: - type: boolean - description: > - When present and set to true it indicates that the Alternative QoS profiles are not - supported by NG-RAN. - required: - - refPccRuleIds - - notifType - - PartialSuccessReport: - description: > - Includes the information reported by the SMF when some of the PCC rules and/or session rules - and/or policy decision and/or condition data are not successfully installed/activated or - stored. - type: object - properties: - failureCause: - $ref: '#/components/schemas/FailureCause' - ruleReports: - type: array - items: - $ref: '#/components/schemas/RuleReport' - minItems: 1 - description: > - Information about the PCC rules provisioned by the PCF not successfully - installed/activated. - sessRuleReports: - type: array - items: - $ref: '#/components/schemas/SessionRuleReport' - minItems: 1 - description: > - Information about the session rules provisioned by the PCF not successfully installed. - ueCampingRep: - $ref: '#/components/schemas/UeCampingRep' - policyDecFailureReports: - type: array - items: - $ref: '#/components/schemas/PolicyDecisionFailureCode' - minItems: 1 - description: Contains the type(s) of failed policy decision and/or condition data. - invalidPolicyDecs: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/InvalidParam' - minItems: 1 - description: > - Indicates the invalid parameters for the reported type(s) of the failed policy decision - and/or condition data. - required: - - failureCause - - AuthorizedDefaultQos: - description: Represents the Authorized Default QoS. - type: object - properties: - 5qi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' - arp: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' - priorityLevel: - $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevelRm' - averWindow: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' - maxDataBurstVol: - $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVolRm' - maxbrUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' - maxbrDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' - gbrUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' - gbrDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' - extMaxDataBurstVol: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' - - ErrorReport: - description: Contains the rule,policy decision and/or condition data error reports. - type: object - properties: - error: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' - ruleReports: - type: array - items: - $ref: '#/components/schemas/RuleReport' - minItems: 1 - description: Used to report the PCC rule failure. - sessRuleReports: - type: array - items: - $ref: '#/components/schemas/SessionRuleReport' - minItems: 1 - description: Used to report the session rule failure. - polDecFailureReports: - type: array - items: - $ref: '#/components/schemas/PolicyDecisionFailureCode' - minItems: 1 - description: Used to report failure of the policy decision and/or condition data. - invalidPolicyDecs: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/InvalidParam' - minItems: 1 - description: > - Indicates the invalid parameters for the reported type(s) of the failed policy decision - and/or condition data. - - SessionRuleReport: - description: Represents reporting of the status of a session rule. - type: object - properties: - ruleIds: - type: array - items: - type: string - minItems: 1 - description: Contains the identifier of the affected session rule(s). - ruleStatus: - $ref: '#/components/schemas/RuleStatus' - sessRuleFailureCode: - $ref: '#/components/schemas/SessionRuleFailureCode' - policyDecFailureReports: - type: array - items: - $ref: '#/components/schemas/PolicyDecisionFailureCode' - minItems: 1 - description: Contains the type(s) of failed policy decision and/or condition data. - required: - - ruleIds - - ruleStatus - - ServingNfIdentity: - description: Contains the serving Network Function identity. - type: object - properties: - servNfInstId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - guami: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' - anGwAddr: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AnGwAddress' - sgsnAddr: - $ref: '#/components/schemas/SgsnAddress' - - SteeringMode: - description: Contains the steering mode value and parameters determined by the PCF. - type: object - properties: - steerModeValue: - $ref: '#/components/schemas/SteerModeValue' - active: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' - standby: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessTypeRm' - 3gLoad: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - prioAcc: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' - thresValue: - $ref: '#/components/schemas/ThresholdValue' - steerModeInd: - $ref: '#/components/schemas/SteerModeIndicator' - primary: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessTypeRm' - - required: - - steerModeValue - - AdditionalAccessInfo: - description: > - Indicates the combination of additional Access Type and RAT Type for a MA PDU session. - type: object - properties: - accessType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' - ratType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' - required: - - accessType - - QosMonitoringData: - description: Contains QoS monitoring related control information. - type: object - properties: - qmId: - type: string - description: Univocally identifies the QoS monitoring policy data within a PDU session. - qosMonParamType: - $ref: '#/components/schemas/QosMonitoringParamType' - reqQosMonParams: - type: array - items: - $ref: '#/components/schemas/RequestedQosMonitoringParameter' - minItems: 1 - description: > - Indicates the QoS information to be monitored when the QoS Monitoring is enabled for - the service data flow. - repFreqs: - type: array - items: - $ref: '#/components/schemas/ReportingFrequency' - minItems: 1 - description: > - Indicates the frequency for the reporting, such as event triggered and/or periodic. - repThreshDl: - type: integer - description: Indicates the period of time in units of miliiseconds for DL packet delay. - nullable: true - repThreshUl: - type: integer - description: Indicates the period of time in units of miliiseconds for UL packet delay. - nullable: true - repThreshRp: - type: integer - description: > - Indicates the period of time in units of miliiseconds for round trip packet delay. - nullable: true - conThreshDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' - conThreshUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' - waitTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' - repPeriod: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' - notifyUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UriRm' - notifyCorreId: - type: string - nullable: true - directNotifInd: - type: boolean - description: > - Indicates that the direct event notification sent by UPF to the Local NEF or AF is - requested if it is included and set to true. - avrgWndw: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' - repThreshDatRateUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' - repThreshDatRateDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' - dataCollAppId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - required: - - qmId - - reqQosMonParams - - repFreqs - nullable: true - - QosMonitoringReport: - description: Contains reporting information on QoS monitoring. - type: object - properties: - refPccRuleIds: - type: array - items: - type: string - minItems: 1 - description: > - An array of PCC rule id references to the PCC rules associated with the QoS monitoring - report. - ulDelays: - type: array - items: - type: integer - minItems: 1 - dlDelays: - type: array - items: - type: integer - minItems: 1 - rtDelays: - type: array - items: - type: integer - minItems: 1 - pdmf: - type: boolean - description: Represents the packet delay measurement failure indicator. - ulDataRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - dlDataRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - ulCongInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - dlCongInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - required: - - refPccRuleIds -# - TsnBridgeInfo: - description: Contains parameters that describe and identify the TSC user plane node. - type: object - properties: - bridgeId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' - dsttAddr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' - dsttPortNum: - $ref: '#/components/schemas/TsnPortNumber' - dsttResidTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - mtuIpv4: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' - mtuIpv6: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' -# - PortManagementContainer: - description: Contains the port management information container for a port. - type: object - properties: - portManCont: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' - portNum: - $ref: '#/components/schemas/TsnPortNumber' - required: - - portManCont - - portNum - BridgeManagementContainer: - description: Contains the UMIC. - type: object - properties: - bridgeManCont: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' - required: - - bridgeManCont - IpMulticastAddressInfo: - description: Contains the IP multicast addressing information. - type: object - properties: - srcIpv4Addr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' - ipv4MulAddr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' - srcIpv6Addr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' - ipv6MulAddr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' - - DownlinkDataNotificationControl: - description: Contains the downlink data notification control information. - type: object - properties: - notifCtrlInds: - type: array - items: - $ref: '#/components/schemas/NotificationControlIndication' - minItems: 1 - typesOfNotif: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' - minItems: 1 - - DownlinkDataNotificationControlRm: - description: > - This data type is defined in the same way as the DownlinkDataNotificationControl data type, - but with the nullable:true property. - type: object - properties: - notifCtrlInds: - type: array - items: - $ref: '#/components/schemas/NotificationControlIndication' - minItems: 1 - nullable: true - typesOfNotif: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' - minItems: 1 - nullable: true - nullable: true - - ThresholdValue: - description: Indicates the threshold value(s) for RTT and/or Packet Loss Rate. - type: object - properties: - rttThres: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' - plrThres: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' - nullable: true - - NwdafData: - description: > - Indicates the list of Analytic ID(s) per NWDAF instance ID used for the PDU Session consumed - by the SMF. - type: object - properties: - nwdafInstanceId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - nwdafEvents: - type: array - items: - $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' - minItems: 1 - required: - - nwdafInstanceId - - CallInfo: - description: Identifies the caller and callee information. - type: object - properties: - callingPartyAddrs: - type: array - items: - type: string - minItems: 1 - calleeInfo: - $ref: '#/components/schemas/CalleeInfo' - nullable: true - - CalleeInfo: - description: Identifies the callee information. - type: object - properties: - calledPartyAddr: - type: string - requestPartyAddrs: - type: array - items: - type: string - minItems: 1 - calledAssertIds: - type: array - items: - type: string - minItems: 1 - nullable: true - -# - TrafficParaData: - description: Contains Traffic Parameter(s) related control information. - type: object - properties: - periodUl: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSecRm' - periodDl: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSecRm' - reqTrafficParas: - type: array - items: - $ref: '#/components/schemas/TrafficParameterMeas' - minItems: 1 - description: Indicates the traffic parameters to be measured. - repFreqs: - type: array - items: - $ref: '#/components/schemas/ReportingFrequency' - minItems: 1 - description: Represents the notification method (periodic or on event detection). - dlN6JitterThr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - repPeriod: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' - - L4sSupportInfo: - description: Contains the ECN marking for L4S support in 5GS information. - type: object - properties: - refPccRuleIds: - type: array - items: - type: string - minItems: 1 - description: > - An array of PCC rule id references to the PCC rules associated with the ECN marking - for L4S support info. - notifType: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/L4sNotifType' - required: - - refPccRuleIds - - notifType - - SliceUsgCtrlInfo: - description: Represents network slice usage control information. - type: object - properties: - pduSessInactivTimer: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' - anyOf: - - required: [pduSessInactivTimer] - - BatOffsetInfoPcc: - description: > - Indicates the offset of the BAT and the optionally adjusted periodicity. - type: object - required: - - ranBatOffsetNotif - - refPccRuleIds - properties: - ranBatOffsetNotif: - type: integer - description: > - Indicates the BAT offset of the arrival time of the data burst in units - of milliseconds. - adjPeriod: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - refPccRuleIds: - type: array - items: - type: string - minItems: 1 - description: > - Identification of the PCC rules associated with the BAT offset and the optionally - adjusted periodicity. - - 5GSmCause: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - EpsRanNasRelCause: - type: string - description: Defines the EPS RAN/NAS release cause. - PacketFilterContent: - type: string - description: Defines a packet filter for an IP flow. - FlowDescription: - type: string - description: Defines a packet filter for an IP flow. - TsnPortNumber: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - ApplicationDescriptor: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' - UePolicyContainer: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' - UrspEnforcementInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' - - FlowDirection: - anyOf: - - type: string - enum: - - DOWNLINK - - UPLINK - - BIDIRECTIONAL - - UNSPECIFIED - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates the direction of the service data flow. - Possible values are: - - DOWNLINK: The corresponding filter applies for traffic to the UE. - - UPLINK: The corresponding filter applies for traffic from the UE. - - BIDIRECTIONAL: The corresponding filter applies for traffic both to and from the UE. - - UNSPECIFIED: The corresponding filter applies for traffic to the UE (downlink), but has no - specific direction declared. The service data flow detection shall apply the filter for - uplink traffic as if the filter was bidirectional. The PCF shall not use the value - UNSPECIFIED in filters created by the network in NW-initiated procedures. The PCF shall only - include the value UNSPECIFIED in filters in UE-initiated procedures if the same value is - received from the SMF. - - FlowDirectionRm: - description: > - This data type is defined in the same way as the "FlowDirection" data type, with the only - difference that it allows null value. - anyOf: - - $ref: '#/components/schemas/FlowDirection' - - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' - - ReportingLevel: - anyOf: - - type: string - enum: - - SER_ID_LEVEL - - RAT_GR_LEVEL - - SPON_CON_LEVEL - - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates the reporting level. - Possible values are: - - SER_ID_LEVEL: Indicates that the usage shall be reported on service id and rating group - combination level. - - RAT_GR_LEVEL: Indicates that the usage shall be reported on rating group level. - - SPON_CON_LEVEL: Indicates that the usage shall be reported on sponsor identity and rating - group combination level. - - MeteringMethod: - anyOf: - - type: string - enum: - - DURATION - - VOLUME - - DURATION_VOLUME - - EVENT - - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates the metering method. - Possible values are: - - DURATION: Indicates that the duration of the service data flow traffic shall be metered. - - VOLUME: Indicates that volume of the service data flow traffic shall be metered. - - DURATION_VOLUME: Indicates that the duration and the volume of the service data flow - traffic shall be metered. - - EVENT: Indicates that events of the service data flow traffic shall be metered. - - PolicyControlRequestTrigger: - anyOf: - - type: string - enum: - - PLMN_CH - - RES_MO_RE - - AC_TY_CH - - UE_IP_CH - - UE_MAC_CH - - AN_CH_COR - - US_RE - - APP_STA - - APP_STO - - AN_INFO - - CM_SES_FAIL - - PS_DA_OFF - - DEF_QOS_CH - - SE_AMBR_CH - - QOS_NOTIF - - NO_CREDIT - - REALLO_OF_CREDIT - - PRA_CH - - SAREA_CH - - SCNN_CH - - RE_TIMEOUT - - RES_RELEASE - - SUCC_RES_ALLO - - RAI_CH - - RAT_TY_CH - - REF_QOS_IND_CH - - NUM_OF_PACKET_FILTER - - UE_STATUS_RESUME - - UE_TZ_CH - - AUTH_PROF_CH - - QOS_MONITORING - - SCELL_CH - - USER_LOCATION_CH - - EPS_FALLBACK - - MA_PDU - - TSN_BRIDGE_INFO - - 5G_RG_JOIN - - 5G_RG_LEAVE - - DDN_FAILURE - - DDN_DELIVERY_STATUS - - GROUP_ID_LIST_CHG - - DDN_FAILURE_CANCELLATION - - DDN_DELIVERY_STATUS_CANCELLATION - - VPLMN_QOS_CH - - SUCC_QOS_UPDATE - - SAT_CATEGORY_CHG - - PCF_UE_NOTIF_IND - - NWDAF_DATA_CHG - - UE_POL_CONT_IND - - URSP_ENFORCEMENT_INFO - - HR_SBO_IND_CHG - - L4S_SUPP - - NET_SLICE_REPL - - BAT_OFFSET_INFO - - UE_REACH_STATUS_CH - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates the policy control request trigger(s). - Possible values are: - - PLMN_CH: PLMN Change - - RES_MO_RE: A request for resource modification has been received by the SMF. The SMF - always reports to the PCF. - - AC_TY_CH: Access Type Change. - - UE_IP_CH: UE IP address change. The SMF always reports to the PCF. - - UE_MAC_CH: A new UE MAC address is detected or a used UE MAC address is inactive for a - specific period. - - AN_CH_COR: Access Network Charging Correlation Information - - US_RE: The PDU Session or the Monitoring key specific resources consumed by a UE either - reached the threshold or needs to be reported for other reasons. - - APP_STA: The start of application traffic has been detected. - - APP_STO: The stop of application traffic has been detected. - - AN_INFO: Access Network Information report. - - CM_SES_FAIL: Credit management session failure. - - PS_DA_OFF: The SMF reports when the 3GPP PS Data Off status changes. The SMF always - reports to the PCF. - - DEF_QOS_CH: Default QoS Change. The SMF always reports to the PCF. - - SE_AMBR_CH: Session-AMBR Change. The SMF always reports to the PCF. - - QOS_NOTIF: The SMF notify the PCF when receiving notification from RAN that QoS targets of - the QoS Flow cannot be guranteed or gurateed again. - - NO_CREDIT: Out of credit. - - REALLO_OF_CREDIT: Reallocation of credit. - - PRA_CH: Change of UE presence in Presence Reporting Area. - - SAREA_CH: Location Change with respect to the Serving Area. - - SCNN_CH: Location Change with respect to the Serving CN node. - - RE_TIMEOUT: Indicates the SMF generated the request because there has been a PCC - revalidation timeout. - - RES_RELEASE: Indicate that the SMF can inform the PCF of the outcome of the release of - resources for those rules that require so. - - SUCC_RES_ALLO: Indicates that the requested rule data is the successful resource - allocation. - - RAI_CH: Location Change with respect to the RAI of GERAN and UTRAN. - - RAT_TY_CH: RAT Type Change. - - REF_QOS_IND_CH: Reflective QoS indication Change - - NUM_OF_PACKET_FILTER: Indicates that the SMF shall report the number of supported packet - filter for signalled QoS rules. - - UE_STATUS_RESUME: Indicates that the UE's status is resumed. - - UE_TZ_CH: UE Time Zone Change. - - AUTH_PROF_CH: The DN-AAA authorization profile index has changed. - - QOS_MONITORING: Indicate that the SMF notifies the PCF of the QoS Monitoring information. - - SCELL_CH: Location Change with respect to the Serving Cell. - - USER_LOCATION_CH: Indicate that user location has been changed, applicable to serving area - change and serving cell change. - - EPS_FALLBACK: EPS Fallback report is enabled in the SMF. - - MA_PDU: UE Indicates that the SMF notifies the PCF of the MA PDU session request. - - TSN_BRIDGE_INFO: TSC user plane node information available. - - 5G_RG_JOIN: The 5G-RG has joined to an IP Multicast Group. - - 5G_RG_LEAVE: The 5G-RG has left an IP Multicast Group. - - DDN_FAILURE: Event subscription for DDN Failure event received. - - DDN_DELIVERY_STATUS: Event subscription for DDN Delivery Status received. - - GROUP_ID_LIST_CHG: UE Internal Group Identifier(s) has changed: the SMF reports that UDM - provided list of group Ids has changed. - - DDN_FAILURE_CANCELLATION: The event subscription for DDN Failure event is cancelled. - - DDN_DELIVERY_STATUS_CANCELLATION: The event subscription for DDD STATUS is cancelled. - - VPLMN_QOS_CH: Change of the QoS supported in the VPLMN. - - SUCC_QOS_UPDATE: Indicates that the requested MPS Action is successful. - - SAT_CATEGORY_CHG: Indicates that the SMF has detected a change between different satellite - backhaul categories, or between a satellite backhaul and a non-satellite backhaul. - - PCF_UE_NOTIF_IND: Indicates the SMF has detected the AMF forwarded the PCF for the UE - indication to receive/stop receiving notifications of SM Policy association - established/terminated events. - - NWDAF_DATA_CHG: Indicates that the NWDAF instance IDs used for the PDU session and/or - associated Analytics IDs used for the PDU session and available in the SMF have changed. - - UE_POL_CONT_IND: Indicates that a UE policy container or failure delivery report is - received from the UE in EPC over a PDN connection. - - URSP_ENFORCEMENT_INFO: Indicates a report of URSP rule enforcement information. - - HR_SBO_IND_CHG: Indicates the HR-SBO support indication has changed. - - L4S_SUPP: Indicates whether ECN marking for L4S is not available or available again - in 5GS. - - NET_SLICE_REPL: Indicates network slice replacement, i.e., a change between the initial - S-NSSAI of the PDU Session and the Alternative S-NSSAI - - BAT_OFFSET_INFO: Indicates that the SMF has detected the BAT offset and optionally - adjusted periodicity. - - UE_REACH_STATUS_CH: Indicates that there is a change in the UE reachability status. - - RequestedRuleDataType: - anyOf: - - type: string - enum: - - CH_ID - - MS_TIME_ZONE - - USER_LOC_INFO - - RES_RELEASE - - SUCC_RES_ALLO - - EPS_FALLBACK - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates the type of rule data requested by the PCF. - Possible values are: - - CH_ID: Indicates that the requested rule data is the charging identifier. - - MS_TIME_ZONE: Indicates that the requested access network info type is the UE's timezone. - - USER_LOC_INFO: Indicates that the requested access network info type is the UE's location. - - RES_RELEASE: Indicates that the requested rule data is the result of the release of - resource. - - SUCC_RES_ALLO: Indicates that the requested rule data is the successful resource - allocation. - - EPS_FALLBACK: Indicates that the requested rule data is the report of QoS flow rejection - due to EPS fallback. - - RuleStatus: - anyOf: - - type: string - enum: - - ACTIVE - - INACTIVE - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates the status of PCC or session rule. - Possible values are - - ACTIVE: Indicates that the PCC rule(s) are successfully installed (for those provisioned - from PCF) or activated (for those pre-defined in SMF), or the session rule(s) are - successfully installed - - INACTIVE: Indicates that the PCC rule(s) are removed (for those provisioned from PCF) or - inactive (for those pre-defined in SMF) or the session rule(s) are removed. - - FailureCode: - anyOf: - - type: string - enum: - - UNK_RULE_ID - - RA_GR_ERR - - SER_ID_ERR - - NF_MAL - - RES_LIM - - MAX_NR_QoS_FLOW - - MISS_FLOW_INFO - - RES_ALLO_FAIL - - UNSUCC_QOS_VAL - - INCOR_FLOW_INFO - - PS_TO_CS_HAN - - APP_ID_ERR - - NO_QOS_FLOW_BOUND - - FILTER_RES - - MISS_REDI_SER_ADDR - - CM_END_USER_SER_DENIED - - CM_CREDIT_CON_NOT_APP - - CM_AUTH_REJ - - CM_USER_UNK - - CM_RAT_FAILED - - UE_STA_SUSP - - UNKNOWN_REF_ID - - INCORRECT_COND_DATA - - REF_ID_COLLISION - - TRAFFIC_STEERING_ERROR - - DNAI_STEERING_ERROR - - AN_GW_FAILE - - MAX_NR_PACKET_FILTERS_EXCEEDED - - PACKET_FILTER_TFT_ALLOCATION_EXCEEDED - - MUTE_CHG_NOT_ALLOWED - - UE_TEMPORARILY_UNAVAILABLE - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates the reason of the PCC rule failure. - Possible values are - - UNK_RULE_ID: Indicates that the pre-provisioned PCC rule could not be successfully - activated because the PCC rule identifier is unknown to the SMF. - - RA_GR_ERR: Indicate that the PCC rule could not be successfully installed or enforced - because the Rating Group specified within the Charging Data policy decision which the PCC - rule refers to is unknown or, invalid. - - SER_ID_ERR: Indicate that the PCC rule could not be successfully installed or enforced - because the Service Identifier specified within the Charging Data policy decision which the - PCC rule refers to is invalid, unknown, or not applicable to the service being charged. - - NF_MAL: Indicate that the PCC rule could not be successfully installed (for those - provisioned from the PCF) or activated (for those pre-defined in SMF) or enforced (for those - already successfully installed) due to SMF/UPF malfunction. - - RES_LIM: Indicate that the PCC rule could not be successfully installed (for those - provisioned from PCF) or activated (for those pre-defined in SMF) or enforced (for those - already successfully installed) due to a limitation of resources at the SMF/UPF. - - MAX_NR_QoS_FLOW: Indicate that the PCC rule could not be successfully installed (for those - provisioned from PCF) or activated (for those pre-defined in SMF) or enforced (for those - already successfully installed) due to the fact that the maximum number of QoS flows has - been reached for the PDU session. - - MISS_FLOW_INFO: Indicate that the PCC rule could not be successfully installed or enforced - because neither the "flowInfos" attribute nor the "appId" attribute is specified within the - PccRule data structure by the PCF during the first install request of the PCC rule. - - RES_ALLO_FAIL: Indicate that the PCC rule could not be successfully installed or - maintained since the QoS flow establishment/modification failed, or the QoS flow was - released. - - UNSUCC_QOS_VAL: indicate that the QoS validation has failed or when Guaranteed Bandwidth > - Max-Requested-Bandwidth. - - INCOR_FLOW_INFO: Indicate that the PCC rule could not be successfully installed or - modified at the SMF because the provided flow information is not supported by the network - (e.g. the provided IP address(es) or Ipv6 prefix(es) do not correspond to an IP version - applicable for the PDU session). - - PS_TO_CS_HAN: Indicate that the PCC rule could not be maintained because of PS to CS - handover. - - APP_ID_ERR: Indicate that the rule could not be successfully installed or enforced because - the Application Identifier is invalid, unknown, or not applicable to the application - required for detection. - - NO_QOS_FLOW_BOUND: Indicate that there is no QoS flow which the SMF can bind the PCC - rule(s) to. - - FILTER_RES: Indicate that the Flow Information within the "flowInfos" attribute cannot be - handled by the SMF because any of the restrictions defined in clause 5.4.2 of 3GPP TS 29.212 - was not met. - - MISS_REDI_SER_ADDR: Indicate that the PCC rule could not be successfully installed or - enforced at the SMF because there is no valid Redirect Server Address within the Traffic - Control Data policy decision which the PCC rule refers to provided by the PCF and no - preconfigured redirection address for this PCC rule at the SMF. - - CM_END_USER_SER_DENIED: Indicate that the charging system denied the service request due - to service restrictions (e.g. terminate rating group) or limitations related to the - end-user, for example the end-user's account could not cover the requested service. - - CM_CREDIT_CON_NOT_APP: Indicate that the charging system determined that the service can - be granted to the end user but no further credit control is needed for the service (e.g. - service is free of charge or is treated for offline charging). - - CM_AUTH_REJ: Indicate that the charging system denied the service request in order to - terminate the service for which credit is requested. - - CM_USER_UNK: Indicate that the specified end user could not be found in the charging - system. - - CM_RAT_FAILED: Indicate that the charging system cannot rate the service request due to - insufficient rating input, incorrect AVP combination or due to an attribute or an attribute - value that is not recognized or supported in the rating. - - UE_STA_SUSP: Indicates that the UE is in suspend state. - - UNKNOWN_REF_ID: Indicates that the PCC rule could not be successfully installed/modified - because the referenced identifier to a Policy Decision Data or to a Condition Data is - unknown to the SMF. - - INCORRECT_COND_DATA: Indicates that the PCC rule could not be successfully - installed/modified because the referenced Condition data are incorrect. - - REF_ID_COLLISION: Indicates that PCC rule could not be successfully installed/modified - because the same Policy Decision is referenced by a session rule (e.g. the session rule - and the PCC rule refer to the same Usage Monitoring decision data). - - TRAFFIC_STEERING_ERROR: Indicates that enforcement of the steering of traffic to the - N6-LAN or 5G-LAN failed; or the dynamic PCC rule could not be successfully installed or - modified at the NF service consumer because there are invalid traffic steering policy - identifier(s) within the provided Traffic Control Data policy decision to which the PCC - rule refers. - - DNAI_STEERING_ERROR: Indicates that the enforcement of the steering of traffic to the - indicated DNAI failed; or the dynamic PCC rule could not be successfully installed or - modified at the NF service consumer because there is invalid route information for a DNAI(s) - (e.g. routing profile id is not configured) within the provided Traffic Control Data policy - decision to which the PCC rule refers. - - AN_GW_FAILED: This value is used to indicate that the AN-Gateway has failed and that the - PCF should refrain from sending policy decisions to the SMF until it is informed that the - S-GW has been recovered. This value shall not be used if the SM Policy association - modification procedure is initiated for PCC rule removal only. - - MAX_NR_PACKET_FILTERS_EXCEEDED: This value is used to indicate that the PCC rule could not - be successfully installed, modified or enforced at the NF service consumer because the - number of supported packet filters for signalled QoS rules for the PDU session has been - reached. - - PACKET_FILTER_TFT_ALLOCATION_EXCEEDED: This value is used to indicate that the PCC rule is - removed at 5GS to EPS mobility because TFT allocation was not possible since the number of - active packet filters in the EPC bearer is exceeded. - - MUTE_CHG_NOT_ALLOWED: Indicates that the PCC rule could not be successfully modified - because the mute condition for application detection report cannot be changed. Applicable - when the functionality introduced with the ADC feature applies. - - UE_TEMPORARILY_UNAVAILABLE: Indicates that the PCC rule could not be successfully - installed or modified because the SMF was informed that the UE was not reachable. - AfSigProtocol: - anyOf: - - type: string - enum: - - NO_INFORMATION - - SIP - - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates the protocol used for signalling between the UE and the AF. - Possible values are - - NO_INFORMATION: Indicate that no information about the AF signalling protocol is being - provided. - - SIP: Indicate that the signalling protocol is Session Initiation Protocol. - - RuleOperation: - anyOf: - - type: string - enum: - - CREATE_PCC_RULE - - DELETE_PCC_RULE - - MODIFY_PCC_RULE_AND_ADD_PACKET_FILTERS - - MODIFY_ PCC_RULE_AND_REPLACE_PACKET_FILTERS - - MODIFY_ PCC_RULE_AND_DELETE_PACKET_FILTERS - - MODIFY_PCC_RULE_WITHOUT_MODIFY_PACKET_FILTERS - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Indicates a UE initiated resource operation that causes a request for PCC rules. - Possible values are - - CREATE_PCC_RULE: Indicates to create a new PCC rule to reserve the resource requested by - the UE. - - DELETE_PCC_RULE: Indicates to delete a PCC rule corresponding to reserve the resource - requested by the UE. - - MODIFY_PCC_RULE_AND_ADD_PACKET_FILTERS: Indicates to modify the PCC rule by adding new - packet filter(s). - - MODIFY_ PCC_RULE_AND_REPLACE_PACKET_FILTERS: Indicates to modify the PCC rule by replacing - the existing packet filter(s). - - MODIFY_ PCC_RULE_AND_DELETE_PACKET_FILTERS: Indicates to modify the PCC rule by deleting - the existing packet filter(s). - - MODIFY_PCC_RULE_WITHOUT_MODIFY_PACKET_FILTERS: Indicates to modify the PCC rule by - modifying the QoS of the PCC rule. - - RedirectAddressType: - anyOf: - - type: string - enum: - - IPV4_ADDR - - IPV6_ADDR - - URL - - SIP_URI - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates the redirect address type. - Possible values are - - IPV4_ADDR: Indicates that the address type is in the form of "dotted-decimal" IPv4 - address. - - IPV6_ADDR: Indicates that the address type is in the form of IPv6 address. - - URL: Indicates that the address type is in the form of Uniform Resource Locator. - - SIP_URI: Indicates that the address type is in the form of SIP Uniform Resource - Identifier. - - QosFlowUsage: - anyOf: - - type: string - enum: - - GENERAL - - IMS_SIG - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates a QoS flow usage information. - Possible values are - - GENERAL: Indicate no specific QoS flow usage information is available. - - IMS_SIG: Indicate that the QoS flow is used for IMS signalling only. - - FailureCause: - description: Indicates the cause of the failure in a Partial Success Report. - anyOf: - - type: string - enum: - - PCC_RULE_EVENT - - PCC_QOS_FLOW_EVENT - - RULE_PERMANENT_ERROR - - RULE_TEMPORARY_ERROR - - POL_DEC_ERROR - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - - CreditManagementStatus: - description: Indicates the reason of the credit management session failure. - anyOf: - - type: string - enum: - - END_USER_SER_DENIED - - CREDIT_CTRL_NOT_APP - - AUTH_REJECTED - - USER_UNKNOWN - - RATING_FAILED - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - - SessionRuleFailureCode: - anyOf: - - type: string - enum: - - NF_MAL - - RES_LIM - - SESSION_RESOURCE_ALLOCATION_FAILURE - - UNSUCC_QOS_VAL - - INCORRECT_UM - - UE_STA_SUSP - - UNKNOWN_REF_ID - - INCORRECT_COND_DATA - - REF_ID_COLLISION - - AN_GW_FAILED - - DEFAULT_QOS_MODIFICATION_FAILURE - - SESSION_AMBR_MODIFICATION_FAILURE - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates the reason of the session rule failure. - Possible values are - - NF_MAL: Indicates that the PCC rule could not be successfully installed (for those - provisioned from the PCF) or activated (for those pre-defined in SMF) or enforced (for those - already successfully installed) due to SMF/UPF malfunction. - - RES_LIM: Indicates that the PCC rule could not be successfully installed (for those - provisioned from PCF) or activated (for those pre-defined in SMF) or enforced (for those - already successfully installed) due to a limitation of resources at the SMF/UPF. - - SESSION_RESOURCE_ALLOCATION_FAILURE: Indicates the session rule could not be successfully - enforced due to failure during the allocation of resources for the PDU session in the UE, - RAN or AMF. - - UNSUCC_QOS_VAL: indicates that the QoS validation has failed. - - INCORRECT_UM: The usage monitoring data of the enforced session rule is not the same for - all the provisioned session rule(s). - - UE_STA_SUSP: Indicates that the UE is in suspend state. - - UNKNOWN_REF_ID: Indicates that the session rule could not be successfully - installed/modified because the referenced identifier to a Policy Decision Data or to a - Condition Data is unknown to the SMF. - - INCORRECT_COND_DATA: Indicates that the session rule could not be successfully - installed/modified because the referenced Condition data are incorrect. - - REF_ID_COLLISION: Indicates that the session rule could not be successfully - installed/modified because the same Policy Decision is referenced by a PCC rule (e.g. the - session rule and the PCC rule refer to the same Usage Monitoring decision data). - - AN_GW_FAILED: Indicates that the AN-Gateway has failed and that the PCF should refrain - from sending policy decisions to the SMF until it is informed that the S-GW has been - recovered. This value shall not be used if the SM Policy association modification procedure - is initiated for session rule removal only. - - DEFAULT_QOS_MODIFICATION_FAILURE: Indicates that the enforcement of the default QoS - modification failed. The SMF shall use this value to indicate to the PCF that the default - QoS modification has failed. - - SESSION_AMBR_MODIFICATION_FAILURE: Indicates that the enforcement of the session-AMBR - modification failed. The SMF shall use this value to indicate to the PCF that the - session-AMBR modification has failed. - - SteeringFunctionality: - anyOf: - - type: string - enum: - - MPTCP - - MPQUIC - - ATSSS_LL - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates functionality to support traffic steering, switching and splitting determined - by the PCF. - Possible values are - - MPTCP: Indicates that PCF authorizes the MPTCP functionality to support traffic - steering, switching and splitting. - - MPQUIC: Indicates that PCF authorizes the MPQUIC functionality to support traffic - steering, switching and splitting. - - ATSSS_LL: Indicates that PCF authorizes the ATSSS-LL functionality to support traffic - steering, switching and splitting. - - SteerModeValue: - description: Indicates the steering mode value determined by the PCF. - anyOf: - - type: string - enum: - - ACTIVE_STANDBY - - LOAD_BALANCING - - SMALLEST_DELAY - - PRIORITY_BASED - - REDUNDANT - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - - MulticastAccessControl: - description: > - Indicates whether the service data flow, corresponding to the service data flow template, is - allowed or not allowed. - anyOf: - - type: string - enum: - - ALLOWED - - NOT_ALLOWED - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - - RequestedQosMonitoringParameter: - description: Indicates the requested QoS monitoring parameters to be measured. - anyOf: - - type: string - enum: - - DOWNLINK - - UPLINK - - ROUND_TRIP - - DOWNLINK_DATA_RATE - - UPLINK_DATA_RATE - - DOWNLINK_CONGESTION - - UPLINK_CONGESTION - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - - ReportingFrequency: - description: Indicates the frequency for the reporting. - anyOf: - - type: string - enum: - - EVENT_TRIGGERED - - PERIODIC - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - - SgsnAddress: - description: describes the address of the SGSN - type: object - anyOf: - - required: [sgsnIpv4Addr] - - required: [sgsnIpv6Addr] - properties: - sgsnIpv4Addr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' - sgsnIpv6Addr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' - - SmPolicyAssociationReleaseCause: - description: > - Represents the cause due to which the PCF requests the termination of the SM policy - association. - anyOf: - - type: string - enum: - - UNSPECIFIED - - UE_SUBSCRIPTION - - INSUFFICIENT_RES - - VALIDATION_CONDITION_NOT_MET - - REACTIVATION_REQUESTED - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - - PduSessionRelCause: - description: Contains the SMF PDU Session release cause. - anyOf: - - type: string - enum: - - PS_TO_CS_HO - - RULE_ERROR - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - - MaPduIndication: - description: > - Contains the MA PDU session indication, i.e., MA PDU Request or MA PDU Network-Upgrade - Allowed. - anyOf: - - type: string - enum: - - MA_PDU_REQUEST - - MA_PDU_NETWORK_UPGRADE_ALLOWED - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - - AtsssCapability: - description: Contains the ATSSS capability supported for the MA PDU Session. - anyOf: - - type: string - enum: - - MPTCP_ATSSS_LL_WITH_ASMODE_UL - - MPTCP_ATSSS_LL_WITH_EXSDMODE_DL_ASMODE_UL - - MPTCP_ATSSS_LL_WITH_ASMODE_DLUL - - ATSSS_LL - - MPTCP_ATSSS_LL - - MPQUIC_ATSSS_LL_WITH_ASMODE_UL - - MPQUIC_ATSSS_LL_WITH_EXSDMODE_DL_ASMODE_UL - - MPQUIC_ATSSS_LL_WITH_ASMODE_DLUL - - MPQUIC_ATSSS_LL - - MPTCP_MPQUIC_ATSSS_LL_WITH_ASMODE_UL - - MPTCP_MPQUIC_ATSSS_LL_WITH_EXSDMODE_DL_ASMODE_UL - - MPTCP_MPQUIC_ATSSS_LL_WITH_ASMODE_DLUL - - MPTCP_MPQUIC_ATSSS_LL - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. -# - NetLocAccessSupport: - anyOf: - - type: string - enum: - - ANR_NOT_SUPPORTED - - TZR_NOT_SUPPORTED - - LOC_NOT_SUPPORTED - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration and is not used to encode - content defined in the present version of this API. - description: | - Indicates the access network support of the report of the requested access network - information. - Possible values are - - ANR_NOT_SUPPORTED: Indicates that the access network does not support the report of access - network information. - - TZR_NOT_SUPPORTED: Indicates that the access network does not support the report of UE - time zone. - - LOC_NOT_SUPPORTED: Indicates that the access network does not support the report of UE - Location (or PLMN Id). - - PolicyDecisionFailureCode: - description: Indicates the type of the failed policy decision and/or condition data. - anyOf: - - type: string - enum: - - TRA_CTRL_DECS_ERR - - QOS_DECS_ERR - - CHG_DECS_ERR - - USA_MON_DECS_ERR - - QOS_MON_DECS_ERR - - CON_DATA_ERR - - POLICY_PARAM_ERR - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. -# - NotificationControlIndication: - description: > - Indicates that the notification of DDD Status is requested and/or that the notification of - DDN Failure is requested. - anyOf: - - type: string - enum: - - DDN_FAILURE - - DDD_STATUS - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. -# - SteerModeIndicator: - description: Contains Autonomous load-balance indicator or UE-assistance indicator. - anyOf: - - type: string - enum: - - AUTO_LOAD_BALANCE - - UE_ASSISTANCE - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. -# - TrafficParameterMeas: - description: Indicates the traffic parameters to be measured. - anyOf: - - type: string - enum: - - DL_N6_JITTER - - DL_PERIOD - - UL_PERIOD - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - - QosMonitoringParamType: - anyOf: - - type: string - enum: - - PACKET_DELAY - - CONGESTION - - DATA_RATE - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - description: | - Indicates the QoS monitoring parameter type. - Possible values are: - - PACKET_DELAY: Indicates that the QoS monitoring parameter to be measured is packet delay. - - CONGESTION: Indicates that the QoS monitoring parameter to be measured is congestion. - - DATA_RATE: Indicates that the QoS monitoring parameter to be measured is data rate. - - TransportMode: - description: > - Indicates the Transport Mode when the steering functionality is MPQUIC functionality. - anyOf: - - type: string - enum: - - DATAGRAM_MODE_1 - - DATAGRAM_MODE_2 - - STREAM_MODE - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - - UeReachabilityStatus: - anyOf: - - type: string - enum: - - REACHABLE - - UNREACHABLE - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - description: | - Indicates the UE rechability status. - Possible values are: - - REACHABLE: Indicates that the UE is reachable. - - UNREACHABLE: Indicates that the UE is unreachable. -# - diff --git a/OpenAPI/TS29520_Nnwdaf_EventsSubscription.yaml b/OpenAPI/TS29520_Nnwdaf_EventsSubscription.yaml deleted file mode 100644 index bc75528311486dbd1d5a0ef7035ed15ffc25829f..0000000000000000000000000000000000000000 --- a/OpenAPI/TS29520_Nnwdaf_EventsSubscription.yaml +++ /dev/null @@ -1,4084 +0,0 @@ -openapi: 3.0.0 - -info: - version: 1.3.1 - title: Nnwdaf_EventsSubscription - description: | - Nnwdaf_EventsSubscription Service API. - © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. - -externalDocs: - description: 3GPP TS 29.520 V18.7.0; 5G System; Network Data Analytics Services. - url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/' - -security: - - {} - - oAuth2ClientCredentials: - - nnwdaf-eventssubscription - -servers: - - url: '{apiRoot}/nnwdaf-eventssubscription/v1' - variables: - apiRoot: - default: https://example.com - description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. - -paths: - /subscriptions: - post: - summary: Create a new Individual NWDAF Events Subscription - operationId: CreateNWDAFEventsSubscription - tags: - - NWDAF Events Subscriptions (Collection) - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NnwdafEventsSubscription' - responses: - '201': - description: Create a new Individual NWDAF Event Subscription resource. - headers: - Location: - description: > - Contains the URI of the newly created resource, according to the structure - {apiRoot}/nnwdaf-eventssubscription//subscriptions/{subscriptionId} - required: true - schema: - type: string - content: - application/json: - schema: - $ref: '#/components/schemas/NnwdafEventsSubscription' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - callbacks: - myNotification: - '{$request.body#/notificationURI}': - post: - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/NnwdafEventsSubscriptionNotification' - minItems: 1 - responses: - '204': - description: The receipt of the Notification is acknowledged. - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - - /subscriptions/{subscriptionId}: - delete: - summary: Delete an existing Individual NWDAF Events Subscription - operationId: DeleteNWDAFEventsSubscription - tags: - - Individual NWDAF Events Subscription (Document) - parameters: - - name: subscriptionId - in: path - description: String identifying a subscription to the Nnwdaf_EventsSubscription Service - required: true - schema: - type: string - responses: - '204': - description: > - No Content. The Individual NWDAF Event Subscription resource matching the subscriptionId - was deleted. - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '501': - $ref: 'TS29571_CommonData.yaml#/components/responses/501' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - put: - summary: Update an existing Individual NWDAF Events Subscription - operationId: UpdateNWDAFEventsSubscription - tags: - - Individual NWDAF Events Subscription (Document) - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NnwdafEventsSubscription' - parameters: - - name: subscriptionId - in: path - description: String identifying a subscription to the Nnwdaf_EventsSubscription Service. - required: true - schema: - type: string - responses: - '200': - description: > - The Individual NWDAF Event Subscription resource was modified successfully and a - representation of that resource is returned. - content: - application/json: - schema: - $ref: '#/components/schemas/NnwdafEventsSubscription' - '204': - description: The Individual NWDAF Event Subscription resource was modified successfully. - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '501': - $ref: 'TS29571_CommonData.yaml#/components/responses/501' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - - /transfers: - post: - summary: Provide information about requested analytics subscriptions transfer and potentially create a new Individual NWDAF Event Subscription Transfer resource. - operationId: CreateNWDAFEventSubscriptionTransfer - tags: - - NWDAF Event Subscription Transfers (Collection) - security: - - {} - - oAuth2ClientCredentials: - - nnwdaf-eventssubscription - - oAuth2ClientCredentials: - - nnwdaf-eventssubscription - - nnwdaf-eventssubscription:transfer - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AnalyticsSubscriptionsTransfer' - responses: - '201': - description: Create a new Individual NWDAF Event Subscription Transfer resource. - headers: - Location: - description: > - Contains the URI of the newly created resource, according to the structure - {apiRoot}/nnwdaf-eventssubscription//transfers/{transferId} - required: true - schema: - type: string - '204': - description: > - No Content. The receipt of the information about analytics subscription(s) that are - requested to be transferred and the ability to handle this information (e.g. execute the - steps required to transfer an analytics subscription directly) is confirmed. - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - - /transfers/{transferId}: - delete: - summary: Delete an existing Individual NWDAF Event Subscription Transfer - operationId: DeleteNWDAFEventSubscriptionTransfer - tags: - - Individual NWDAF Event Subscription Transfer (Document) - security: - - {} - - oAuth2ClientCredentials: - - nnwdaf-eventssubscription - - oAuth2ClientCredentials: - - nnwdaf-eventssubscription - - nnwdaf-eventssubscription:transfer - parameters: - - name: transferId - in: path - description: > - String identifying a request for an analytics subscription transfer to the - Nnwdaf_EventsSubscription Service. - required: true - schema: - type: string - responses: - '204': - description: > - No Content. The Individual NWDAF Event Subscription Transfer resource matching the - transferId was deleted. - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '501': - $ref: 'TS29571_CommonData.yaml#/components/responses/501' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - put: - summary: Update an existing Individual NWDAF Event Subscription Transfer - operationId: UpdateNWDAFEventSubscriptionTransfer - tags: - - Individual NWDAF Event Subscription Transfer (Document) - security: - - {} - - oAuth2ClientCredentials: - - nnwdaf-eventssubscription - - oAuth2ClientCredentials: - - nnwdaf-eventssubscription - - nnwdaf-eventssubscription:transfer - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AnalyticsSubscriptionsTransfer' - parameters: - - name: transferId - in: path - description: > - String identifying a request for an analytics subscription transfer to the - Nnwdaf_EventsSubscription Service - required: true - schema: - type: string - responses: - '204': - description: > - The Individual NWDAF Event Subscription Transfer resource was modified successfully. - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '501': - $ref: 'TS29571_CommonData.yaml#/components/responses/501' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - -components: - - securitySchemes: - oAuth2ClientCredentials: - type: oauth2 - flows: - clientCredentials: - tokenUrl: '{nrfApiRoot}/oauth2/token' - scopes: - nnwdaf-eventssubscription: Access to the Nnwdaf_EventsSubscription API - nnwdaf-eventssubscription:transfer: > - Access to service operations applying to NWDAF event subscription transfer. - - schemas: - - NnwdafEventsSubscription: - description: Represents an Individual NWDAF Event Subscription resource. - type: object - properties: - eventSubscriptions: - type: array - items: - $ref: '#/components/schemas/EventSubscription' - minItems: 1 - description: Subscribed events - evtReq: - $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' - notificationURI: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' - notifCorrId: - type: string - description: Notification correlation identifier. - supportedFeatures: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - eventNotifications: - type: array - items: - $ref: '#/components/schemas/EventNotification' - minItems: 1 - failEventReports: - type: array - items: - $ref: '#/components/schemas/FailureEventInfo' - minItems: 1 - prevSub: - $ref: '#/components/schemas/PrevSubInfo' - consNfInfo: - $ref: '#/components/schemas/ConsumerNfInformation' - required: - - eventSubscriptions - - EventSubscription: - description: Represents a subscription to a single event. - type: object - properties: - anySlice: - $ref: '#/components/schemas/AnySlice' - appIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - minItems: 1 - description: Identification(s) of application to which the subscription applies. - deviations: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - minItems: 1 - dnns: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - minItems: 1 - description: Identification(s) of DNN to which the subscription applies. - dnais: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' - minItems: 1 - event: - $ref: '#/components/schemas/NwdafEvent' - extraReportReq: - $ref: '#/components/schemas/EventReportingRequirement' - ladnDnns: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - minItems: 1 - description: Identification(s) of LADN DNN to indicate the LADN service area as the AOI. - loadLevelThreshold: - type: integer - description: > - Indicates that the NWDAF shall report the corresponding network slice load level to the - NF service consumer where the load level of the network slice identified by snssais is - reached. - notificationMethod: - $ref: '#/components/schemas/NotificationMethod' - matchingDir: - $ref: '#/components/schemas/MatchingDirection' - nfLoadLvlThds: - type: array - items: - $ref: '#/components/schemas/ThresholdLevel' - minItems: 1 - description: > - Shall be supplied in order to start reporting when an average load level is reached. - nfInstanceIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - minItems: 1 - nfSetIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' - minItems: 1 - nfTypes: - type: array - items: - $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' - minItems: 1 - networkArea: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - location: - $ref: '#/components/schemas/GeoLocation' - temporalGranSize: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - spatialGranSizeTa: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - spatialGranSizeCell: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - fineGranAreas: - type: array - items: - $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' - minItems: 1 - description: Indicates the fine granularity areas to which the subscription applies. - visitedAreas: - type: array - items: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - minItems: 1 - maxTopAppUlNbr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - maxTopAppDlNbr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - nsiIdInfos: - type: array - items: - $ref: '#/components/schemas/NsiIdInfo' - minItems: 1 - nsiLevelThrds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - minItems: 1 - qosRequ: - $ref: '#/components/schemas/QosRequirement' - qosFlowRetThds: - type: array - items: - $ref: '#/components/schemas/RetainabilityThreshold' - minItems: 1 - ranUeThrouThds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - minItems: 1 - repetitionPeriod: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - snssaia: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - minItems: 1 - description: > - Identification(s) of network slice to which the subscription applies. It corresponds to - snssais in the data model definition of 3GPP TS 29.520. - tgtUe: - $ref: '#/components/schemas/TargetUeInformation' - roamingInfo: - $ref: '#/components/schemas/RoamingInfo' - congThresholds: - type: array - items: - $ref: '#/components/schemas/ThresholdLevel' - minItems: 1 - nwPerfRequs: - type: array - items: - $ref: '#/components/schemas/NetworkPerfRequirement' - minItems: 1 - ueCommReqs: - type: array - items: - $ref: '#/components/schemas/UeCommReq' - minItems: 1 - ueMobilityReqs: - type: array - items: - $ref: '#/components/schemas/UeMobilityReq' - minItems: 1 - userDataConOrderCri: - $ref: '#/components/schemas/UserDataConOrderCrit' - bwRequs: - type: array - items: - $ref: '#/components/schemas/BwRequirement' - minItems: 1 - excepRequs: - type: array - items: - $ref: '#/components/schemas/Exception' - minItems: 1 - exptAnaType: - $ref: '#/components/schemas/ExpectedAnalyticsType' - exptUeBehav: - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExpectedUeBehaviourData' - ratFreqs: - type: array - items: - $ref: '#/components/schemas/RatFreqInformation' - minItems: 1 - listOfAnaSubsets: - type: array - items: - $ref: '#/components/schemas/AnalyticsSubset' - minItems: 1 - disperReqs: - type: array - items: - $ref: '#/components/schemas/DispersionRequirement' - minItems: 1 - redTransReqs: - type: array - items: - $ref: '#/components/schemas/RedundantTransmissionExpReq' - minItems: 1 - wlanReqs: - type: array - items: - $ref: '#/components/schemas/WlanPerformanceReq' - minItems: 1 - upfInfo: - $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/UpfInformation' - appServerAddrs: - type: array - items: - $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' - minItems: 1 - dnPerfReqs: - type: array - items: - $ref: '#/components/schemas/DnPerformanceReq' - minItems: 1 - pduSesInfos: - type: array - items: - $ref: '#/components/schemas/PduSessionInfo' - minItems: 1 - useCaseCxt: - type: string - description: > - Indicates the context of usage of the analytics. The value and format of this parameter - are not standardized. - pduSesTrafReqs: - type: array - items: - $ref: '#/components/schemas/PduSesTrafficReq' - minItems: 1 - locAccReqs: - type: array - items: - $ref: '#/components/schemas/LocAccuracyReq' - minItems: 1 - locGranularity: - $ref: '#/components/schemas/LocInfoGranularity' - locOrientation: - $ref: '#/components/schemas/LocationOrientation' - dataVlTrnsTmRqs: - type: array - items: - $ref: '#/components/schemas/E2eDataVolTransTimeReq' - minItems: 1 - accuReq: - $ref: '#/components/schemas/AccuracyReq' - pauseFlg: - type: boolean - description: > - Pause analytics consumption flag. Set to "true" to indicate the NWDAF to stop sending - the notifications of analytics. Default value is "false" if omitted. - resumeFlg: - type: boolean - description: > - Resume analytics consumption flag. Set to "true" to indicate the NWDAF to resume sending - the notifications of analytics. Default value is "false" if omitted. - movBehavReqs: - type: array - items: - $ref: '#/components/schemas/MovBehavReq' - minItems: 1 - relProxReqs: - type: array - items: - $ref: '#/components/schemas/RelProxReq' - minItems: 1 - feedback: - $ref: '#/components/schemas/AnalyticsFeedbackInfo' - required: - - event - not: - required: [excepRequs, exptAnaType] - - NnwdafEventsSubscriptionNotification: - description: Represents an Individual NWDAF Event Subscription Notification resource. - type: object - properties: - eventNotifications: - type: array - items: - $ref: '#/components/schemas/EventNotification' - minItems: 1 - description: Notifications about Individual Events - subscriptionId: - type: string - description: String identifying a subscription to the Nnwdaf_EventsSubscription Service - notifCorrId: - type: string - description: Notification correlation identifier. - oldSubscriptionId: - type: string - description: > - Subscription ID which was allocated by the source NWDAF. This parameter shall be present - if the notification is for informing the assignment of a new Subscription Id by the - target NWDAF. - resourceUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' - termCause: - $ref: '#/components/schemas/TermCause' - transEvents: - type: array - items: - $ref: '#/components/schemas/NwdafEvent' - minItems: 1 - required: - - subscriptionId - oneOf: - - required: [eventNotifications] - - allOf: - - required: [resourceUri] - - required: [oldSubscriptionId] - - EventNotification: - description: Represents a notification on events that occurred. - type: object - properties: - event: - $ref: '#/components/schemas/NwdafEvent' - start: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - expiry: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - timeStampGen: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - failNotifyCode: - $ref: '#/components/schemas/NwdafFailureCode' - rvWaitTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - anaMetaInfo: - $ref: '#/components/schemas/AnalyticsMetadataInfo' - nfLoadLevelInfos: - type: array - items: - $ref: '#/components/schemas/NfLoadLevelInformation' - minItems: 1 - nsiLoadLevelInfos: - type: array - items: - $ref: '#/components/schemas/NsiLoadLevelInfo' - minItems: 1 - pfdDetermInfos: - type: array - items: - $ref: '#/components/schemas/PfdDeterminationInfo' - minItems: 1 - sliceLoadLevelInfo: - $ref: '#/components/schemas/SliceLoadLevelInformation' - svcExps: - type: array - items: - $ref: '#/components/schemas/ServiceExperienceInfo' - minItems: 1 - qosSustainInfos: - type: array - items: - $ref: '#/components/schemas/QosSustainabilityInfo' - minItems: 1 - ueComms: - type: array - items: - $ref: '#/components/schemas/UeCommunication' - minItems: 1 - ueMobs: - type: array - items: - $ref: '#/components/schemas/UeMobility' - minItems: 1 - userDataCongInfos: - type: array - items: - $ref: '#/components/schemas/UserDataCongestionInfo' - minItems: 1 - abnorBehavrs: - type: array - items: - $ref: '#/components/schemas/AbnormalBehaviour' - minItems: 1 - nwPerfs: - type: array - items: - $ref: '#/components/schemas/NetworkPerfInfo' - minItems: 1 - dnPerfInfos: - type: array - items: - $ref: '#/components/schemas/DnPerfInfo' - minItems: 1 - disperInfos: - type: array - items: - $ref: '#/components/schemas/DispersionInfo' - minItems: 1 - redTransInfos: - type: array - items: - $ref: '#/components/schemas/RedundantTransmissionExpInfo' - minItems: 1 - wlanInfos: - type: array - items: - $ref: '#/components/schemas/WlanPerformanceInfo' - minItems: 1 - smccExps: - type: array - items: - $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/SmcceInfo' - minItems: 1 - pduSesTrafInfos: - type: array - items: - $ref: '#/components/schemas/PduSesTrafficInfo' - minItems: 1 - dataVlTrnsTmInfos: - type: array - items: - $ref: '#/components/schemas/E2eDataVolTransTimeInfo' - minItems: 1 - accuInfo: - $ref: '#/components/schemas/AccuracyInfo' - cancelAccuInd: - type: boolean - description: > - Indicates cancelled subscription of the analytics accuracy information. - Set to "true" indicates the NWDAF cancelled subscription of analytics accuracy - information as the NWDAF does not support the accuracy checking capability. - Otherwise set to "false". Default value is "false" if omitted. - pauseInd: - type: boolean - description: > - Pause analytics consumption indication. Set to "true" to indicate the consumer to stop - the consumption of the analytics. Default value is "false" if omitted. - resumeInd: - type: boolean - description: > - Resume analytics consumption indication. Set to "true" to indicate the consumer to - resume the consumption of the analytics. Default value is "false" if omitted. - movBehavInfos: - type: array - items: - $ref: '#/components/schemas/MovBehavInfo' - minItems: 1 - locAccInfos: - type: array - items: - $ref: '#/components/schemas/LocAccuracyInfo' - minItems: 1 - relProxInfos: - type: array - items: - $ref: '#/components/schemas/RelProxInfo' - minItems: 1 - required: - - event - - ServiceExperienceInfo: - description: Represents service experience information. - type: object - properties: - svcExprc: - $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/SvcExperience' - svcExprcVariance: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - supis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - appId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - srvExpcType: - $ref: '#/components/schemas/ServiceExperienceType' - ueLocs: - type: array - items: - $ref: '#/components/schemas/LocationInfo' - minItems: 1 - upfInfo: - $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/UpfInformation' - dnai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' - appServerInst: - $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - dnn: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - networkArea: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - nsiId: - $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' - ratio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - ratFreq: - $ref: '#/components/schemas/RatFreqInformation' - pduSesInfo: - $ref: '#/components/schemas/PduSessionInfo' - required: - - svcExprc - - BwRequirement: - description: Represents bandwidth requirements. - type: object - properties: - appId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - marBwDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - marBwUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - mirBwDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - mirBwUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - required: - - appId - - SliceLoadLevelInformation: - description: Contains load level information applicable for one or several slices. - type: object - properties: - loadLevelInformation: - $ref: '#/components/schemas/LoadLevelInformation' - snssais: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - minItems: 1 - description: Identification(s) of network slice to which the subscription applies. - required: - - loadLevelInformation - - snssais - - NsiLoadLevelInfo: - description: > - Represents the network slice and optionally the associated network slice instance and the - load level information. - type: object - properties: - loadLevelInformation: - $ref: '#/components/schemas/LoadLevelInformation' - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - nsiId: - $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' - resUsage: - $ref: '#/components/schemas/ResourceUsage' - numOfExceedLoadLevelThr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - exceedLoadLevelThrInd: - type: boolean - description: > - Indicates whether the Load Level Threshold is met or exceeded by the statistics value. - Set to "true" if the Load Level Threshold is met or exceeded, otherwise set to "false". - Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to - EXCEED_LOAD_LEVEL_THR_IND. - networkArea: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - timePeriod: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' - resUsgThrCrossTimePeriod: - type: array - items: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' - minItems: 1 - description: > - Each element indicates the time elapsed between times each threshold is met or exceeded - or crossed. The start time and end time are the exact time stamps of the resource usage - threshold is reached or exceeded. May be present if the "listOfAnaSubsets" attribute is - provided and the maximum number of instances shall not exceed the value provided in the - "numOfExceedLoadLevelThr" attribute. - numOfUes: - $ref: '#/components/schemas/NumberAverage' - numOfPduSess: - $ref: '#/components/schemas/NumberAverage' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - required: - - loadLevelInformation - - snssai - - NsiIdInfo: - description: Represents the S-NSSAI and the optionally associated Network Slice Instance(s). - type: object - properties: - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - nsiIds: - type: array - items: - $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' - minItems: 1 - required: - - snssai - - EventReportingRequirement: - description: Represents the type of reporting that the subscription requires. - type: object - properties: - accuracy: - $ref: '#/components/schemas/Accuracy' - accPerSubset: - type: array - items: - $ref: '#/components/schemas/Accuracy' - minItems: 1 - description: > - Each element indicates the preferred accuracy level per analytics subset. It may be - present if the "listOfAnaSubsets" attribute is present in the subscription request. - startTs: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - endTs: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - offsetPeriod: - type: integer - description: > - Offset period in units of seconds to the reporting time, if the value is negative means - statistics in the past offset period, otherwise a positive value means prediction in the - future offset period. May be present if the "repPeriod" attribute is included within the - "evtReq" attribute or the "repetitionPeriod" attribute is included within the - EventSubscription type. - sampRatio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - maxObjectNbr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - maxSupiNbr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - timeAnaNeeded: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - anaMeta: - type: array - items: - $ref: '#/components/schemas/AnalyticsMetadata' - minItems: 1 - anaMetaInd: - $ref: '#/components/schemas/AnalyticsMetadataIndication' - histAnaTimePeriod: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' - - TargetUeInformation: - description: Identifies the target UE information. - type: object - properties: - anyUe: - type: boolean - description: > - Identifies any UE when setting to "true". Default value is "false" if omitted. - supis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - gpsis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - minItems: 1 - intGroupIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' - minItems: 1 - - UeMobility: - description: Represents UE mobility information. - type: object - properties: - ts: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - recurringTime: - $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime' - duration: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - durationVariance: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - locInfos: - type: array - items: - $ref: '#/components/schemas/LocationInfo' - minItems: 1 - directionInfos: - type: array - items: - $ref: '#/components/schemas/DirectionInfo' - minItems: 1 - allOf: - - required: [duration] - - required: [locInfos] - - oneOf: - - required: [ts] - - required: [recurringTime] - - LocationInfo: - description: Represents UE location information. - type: object - properties: - loc: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' - geoLoc: - $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' - ratio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - geoDistrInfos: - type: array - items: - $ref: '#/components/schemas/GeoDistributionInfo' - minItems: 1 - distThreshold: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - required: - - loc - - DirectionInfo: - description: Represents the UE direction information. - type: object - properties: - supi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - gpsi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - numOfUe: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - avrSpeed: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - ratio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - direction: - $ref: '#/components/schemas/Direction' - required: - - direction - oneOf: - - required: [supi] - - required: [gpsi] - - GeoDistributionInfo: - description: Represents the geographical distribution of the UEs. - type: object - properties: - loc: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' - supis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - gpsis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - minItems: 1 - required: - - loc - oneOf: - - required: [supis] - - required: [gpsis] - - UeCommunication: - description: Represents UE communication information. - type: object - properties: - commDur: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - commDurVariance: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - perioTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - perioTimeVariance: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - ts: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - tsVariance: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - recurringTime: - $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime' - trafChar: - $ref: '#/components/schemas/TrafficCharacterization' - ratio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - perioCommInd: - type: boolean - description: > - This attribute indicates whether the UE communicates periodically or not. Set to "true" - to indicate the UE communicates periodically, otherwise set to "false" or omitted. - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - anaOfAppList: - $ref: '#/components/schemas/AppListForUeComm' - sessInactTimer: - $ref: '#/components/schemas/SessInactTimerForUeComm' - allOf: - - required: [commDur] - - required: [trafChar] - - oneOf: - - required: [ts] - - required: [recurringTime] - TrafficCharacterization: - description: Identifies the detailed traffic characterization. - type: object - properties: - dnn: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - appId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - fDescs: - type: array - items: - $ref: '#/components/schemas/IpEthFlowDescription' - minItems: 1 - maxItems: 2 - ulVol: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - ulVolVariance: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - dlVol: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - dlVolVariance: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - anyOf: - - required: [ulVol] - - required: [dlVol] - - UserDataCongestionInfo: - description: Represents the user data congestion information. - type: object - properties: - networkArea: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - congestionInfo: - $ref: '#/components/schemas/CongestionInfo' - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - required: - - networkArea - - congestionInfo - - CongestionInfo: - description: Represents the congestion information. - type: object - properties: - congType: - $ref: '#/components/schemas/CongestionType' - timeIntev: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' - nsi: - $ref: '#/components/schemas/ThresholdLevel' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - topAppListUl: - type: array - items: - $ref: '#/components/schemas/TopApplication' - minItems: 1 - topAppListDl: - type: array - items: - $ref: '#/components/schemas/TopApplication' - minItems: 1 - required: - - congType - - timeIntev - - nsi - - TopApplication: - description: Top application that contributes the most to the traffic. - type: object - properties: - appId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - ipTrafficFilter: - $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' - ratio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - oneOf: - - required: [appId] - - required: [ipTrafficFilter] - - QosSustainabilityInfo: - description: Represents the QoS Sustainability information. - type: object - properties: - areaInfo: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - fineAreaInfos: - type: array - items: - $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' - minItems: 1 - description: > - This attribute contains the geographical locations in a fine granularity. - startTs: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - endTs: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - qosFlowRetThd: - $ref: '#/components/schemas/RetainabilityThreshold' - ranUeThrouThd: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - oneOf: - - required: [qosFlowRetThd] - - required: [ranUeThrouThd] - - QosRequirement: - description: Represents the QoS requirements. - type: object - properties: - 5qi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' - gfbrUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - gfbrDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - resType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/QosResourceType' - pdb: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' - per: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' - deviceSpeed: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' - deviceType: - $ref: '#/components/schemas/DeviceType' - oneOf: - - required: [5qi] - - required: [resType] - - ThresholdLevel: - description: Represents a threshold level. - type: object - properties: - congLevel: - type: integer - nfLoadLevel: - type: integer - nfCpuUsage: - type: integer - nfMemoryUsage: - type: integer - nfStorageUsage: - type: integer - avgTrafficRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - maxTrafficRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - minTrafficRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - aggTrafficRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - varTrafficRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - avgPacketDelay: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' - maxPacketDelay: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' - varPacketDelay: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - avgPacketLossRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' - maxPacketLossRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' - varPacketLossRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - svcExpLevel: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - speed: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - - NfLoadLevelInformation: - description: Represents load level information of a given NF instance. - type: object - properties: - nfType: - $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' - nfInstanceId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - nfSetId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' - nfStatus: - $ref: '#/components/schemas/NfStatus' - nfCpuUsage: - type: integer - nfMemoryUsage: - type: integer - nfStorageUsage: - type: integer - nfLoadLevelAverage: - type: integer - nfLoadLevelpeak: - type: integer - nfLoadAvgInAoi: - type: integer - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - allOf: - - required: [nfType] - - required: [nfInstanceId] - - anyOf: - - required: [nfStatus] - - required: [nfCpuUsage] - - required: [nfMemoryUsage] - - required: [nfStorageUsage] - - required: [nfLoadLevelAverage] - - required: [nfLoadLevelPeak] - - NfStatus: - description: Contains the percentage of time spent on various NF states. - type: object - properties: - statusRegistered: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - statusUnregistered: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - statusUndiscoverable: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - anyOf: - - required: [statusRegistered] - - required: [statusUnregistered] - - required: [statusUndiscoverable] - - AnySlice: - type: boolean - description: > - "false" represents not applicable for all slices. "true" represents applicable for all slices. - - LoadLevelInformation: - type: integer - description: > - Load level information of the network slice and the optionally associated network slice - instance. - - AbnormalBehaviour: - description: Represents the abnormal behaviour information. - type: object - properties: - supis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - excep: - $ref: '#/components/schemas/Exception' - dnn: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - ratio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - addtMeasInfo: - $ref: '#/components/schemas/AdditionalMeasurement' - required: - - excep - - Exception: - description: Represents the Exception information. - type: object - properties: - excepId: - $ref: '#/components/schemas/ExceptionId' - excepLevel: - type: integer - excepTrend: - $ref: '#/components/schemas/ExceptionTrend' - required: - - excepId - - AdditionalMeasurement: - description: Represents additional measurement information. - type: object - properties: - unexpLoc: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - unexpFlowTeps: - type: array - items: - $ref: '#/components/schemas/IpEthFlowDescription' - minItems: 1 - unexpWakes: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - minItems: 1 - ddosAttack: - $ref: '#/components/schemas/AddressList' - wrgDest: - $ref: '#/components/schemas/AddressList' - circums: - type: array - items: - $ref: '#/components/schemas/CircumstanceDescription' - minItems: 1 - - IpEthFlowDescription: - description: Contains the description of an Uplink and/or Downlink Ethernet flow. - type: object - properties: - ipTrafficFilter: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' - ethTrafficFilter: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' - oneOf: - - required: [ipTrafficFilter] - - required: [ethTrafficFilter] - - AddressList: - description: Represents a list of IPv4 and/or IPv6 addresses. - type: object - properties: - ipv4Addrs: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' - minItems: 1 - ipv6Addrs: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' - minItems: 1 - - CircumstanceDescription: - description: Contains the description of a circumstance. - type: object - properties: - freq: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - tm: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - locArea: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - vol: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - - RetainabilityThreshold: - description: Represents a QoS flow retainability threshold. - type: object - properties: - relFlowNum: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - relTimeUnit: - $ref: '#/components/schemas/TimeUnit' - relFlowRatio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - oneOf: - - allOf: - - required: [relFlowNum] - - required: [relTimeUnit] - - required: [relFlowRatio] - - NetworkPerfRequirement: - description: Represents a network performance requirement. - type: object - properties: - nwPerfType: - $ref: '#/components/schemas/NetworkPerfType' - relativeRatio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - absoluteNum: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - orderCriterion: - $ref: '#/components/schemas/NetworkPerfOrderCriterion' - rscUsgReq: - $ref: '#/components/schemas/ResourceUsageRequirement' - required: - - nwPerfType - not: - required: [relativeRatio, absoluteNum] - - NetworkPerfInfo: - description: Represents the network performance information. - type: object - properties: - networkArea: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - nwPerfType: - $ref: '#/components/schemas/NetworkPerfType' - anaPeriod: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' - relativeRatio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - absoluteNum: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - rscUsgReq: - $ref: '#/components/schemas/ResourceUsageRequirement' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - allOf: - - required: [networkArea] - - required: [nwPerfType] - - oneOf: - - required: [relativeRatio] - - required: [absoluteNum] - - FailureEventInfo: - description: Contains information on the event for which the subscription is not successful. - type: object - properties: - event: - $ref: '#/components/schemas/NwdafEvent' - failureCode: - $ref: '#/components/schemas/NwdafFailureCode' - required: - - event - - failureCode - - AnalyticsMetadataIndication: - description: > - Contains analytics metadata information requested to be used during analytics generation. - type: object - properties: - dataWindow: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' - dataStatProps: - type: array - items: - $ref: '#/components/schemas/DatasetStatisticalProperty' - minItems: 1 - strategy: - $ref: '#/components/schemas/OutputStrategy' - aggrNwdafIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - minItems: 1 - - AnalyticsMetadataInfo: - description: Contains analytics metadata information required for analytics aggregation. - type: object - properties: - numSamples: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - dataWindow: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' - dataStatProps: - type: array - items: - $ref: '#/components/schemas/DatasetStatisticalProperty' - minItems: 1 - strategy: - $ref: '#/components/schemas/OutputStrategy' - accuracy: - $ref: '#/components/schemas/Accuracy' - NumberAverage: - description: Represents average and variance information. - type: object - properties: - number: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - variance: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - skewness: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - required: - - number - - variance - - AnalyticsSubscriptionsTransfer: - description: Contains information about a request to transfer analytics subscriptions. - type: object - properties: - subsTransInfos: - type: array - items: - $ref: '#/components/schemas/SubscriptionTransferInfo' - minItems: 1 - failTransEventReports: - type: array - items: - $ref: '#/components/schemas/NwdafEvent' - minItems: 1 - required: - - subsTransInfos - - SubscriptionTransferInfo: - description: Contains information about subscriptions that are requested to be transferred. - type: object - properties: - transReqType: - $ref: '#/components/schemas/TransferRequestType' - nwdafEvSub: - $ref: '#/components/schemas/NnwdafEventsSubscription' - consumerId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - contextId: - $ref: '#/components/schemas/AnalyticsContextIdentifier' - sourceNfIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - minItems: 1 - sourceSetIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' - minItems: 1 - modelInfo: - type: array - items: - $ref: '#/components/schemas/ModelInfo' - minItems: 1 - required: - - transReqType - - nwdafEvSub - - consumerId - - ModelInfo: - description: Contains information about an ML model. - type: object - properties: - analyticsId: - $ref: '#/components/schemas/NwdafEvent' - mlModelInfos: - type: array - items: - $ref: '#/components/schemas/MLModelInfo' - minItems: 1 - required: - - analyticsId - - mlModelInfos - MLModelInfo: - description: Contains information about an ML models. - type: object - properties: - mlFileAddrs: - type: array - items: - $ref: 'TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLModelAddr' - minItems: 1 - modelProvId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - modelProvSetId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' - oneOf: - - required: [modelProvId] - - required: [modelProvSetId] - - AnalyticsContextIdentifier: - description: Contains information about available analytics contexts. - type: object - properties: - subscriptionId: - type: string - description: The identifier of a subscription. - nfAnaCtxts: - type: array - items: - $ref: '#/components/schemas/NwdafEvent' - minItems: 1 - description: > - List of analytics types for which NF related analytics contexts can be retrieved. - ueAnaCtxts: - type: array - items: - $ref: '#/components/schemas/UeAnalyticsContextDescriptor' - minItems: 1 - description: > - List of objects that indicate for which SUPI and analytics types combinations analytics - context can be retrieved. - allOf: - - anyOf: - - required: [nfAnaCtxts] - - required: [ueAnaCtxts] - - required: [subscriptionId] - - UeAnalyticsContextDescriptor: - description: Contains information about available UE related analytics contexts. - type: object - properties: - supi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - anaTypes: - type: array - items: - $ref: '#/components/schemas/NwdafEvent' - minItems: 1 - description: > - List of analytics types for which UE related analytics contexts can be retrieved. - required: - - supi - - anaTypes - - DnPerfInfo: - description: Represents DN performance information. - type: object - properties: - appId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - dnn: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - dnPerf: - type: array - items: - $ref: '#/components/schemas/DnPerf' - minItems: 1 - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - required: - - dnPerf - - DnPerf: - description: Represents DN performance for the application. - type: object - properties: - appServerInsAddr: - $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' - upfInfo: - $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/UpfInformation' - dnai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' - perfData: - $ref: '#/components/schemas/PerfData' - spatialValidCon: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - temporalValidCon: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' - required: - - perfData - - PerfData: - description: Represents DN performance data. - type: object - properties: - avgTrafficRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - maxTrafficRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - minTrafficRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - aggTrafficRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - varTrafficRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - trafRateUeIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - avePacketDelay: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' - maxPacketDelay: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' - varPacketDelay: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - packDelayUeIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - avgPacketLossRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' - maxPacketLossRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' - varPacketLossRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - packLossUeIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - numOfUe: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - - DispersionRequirement: - description: Represents the dispersion analytics requirements. - type: object - properties: - disperType: - $ref: '#/components/schemas/DispersionType' - classCriters: - type: array - items: - $ref: '#/components/schemas/ClassCriterion' - minItems: 1 - rankCriters: - type: array - items: - $ref: '#/components/schemas/RankingCriterion' - minItems: 1 - dispOrderCriter: - $ref: '#/components/schemas/DispersionOrderingCriterion' - order: - $ref: '#/components/schemas/MatchingDirection' - required: - - disperType - - ClassCriterion: - description: > - Indicates the dispersion class criterion for fixed, camper and/or traveller UE, and/or the - top-heavy UE dispersion class criterion. - type: object - properties: - disperClass: - $ref: '#/components/schemas/DispersionClass' - classThreshold: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - thresMatch: - $ref: '#/components/schemas/MatchingDirection' - required: - - disperClass - - classThreshold - - thresMatch - - RankingCriterion: - description: Indicates the usage ranking criterion between the high, medium and low usage UE. - type: object - properties: - highBase: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - lowBase: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - required: - - highBase - - lowBase - - DispersionInfo: - description: > - Represents the Dispersion information. When subscribed event is "DISPERSION", the - "disperInfos" attribute shall be included. - type: object - properties: - tsStart: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - tsDuration: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - disperCollects: - type: array - items: - $ref: '#/components/schemas/DispersionCollection' - minItems: 1 - disperType: - $ref: '#/components/schemas/DispersionType' - required: - - tsStart - - tsDuration - - disperCollects - - disperType - - DispersionCollection: - description: Dispersion collection per UE location or per slice. - type: object - properties: - ueLoc: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - supis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - gpsis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - minItems: 1 - appVolumes: - type: array - items: - $ref: '#/components/schemas/ApplicationVolume' - minItems: 1 - disperAmount: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - disperClass: - $ref: '#/components/schemas/DispersionClass' - usageRank: - type: integer - description: Integer where the allowed values correspond to 1, 2, 3 only. - minimum: 1 - maximum: 3 - percentileRank: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - ueRatio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - allOf: - - oneOf: - - required: [ueLoc] - - required: [snssai] - - anyOf: - - required: [disperAmount] - - required: [disperClass] - - required: [usageRank] - - required: [percentileRank] - - ApplicationVolume: - description: Application data volume per Application Id. - type: object - properties: - appId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - appVolume: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - required: - - appId - - appVolume - - RedundantTransmissionExpReq: - description: Represents other redundant transmission experience analytics requirements. - type: object - properties: - redTOrderCriter: - $ref: '#/components/schemas/RedTransExpOrderingCriterion' - order: - $ref: '#/components/schemas/MatchingDirection' - - RedundantTransmissionExpInfo: - description: > - The redundant transmission experience related information. When subscribed event is - "RED_TRANS_EXP", the "redTransInfos" attribute shall be included. - type: object - properties: - spatialValidCon: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - dnn: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - redTransExps: - type: array - items: - $ref: '#/components/schemas/RedundantTransmissionExpPerTS' - minItems: 1 - required: - - redTransExps - - RedundantTransmissionExpPerTS: - description: The redundant transmission experience per Time Slot. - type: object - properties: - tsStart: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - tsDuration: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - obsvRedTransExp: - $ref: '#/components/schemas/ObservedRedundantTransExp' - redTransStatus: - type: boolean - description: > - Redundant Transmission Status. Set to "true" if redundant transmission was activated, - otherwise set to "false". Default value is "false" if omitted. - ueRatio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - required: - - tsStart - - tsDuration - - obsvRedTransExp - ObservedRedundantTransExp: - description: Represents the observed redundant transmission experience related information. - type: object - properties: - avgPktDropRateUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' - varPktDropRateUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - avgPktDropRateDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' - varPktDropRateDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - avgPktDelayUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' - varPktDelayUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - avgPktDelayDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' - varPktDelayDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - avgE2ePktDelayUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' - varE2ePktDelayUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - avgE2ePktDelayDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' - varE2ePktDelayDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - avgE2ePktLossRateUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' - varE2ePktLossRateUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - avgE2ePktLossRateDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' - varE2ePktLossRateDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - - WlanPerformanceReq: - description: Represents other WLAN performance analytics requirements. - type: object - properties: - ssIds: - type: array - items: - type: string - minItems: 1 - bssIds: - type: array - items: - type: string - minItems: 1 - wlanOrderCriter: - $ref: '#/components/schemas/WlanOrderingCriterion' - order: - $ref: '#/components/schemas/MatchingDirection' - - WlanPerformanceInfo: - description: The WLAN performance related information. - type: object - properties: - networkArea: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - wlanPerSsidInfos: - type: array - items: - $ref: '#/components/schemas/WlanPerSsIdPerformanceInfo' - minItems: 1 - wlanPerUeIdInfos: - type: array - items: - $ref: '#/components/schemas/WlanPerUeIdPerformanceInfo' - minItems: 1 - description: > - WLAN performance information for UE Id(s) of WLAN access points deployed in the Area - of Interest. - required: - - wlanPerSsidInfos - - WlanPerSsIdPerformanceInfo: - description: The WLAN performance per SSID. - type: object - properties: - ssId: - type: string - wlanPerTsInfos: - type: array - items: - $ref: '#/components/schemas/WlanPerTsPerformanceInfo' - minItems: 1 - required: - - ssId - - wlanPerTsInfos - - WlanPerUeIdPerformanceInfo: - description: The WLAN performance per UE ID. - type: object - properties: - supi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - gpsi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - wlanPerTsInfos: - type: array - items: - $ref: '#/components/schemas/WlanPerTsPerformanceInfo' - minItems: 1 - description: > - WLAN performance information per Time Slot during the analytics target period. - required: - - wlanPerTsInfos - oneOf: - - required: [supi] - - required: [gpsi] - - WlanPerTsPerformanceInfo: - description: WLAN performance information per Time Slot during the analytics target period. - type: object - properties: - tsStart: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - tsDuration: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - rssi: - type: integer - rtt: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - trafficInfo: - $ref: '#/components/schemas/TrafficInformation' - numberOfUes: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - required: - - tsStart - - tsDuration - anyOf: - - required: [rssi] - - required: [rtt] - - required: [trafficInfo] - - required: [numberOfUes] - - TrafficInformation: - description: Traffic information including UL/DL data rate and/or Traffic volume. - type: object - properties: - uplinkRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - downlinkRate: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - uplinkVolume: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - downlinkVolume: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - totalVolume: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - anyOf: - - required: [uplinkRate] - - required: [downlinkRate] - - required: [uplinkVolume] - - required: [downlinkVolume] - - required: [totalVolume] - - AppListForUeComm: - description: Represents the analytics of the application list used by UE. - type: object - properties: - appId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - startTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - appDur: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - occurRatio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - spatialValidity: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - required: - - appId - - SessInactTimerForUeComm: - description: Represents the N4 Session inactivity timer. - type: object - properties: - n4SessId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' - sessInactiveTimer: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - required: - - n4SessId - - sessInactiveTimer - - DnPerformanceReq: - description: Represents other DN performance analytics requirements. - type: object - properties: - dnPerfOrderCriter: - $ref: '#/components/schemas/DnPerfOrderingCriterion' - order: - $ref: '#/components/schemas/MatchingDirection' - reportThresholds: - type: array - items: - $ref: '#/components/schemas/ThresholdLevel' - minItems: 1 - - RatFreqInformation: - description: Represents the RAT type and/or Frequency information. - type: object - properties: - allFreq: - type: boolean - description: > - Set to "true" to indicate to handle all the frequencies the NWDAF received, otherwise - set to "false" or omit. The "allFreq" attribute and the "freq" attribute are mutually - exclusive. - allRat: - type: boolean - description: > - Set to "true" to indicate to handle all the RAT Types the NWDAF received, otherwise - set to "false" or omit. The "allRat" attribute and the "ratType" attribute are mutually - exclusive. - freq: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ArfcnValueNR' - ratType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' - svcExpThreshold: - $ref: '#/components/schemas/ThresholdLevel' - matchingDir: - $ref: '#/components/schemas/MatchingDirection' - - PrevSubInfo: - description: Information of the previous subscription. - type: object - properties: - producerId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - producerSetId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' - subscriptionId: - type: string - description: The identifier of a subscription. - nfAnaEvents: - type: array - items: - $ref: '#/components/schemas/NwdafEvent' - minItems: 1 - ueAnaEvents: - type: array - items: - $ref: '#/components/schemas/UeAnalyticsContextDescriptor' - minItems: 1 - required: - - subscriptionId - oneOf: - - required: [producerId] - - required: [producerSetId] - - ResourceUsage: - description: > - The current usage of the virtual resources assigned to the NF instances belonging to a - particular network slice instance. - type: object - properties: - cpuUsage: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - memoryUsage: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - storageUsage: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - - ConsumerNfInformation: - description: Represents the analytics consumer NF Information. - type: object - properties: - nfId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - nfSetId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' - taiList: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' - minItems: 1 - oneOf: - - oneOf: - - required: [nfId] - - required: [nfSetId] - - required: [taiList] - - UeCommReq: - description: UE communication analytics requirement. - type: object - properties: - orderCriterion: - $ref: '#/components/schemas/UeCommOrderCriterion' - orderDirection: - $ref: '#/components/schemas/MatchingDirection' - UeMobilityReq: - description: UE mobility analytics requirement. - type: object - properties: - orderCriterion: - $ref: '#/components/schemas/UeMobilityOrderCriterion' - orderDirection: - $ref: '#/components/schemas/MatchingDirection' - ueLocOrderInd: - type: boolean - description: > - UE Location order indication. Set to "true" to indicate the NWDAF to provide UE - locations in the UE Mobility analytics in time order, otherwise set to "false" or - omitted. - distThresholds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - minItems: 1 - description: Indicates the linear distance threshold. - - PduSessionInfo: - description: Represents combination of PDU Session parameter(s) information. - type: object - properties: - pduSessType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' - sscMode: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' - accessTypes: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' - minItems: 1 - - PfdDeterminationInfo: - description: Represents the PFD Determination information for a known application identifier. - type: object - properties: - appId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - suggPfdInfoList: - type: array - items: - $ref: '#/components/schemas/SuggestedPfdInfo' - minItems: 1 - required: - - appId - - suggPfdInfoList - - SuggestedPfdInfo: - description: Represents the suggested PFD information for the application identifier. - type: object - properties: - pfdId: - type: string - description: > - Identifier of the PFD (i.e. new PFD ID assigned by NWDAF or existing PFD ID retrieved - from UDR which was generated by NWDAF). - ip3TupleList: - type: array - items: - type: string - minItems: 1 - description: > - Represents a 3-tuple with protocol, server ip and server port for UL/DL - application traffic. The content of the string has the same encoding as the IPFilterRule - AVP value as defined in IETF RFC 6733. - urls: - type: array - items: - type: string - minItems: 1 - description: Represents the significant parts of the URL to be matched, e.g. host name. - domainNames: - type: array - items: - type: string - minItems: 1 - description: Represents Domain name matching criteria. - dnProtocol: - $ref: 'TS29122_PfdManagement.yaml#/components/schemas/DomainNameProtocol' - pfdConfidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - required: - - pfdId - - PduSesTrafficInfo: - description: Represents the PDU Set traffic analytics information. - type: object - properties: - supis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - dnn: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - tdMatchTrafs: - type: array - items: - $ref: '#/components/schemas/TdTraffic' - minItems: 1 - tdUnmatchTrafs: - type: array - items: - $ref: '#/components/schemas/TdTraffic' - minItems: 1 - allOf: - - anyOf: - - required: [dnn] - - required: [snssai] - - anyOf: - - required: [tdMatchTrafs] - - required: [tdUnmatchTrafs] - - TdTraffic: - description: Represents traffic that matches or unmatches Traffic Descriptor of URSP rule. - type: object - properties: - pduSesTrafReqs: - type: array - items: - $ref: '#/components/schemas/PduSesTrafficReq' - minItems: 1 - ulVol: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - dlVol: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - allVol: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - ulNumOfPkt: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - dlNumOfPkt: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - allNumOfPkt: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - - PduSesTrafficReq: - description: Represents the PDU Session traffic analytics requirements. - type: object - properties: - flowDescs: - type: array - items: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' - minItems: 1 - description: > - Indicates traffic flow filtering description(s) for IP flow(s). - appId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - domainDescs: - type: array - items: - type: string - minItems: 1 - description: > - FQDN(s) or a regular expression which are used as a domain name matching criteria. - oneOf: - - required: [flowDescs] - - required: [appId] - - required: [domainDescs] - - ResourceUsageRequirement: - description: resource usage requirement. - type: object - properties: - tfcDirc: - $ref: '#/components/schemas/TrafficDirection' - valExp: - $ref: '#/components/schemas/ValueExpression' - - E2eDataVolTransTimeReq: - description: Represents other E2E data volume transfer time analytics requirements. - type: object - properties: - criterion: - $ref: '#/components/schemas/E2eDataVolTransTimeCriterion' - order: - $ref: '#/components/schemas/MatchingDirection' - highTransTmThr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - lowTransTmThr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - repeatDataTrans: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - tsIntervalDataTrans: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - dataVolume: - $ref: '#/components/schemas/DataVolume' - maxNumberUes: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - oneOf: - - required: [repeatDataTrans] - - required: [tsIntervalDataTrans] - - DataVolume: - description: Data Volume including UL/DL. - type: object - properties: - uplinkVolume: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - downlinkVolume: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - anyOf: - - required: [uplinkVolume] - - required: [downlinkVolume] - - E2eDataVolTransTimeInfo: - description: > - Represents the E2E data volume transfer time analytics information when subscribed event is - "E2E_DATA_VOL_TRANS_TIME", the "dataVlTrnsTmInfos" attribute shall be included. - type: object - properties: - e2eDataVolTransTimes: - type: array - items: - $ref: '#/components/schemas/E2eDataVolTransTimePerTS' - minItems: 1 - e2eDataVolTransTimeUeLists: - type: array - items: - $ref: '#/components/schemas/E2eDataVolTransTimeUeList' - minItems: 1 - geoDistrInfos: - type: array - items: - $ref: '#/components/schemas/GeoDistributionInfo' - minItems: 1 - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - required: - - e2eDataVolTransTimes - - E2eDataVolTransTimePerTS: - description: Represents the E2E data volume transfer time analytics per Time Slot. - type: object - properties: - tsStart: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - tsDuration: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - e2eDataVolTransTimePerUe: - type: array - items: - $ref: '#/components/schemas/E2eDataVolTransTimePerUe' - minItems: 1 - required: - - tsStart - - tsDuration - - e2eDataVolTransTimePerUe - - E2eDataVolTransTimePerUe: - description: Represents the E2E data volume transfer time per UE. - type: object - properties: - supi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - gpsi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - snssai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - accessType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' - ratTypes: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' - minItems: 1 - description: The RAT types. - appId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - ueLoc: - $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' - dnn: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - spatialValidity: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - validityPeriod: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' - dataVolTransTime: - $ref: '#/components/schemas/DataVolumeTransferTime' - oneOf: - - required: [ueLoc] - - required: [snssai] - - E2eDataVolTransTimeUeList: - description: > - Contains the list of UEs classified based on experience level of E2E Data Volume Transfer - Time - type: object - properties: - highLevel: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - mediumLevel: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - lowLevel: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - lowRatio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - mediumRatio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - highRatio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - spatialValidity: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' - validityPeriod: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' - anyOf: - - required: [highLevel] - - required: [mediumLevel] - - required: [lowLevel] - - DataVolumeTransferTime: - description: > - Indicates the E2E data volume transfer time and the data volume used to derive the transfer - time. - type: object - properties: - uplinkVolume: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - avgTransTimeUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - varTransTimeUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - downlinkVolume: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' - avgTransTimeDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - varTransTimeDl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - - GeoLocation: - description: > - Represents a horizontal and optionally vertical location using either geographic - or local coordinates. - type: object - properties: - point: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Point' - pointAlt: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PointAltitude' - refPoint: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocalOrigin' - localCoords: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RelativeCartesianLocation' - anyOf: - - required: [point] - - required: [pointAlt] - - allOf: - - required: [refPoint] - - required: [localCoords] - - LocAccuracyReq: - description: > - Contains location accuracy analytics requirements. - type: object - properties: - accThres: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - accThresMatchDir: - $ref: '#/components/schemas/MatchingDirection' - inOutThres: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - inOutThresMatchDir: - $ref: '#/components/schemas/MatchingDirection' - posMethod: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethod' - - LocAccuracyInfo: - description: > - Contains location accuracy analytics. - type: object - properties: - locAccPerMeths: - type: array - items: - $ref: '#/components/schemas/LocAccuracyPerMethod' - minItems: 1 - description: Location accuracy information per positioning method. - inOutUePct: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - inOutInd: - type: boolean - description: Indicates if the target location is indoors or outdoors. - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - required: - - locAccPerMeths - not: - required: [inOutUePct, inOutInd] - - - LocAccuracyPerMethod: - description: > - Contains location accuracy analytics per positioning method. - type: object - properties: - posMethod: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethod' - locAcc: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - losNlosPct: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - losNlosInd: - type: boolean - description: Indicates whether the target location is measured with LOS or NLOS. - required: - - posMethod - - locAcc - - AccuracyReq: - description: Represents the analytics accuracy requirement information. - type: object - properties: - accuTimeWin: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' - accuPeriod: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - accuDevThr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - minNum: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - updatedAnaFlg: - type: boolean - description: > - Indicates the updated Analytics flag. Set to "true" indicates that the NWDAF can provide - the updated analytics if the analytics can be generated within the analytics accuracy - information time window, which is specified by "accuTimeWin" attribute. - Otherwise set to “false”. Default value is “false” if omitted. - correctionInterval: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - - AccuracyInfo: - description: The analytics accuracy information. - type: object - properties: - accuracyVal: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - accuSampleNbr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - anaAccuInd: - $ref: '#/components/schemas/AnalyticsAccuracyIndication' - required: - - accuracyVal - - MovBehavReq: - description: Represents the Movement Behaviour analytics requirements. - type: object - properties: - locationGranReq: - $ref: '#/components/schemas/LocInfoGranularity' - reportThresholds: - $ref: '#/components/schemas/ThresholdLevel' - - MovBehavInfo: - description: Represents the Movement Behaviour information. - type: object - properties: - geoLoc: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicalCoordinates' - movBehavs: - type: array - items: - $ref: '#/components/schemas/MovBehav' - minItems: 1 - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - - MovBehav: - description: Represents the Movement Behaviour information per time slot. - type: object - properties: - tsStart: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - tsDuration: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - numOfUe: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - ratio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - avrSpeed: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - speedThresdInfos: - type: array - items: - $ref: '#/components/schemas/SpeedThresholdInfo' - minItems: 1 - directionUeInfos: - type: array - items: - $ref: '#/components/schemas/DirectionInfo' - minItems: 1 - required: - - tsStart - - tsDuration - - SpeedThresholdInfo: - description: UEs information whose speed is faster than the speed threshold. - type: object - properties: - speedThr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - numOfUe: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - ratio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - - RelProxReq: - description: Represents the Relative Proximity analytics requirements. - type: object - properties: - direction: - type: array - items: - $ref: '#/components/schemas/Direction' - minItems: 1 - numOfUe: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - proximityCrits: - type: array - items: - $ref: '#/components/schemas/ProximityCriterion' - minItems: 1 - - RelProxInfo: - description: Represents the Relative Proximity information. - type: object - properties: - tsStart: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - tsDuration: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' - supis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - gpsis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - minItems: 1 - ueProximities: - type: array - items: - $ref: '#/components/schemas/UeProximity' - minItems: 1 - ttcInfo: - $ref: '#/components/schemas/TimeToCollisionInfo' - required: - - tsStart - - tsDuration - - ueProximities - - UeProximity: - description: Represents the Observed or Predicted proximity information. - type: object - properties: - ueDistance: - type: integer - ueVelocity: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' - avrSpeed: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - locOrientation: - $ref: '#/components/schemas/LocationOrientation' - ueTrajectories: - type: array - items: - $ref: '#/components/schemas/UeTrajectory' - minItems: 1 - ratio: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - - UeTrajectory: - description: Represents timestamped UE positions. - type: object - properties: - supi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - gpsi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - timestampedLocs: - type: array - items: - $ref: '#/components/schemas/TimestampedLocation' - minItems: 1 - required: - - timestampedLocs - oneOf: - - required: [supi] - - required: [gpsi] - - TimestampedLocation: - description: The timestamped locations of the trajectory of the UE. - type: object - properties: - ts: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - locInfo: - items: - $ref: '#/components/schemas/LocationInfo' - required: - - ts - - locInfo - - TimeToCollisionInfo: - description: Represents Time To Collision (TTC) information. - type: object - properties: - ttc: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - accuracy: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - confidence: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - - AnalyticsFeedbackInfo: - description: Analytics feedback information. - type: object - properties: - actionTimes: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - minItems: 1 - description: The times at which an action was taken. - usedAnaTypes: - type: array - items: - $ref: '#/components/schemas/NwdafEvent' - minItems: 1 - description: The analytics types that were used to take the action. - impactInd: - type: boolean - description: Indication about the impact of an action on the ground truth data. - required: - - actionTimes - - RoamingInfo: - description: Information related to roaming analytics. - type: object - properties: - plmnId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' - aois: - type: array - items: - $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' - minItems: 1 - description: Areas of Interest in the HPLMN or the VPLMN. - servingNfIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - minItems: 1 - description: NF ID(s) of the NF(s) serving the roaming UE(s) in the VPLMN. - servingNfSetIds: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' - minItems: 1 - description: NF Set ID(s) of the NF Set(s) serving the roaming UE(s) in the VPLMN. - -# -# ENUMERATIONS DATA TYPES -# - NotificationMethod: - anyOf: - - type: string - enum: - - PERIODIC - - THRESHOLD - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the notification methods for the subscribed events. - Possible values are: - - PERIODIC: The notification of the subscribed NWDAF Event is periodical. The period - between the notifications is identified by repetitionPeriod and represents time in - seconds. - - THRESHOLD: The subscribe of NWDAF Event is upon threshold exceeded. - - NwdafEvent: - anyOf: - - type: string - enum: - - SLICE_LOAD_LEVEL - - NETWORK_PERFORMANCE - - NF_LOAD - - SERVICE_EXPERIENCE - - UE_MOBILITY - - UE_COMMUNICATION - - QOS_SUSTAINABILITY - - ABNORMAL_BEHAVIOUR - - USER_DATA_CONGESTION - - NSI_LOAD_LEVEL - - DN_PERFORMANCE - - DISPERSION - - RED_TRANS_EXP - - WLAN_PERFORMANCE - - SM_CONGESTION - - PFD_DETERMINATION - - PDU_SESSION_TRAFFIC - - E2E_DATA_VOL_TRANS_TIME - - MOVEMENT_BEHAVIOUR - - NUM_OF_UE - - MOV_UE_RATIO - - AVR_SPEED - - SPEED_THRESHOLD - - MOV_UE_DIRECTION - - LOC_ACCURACY - - RELATIVE_PROXIMITY - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Describes the NWDAF Events. - Possible values are: - - SLICE_LOAD_LEVEL: Indicates that the event subscribed is load level information of Network - Slice. - - NETWORK_PERFORMANCE: Indicates that the event subscribed is network performance - information. - - NF_LOAD: Indicates that the event subscribed is load level and status of one or several - Network Functions. - - SERVICE_EXPERIENCE: Indicates that the event subscribed is service experience. - - UE_MOBILITY: Indicates that the event subscribed is UE mobility information. - - UE_COMMUNICATION: Indicates that the event subscribed is UE communication information. - - QOS_SUSTAINABILITY: Indicates that the event subscribed is QoS sustainability. - - ABNORMAL_BEHAVIOUR: Indicates that the event subscribed is abnormal behaviour. - - USER_DATA_CONGESTION: Indicates that the event subscribed is user data congestion - information. - - NSI_LOAD_LEVEL: Indicates that the event subscribed is load level information of Network - Slice and the optionally associated Network Slice Instance. - - DN_PERFORMANCE: Indicates that the event subscribed is DN performance information. - - DISPERSION: Indicates that the event subscribed is dispersion information. - - RED_TRANS_EXP: Indicates that the event subscribed is redundant transmission experience. - - WLAN_PERFORMANCE: Indicates that the event subscribed is WLAN performance. - - SM_CONGESTION: Indicates the Session Management Congestion Control Experience information - for specific DNN and/or S-NSSAI. - - PFD_DETERMINATION: Indicates that the event subscribed is the PFD Determination nformation - for known application identifier(s). - - PDU_SESSION_TRAFFIC: Indicates that the event subscribed is the PDU Session traffic - information. - - E2E_DATA_VOL_TRANS_TIME: Indicates that the event subscribed is of E2E data volume - transfer time. - - MOVEMENT_BEHAVIOUR: Indicates that the event subscribed is the Movement Behaviour - information. - - LOC_ACCURACY: Indicates that the event subscribed is of location accuracy. - - RELATIVE_PROXIMITY: Indicates that the event subscribed is the Relative Proximity - information. - - Accuracy: - anyOf: - - type: string - enum: - - LOW - - MEDIUM - - HIGH - - HIGHEST - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the preferred level of accuracy of the analytics. - Possible values are: - - LOW: Low accuracy. - - MEDIUM: Medium accuracy. - - HIGH: High accuracy. - - HIGHEST: Highest accuracy. - - CongestionType: - anyOf: - - type: string - enum: - - USER_PLANE - - CONTROL_PLANE - - USER_AND_CONTROL_PLANE - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Indicates the congestion analytics type. - Possible values are: - - USER_PLANE: The congestion analytics type is User Plane. - - CONTROL_PLANE: The congestion analytics type is Control Plane. - - USER_AND_CONTROL_PLANE: The congestion analytics type is User Plane and Control Plane. - - ExceptionId: - anyOf: - - type: string - enum: - - UNEXPECTED_UE_LOCATION - - UNEXPECTED_LONG_LIVE_FLOW - - UNEXPECTED_LARGE_RATE_FLOW - - UNEXPECTED_WAKEUP - - SUSPICION_OF_DDOS_ATTACK - - WRONG_DESTINATION_ADDRESS - - TOO_FREQUENT_SERVICE_ACCESS - - UNEXPECTED_RADIO_LINK_FAILURES - - PING_PONG_ACROSS_CELLS - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Describes the Exception Id. - Possible values are: - - UNEXPECTED_UE_LOCATION: Unexpected UE location. - - UNEXPECTED_LONG_LIVE_FLOW: Unexpected long-live rate flows. - - UNEXPECTED_LARGE_RATE_FLOW: Unexpected large rate flows. - - UNEXPECTED_WAKEUP: Unexpected wakeup. - - SUSPICION_OF_DDOS_ATTACK: Suspicion of DDoS attack. - - WRONG_DESTINATION_ADDRESS: Wrong destination address. - - TOO_FREQUENT_SERVICE_ACCESS: Too frequent Service Access. - - UNEXPECTED_RADIO_LINK_FAILURES: Unexpected radio link failures. - - PING_PONG_ACROSS_CELLS: Ping-ponging across neighbouring cells. - - ExceptionTrend: - anyOf: - - type: string - enum: - - UP - - DOWN - - UNKNOW - - STABLE - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the Exception Trend. - Possible values are: - - UP: Up trend of the exception level. - - DOWN: Down trend of the exception level. - - UNKNOW: Unknown trend of the exception level. - - STABLE: Stable trend of the exception level. - - TimeUnit: - anyOf: - - type: string - enum: - - MINUTE - - HOUR - - DAY - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the unit for the session active time. - Possible values are: - - MINUTE: Time unit is per minute. - - HOUR: Time unit is per hour. - - DAY: Time unit is per day. - - NetworkPerfType: - anyOf: - - type: string - enum: - - GNB_ACTIVE_RATIO - - GNB_COMPUTING_USAGE - - GNB_MEMORY_USAGE - - GNB_DISK_USAGE - - GNB_RSC_USAGE_OVERALL_TRAFFIC - - GNB_RSC_USAGE_GBR_TRAFFIC - - GNB_RSC_USAGE_DELAY_CRIT_GBR_TRAFFIC - - NUM_OF_UE - - SESS_SUCC_RATIO - - HO_SUCC_RATIO - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the network performance types. - Possible values are: - - GNB_ACTIVE_RATIO: Indicates that the network performance requirement is gNodeB active - (i.e. up and running) rate. Indicates the ratio of gNB active (i.e. up and running) number - to the total number of gNB. - - GNB_COMPUTING_USAGE: Indicates gNodeB computing resource usage. - - GNB_MEMORY_USAGE: Indicates gNodeB memory usage. - - GNB_DISK_USAGE: Indicates gNodeB disk usage. - - GNB_RSC_USAGE_OVERALL_TRAFFIC: The gNB resource usage. - - GNB_RSC_USAGE_GBR_TRAFFIC: The gNB resource usage for GBR traffic. - - GNB_RSC_USAGE_DELAY_CRIT_GBR_TRAFFIC: The gNB resource usage for Delay-critical GBR - traffic. - - NUM_OF_UE: Indicates number of UEs. - - SESS_SUCC_RATIO: Indicates ratio of successful setup of PDU sessions to total PDU - session setup attempts. - - HO_SUCC_RATIO: Indicates Ratio of successful handovers to the total handover attempts. - - ExpectedAnalyticsType: - anyOf: - - type: string - enum: - - MOBILITY - - COMMUN - - MOBILITY_AND_COMMUN - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the expected UE analytics type. - Possible values are: - - MOBILITY: Mobility related abnormal behaviour analytics is expected by the consumer. - - COMMUN: Communication related abnormal behaviour analytics is expected by the consumer. - - MOBILITY_AND_COMMUN: Both mobility and communication related abnormal behaviour analytics - is expected by the consumer. - - MatchingDirection: - anyOf: - - type: string - enum: - - ASCENDING - - DESCENDING - - CROSSED - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the matching direction when crossing a threshold. - Possible values are: - - ASCENDING: Threshold is crossed in ascending direction. - - DESCENDING: Threshold is crossed in descending direction. - - CROSSED: Threshold is crossed either in ascending or descending direction. - - NwdafFailureCode: - anyOf: - - type: string - enum: - - UNAVAILABLE_DATA - - BOTH_STAT_PRED_NOT_ALLOWED - - PREDICTION_NOT_ALLOWED - - UNSATISFIED_REQUESTED_ANALYTICS_TIME - - NO_ROAMING_SUPPORT - - OTHER - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the failure reason. - Possible values are: - - UNAVAILABLE_DATA: Indicates the requested statistics information for the event is rejected - since necessary data to perform the service is unavailable. - - BOTH_STAT_PRED_NOT_ALLOWED: Indicates the requested analysis information for the event is - rejected since the start time is in the past and the end time is in the future, which - means the NF service consumer requested both statistics and prediction for the analytics. - - PREDICTION_NOT_ALLOWED: Indicates that the request for the prediction of the analytics - event is not allowed. - - UNSATISFIED_REQUESTED_ANALYTICS_TIME: Indicates that the requested event is rejected since - the analytics information is not ready when the time indicated by the "timeAnaNeeded" - attribute (as provided during the creation or modification of subscription) is reached. - - NO_ROAMING_SUPPORT: Indicates that the request shall be rejected because roaming analytics - or data are required and the NWDAF neither supports roaming exchange capabilitiy nor can - it forward the request to another NWDAF. - - OTHER: Indicates the requested analysis information for the event is rejected due to other - reasons. - - AnalyticsMetadata: - anyOf: - - type: string - enum: - - NUM_OF_SAMPLES - - DATA_WINDOW - - DATA_STAT_PROPS - - STRATEGY - - ACCURACY - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the types of analytics metadata information that can be requested. - Possible values are: - - NUM_OF_SAMPLES: Number of data samples used for the generation of the output analytics. - - DATA_WINDOW: Data time window of the data samples. - - DATA_STAT_PROPS: Dataset statistical properties of the data used to generate the - analytics. - - STRATEGY: Output strategy used for the reporting of the analytics. - - ACCURACY: Level of accuracy reached for the analytics. - - DatasetStatisticalProperty: - anyOf: - - type: string - enum: - - UNIFORM_DIST_DATA - - NO_OUTLIERS - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the dataset statistical properties. - Possible values are: - - UNIFORM_DIST_DATA: Indicates the use of data samples that are uniformly distributed - according to the different aspects of the requested analytics. - - NO_OUTLIERS: Indicates that the data samples shall disregard data samples that are at - the extreme boundaries of the value range. - - OutputStrategy: - anyOf: - - type: string - enum: - - BINARY - - GRADIENT - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the output strategy used for the analytics reporting. - Possible values are: - - BINARY: Indicates that the analytics shall only be reported when the requested level - of accuracy is reached within a cycle of periodic notification. - - GRADIENT: Indicates that the analytics shall be reported according with the periodicity - irrespective of whether the requested level of accuracy has been reached or not. - - TransferRequestType: - anyOf: - - type: string - enum: - - PREPARE - - TRANSFER - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the request type for the analytics subscription transfer. - Possible values are: - - PREPARE: Indicates that the request is for analytics subscription transfer preparation. - - TRANSFER: Indicates that the request is for analytics subscription transfer execution. - - AnalyticsSubset: - anyOf: - - type: string - enum: - - NUM_OF_UE_REG - - NUM_OF_PDU_SESS_ESTBL - - RES_USAGE - - NUM_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR - - PERIOD_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR - - EXCEED_LOAD_LEVEL_THR_IND - - LIST_OF_TOP_APP_UL - - LIST_OF_TOP_APP_DL - - NF_STATUS - - NF_RESOURCE_USAGE - - NF_LOAD - - NF_PEAK_LOAD - - NF_LOAD_AVG_IN_AOI - - DISPER_AMOUNT - - DISPER_CLASS - - RANKING - - PERCENTILE_RANKING - - RSSI - - RTT - - TRAFFIC_INFO - - NUMBER_OF_UES - - APP_LIST_FOR_UE_COMM - - N4_SESS_INACT_TIMER_FOR_UE_COMM - - AVG_TRAFFIC_RATE - - MAX_TRAFFIC_RATE - - AGG_TRAFFIC_RATE - - VAR_TRAFFIC_RATE - - AVG_PACKET_DELAY - - MAX_PACKET_DELAY - - VAR_PACKET_DELAY - - AVG_PACKET_LOSS_RATE - - MAX_PACKET_LOSS_RATE - - VAR_PACKET_LOSS_RATE - - UE_LOCATION - - LIST_OF_HIGH_EXP_UE - - LIST_OF_MEDIUM_EXP_UE - - LIST_OF_LOW_EXP_UE - - AVG_UL_PKT_DROP_RATE - - VAR_UL_PKT_DROP_RATE - - AVG_DL_PKT_DROP_RATE - - VAR_DL_PKT_DROP_RATE - - AVG_UL_PKT_DELAY - - VAR_UL_PKT_DELAY - - AVG_DL_PKT_DELAY - - VAR_DL_PKT_DELAY - - TRAFFIC_MATCH_TD - - TRAFFIC_UNMATCH_TD - - NUMBER_OF_UE - - UE_GEOG_DIST - - UE_DIRECTION - - AVG_E2E_UL_PKT_DELAY - - VAR_E2E_UL_PKT_DELAY - - AVG_E2E_DL_PKT_DELAY - - VAR_E2E_DL_PKT_DELAY - - AVG_E2E_UL_PKT_LOSS_RATE - - VAR_E2E_UL_PKT_LOSS_RATE - - AVG_E2E_DL_PKT_LOSS_RATE - - VAR_E2E_DL_PKT_LOSS_RATE - - E2E_DATA_VOL_TRANS_TIME_FOR_UE_LIST - - IN_OUT_PERCENT - - TIME_TO_COLLISION - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the analytics subset. - Possible values are: - - NUM_OF_UE_REG: The number of UE registered. This value is only applicable to - NSI_LOAD_LEVEL event. - - NUM_OF_PDU_SESS_ESTBL: The number of PDU sessions established. This value is only - applicable to NSI_LOAD_LEVEL event. - - RES_USAGE: The current usage of the virtual resources assigned to the NF instances - belonging to a particular network slice instance. This value is only applicable to - NSI_LOAD_LEVEL event. - - NUM_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR: The number of times the resource usage threshold - of the network slice instance is reached or exceeded if a threshold value is provided by - the consumer. This value is only applicable to NSI_LOAD_LEVEL event. - - PERIOD_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR: The time interval between each time the - threshold being met or exceeded on the network slice (instance). This value is only - applicable to NSI_LOAD_LEVEL event. - - EXCEED_LOAD_LEVEL_THR_IND: Whether the Load Level Threshold is met or exceeded by the - statistics value. This value is only applicable to NSI_LOAD_LEVEL event. - - LIST_OF_TOP_APP_UL: The list of applications that contribute the most to the traffic in - the UL direction. This value is only applicable to USER_DATA_CONGESTION event. - - LIST_OF_TOP_APP_DL: The list of applications that contribute the most to the traffic in - the DL direction. This value is only applicable to USER_DATA_CONGESTION event. - - NF_STATUS: The availability status of the NF on the Analytics target period, expressed - as a percentage of time per status value (registered, suspended, undiscoverable). This - value is only applicable to NF_LOAD event. - - NF_RESOURCE_USAGE: The average usage of assigned resources (CPU, memory, storage). This - value is only applicable to NF_LOAD event. - - NF_LOAD: The average load of the NF instance over the Analytics target period. This value - is only applicable to NF_LOAD event. - - NF_PEAK_LOAD: The maximum load of the NF instance over the Analytics target period. This - value is only applicable to NF_LOAD event. - - NF_LOAD_AVG_IN_AOI: The average load of the NF instances over the area of interest. This - value is only applicable to NF_LOAD event. - - DISPER_AMOUNT: Indicates the dispersion amount of the reported data volume or transaction - dispersion type. This value is only applicable to DISPERSION event. - - DISPER_CLASS: Indicates the dispersion mobility class: fixed, camper, traveller upon set - its usage threshold, and/or the top-heavy class upon set its percentile rating threshold. - This value is only applicable to DISPERSION event. - - RANKING: Data/transaction usage ranking high (i.e.value 1), medium (2) or low (3). This - value is only applicable to DISPERSION event. - - PERCENTILE_RANKING: Percentile ranking of the target UE in the Cumulative Distribution - Function of data usage for the population of all UEs. This value is only applicable to - DISPERSION event. - - RSSI: Indicated the RSSI in the unit of dBm. This value is only applicable to - WLAN_PERFORMANCE event. - - RTT: Indicates the RTT in the unit of millisecond. This value is only applicable to - WLAN_PERFORMANCE event. - - TRAFFIC_INFO: Traffic information including UL/DL data rate and/or Traffic volume. This - value is only applicable to WLAN_PERFORMANCE event. - - NUMBER_OF_UES: Number of UEs observed for the SSID. This value is only applicable to - WLAN_PERFORMANCE event. - - APP_LIST_FOR_UE_COMM: The analytics of the application list used by UE. This value is only - applicable to UE_COMM event. - - N4_SESS_INACT_TIMER_FOR_UE_COMM: The N4 Session inactivity timer. This value is only - applicable to UE_COMM event. - - AVG_TRAFFIC_RATE: Indicates average traffic rate. This value is only applicable to - DN_PERFORMANCE event. - - MAX_TRAFFIC_RATE: Indicates maximum traffic rate. This value is only applicable to - DN_PERFORMANCE event. - - AGG_TRAFFIC_RATE: Indicates aggregated traffic rate. This value is only applicable to - DN_PERFORMANCE event. - - VAR_TRAFFIC_RATE: Indicates variance traffic rate. This value is only applicable to - DN_PERFORMANCE event. - - AVG_PACKET_DELAY: Indicates average Packet Delay. This value is only applicable to - DN_PERFORMANCE event. - - MAX_PACKET_DELAY: Indicates maximum Packet Delay. This value is only applicable to - DN_PERFORMANCE event. - - VAR_PACKET_DELAY: Indicates variance Packet Delay. This value is only applicable to - DN_PERFORMANCE event. - - AVG_PACKET_LOSS_RATE: Indicates average Loss Rate. This value is only applicable to - DN_PERFORMANCE event. - - MAX_PACKET_LOSS_RATE: Indicates maximum Packet Loss Rate. This value is only applicable to - DN_PERFORMANCE event. - - VAR_PACKET_LOSS_RATE: Indicates variance Packet Loss Rate. This value is only applicable - to DN_PERFORMANCE event. - - UE_LOCATION: Indicates UE location information. This value is only applicable to - SERVICE_EXPERIENCE event. - - LIST_OF_HIGH_EXP_UE: Indicates list of high experienced UE. This value is only applicable - to SM_CONGESTION event. - - LIST_OF_MEDIUM_EXP_UE: Indicates list of medium experienced UE. This value is only - applicable to SM_CONGESTION event. - - LIST_OF_LOW_EXP_UE: Indicates list of low experienced UE. This value is only applicable to - SM_CONGESTION event. - - AVG_UL_PKT_DROP_RATE: Indicates average uplink packet drop rate on GTP-U path on N3. This - value is only applicable to RED_TRANS_EXP event. - - VAR_UL_PKT_DROP_RATE: Indicates variance of uplink packet drop rate on GTP-U path on N3. - This value is only applicable to RED_TRANS_EXP event. - - AVG_DL_PKT_DROP_RATE: Indicates average downlink packet drop rate on GTP-U path on N3. - This value is only applicable to RED_TRANS_EXP event. - - VAR_DL_PKT_DROP_RATE: Indicates variance of downlink packet drop rate on GTP-U path on N3. - This value is only applicable to RED_TRANS_EXP event. - - AVG_UL_PKT_DELAY: Indicates average uplink packet delay round trip on GTP-U path on N3. - This value is only applicable to RED_TRANS_EXP event. - - VAR_UL_PKT_DELAY: Indicates variance uplink packet delay round trip on GTP-U path on N3. - This value is only applicable to RED_TRANS_EXP event. - - AVG_DL_PKT_DELAY: Indicates average downlink packet delay round trip on GTP-U path on N3. - This value is only applicable to RED_TRANS_EXP event. - - VAR_DL_PKT_DELAY: Indicates variance downlink packet delay round trip on GTP-U path on N3. - This value is only applicable to RED_TRANS_EXP event. - - TRAFFIC_MATCH_TD: Identifies traffic that matches Traffic Descriptor provided by - the consumer. - - TRAFFIC_UNMATCH_TD: Identifies traffic that does not match Traffic Descriptor - provided by the consumer. - - NUMBER_OF_UE: Indicates the number of UEs. This value is only applicable to - DN_PERFORMANCE event. - - UE_GEOG_DIST: Indicates the geographical distribution of the UEs that can be selected by - the AF for application service. This value is only applicable to UE_MOBILITY event. - - UE_DIRECTION: Indicates the direction of the UEs. This value is only applicable to - UE_MOBILITY event. - - AVG_E2E_UL_PKT_DELAY: Indicates average End-to-End (between UE and UPF) uplink packet - delay. This value is only applicable to RED_TRANS_EXP event. - - VAR_E2E_UL_PKT_DELAY: Indicates the variance of End-to-End (between UE and UPF) uplink - packet delay. This value is only applicable to RED_TRANS_EXP event. - - AVG_E2E_DL_PKT_DELAY: Indicates average End-to-End (between UE and UPF) downlink packet - delay. This value is only applicable to RED_TRANS_EXP event. - - VAR_E2E_DL_PKT_DELAY: Indicates the variance of End-to-End (between UE and UPF) downlink - packet delay. This value is only applicable to RED_TRANS_EXP event. - - AVG_E2E_UL_PKT_LOSS_RATE: Indicates average End-to-End (between UE and UPF) uplink packet - loss rate. This value is only applicable to RED_TRANS_EXP event. - - VAR_E2E_UL_PKT_LOSS_RATE: Indicates the variance of End-to-End (between UE and UPF) uplink - packet loss rate. This value is only applicable to RED_TRANS_EXP event. - - AVG_E2E_DL_PKT_LOSS_RATE: Indicates average End-to-End (between UE and UPF) downlink - packet loss rate. This value is only applicable to RED_TRANS_EXP event. - - VAR_E2E_DL_PKT_LOSS_RATE: Indicates the variance of End-to-End (between UE and UPF) - downlink packet loss rate. This value is only applicable to RED_TRANS_EXP event. - - E2E_DATA_VOL_TRANS_TIME_FOR_UE_LIST: Indicates the classified E2E data volume transfer - time statistics or predictions for multiple UEs with respect to one or more reporting - thresholds. - - NUM_OF_UE: Indicates the total number of users in the area of interest. This - value is only applicable to MOVEMENT_BEHAVIOUR event. - - MOV_UE_RATIO: Indicates the Ratio of moving UEs in the area of interest. This value - is only applicable to MOVEMENT_BEHAVIOUR event. - - AVR_SPEED: Indicates the average speed of all UEs in the area of interest. This value - is only applicable to MOVEMENT_BEHAVIOUR event. - - SPEED_THRESHOLD: Indicates the information on UEs in the area of interest whose speed - is faster than the speed threshold. This value is only applicable to MOVEMENT_BEHAVIOUR - event. - - MOV_UE_DIRECTION: Indicates the heading directions of the UE flow in the target area. - This value is only applicable to MOVEMENT_BEHAVIOUR event. - - IN_OUT_PERCENT: Indicates the percentage of indoor/outdoor UEs at a location. - The value is only applicable to the LOC_ACCURACY event. - - TIME_TO_COLLISION: Indicates the time until for a collision with another UE happens. - This value is only applicable to RELATIVE_PROXIMITY event prediction. - - DispersionType: - anyOf: - - type: string - enum: - - DVDA - - TDA - - DVDA_AND_TDA - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the dispersion type. - Possible values are: - - DVDA: Data Volume Dispersion Analytics. - - TDA: Transactions Dispersion Analytics. - - DVDA_AND_TDA: Data Volume Dispersion Analytics and Transactions Dispersion Analytics. - - DispersionClass: - anyOf: - - type: string - enum: - - FIXED - - CAMPER - - TRAVELLER - - TOP_HEAVY - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the dispersion class. - Possible values are: - - FIXED: Dispersion class as fixed UE its data or transaction usage at a location or - a slice, is higher than its class threshold set for its all data or transaction usage. - - CAMPER: Dispersion class as camper UE, its data or transaction usage at a location or - a slice, is higher than its class threshold and lower than the fixed class threshold set - for its all data or transaction usage. - - TRAVELLER: Dispersion class as traveller UE, its data or transaction usage at a location - or a slice, is lower than the camper class threshold set for its all data or transaction - usage. - - TOP_HEAVY: Dispersion class as Top_Heavy UE, who's dispersion percentile rating at a - location or a slice, is higher than its class threshold. - - DispersionOrderingCriterion: - anyOf: - - type: string - enum: - - TIME_SLOT_START - - DISPERSION - - CLASSIFICATION - - RANKING - - PERCENTILE_RANKING - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the order criterion for the list of dispersion. - Possible values are: - - TIME_SLOT_START: Indicates the order of time slot start. - - DISPERSION: Indicates the order of data/transaction dispersion. - - CLASSIFICATION: Indicates the order of data/transaction classification. - - RANKING: Indicates the order of data/transaction ranking. - - PERCENTILE_RANKING: Indicates the order of data/transaction percentile ranking. - - DeviceType: - anyOf: - - type: string - enum: - - MOBILE_PHONE - - SMART_PHONE - - TABLET - - DONGLE - - MODEM - - WLAN_ROUTER - - IOT_DEVICE - - WEARABLE - - MOBILE_TEST_PLATFORM - - UNDEFINED - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Represents the device type. - Possible values are: - - MOBILE_PHONE: Mobile Phone. - - SMART_PHONE: Smartphone. - - TABLET: Tablet. - - DONGLE: Dongle. - - MODEM: Modem. - - WLAN_ROUTER: WLAN Router. - - IOT_DEVICE: IoT Device. - - WEARABLE: Wearable. - - MOBILE_TEST_PLATFORM: Mobile Test Platform. - - UNDEFINED: Undefined. - - RedTransExpOrderingCriterion: - anyOf: - - type: string - enum: - - TIME_SLOT_START - - RED_TRANS_EXP - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the order criterion for the list of Redundant Transmission Experience. - Possible values are: - - TIME_SLOT_START: Indicates the order of time slot start. - - RED_TRANS_EXP: Indicates the order of Redundant Transmission Experience. - - WlanOrderingCriterion: - anyOf: - - type: string - enum: - - TIME_SLOT_START - - NUMBER_OF_UES - - RSSI - - RTT - - TRAFFIC_INFO - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the order criterion for the list of WLAN performance information. - Possible values are: - - TIME_SLOT_START: Indicates the order of time slot start. - - NUMBER_OF_UES: Indicates the order of number of UEs. - - RSSI: Indicates the order of RSSI. - - RTT: Indicates the order of RTT. - - TRAFFIC_INFO: Indicates the order of Traffic information. - - ServiceExperienceType: - anyOf: - - type: string - enum: - - VOICE - - VIDEO - - OTHER - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - but is not used to encode content defined in the present version of this API. - description: | - Represents the type of the service experience analytics. - Possible values are: - - VOICE: Indicates that the service experience analytics is for voice service. - - VIDEO: Indicates that the service experience analytics is for video service. - - OTHER: Indicates that the service experience analytics is for other service. - - DnPerfOrderingCriterion: - anyOf: - - type: string - enum: - - AVERAGE_TRAFFIC_RATE - - MAXIMUM_TRAFFIC_RATE - - AVERAGE_PACKET_DELAY - - MAXIMUM_PACKET_DELAY - - AVERAGE_PACKET_LOSS_RATE - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Represents the order criterion for the list of DN performance analytics. - Possible values are: - - AVERAGE_TRAFFIC_RATE: Indicates the average traffic rate. - - MAXIMUM_TRAFFIC_RATE: Indicates the maximum traffic rate. - - AVERAGE_PACKET_DELAY: Indicates the average packet delay. - - MAXIMUM_PACKET_DELAY: Indicates the maximum packet delay. - - AVERAGE_PACKET_LOSS_RATE: Indicates the average packet loss rate. - - TermCause: - anyOf: - - type: string - enum: - - USER_CONSENT_REVOKED - - NWDAF_OVERLOAD - - UE_LEFT_AREA - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Represents the cause for the analytics subscription termination request. - Possible values are: - - USER_CONSENT_REVOKED: The user consent has been revoked. - - NWDAF_OVERLOAD: The NWDAF is overloaded. - - UE_LEFT_AREA: The UE has moved out of the NWDAF serving area. - UserDataConOrderCrit: - anyOf: - - type: string - enum: - - APPLICABLE_TIME_WINDOW - - NETWORK_STATUS_INDICATION - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Represents the cause for requesting to terminate an analytics subscription. - Possible values are: - - APPLICABLE_TIME_WINDOW: The ordering criterion is the Applicable Time Window. - - NETWORK_STATUS_INDICATION: The ordering criterion is the network status indication. - - UeMobilityOrderCriterion: - anyOf: - - type: string - enum: - - TIME_SLOT - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Represents the ordering criterion for the list of UE mobility analytics. - Possible values are: - - TIME_SLOT: The ordering criterion is the time slot. - - UeCommOrderCriterion: - anyOf: - - type: string - enum: - - START_TIME - - DURATION - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Represents the ordering criterion for the list of UE communication analytics. - Possible values are: - - START_TIME: The ordering criterion of the analytics is the start time. - - DURATION: The ordering criterion of the analytics is the duration of the communication. - - NetworkPerfOrderCriterion: - anyOf: - - type: string - enum: - - NUMBER_OF_UES - - COMMUNICATION_PERF - - MOBILITY_PERF - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Represents the ordering criterion for the list of network performance analytics. - Possible values are: - - NUMBER_OF_UES: The ordering criterion of the analytics is the number of UEs. - - COMMUNICATION_PERF: The ordering criterion of the analytics is the communication performance. - - MOBILITY_PERF: The ordering criterion of the analytics is themobility performance. - - LocInfoGranularity: - anyOf: - - type: string - enum: - - TA_LEVEL - - CELL_LEVEL - - LON_AND_LAT_LEVEL - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Represents the preferred granularity of location information. - Possible values are: - - TA_LEVEL: Indicates location granularity of TA level. - - CELL_LEVEL: Indicates location granularity of Cell level. - - LON_AND_LAT_LEVEL: Indicates location granularity of longitude and latitude level. - - TrafficDirection: - anyOf: - - type: string - enum: - - UL_AND_DL - - UL - - DL - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Represents the traffic direction for the resource usage information. - Possible values are: - - UL_AND_DL: Uplink and downlink traffic. - - UL: Uplink traffic. - - DL: Downlink traffic. - - ValueExpression: - anyOf: - - type: string - enum: - - AVERAGE - - PEAK - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Represents the average or peak value of the resource usage for the network performance type. - Possible values are: - - AVERAGE: Resource usage information in average value. - - PEAK: Resource usage information in peak value. - - E2eDataVolTransTimeCriterion: - anyOf: - - type: string - enum: - - E2E_DATA_VOL_TRANS_TIME - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Represents the ordering criterion for the list of E2E data volume transfer time. - Possible values are: - - E2E_DATA_VOL_TRANS_TIME: The ordering criterion is the E2E data volume transfer time. - - AnalyticsAccuracyIndication: - anyOf: - - type: string - enum: - - MEET - - NOT_MEET - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Represents the notification methods for the subscribed events. - Possible values are: - - MEET: Indicates meet the analytics accuracy requirement. - - NOT_MEET: Indicates not meet the analytics accuracy requirement. - - LocationOrientation: - anyOf: - - type: string - enum: - - HORIZONTAL - - VERTICAL - - HOR_AND_VER - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Possible values are: - - HORIZONTAL: Indicates horizontal orientation. - - VERTICAL: Indicates vertical orientation. - - HOR_AND_VER: Indicates both horizontal and vertical orientation. - - Direction: - anyOf: - - type: string - enum: - - NORTH - - SOUTH - - EAST - - WEST - - NORTHWEST - - NORTHEAST - - SOUTHWEST - - SOUTHEAST - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Possible values are: - - NORTH: North direction. - - SOUTH: South direction. - - EAST: EAST direction. - - WEST: WEST direction. - - NORTHWEST: Northwest direction. - - NORTHEAST: Northeast direction. - - SOUTHWEST: Southwest direction. - - SOUTHEAST: Southeast direction. - - ProximityCriterion: - anyOf: - - type: string - enum: - - VELOCITY - - AVG_SPD - - ORIENTATION - - TRAJECTORY - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration but - is not used to encode content defined in the present version of this API. - description: | - Possible values are: - - VELOCITY: Velocity. - - AVG_SPD: Average speed. - - ORIENTATION: Orientation. - - TRAJECTORY: Mobility trajectory. diff --git a/OpenAPI/TS29571_CommonData.yaml b/OpenAPI/TS29571_CommonData.yaml deleted file mode 100644 index d364dce01de8c02acab650a48412bd5f8f9e872e..0000000000000000000000000000000000000000 --- a/OpenAPI/TS29571_CommonData.yaml +++ /dev/null @@ -1,6734 +0,0 @@ -openapi: 3.0.0 - -info: - version: '1.5.1' - - - title: 'Common Data Types' - description: | - Common Data Types for Service Based Interfaces. - © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. - -externalDocs: - description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 18.7.0 - url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.571/' - -paths: {} -components: - schemas: - -# -# Common Data Types for Generic usage definitions as defined in clause 5.2 -# - -# -# COMMON SIMPLE DATA TYPES -# - Binary: - format: binary - type: string - description: string with format 'binary' as defined in OpenAPI. - - BinaryRm: - format: binary - type: string - nullable: true - description: > - "string with format 'binary' as defined in OpenAPI OpenAPI with 'nullable: true' property." - - Bytes: - format: byte - type: string - description: string with format 'bytes' as defined in OpenAPI - - BytesRm: - format: byte - type: string - nullable: true - description: > - string with format 'bytes' as defined in OpenAPI OpenAPI with 'nullable: true' property. - - Date: - format: date - type: string - description: string with format 'date' as defined in OpenAPI. - - DateRm: - format: date - type: string - nullable: true - description: > - string with format 'date' as defined in OpenAPI OpenAPI with 'nullable: true' property. - - DateTime: - format: date-time - type: string - description: string with format 'date-time' as defined in OpenAPI. - - DateTimeRm: - format: date-time - type: string - nullable: true - description: > - string with format 'date-time' as defined in OpenAPI with 'nullable:true' property. - - DiameterIdentity: - $ref: '#/components/schemas/Fqdn' - - DiameterIdentityRm: - $ref: '#/components/schemas/FqdnRm' - - Double: - format: double - type: number - description: string with format 'double' as defined in OpenAPI - - DoubleRm: - format: double - type: number - nullable: true - description: > - string with format 'double' as defined in OpenAPI with 'nullable: true' property. - - DurationSec: - type: integer - description: indicating a time in seconds. - - DurationSecRm: - type: integer - nullable: true - description: "indicating a time in seconds with OpenAPI defined 'nullable: true' property." - - Float: - format: float - type: number - description: string with format 'float' as defined in OpenAPI. - - FloatRm: - format: float - type: number - nullable: true - description: > - string with format 'float' as defined in OpenAPI with the OpenAPI defined - 'nullable: true' property. - - Int32: - format: int32 - type: integer - description: string with format 'int32' as defined in OpenAPI. - - Int32Rm: - format: int32 - type: integer - nullable: true - description: > - string with format 'int32' as defined in OpenAPI with the OpenAPI defined - 'nullable: true' property. - - Int64: - type: integer - format: int64 - description: string with format 'int64' as defined in OpenAPI. - - Int64Rm: - format: int64 - type: integer - nullable: true - description: > - string with format 'int64' as defined in OpenAPI with the OpenAPI defined - 'nullable: true' property. - - 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' - description: > - String identifying a IPv4 address formatted in the 'dotted decimal' notation - as defined in RFC 1166. - - 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 - description: > - String identifying a IPv4 address formatted in the 'dotted decimal' notation - as defined in RFC 1166 with the OpenAPI defined 'nullable: true' property. - - Ipv4AddrMask: - 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])(\/([0-9]|[1-2][0-9]|3[0-2]))$' - example: '198.51.0.0/16' - description: > - "String identifying a IPv4 address mask formatted in the 'dotted decimal' notation - as defined in RFC 1166." - - Ipv4AddrMaskRm: - 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])(\/([0-9]|[1-2][0-9]|3[0-2]))$' - example: '198.51.0.0/16' - nullable: true - description: > - String identifying a IPv4 address mask formatted in the 'dotted decimal' notation - as defined in RFC 1166 with the OpenAPI defined 'nullable: true' property. - - 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' - description: > - String identifying an IPv6 address formatted according to clause 4 of RFC5952. - The mixed IPv4 IPv6 notation according to clause 5 of RFC5952 shall not be used. - - 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 - description: > - String identifying an IPv6 address formatted according to clause 4 of RFC5952 with the - OpenAPI 'nullable: true' property. - The mixed IPv4 IPv6 notation according to clause 5 of RFC5952 shall not be used. - - 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' - description: > - String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952. - IPv6Prefix data type may contain an individual /128 IPv6 address. - - Ipv6PrefixRm: - 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}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$' - nullable: true - description: > - String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952 with - the OpenAPI 'nullable: true' property. IPv6Prefix data type may contain an individual - /128 IPv6 address. - - MacAddr48: - type: string - pattern: '^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$' - description: > - String identifying a MAC address formatted in the hexadecimal notation - according to clause 1.1 and clause 2.1 of RFC 7042. - - MacAddr48Rm: - type: string - pattern: '^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$' - nullable: true - description: > - "String identifying a MAC address formatted in the hexadecimal notation according to - clause 1.1 and clause 2.1 of RFC 7042 with the OpenAPI 'nullable: true' property." - - SupportedFeatures: - type: string - pattern: '^[A-Fa-f0-9]*$' - description: > - A string used to indicate the features supported by an API that is used as defined in clause - 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in - hexadecimal representation Each character in the string shall take a value of "0" to "9", - "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in - table 5.2.2-3. The most significant character representing the highest-numbered features - shall appear first in the string, and the character representing features 1 to 4 - shall appear last in the string. The list of features and their numbering (starting with 1) - are defined separately for each API. If the string contains a lower number of characters - than there are defined features for an API, all features that would be represented by - characters that are not present in the string are not supported. - - Uinteger: - type: integer - minimum: 0 - description: Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. - - UintegerRm: - type: integer - minimum: 0 - description: > - Unsigned Integer, i.e. only value 0 and integers above 0 are permissible with - the OpenAPI 'nullable: true' property. - nullable: true - - Uint16: - type: integer - minimum: 0 - maximum: 65535 - description: > - Integer where the allowed values correspond to the value range of an - unsigned 16-bit integer. - - Uint16Rm: - type: integer - minimum: 0 - maximum: 65535 - nullable: true - description: > - Integer where the allowed values correspond to the value range of an unsigned - 16-bit integer with the OpenAPI 'nullable: true' property. - - Uint32: - type: integer - minimum: 0 - maximum: 4294967295 #(2^32)-1 - description: > - Integer where the allowed values correspond to the value range of an unsigned - 32-bit integer. - - Uint32Rm: - format: int32 - type: integer - minimum: 0 - maximum: 4294967295 #(2^32)-1 - nullable: true - description: > - Integer where the allowed values correspond to the value range of an unsigned - 32-bit integer with the OpenAPI 'nullable: true' property. - - Uint64: - type: integer - minimum: 0 - maximum: 18446744073709551615 #(2^64)-1 - description: > - Integer where the allowed values correspond to the value range of an - unsigned 64-bit integer. - - Uint64Rm: - type: integer - minimum: 0 - maximum: 18446744073709551615 #(2^64)-1 - nullable: true - description: > - Integer where the allowed values correspond to the value range of an unsigned - 16-bit integer with the OpenAPI 'nullable: true' property. - - Uri: - type: string - description: String providing an URI formatted according to RFC 3986. - - UriRm: - type: string - nullable: true - description: > - String providing an URI formatted according to RFC 3986 with the OpenAPI - 'nullable: true' property. - - VarUeId: - type: string - pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|gci-.+|gli-.+|.+)$' - description: String represents the SUPI or GPSI - - VarUeIdRm: - type: string - pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|gci-.+|gli-.+|.+)$' - nullable: true - description: "String represents the SUPI or GPSI with the OpenAPI 'nullable: true' property." - - TimeZone: - type: string - example: '-08:00+1' - description: | - String with format "time-numoffset" optionally appended by "daylightSavingTime", where - - "time-numoffset" shall represent the time zone adjusted for daylight saving time and be - encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339; - - "daylightSavingTime" shall represent the adjustment that has been made and shall be - encoded as "+1" or "+2" for a +1 or +2 hours adjustment. - - The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time. - - TimeZoneRm: - type: string - nullable: true - description: | - "String with format 'time-numoffset' optionally appended by '', where - - 'time-numoffset' shall represent the time zone adjusted for daylight saving time and be - encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339; - - 'daylightSavingTime' shall represent the adjustment that has been made and shall be - encoded as '+1' or '+2' for a +1 or +2 hours adjustment. - - But with the OpenAPI 'nullable: true' property." - - StnSr: - type: string - description: String representing the STN-SR as defined in clause 18.6 of 3GPP TS 23.003. - - StnSrRm: - type: string - nullable: true - description: > - String representing the STN-SR as defined in clause 18.6 of 3GPP TS 23.003 - with the OpenAPI 'nullable: true' property. - - CMsisdn: - type: string - pattern: '^[0-9]{5,15}$' - description: String representing the C-MSISDN as defined in clause 18.7 of 3GPP TS 23.003. - - CMsisdnRm: - type: string - pattern: '^[0-9]{5,15}$' - nullable: true - description: > - String representing the C-MSISDN as defined in clause 18.7 of 3GPP TS 23.003 with - the OpenAPI 'nullable: true' property. - - MonthOfYear: - type: integer - minimum: 1 - maximum: 12 - description: > - integer between and including 1 and 12 denoting a month. 1 shall indicate January, - and the subsequent months shall be indicated with the next higher numbers. - 12 shall indicate December. - - DayOfWeek: - type: integer - minimum: 1 - maximum: 7 - description: > - integer between and including 1 and 7 denoting a weekday. 1 shall indicate Monday, - and the subsequent weekdays shall be indicated with the next higher numbers. - 7 shall indicate Sunday. - - TimeOfDay: - type: string - description: > - String with format partial-time or full-time as defined in clause 5.6 of IETF RFC 3339. - Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC). - - EmptyObject: - description: Empty JSON object { }, it is defined with the keyword additionalProperties false - type: object - additionalProperties: false - - Fqdn: - description: Fully Qualified Domain Name - type: string - pattern: '^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$' - minLength: 4 - maxLength: 253 - - FqdnRm: - description: Fully Qualified Domain Name, but it also allows the null value - anyOf: - - $ref: '#/components/schemas/Fqdn' - - $ref: '#/components/schemas/NullValue' - -# -# COMMON ENUMERATED DATA TYPES -# - - PatchOperation: - anyOf: - - type: string - enum: - - add - - copy - - move - - remove - - replace - - test - - type: string - description: Operations as defined in IETF RFC 6902. - - UriScheme: - anyOf: - - type: string - enum: - - http - - https - - type: string - description: HTTP and HTTPS URI scheme. - - ChangeType: - anyOf: - - type: string - enum: - - ADD - - MOVE - - REMOVE - - REPLACE - - type: string - description: Indicates the type of change to be performed. - - HttpMethod: - anyOf: - - type: string - enum: - - GET - - POST - - PUT - - DELETE - - PATCH - - OPTIONS - - HEAD - - CONNECT - - TRACE - - type: string - description: HTTP methodes. - - NullValue: - enum: - - null - description: JSON's null value. - - - MatchingOperator: - anyOf: - - type: string - enum: - - FULL_MATCH - - MATCH_ALL - - STARTS_WITH - - NOT_START_WITH - - ENDS_WITH - - NOT_END_WITH - - CONTAINS - - NOT_CONTAIN - - type: string - description: the matching operation. - -# -# COMMON STRUCTURED DATA TYPES -# - - ProblemDetails: - description: Provides additional information in an error response. - type: object - properties: - type: - $ref: '#/components/schemas/Uri' - title: - type: string - status: - type: integer - detail: - type: string - description: A human-readable explanation specific to this occurrence of the problem. - instance: - $ref: '#/components/schemas/Uri' - cause: - type: string - description: > - A machine-readable application error cause specific to this occurrence of the problem. - This IE should be present and provide application-related error information, if - available. - invalidParams: - type: array - items: - $ref: '#/components/schemas/InvalidParam' - minItems: 1 - supportedFeatures: - $ref: '#/components/schemas/SupportedFeatures' - accessTokenError: - $ref: 'TS29510_Nnrf_AccessToken.yaml#/components/schemas/AccessTokenErr' - accessTokenRequest: - $ref: 'TS29510_Nnrf_AccessToken.yaml#/components/schemas/AccessTokenReq' - nrfId: - $ref: '#/components/schemas/Fqdn' - supportedApiVersions: - type: array - items: - type: string - minItems: 1 - noProfileMatchInfo: - $ref: 'TS29510_Nnrf_NFDiscovery.yaml#/components/schemas/NoProfileMatchInfo' - - Link: - type: object - properties: - href: - $ref: '#/components/schemas/Uri' - description: It contains the URI of the linked resource. - - LinkRm: - type: object - properties: - href: - $ref: '#/components/schemas/Uri' - nullable: true - description: > - It contains the URI of the linked resource with the OpenAPI 'nullable: true' property. - - PatchItem: - type: object - properties: - op: - $ref: '#/components/schemas/PatchOperation' - path: - type: string - description: > - contains a JSON pointer value (as defined in IETF RFC 6901) that references - a location of a resource on which the patch operation shall be performed. - from: - type: string - description: > - indicates the path of the source JSON element (according to JSON Pointer syntax) - being moved or copied to the location indicated by the "path" attribute. - value: {} - required: - - op - - path - description: it contains information on data to be changed. - - LinksValueSchema: - oneOf: - - type: array - items: - $ref: '#/components/schemas/Link' - minItems: 1 - - $ref: '#/components/schemas/Link' - description: A list of mutually exclusive alternatives of 1 or more links. - - SelfLink: - type: object - properties: - self: - $ref: '#/components/schemas/Link' - required: - - self - description: It contains the URI of the linked resource. - - InvalidParam: - type: object - properties: - param: - type: string - description: > - If the invalid parameter is an attribute in a JSON body, this IE shall contain the - attribute's name and shall be encoded as a JSON Pointer. If the invalid parameter is - an HTTP header, this IE shall be formatted as the concatenation of the string "header " - plus the name of such header. If the invalid parameter is a query parameter, this IE - shall be formatted as the concatenation of the string "query " plus the name of such - query parameter. If the invalid parameter is a variable part in the path of a resource - URI, this IE shall contain the name of the variable, including the symbols "{" and "}" - used in OpenAPI specification as the notation to represent variable path segments. - reason: - type: string - description: > - A human-readable reason, e.g. "must be a positive integer". In cases involving failed - operations in a PATCH request, the reason string should identify the operation that - failed using the operation's array index to assist in correlation of the invalid - parameter with the failed operation, e.g." Replacement value invalid for attribute - (failed operation index= 4)" - required: - - param - description: It contains an invalid parameter and a related description. - - ChangeItem: - type: object - properties: - op: - $ref: '#/components/schemas/ChangeType' - path: - type: string - description: > - contains a JSON pointer value (as defined in IETF RFC 6901) that references a target - location within the resource on which the change has been applied. - from: - type: string - description: > - indicates the path of the source JSON element (according to JSON Pointer syntax) - being moved or copied to the location indicated by the "path" attribute. It shall - be present if the "op" attribute is of value "MOVE". - origValue: {} - newValue: {} - required: - - op - - path - description: It contains data which need to be changed. - - NotifyItem: - type: object - required: - - resourceId - - changes - properties: - resourceId: - $ref: '#/components/schemas/Uri' - changes: - type: array - items: - $ref: '#/components/schemas/ChangeItem' - minItems: 1 - description: Indicates changes on a resource. - - ComplexQuery: - oneOf: - - $ref: '#/components/schemas/Cnf' - - $ref: '#/components/schemas/Dnf' - description: > - The ComplexQuery data type is either a conjunctive normal form or a disjunctive normal form. - The attribute names "cnfUnits" and "dnfUnits" (see clause 5.2.4.11 and clause 5.2.4.12) - serve as discriminator. - - Cnf: - type: object - required: - - cnfUnits - properties: - cnfUnits: - type: array - items: - $ref: '#/components/schemas/CnfUnit' - minItems: 1 - description: A conjunctive normal form - - Dnf: - type: object - required: - - dnfUnits - properties: - dnfUnits: - type: array - items: - $ref: '#/components/schemas/DnfUnit' - minItems: 1 - description: A disjunctive normal form. - - CnfUnit: - type: object - required: - - cnfUnit - properties: - cnfUnit: - type: array - items: - $ref: '#/components/schemas/Atom' - minItems: 1 - description: > - During the processing of cnfUnits attribute, all the members in the array shall be - interpreted as logically concatenated with logical "AND". - - DnfUnit: - type: object - required: - - dnfUnit - properties: - dnfUnit: - type: array - items: - $ref: '#/components/schemas/Atom' - minItems: 1 - description: > - During the processing of dnfUnits attribute, all the members in the array shall be - interpreted as logically concatenated with logical "OR". - - Atom: - description: contains a search parameter and its positive or negative content. - type: object - required: - - attr - - value - properties: - attr: - type: string - description: contains the name of a defined query parameter. - value: {} - negative: - type: boolean - description: indicates whether the negative condition applies for the query condition. - - PatchResult: - description: The execution report result on failed modification. - type: object - required: - - report - properties: - report: - type: array - items: - $ref: '#/components/schemas/ReportItem' - minItems: 1 - description: > - The execution report contains an array of report items. Each report item indicates one - failed modification. - - ReportItem: - type: object - required: - - path - properties: - path: - type: string - description: > - Contains a JSON pointer value (as defined in IETF RFC 6901) that references a - location of a resource to which the modification is subject. - reason: - type: string - description: > - A human-readable reason providing details on the reported modification failure. - The reason string should identify the operation that failed using the operation's - array index to assist in correlation of the invalid parameter with the failed - operation, e.g. "Replacement value invalid for attribute (failed operation index= 4)". - description: indicates performed modivications. - - HalTemplate: - description: > - Hypertext Application Language (HAL) template contains the extended 3GPP hypermedia format. - type: object - required: - - method - properties: - title: - type: string - description: A human-readable string that can be used to identify this template - method: - $ref: '#/components/schemas/HttpMethod' - contentType: - type: string - description: > - The media type that should be used for the corresponding request. If the attribute - is missing, or contains an unrecognized value, the client should act as if the - contentType is set to "application/json". - properties: - type: array - items: - $ref: '#/components/schemas/Property' - minItems: 1 - description: > - The properties that should be included in the body of the corresponding request. - If the contentType attribute is set to "application/json", then this attribute - describes the attributes of the JSON object of the body. - - Property: - description: > - If the contentType attribute is set to "application/json", then this attribute describes - the attributes of the JSON object of the body. - type: object - required: - - name - properties: - name: - type: string - description: The name of the property - required: - type: boolean - description: > - Indicates whether the property is required – true= required – - false(default)= not required. - regex: - type: string - description: A regular expression string to be applied to the value of the property. - value: - type: string - description: The property value. When present, it shall be a valid JSON string. - - RedirectResponse: - description: > - The response shall include a Location header field containing a different URI - (pointing to a different URI of an other service instance), or the same URI if a request - is redirected to the same target resource via a different SCP. - type: object - properties: - cause: - type: string - targetScp: - $ref: '#/components/schemas/Uri' - targetSepp: - $ref: '#/components/schemas/Uri' - - TunnelAddress: - description: Tunnel address - type: object - properties: - ipv4Addr: - $ref: '#/components/schemas/Ipv4Addr' - ipv6Addr: - $ref: '#/components/schemas/Ipv6Addr' - portNumber: - $ref: '#/components/schemas/Uinteger' - required: - - portNumber - anyOf: - - required: [ ipv4Addr ] - - required: [ ipv6Addr ] - - - FqdnPatternMatchingRule: - description: a matching rule for a FQDN pattern - type: object - oneOf: - - required: [ regex ] - - required: [ stringMatchingRule ] - properties: - regex: - type: string - stringMatchingRule: - $ref: '#/components/schemas/StringMatchingRule' - - - StringMatchingRule: - description: A list of conditions for string matching - type: object - properties: - stringMatchingConditions: - type: array - items: - $ref: '#/components/schemas/StringMatchingCondition' - minItems: 1 - - StringMatchingCondition: - description: A String with Matching Operator - type: object - properties: - matchingString: - type: string - matchingOperator: - $ref: '#/components/schemas/MatchingOperator' - required: - - matchingOperator - - Ipv4AddressRange: - description: Range of IPv4 addresses - type: object - properties: - start: - $ref: '#/components/schemas/Ipv4Addr' - end: - $ref: '#/components/schemas/Ipv4Addr' - required: - - start - - end - - - Ipv6AddressRange: - description: Range of IPv6 addresses - type: object - properties: - start: - $ref: '#/components/schemas/Ipv6Addr' - end: - $ref: '#/components/schemas/Ipv6Addr' - required: - - start - - end - - Ipv6PrefixRange: - description: Range of IPv6 prefixes - type: object - properties: - start: - $ref: '#/components/schemas/Ipv6Prefix' - end: - $ref: '#/components/schemas/Ipv6Prefix' - required: - - start - - end - -# -# Data Types related to Subscription, Identification and Numbering as defined in clause 5.3 -# - -# -# SIMPLE DATA TYPES -# - Dnn: - type: string - description: > - String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; - it shall contain either a DNN Network Identifier, or a full DNN with both the Network - Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. - It shall be coded as string in which the labels are separated by dots - (e.g. "Label1.Label2.Label3"). - DnnRm: - type: string - nullable: true - description: > - String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; - it shall contain either a DNN Network Identifier, or a full DNN with both the - Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 - and 9.1.2. It shall be coded as string in which the labels are separated by dots - (e.g. 'Label1.Label2.Label3') with the OpenAPI 'nullable: true' property. - - WildcardDnn: - type: string - pattern: '^[*]$' - description: String representing the Wildcard DNN. It shall contain the string "*". - - WildcardDnnRm: - type: string - pattern: '^[*]$' - nullable: true - description: > - String representing the Wildcard DNN. It shall contain the string '*' but with the - OpenAPI 'nullable: true' property. - - Gpsi: - type: string - pattern: '^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$' - description: > - String identifying a Gpsi shall contain either an External Id or an MSISDN. - It shall be formatted as follows -External Identifier= "extid-'extid', where 'extid' - shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an - External Identifier. - - GpsiRm: - type: string - pattern: '^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$' - nullable: true - description: > - String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be - formatted as follows -External Identifier= 'extid-'extid', where 'extid' shall be formatted - according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier with the - OpenAPI 'nullable: true' property. - - GroupId: - type: string - pattern: '^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$' - description: > - String identifying a group of devices network internal globally unique ID which identifies - a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003. - - GroupIdRm: - type: string - pattern: '^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$' - nullable: true - description: > - String identifying a group of devices network internal globally unique ID which - identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003 with the - OpenAPI 'nullable: true' property. - - ExternalGroupId: - type: string - pattern: '^extgroupid-[^@]+@[^@]+$' - description: > - String identifying External Group Identifier that identifies a group made up of one or - more subscriptions associated to a group of IMSIs, as specified in clause 19.7.3 of 3GPP - TS 23.003. - - ExternalGroupIdRm: - type: string - pattern: '^extgroupid-[^@]+@[^@]+$' - nullable: true - description: > - String identifying External Group Identifier that identifies a group made up of one or - more subscriptions associated to a group of IMSIs, as specified in clause 19.7.3 of - 3GPP TS 23.003 with the OpenAPI 'nullable: true' property. - - Pei: - type: string - pattern: '^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$' - description: > - String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, - as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via - wireline access, with an indication that this address cannot be trusted for regulatory - purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as - specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or - imeisv-0123456789012345. - - PeiRm: - type: string - pattern: '^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$' - nullable: true - description: > - This data type is defined in the same way as the 'Pei' data type but with - the OpenAPI 'nullable: true' property. - - Supi: - type: string - pattern: '^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$' - description: | - String identifying a Supi that shall contain either an IMSI, a network specific identifier, - a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause - 2.2A of 3GPP TS 23.003. It shall be formatted as follows - - for an IMSI "imsi-", where shall be formatted according to clause 2.2 - of 3GPP TS 23.003 that describes an IMSI. - - for a network specific identifier "nai-, where shall be formatted - according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI. - - for a GCI "gci-", where shall be formatted according to clause 28.15.2 - of 3GPP TS 23.003. - - for a GLI "gli-", where shall be formatted according to clause 28.16.2 of - 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall - only contain characters allowed according to the "lower-with-hyphen" naming convention - defined in 3GPP TS 29.501. - - SupiRm: - type: string - pattern: '^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$' - nullable: true - description: > - This data type is defined in the same way as the 'Supi' data type, but with the - OpenAPI 'nullable: true' property. - - NfInstanceId: - type: string - format: uuid - description: > - String uniquely identifying a NF instance. The format of the NF Instance ID shall be a - Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122. - - AmfId: - type: string - pattern: '^[A-Fa-f0-9]{6}$' - description: > - String identifying the AMF ID composed of AMF Region ID (8 bits), AMF Set ID (10 bits) - and AMF Pointer (6 bits) as specified in clause 2.10.1 of 3GPP TS 23.003. It is encoded - as a string of 6 hexadecimal characters (i.e., 24 bits). - - AmfRegionId: - type: string - pattern: '^[A-Fa-f0-9]{2}$' - description: > - String identifying the AMF Set ID (10 bits) as specified in clause 2.10.1 of 3GPP TS 23.003. - It is encoded as a string of 3 hexadecimal characters where the first character is limited - to values 0 to 3 (i.e. 10 bits) - - AmfSetId: - type: string - pattern: '^[0-3][A-Fa-f0-9]{2}$' - description: > - String identifying the AMF Set ID (10 bits) as specified in clause 2.10.1 of 3GPP TS 23.003. - It is encoded as a string of 3 hexadecimal characters where the first character is limited - to values 0 to 3 (i.e. 10 bits). - - RfspIndex: - type: integer - minimum: 1 - maximum: 256 - description: > - Unsigned integer representing the "Subscriber Profile ID for RAT/Frequency Priority" - as specified in 3GPP TS 36.413. - - RfspIndexRm: - type: integer - minimum: 1 - maximum: 256 - nullable: true - description: > - Unsigned integer representing the 'Subscriber Profile ID for RAT/Frequency Priority' - as specified in 3GPP TS 36.413 with the OpenAPI 'nullable: true' property. - - NfGroupId: - type: string - description: Identifier of a group of NFs. - - MtcProviderInformation: - type: string - description: String uniquely identifying MTC provider information. - - CagId: - type: string - pattern: '^[A-Fa-f0-9]{8}$' - description: String containing a Closed Access Group Identifier. - - SupiOrSuci: - type: string - pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|suci-(0-[0-9]{3}-[0-9]{2,3}|[1-7]-.+)-[0-9]{1,4}-(0-0-.*|[a-fA-F1-9]-([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])-[a-fA-F0-9]+)|.+)$' - description: String identifying a SUPI or a SUCI. - - Imsi: - description: String identifying an IMSI - type: string - pattern: '^[0-9]{5,15}$' - - ApplicationlayerId: - type: string - description: > - String identifying an UE with application layer ID. The format of the application - layer ID parameter is same as the Application layer ID defined in clause 11.3.4 of - 3GPP TS 24.554. - - NsacSai: - type: string - description: > - String identifying the Network Slice Admission Control Service Area Identifier. - - -# -# ENUMERATED DATA TYPES -# - - GroupServiceId: - anyOf: - - type: integer - enum: - - 1 - - 2 - - 3 - - type: integer - description: > - This integer provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Possible values are: - - 1: Group specific NAS level congestion control - - 2: Group specific Monitoring of Number of UEs present in a geographical area - - 3: Group specific Group specific for 5G LAN Type service - -# -# STRUCTURED DATA TYPES -# - Guami: - type: object - properties: - plmnId: - $ref: '#/components/schemas/PlmnIdNid' - amfId: - $ref: '#/components/schemas/AmfId' - required: - - plmnId - - amfId - description: Globally Unique AMF Identifier constructed out of PLMN, Network and AMF identity. - - GuamiRm: - anyOf: - - $ref: '#/components/schemas/Guami' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'Guami' data type, but with the OpenAPI - 'nullable: true' property. - - NetworkId: - type: object - properties: - mnc: - $ref: '#/components/schemas/Mnc' - mcc: - $ref: '#/components/schemas/Mcc' - description: contains PLMN and Network identity. - - -# -# Data Types related to 5G Network as defined in clause 5.4 -# - -# -# SIMPLE DATA TYPES -# - ApplicationId: - type: string - description: String providing an application identifier. - ApplicationIdRm: - type: string - nullable: true - description: > - String providing an application identifier with the OpenAPI 'nullable: true' property. - - PduSessionId: - type: integer - minimum: 0 - maximum: 255 - description: > - Unsigned integer identifying a PDU session, within the range 0 to 255, as specified in - clause 11.2.3.1b, bits 1 to 8, of 3GPP TS 24.007. If the PDU Session ID is allocated by the - Core Network for UEs not supporting N1 mode, reserved range 64 to 95 is used. PDU Session ID - within the reserved range is only visible in the Core Network. - - Mcc: - type: string - pattern: '^\d{3}$' - description: > - Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 - of 3GPP TS 38.413. - - MccRm: - type: string - pattern: '^\d{3}$' - nullable: true - description: > - Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of - 3GPP TS 38.413 with the OpenAPI 'nullable: true' property. - - Mnc: - type: string - pattern: '^\d{2,3}$' - description: > - Mobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in - clause 9.3.3.5 of 3GPP TS 38.413. - - MncRm: - type: string - pattern: '^\d{2,3}$' - nullable: true - description: > - Mobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in clause - 9.3.3.5 of 3GPP TS 38.413 with the OpenAPI 'nullable: true' property. - - Tac: - type: string - pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' - description: > - 2 or 3-octet string identifying a tracking area code as specified in clause 9.3.3.10 - of 3GPP TS 38.413, in hexadecimal representation. Each character in the string shall - take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The - most significant character representing the 4 most significant bits of the TAC shall - appear first in the string, and the character representing the 4 least significant bit - of the TAC shall appear last in the string. - - TacRm: - type: string - pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' - nullable: true - description: > - This data type is defined in the same way as the 'Tac' data type, but with the - OpenAPI 'nullable: true' property. - - EutraCellId: - type: string - pattern: '^[A-Fa-f0-9]{7}$' - description: > - 28-bit string identifying an E-UTRA Cell Id as specified in clause 9.3.1.9 of - 3GPP TS 38.413, in hexadecimal representation. Each character in the string shall take a - value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most - significant character representing the 4 most significant bits of the Cell Id shall appear - first in the string, and the character representing the 4 least significant bit of the - Cell Id shall appear last in the string. - - EutraCellIdRm: - type: string - pattern: '^[A-Fa-f0-9]{7}$' - nullable: true - description: > - This data type is defined in the same way as the 'EutraCellId' data type, but with - the OpenAPI 'nullable: true' property. - - NrCellId: - type: string - pattern: '^[A-Fa-f0-9]{9}$' - description: > - 36-bit string identifying an NR Cell Id as specified in clause 9.3.1.7 of 3GPP TS 38.413, - in hexadecimal representation. Each character in the string shall take a value of "0" to - "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character - representing the 4 most significant bits of the Cell Id shall appear first in the string, - and the character representing the 4 least significant bit of the Cell Id shall appear last - in the string. - - NrCellIdRm: - type: string - pattern: '^[A-Fa-f0-9]{9}$' - nullable: true - description: > - This data type is defined in the same way as the 'NrCellId' data type, but with the - OpenAPI 'nullable: true' property. - Dnai: - type: string - description: DNAI (Data network access identifier), see clause 5.6.7 of 3GPP TS 23.501. - - DnaiRm: - type: string - nullable: true - description: > - This data type is defined in the same way as the 'Dnai' data type, but with the - OpenAPI 'nullable: true' property. - - 5GMmCause: - $ref: '#/components/schemas/Uinteger' - - AmfName: - $ref: '#/components/schemas/Fqdn' - - AreaCode: - type: string - description: Values are operator specific. - - AreaCodeRm: - type: string - nullable: true - description: > - This data type is defined in the same way as the 'AreaCode' data type, but with the - OpenAPI 'nullable: true' property. - - N3IwfId: - type: string - pattern: '^[A-Fa-f0-9]+$' - description: > - This represents the identifier of the N3IWF ID as specified in clause 9.3.1.57 of - 3GPP TS 38.413 in hexadecimal representation. Each character in the string shall take a value - of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant - character representing the 4 most significant bits of the N3IWF ID shall appear first in the - string, and the character representing the 4 least significant bit of the N3IWF ID shall - appear last in the string. - - WAgfId: - type: string - pattern: '^[A-Fa-f0-9]+$' - description: > - This represents the identifier of the W-AGF ID as specified in clause 9.3.1.162 of - 3GPP TS 38.413 in hexadecimal representation. Each character in the string shall take a - value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most - significant character representing the 4 most significant bits of the W-AGF ID shall - appear first in the string, and the character representing the 4 least significant bit - of the W-AGF ID shall appear last in the string. - - TngfId: - type: string - pattern: '^[A-Fa-f0-9]+$' - description: > - This represents the identifier of the TNGF ID as specified in clause 9.3.1.161 of - 3GPP TS 38.413 in hexadecimal representation. Each character in the string shall take a value - of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant - character representing the 4 most significant bits of the TNGF ID shall appear first in - the string, and the character representing the 4 least significant bit of the TNGF ID - shall appear last in the string. - - NgeNbId: - type: string - pattern: '^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$' - description: > - This represents the identifier of the ng-eNB ID as specified in clause 9.3.1.8 of - 3GPP TS 38.413. The value of the ng-eNB ID shall be encoded in hexadecimal representation. - Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and - shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, so the most - significant character representing the padding 0 if required together with the 4 most - significant bits of the ng-eNB ID shall appear first in the string, and the character - representing the 4 least significant bit of the ng-eNB ID (to form a nibble) shall appear - last in the string. - - example: SMacroNGeNB-34B89 - Nid: - type: string - pattern: '^[A-Fa-f0-9]{11}$' - description: > - This represents the Network Identifier, which together with a PLMN ID is used to identify - an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1). - - NidRm: - type: string - pattern: '^[A-Fa-f0-9]{11}$' - nullable: true - description: > - This data type is defined in the same way as the 'Nid' data type, but with the OpenAPI - 'nullable: true' property." - - NfSetId: - type: string - description: > - NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string - "set.set.5gc.mnc.mcc", or - "set.set.5gc.nid.mnc.mcc" with - encoded as defined in clause 5.4.2 ("Mcc" data type definition) - encoding the Mobile Network Code part of the PLMN, comprising 3 digits. - If there are only 2 significant digits in the MNC, one "0" digit shall be inserted - at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$' - encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but - with lower case characters encoded as a string of characters consisting of - alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that - shall end with either an alphabetic character or a digit. - - NfServiceSetId: - type: string - description: > - NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following - string "set.sn.nfi.5gc.mnc.mcc", or - "set.sn.nfi.5gc.nid.mnc.mcc" with - encoded as defined in clause 5.4.2 ("Mcc" data type definition) - encoding the Mobile Network Code part of the PLMN, comprising 3 digits. - If there are only 2 significant digits in the MNC, one "0" digit shall be inserted - at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$' - encoded as defined in clause 5.4.2 ("Nid" data type definition) - encoded as defined in clause 5.3.2 - encoded as defined in 3GPP TS 29.510 - encoded as a string of characters consisting of alphabetic - characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end - with either an alphabetic character or a digit. - - PlmnAssiUeRadioCapId: - $ref: '#/components/schemas/Bytes' - - ManAssiUeRadioCapId: - $ref: '#/components/schemas/Bytes' - - TypeAllocationCode: - type: string - pattern: '^[0-9]{8}$' - description: > - Type Allocation Code (TAC) of the UE, comprising the initial eight-digit portion of the - 15-digit IMEI and 16-digit IMEISV codes. See clause 6.2 of 3GPP TS 23.003. - - HfcNId: - type: string - maxLength: 6 - description: > - This IE represents the identifier of the HFC node Id as specified in CableLabs - WR-TR-5WWC-ARCH. It is provisioned by the wireline operator as part of wireline - operations and may contain up to six characters. - - HfcNIdRm: - type: string - maxLength: 6 - nullable: true - description: > - This data type is defined in the same way as the 'HfcNId' data type, but with the - OpenAPI 'nullable: true' property. - - ENbId: - type: string - pattern: '^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$' - description: > - This represents the identifier of the eNB ID as specified in clause 9.2.1.37 of - 3GPP TS 36.413. The string shall be formatted with the following pattern - '^('MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5} - |HomeeNB-[A-Fa-f0-9]{7})$'. The value of the eNB ID shall be encoded in hexadecimal - representation. Each character in the string shall take a value of "0" to "9", "a" to "f" - or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple - nibbles, so the most significant character representing the padding 0 if required together - with the 4 most significant bits of the eNB ID shall appear first in the string, and the - character representing the 4 least significant bit of the eNB ID (to form a nibble) shall - appear last in the string. - - Gli: - $ref: '#/components/schemas/Bytes' - Gci: - type: string - description: > - Global Cable Identifier uniquely identifying the connection between the 5G-CRG or FN-CRG - to the 5GS. See clause 28.15.4 of 3GPP TS 23.003. This shall be encoded as a string per - clause 28.15.4 of 3GPP TS 23.003, and compliant with the syntax specified in clause 2.2 - of IETF RFC 7542 for the username part of a NAI. The GCI value is specified in - CableLabs WR-TR-5WWC-ARCH. - - NsSrg: - type: string - description: > - String providing a Network Slice Simultaneous Registration Group. See clause 5.15.12 of - 3GPP TS 23.501 - - NsSrgRm: - type: string - nullable: true - description: > - String providing a Network Slice Simultaneous Registration Group with the OpenAPI - "nullable: true" property. See clause 5.15.12 of 3GPP TS 23.501 - - - RelayServiceCode: - type: integer - minimum: 0 - maximum: 16777215 - description: > - Relay Service Code to identify a connectivity service provided by the UE-to-Network relay or - the UE-to-UE relay. - - 5GPrukId: - type: string - description: > - A string carrying the CP-PRUK ID of the 5G ProSe Remote UE or the 5G ProSe End UE. - The CP-PRUK ID is a string in NAI format as specified in clause 28.7.11 of 3GPP TS 23.003. - pattern: '^rid[0-9]{1,4}\.pid[0-9a-fA-F]+\@prose-cp\.5gc\.mnc[0-9]{2,3}\.mcc[0-9]{3}\.3gppnetwork\.org$' - - NsagId: - type: integer - description: > - The Network Slice AS Group ID, see 3GPP TS 38.413 - - NsagIdRm: - type: integer - nullable: true - description: > - This data type is defined in the same way as the "NsagId" data type, but with the OpenAPI - "nullable: true" property - - GeoSatelliteId: - type: string - description: > - A string carrying the GEO Satellite ID. - - OffloadIdentifier: - type: string - description: > - Offload identifier uniquely identifying a VPLMN offloading policy information instance - pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{8}(-v[0-9]{1,2}){0,1}$' - -# -# ENUMERATED DATA TYPES -# - - AccessType: - type: string - enum: - - 3GPP_ACCESS - - NON_3GPP_ACCESS - description: Indicates whether the access is via 3GPP or via non-3GPP. - - AccessTypeRm: - anyOf: - - $ref: '#/components/schemas/AccessType' - - $ref: '#/components/schemas/NullValue' - description: > - Indicates wether the access is via 3GPP or via non-3GPP but with the OpenAPI - 'nullable: true' property." - - RatType: - anyOf: - - type: string - enum: - - NR - - EUTRA - - WLAN - - VIRTUAL - - NBIOT - - WIRELINE - - WIRELINE_CABLE - - WIRELINE_BBF - - LTE-M - - NR_U - - EUTRA_U - - TRUSTED_N3GA - - TRUSTED_WLAN - - UTRA - - GERA - - NR_LEO - - NR_MEO - - NR_GEO - - NR_OTHER_SAT - - NR_REDCAP - - WB_E_UTRAN_LEO - - WB_E_UTRAN_MEO - - WB_E_UTRAN_GEO - - WB_E_UTRAN_OTHERSAT - - NB_IOT_LEO - - NB_IOT_MEO - - NB_IOT_GEO - - NB_IOT_OTHERSAT - - LTE_M_LEO - - LTE_M_MEO - - LTE_M_GEO - - LTE_M_OTHERSAT - - NR_EREDCAP - - type: string - description: Indicates the radio access used. - - RatTypeRm: - anyOf: - - $ref: '#/components/schemas/RatType' - - $ref: '#/components/schemas/NullValue' - description: > - Provides information about the radio access but with the OpenAPI 'nullable: true' property. - - PduSessionType: - anyOf: - - type: string - enum: - - IPV4 - - IPV6 - - IPV4V6 - - UNSTRUCTURED - - ETHERNET - - type: string - description: > - PduSessionType indicates the type of a PDU session. It shall comply with the provisions - defined in table 5.4.3.3-1. - - PduSessionTypeRm: - anyOf: - - $ref: '#/components/schemas/PduSessionType' - - $ref: '#/components/schemas/NullValue' - description: > - PduSessionType indicates the type of a PDU session. It shall comply with the provisions - defined in table 5.4.3.3-1 but with the OpenAPI "nullable: true" property. - - UpIntegrity: - anyOf: - - type: string - enum: - - REQUIRED - - PREFERRED - - NOT_NEEDED - - type: string - description: > - indicates whether UP integrity protection is required, preferred or not needed for all - the traffic on the PDU Session. It shall comply with the provisions defined in - table 5.4.3.4-1. - - UpIntegrityRm: - anyOf: - - $ref: '#/components/schemas/UpIntegrity' - - $ref: '#/components/schemas/NullValue' - description: > - indicates whether UP integrity protection is required, preferred or not needed for all - the traffic on the PDU Session. It shall comply with the provisions defined in - table 5.4.3.4-1. - - UpConfidentiality: - anyOf: - - type: string - enum: - - REQUIRED - - PREFERRED - - NOT_NEEDED - - type: string - description: > - indicates whether UP confidentiality protection is required, preferred or not needed for - all the traffic on the PDU Session. It shall comply with the provisions defined in - table 5.4.3.5-1. - - UpConfidentialityRm: - anyOf: - - $ref: '#/components/schemas/UpConfidentiality' - - $ref: '#/components/schemas/NullValue' - description: > - indicates whether UP integrity protection is required, preferred or not needed for all the - traffic on the PDU Session. It shall comply with the provisions defined in table 5.4.3.4-1, - but with the OpenAPI 'nullable: true' property. - - SscMode: - anyOf: - - type: string - enum: - - SSC_MODE_1 - - SSC_MODE_2 - - SSC_MODE_3 - - type: string - description: > - represents the service and session continuity mode It shall comply with the provisions - defined in table 5.4.3.6-1. - - SscModeRm: - anyOf: - - $ref: '#/components/schemas/SscMode' - - $ref: '#/components/schemas/NullValue' - description: > - represents the service and session continuity mode It shall comply with the provisions - defined in table 5.4.3.6-1 but with the OpenAPI 'nullable: true' property. - - DnaiChangeType: - anyOf: - - type: string - enum: - - EARLY - - EARLY_LATE - - LATE - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - but is not used to encode content defined in the present version of this API. - - description: | - Possible values are: - - EARLY: Early notification of UP path reconfiguration. - - EARLY_LATE: Early and late notification of UP path reconfiguration. This value shall - only be present in the subscription to the DNAI change event. - - LATE: Late notification of UP path reconfiguration. - - DnaiChangeTypeRm: - anyOf: - - $ref: '#/components/schemas/DnaiChangeType' - - $ref: '#/components/schemas/NullValue' - description: > - It can take the values as specified for DnaiChangeType but with the OpenAPI - 'nullable: true' property. - - RestrictionType: - anyOf: - - type: string - enum: - - ALLOWED_AREAS - - NOT_ALLOWED_AREAS - - type: string - description: It contains the restriction type ALLOWED_AREAS or NOT_ALLOWED_AREAS. - - RestrictionTypeRm: - anyOf: - - $ref: '#/components/schemas/RestrictionType' - - $ref: '#/components/schemas/NullValue' - description: > - It contains the restriction type ALLOWED_AREAS or NOT_ALLOWED_AREAS but with the - OpenAPI 'nullable: true' property. - - CoreNetworkType: - anyOf: - - type: string - enum: - - 5GC - - EPC - - type: string - description: It contains the Core Network type 5GC or EPC. - - CoreNetworkTypeRm: - anyOf: - - $ref: '#/components/schemas/CoreNetworkType' - - $ref: '#/components/schemas/NullValue' - description: > - It contains the Core Network type 5GC or EPC but with the OpenAPI - 'nullable: true' property. - - PresenceState: - anyOf: - - type: string - enum: - - IN_AREA - - OUT_OF_AREA - - UNKNOWN - - INACTIVE - - type: string - description: | - Possible values are: - -IN_AREA: Indicates that the UE is inside or enters the presence reporting area. - -OUT_OF_AREA: Indicates that the UE is outside or leaves the presence reporting area - -UNKNOW: Indicates it is unknown whether the UE is in the presence reporting area or not - -INACTIVE: Indicates that the presence reporting area is inactive in the serving node. - - StationaryIndication: - anyOf: - - type: string - enum: - - STATIONARY - - MOBILE - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Possible values are: - - STATIONARY: Identifies the UE is stationary - - MOBILE: Identifies the UE is mobile - - StationaryIndicationRm: - anyOf: - - $ref: '#/components/schemas/StationaryIndication' - - $ref: '#/components/schemas/NullValue' - description: > - This enumeration is defined in the same way as the 'StationaryIndication' enumeration, - but with the OpenAPI 'nullable: true' property." - - ScheduledCommunicationType: - anyOf: - - type: string - enum: - - DOWNLINK_ONLY - - UPLINK_ONLY - - BIDIRECTIONAL - - type: string - description: | - Possible values are: - -DOWNLINK_ONLY: Downlink only - -UPLINK_ONLY: Uplink only - -BIDIRECTIONA: Bi-directional - - ScheduledCommunicationTypeRm: - anyOf: - - $ref: '#/components/schemas/ScheduledCommunicationType' - - $ref: '#/components/schemas/NullValue' - description: > - This enumeration is defined in the same way as the 'ScheduledCommunicationTypen' - enumeration, but with the OpenAPI 'nullable: true' property." - - TrafficProfile: - anyOf: - - type: string - enum: - - SINGLE_TRANS_UL - - SINGLE_TRANS_DL - - DUAL_TRANS_UL_FIRST - - DUAL_TRANS_DL_FIRST - - MULTI_TRANS - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - - description: | - Possible values are: - - SINGLE_TRANS_UL: Uplink single packet transmission. - - SINGLE_TRANS_DL: Downlink single packet transmission. - - DUAL_TRANS_UL_FIRST: Dual packet transmission, firstly uplink packet transmission - with subsequent downlink packet transmission. - - DUAL_TRANS_DL_FIRST: Dual packet transmission, firstly downlink packet transmission - with subsequent uplink packet transmission. - - TrafficProfileRm: - anyOf: - - $ref: '#/components/schemas/TrafficProfile' - - $ref: '#/components/schemas/NullValue' - description: > - This enumeration is defined in the same way as the 'TrafficProfile' enumeration, but - with the OpenAPI 'nullable: true' property. - - LcsServiceAuth: - anyOf: - - type: string - enum: - - "LOCATION_ALLOWED_WITH_NOTIFICATION" - - "LOCATION_ALLOWED_WITHOUT_NOTIFICATION" - - "LOCATION_ALLOWED_WITHOUT_RESPONSE" - - "LOCATION_RESTRICTED_WITHOUT_RESPONSE" - - "NOTIFICATION_ONLY" - - "NOTIFICATION_AND_VERIFICATION_ONLY" - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Possible values are: - - "LOCATION_ALLOWED_WITH_NOTIFICATION": Location allowed with notification - - "LOCATION_ALLOWED_WITHOUT_NOTIFICATION": Location allowed without notification - - "LOCATION_ALLOWED_WITHOUT_RESPONSE": Location with notification and privacy - verification; location allowed if no response - - "LOCATION_RESTRICTED_WITHOUT_RESPONSE": Location with notification and privacy - verification; location restricted if no response - - "NOTIFICATION_ONLY": Notification only - - "NOTIFICATION_AND_VERIFICATION_ONLY": Notification and privacy verification only - UeAuth: - anyOf: - - type: string - enum: - - AUTHORIZED - - NOT_AUTHORIZED - - type: string - description: | - Possible values are: - - AUTHORIZED: Indicates that the UE is authorized. - - NOT_AUTHORIZED: Indicates that the UE is not authorized. - - DlDataDeliveryStatus: - anyOf: - - type: string - enum: - - BUFFERED - - TRANSMITTED - - DISCARDED - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Possible values are: - - BUFFERED: The first downlink data is buffered with extended buffering matching the - source of the downlink traffic. - - TRANSMITTED: The first downlink data matching the source of the downlink traffic is - transmitted after previous buffering or discarding of corresponding packet(s) because - the UE of the PDU Session becomes ACTIVE, and buffered data can be delivered to UE. - - DISCARDED: The first downlink data matching the source of the downlink traffic is - discarded because the Extended Buffering time, as determined by the SMF, expires or - the amount of downlink data to be buffered is exceeded. - - DlDataDeliveryStatusRm: - anyOf: - - $ref: '#/components/schemas/DlDataDeliveryStatus' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the ' DlDataDeliveryStatus ' data type, - but with the OpenAPI 'nullable: true' property. - - AuthStatus: - anyOf: - - type: string - enum: - - EAP_SUCCESS - - EAP_FAILURE - - PENDING - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - - description: | - Possible values are: - - "EAP_SUCCESS": The NSSAA status is EAP-Success. - - "EAP_FAILURE": The NSSAA status is EAP-Failure. - - "PENDING": The NSSAA status is Pending. - - LineType: - anyOf: - - type: string - enum: - - DSL - - PON - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - - description: | - Possible values are: - - DSL: Identifies a DSL line - - PON: Identifies a PON line - - LineTypeRm: - anyOf: - - $ref: '#/components/schemas/LineType' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'LineType' data type, but with the - OpenAPI 'nullable: true' property. - - - NotificationFlag: - anyOf: - - type: string - enum: - - ACTIVATE - - DEACTIVATE - - RETRIEVAL - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - - description: | - Possible values are: - - ACTIVATE: The event notification is activated. - - DEACTIVATE: The event notification is deactivated and shall be muted. The available - event(s) shall be stored. - - RETRIEVAL: The event notification shall be sent to the NF service consumer(s), - after that, is muted again. - - - TransportProtocol: - anyOf: - - type: string - enum: - - UDP - - TCP - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - - description: | - Possible values are: - - UDP: User Datagram Protocol. - - TCP: Transmission Control Protocol. - - - SatelliteBackhaulCategory: - anyOf: - - type: string - enum: - - GEO - - MEO - - LEO - - OTHER_SAT - - DYNAMIC_GEO - - DYNAMIC_MEO - - DYNAMIC_LEO - - DYNAMIC_OTHER_SAT - - NON_SATELLITE - - type: string - description: Indicates the satellite backhaul used. - - SatelliteBackhaulCategoryRm: - anyOf: - - $ref: '#/components/schemas/SatelliteBackhaulCategory' - - $ref: '#/components/schemas/NullValue' - description: > - Provides information about the satellite backhaul but with the OpenAPI - 'nullable: true' property. - - BufferedNotificationsAction: - anyOf: - - type: string - enum: - - SEND_ALL - - DISCARD_ALL - - DROP_OLD - - type: string - description: > - Indicates the required action by the event producer NF on the buffered Notifications. - - SubscriptionAction: - anyOf: - - type: string - enum: - - CLOSE - - CONTINUE_WITH_MUTING - - CONTINUE_WITHOUT_MUTING - - type: string - description: > - Indicates the required action by the event producer NF on the event subscription if an - exception occurs while the event is muted. - - SnssaiStatus: - anyOf: - - type: string - enum: - - AVAILABLE - - UNAVAILABLE - - type: string - description: Indicates the S-NSSAI availability. - - TerminationIndication: - description: Indicates the termination of Network Slice Replacement. - anyOf: - - type: string - enum: - - NEW_UES_TERMINATION - - ALL_UES_TERMINATION - - type: string - - -# -# STRUCTURED DATA TYPES -# - SubscribedDefaultQos: - type: object - required: - - 5qi - - arp - properties: - 5qi: - $ref: '#/components/schemas/5Qi' - arp: - $ref: '#/components/schemas/Arp' - priorityLevel: - $ref: '#/components/schemas/5QiPriorityLevel' - description: Provides the subsribed 5QI and the ARP, it may contain the priority level. - - Snssai: - type: object - properties: - sst: - type: integer - minimum: 0 - maximum: 255 - description: > - Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. - It indicates the expected Network Slice behaviour in terms of features and services. - Values 0 to 127 correspond to the standardized SST range. Values 128 to 255 correspond - to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. - Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501. - - sd: - type: string - pattern: '^[A-Fa-f0-9]{6}$' - description: > - 3-octet string, representing the Slice Differentiator, in hexadecimal representation. - Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" - and shall represent 4 bits. The most significant character representing the 4 most - significant bits of the SD shall appear first in the string, and the character - representing the 4 least significant bit of the SD shall appear last in the string. - This is an optional parameter that complements the Slice/Service type(s) to allow to - differentiate amongst multiple Network Slices of the same Slice/Service type. This IE - shall be absent if no SD value is associated with the SST. - description: > - When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall - be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits - "sd". - - required: - - sst - - PlmnId: - type: object - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - description: > - When PlmnId needs to be converted to string (e.g. when used in maps as key), the string - shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc". - - required: - - mcc - - mnc - PlmnIdRm: - anyOf: - - $ref: '#/components/schemas/PlmnId' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'PlmnId' data type, but with the - OpenAPI 'nullable: true' property. - - Tai: - description: Contains the tracking area identity as described in 3GPP 23.003 - type: object - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - tac: - $ref: '#/components/schemas/Tac' - nid: - $ref: '#/components/schemas/Nid' - required: - - plmnId - - tac - - TaiRm: - anyOf: - - $ref: '#/components/schemas/Tai' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'Tai' data type, but with the OpenAPI - 'nullable: true' property. - - Ecgi: - description: Contains the ECGI (E-UTRAN Cell Global Identity), as described in 3GPP 23.003 - type: object - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - eutraCellId: - $ref: '#/components/schemas/EutraCellId' - nid: - $ref: '#/components/schemas/Nid' - required: - - plmnId - - eutraCellId - - EcgiRm: - anyOf: - - $ref: '#/components/schemas/Ecgi' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'Ecgi' data type, but with the - OpenAPI 'nullable: true' property. - - Ncgi: - description: Contains the NCGI (NR Cell Global Identity), as described in 3GPP 23.003 - type: object - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - nrCellId: - $ref: '#/components/schemas/NrCellId' - nid: - $ref: '#/components/schemas/Nid' - required: - - plmnId - - nrCellId - - NcgiRm: - anyOf: - - $ref: '#/components/schemas/Ncgi' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'Ncgi' data type, but with the - OpenAPI 'nullable: true' property. - - UserLocation: - type: object - properties: - eutraLocation: - $ref: '#/components/schemas/EutraLocation' - nrLocation: - $ref: '#/components/schemas/NrLocation' - n3gaLocation: - $ref: '#/components/schemas/N3gaLocation' - utraLocation: - $ref: '#/components/schemas/UtraLocation' - geraLocation: - $ref: '#/components/schemas/GeraLocation' - description: > - At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several - of them may be present. - - EutraLocation: - description: Contains the E-UTRA user location. - type: object - properties: - tai: - $ref: '#/components/schemas/Tai' - ignoreTai: - type: boolean - default: false - ecgi: - $ref: '#/components/schemas/Ecgi' - ignoreEcgi: - type: boolean - default: false - description: > - This flag when present shall indicate that the Ecgi shall be ignored - When present, it shall be set as follows: - - true: ecgi shall be ignored. - - false (default): ecgi shall not be ignored. - ageOfLocationInformation: - type: integer - minimum: 0 - maximum: 32767 - description: > - The value represents the elapsed time in minutes since the last network contact of the - mobile station. Value "0" indicates that the location information was obtained after a - successful paging procedure for Active Location Retrieval when the UE is in idle mode - or after a successful NG-RAN location reporting procedure with the eNB when the UE is - in connected mode. Any other value than "0" indicates that the location information is - the last known one. See 3GPP TS 29.002 clause 17.7.8. - ueLocationTimestamp: - $ref: '#/components/schemas/DateTime' - geographicalInformation: - type: string - pattern: '^[0-9A-F]{16}$' - description: > - Refer to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the - description of an ellipsoid point with uncertainty circle is allowed to be used. - geodeticInformation: - type: string - pattern: '^[0-9A-F]{20}$' - description: > - Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] - clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle - is allowed to be used. - globalNgenbId: - $ref: '#/components/schemas/GlobalRanNodeId' - - globalENbId: - $ref: '#/components/schemas/GlobalRanNodeId' - required: - - tai - - ecgi - - EutraLocationRm: - anyOf: - - $ref: '#/components/schemas/EutraLocation' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'EutraLocation' data type, but with - the OpenAPI 'nullable: true' property. - - NrLocation: - description: Contains the NR user location. - type: object - properties: - tai: - $ref: '#/components/schemas/Tai' - ncgi: - $ref: '#/components/schemas/Ncgi' - ignoreNcgi: - type: boolean - default: false - ageOfLocationInformation: - type: integer - minimum: 0 - maximum: 32767 - description: > - The value represents the elapsed time in minutes since the last network contact of the mobile - station. Value "0" indicates that the location information was obtained after a - successful paging procedure for Active Location Retrieval when the UE is in idle mode - or after a successful NG-RAN location reporting procedure with the eNB when the UE is - in connected mode. Any other value than "0" indicates that the location information is - the last known one. See 3GPP TS 29.002 clause 17.7.8. - ueLocationTimestamp: - $ref: '#/components/schemas/DateTime' - geographicalInformation: - type: string - pattern: '^[0-9A-F]{16}$' - description: > - Refer to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description - of an ellipsoid point with uncertainty circle is allowed to be used. - geodeticInformation: - type: string - pattern: '^[0-9A-F]{20}$' - description: > - Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause - 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed - to be used. - globalGnbId: - $ref: '#/components/schemas/GlobalRanNodeId' - ntnTaiInfo: - $ref: '#/components/schemas/NtnTaiInfo' - required: - - tai - - ncgi - - NrLocationRm: - anyOf: - - $ref: '#/components/schemas/NrLocation' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'NrLocation' data type, but with the - OpenAPI 'nullable: true' property." - - N3gaLocation: - description: Contains the Non-3GPP access user location. - type: object - properties: - n3gppTai: - $ref: '#/components/schemas/Tai' - n3IwfId: - type: string - pattern: '^[A-Fa-f0-9]+$' - description: > - This IE shall contain the N3IWF identifier received over NGAP and shall be encoded as a - string of hexadecimal characters. Each character in the string shall take a value of "0" - to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant - character representing the 4 most significant bits of the N3IWF ID shall appear first in - the string, and the character representing the 4 least significant bit of the N3IWF ID - shall appear last in the string. - - ueIpv4Addr: - $ref: '#/components/schemas/Ipv4Addr' - ueIpv6Addr: - $ref: '#/components/schemas/Ipv6Addr' - portNumber: - $ref: '#/components/schemas/Uinteger' - protocol: - $ref: '#/components/schemas/TransportProtocol' - tnapId: - $ref: '#/components/schemas/TnapId' - twapId: - $ref: '#/components/schemas/TwapId' - hfcNodeId: - $ref: '#/components/schemas/HfcNodeId' - gli: - $ref: '#/components/schemas/Gli' - w5gbanLineType: - $ref: '#/components/schemas/LineType' - gci: - $ref: '#/components/schemas/Gci' - - UpSecurity: - description: Contains Userplain security information. - type: object - properties: - upIntegr: - $ref: '#/components/schemas/UpIntegrity' - upConfid: - $ref: '#/components/schemas/UpConfidentiality' - required: - - upIntegr - - upConfid - - UpSecurityRm: - anyOf: - - $ref: '#/components/schemas/UpSecurity' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'UpSecurity' data type, but with the - OpenAPI 'nullable: true' property. - - NgApCause: - description: Represents the NGAP cause. - type: object - properties: - group: - $ref: '#/components/schemas/Uinteger' - value: - $ref: '#/components/schemas/Uinteger' - required: - - group - - value - - BackupAmfInfo: - description: Provides details of the Backup AMF. - type: object - properties: - backupAmf: - $ref: '#/components/schemas/AmfName' - guamiList: - type: array - items: - $ref: '#/components/schemas/Guami' - minItems: 1 - description: > - If present, this IE shall contain the list of GUAMI(s) (supported by the AMF) for - which the backupAmf IE applies. - required: - - backupAmf - - RefToBinaryData: - description: This parameter provides information about the referenced binary body data. - type: object - properties: - contentId: - type: string - description: > - This IE shall contain the value of the Content-ID header of the referenced binary - body part. - required: - - contentId - - RefToBinaryDataRm: - anyOf: - - $ref: '#/components/schemas/RefToBinaryData' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the ' RefToBinaryData ' data type, - but with the OpenAPI 'nullable: true' property. - - RouteToLocation: - type: object - properties: - dnai: - $ref: '#/components/schemas/Dnai' - routeInfo: - $ref: '#/components/schemas/RouteInformation' - routeProfId: - type: string - nullable: true - description: Identifies the routing profile Id. - required: - - dnai - anyOf: - - required: [ routeInfo ] - - required: [ routeProfId ] - nullable: true - description: > - At least one of the "routeInfo" attribute and the "routeProfId" attribute shall be included - in the "RouteToLocation" data type. - - RouteInformation: - type: object - properties: - ipv4Addr: - $ref: '#/components/schemas/Ipv4Addr' - ipv6Addr: - $ref: '#/components/schemas/Ipv6Addr' - portNumber: - $ref: '#/components/schemas/Uinteger' - required: - - portNumber - nullable: true - description: > - At least one of the "ipv4Addr" attribute and the "ipv6Addr" attribute shall be included in - the "RouteInformation" data type. - - Area: - description: Provides area information. - type: object - oneOf: - - required: - - tacs - - required: - - areaCode - properties: - tacs: - type: array - items: - $ref: '#/components/schemas/Tac' - minItems: 1 - areaCode: - $ref: '#/components/schemas/AreaCode' - - ServiceAreaRestriction: - description: Provides information about allowed or not allowed areas. - type: object - properties: - restrictionType: - $ref: '#/components/schemas/RestrictionType' - areas: - type: array - items: - $ref: '#/components/schemas/Area' - maxNumOfTAs: - $ref: '#/components/schemas/Uinteger' - maxNumOfTAsForNotAllowedAreas: - $ref: '#/components/schemas/Uinteger' - allOf: - # - # 1st condition: restrictionType and areas attributes shall be either both absent - # or both present - # - - oneOf: - - not: - required: [ restrictionType ] - - required: [ areas ] - # - # 2nd condition: if restrictionType takes value NOT_ALLOWED_AREAS, - # then maxNumOfTAs shall be absent - # - - anyOf: - - not: - required: [ restrictionType ] - properties: - restrictionType: - type: string - enum: [ NOT_ALLOWED_AREAS ] - - not: - required: [ maxNumOfTAs ] - # - # 3rd condition: if restrictionType takes value ALLOWED_AREAS, - # then maxNumOfTAsForNotAllowedAreas shall be absent - # - - anyOf: - - not: - required: [ restrictionType ] - properties: - restrictionType: - type: string - enum: [ ALLOWED_AREAS ] - - not: - required: [ maxNumOfTAsForNotAllowedAreas ] - - PresenceInfo: - type: object - properties: - praId: - type: string - description: > - Represents an identifier of the Presence Reporting Area (see clause 28.10 of 3GPP - TS 23.003. This IE shall be present if the Area of Interest subscribed or reported is - a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas. - When present, it shall be encoded as a string representing an integer in the following - ranges: - 0 to 8 388 607 for UE-dedicated PRA - 8 388 608 to 16 777 215 for Core Network predefined PRA - Examples: - PRA ID 123 is encoded as "123" - PRA ID 11 238 660 is encoded as "11238660" - - additionalPraId: - type: string - description: > - This IE may be present if the praId IE is present and if it contains a PRA identifier - referring to a set of Core Network predefined Presence Reporting Areas. When present, - this IE shall contain a PRA Identifier of an individual PRA within the Set of Core - Network predefined Presence Reporting Areas indicated by the praId IE. - - presenceState: - $ref: '#/components/schemas/PresenceState' - trackingAreaList: - type: array - items: - $ref: '#/components/schemas/Tai' - minItems: 1 - description: > - Represents the list of tracking areas that constitutes the area. This IE shall be - present if the subscription or the event report is for tracking UE presence in the - tracking areas. For non 3GPP access the TAI shall be the N3GPP TAI. - - ecgiList: - type: array - items: - $ref: '#/components/schemas/Ecgi' - minItems: 1 - description: > - Represents the list of EUTRAN cell Ids that constitutes the area. This IE shall - be present if the Area of Interest subscribed is a list of EUTRAN cell Ids. - - ncgiList: - type: array - items: - $ref: '#/components/schemas/Ncgi' - minItems: 1 - description: > - Represents the list of NR cell Ids that constitutes the area. This IE shall be - present if the Area of Interest subscribed is a list of NR cell Ids. - - globalRanNodeIdList: - type: array - items: - $ref: '#/components/schemas/GlobalRanNodeId' - minItems: 1 - description: > - Represents the list of NG RAN node identifiers that constitutes the area. This IE shall - be present if the Area of Interest subscribed is a list of NG RAN node identifiers. - - globaleNbIdList: - type: array - items: - $ref: '#/components/schemas/GlobalRanNodeId' - minItems: 1 - description: > - Represents the list of eNodeB identifiers that constitutes the area. This IE shall be - present if the Area of Interest subscribed is a list of eNodeB identifiers. - description: > - If the additionalPraId IE is present, this IE shall state the presence information of the - UE for the individual PRA identified by the additionalPraId IE; If the additionalPraId IE - is not present, this IE shall state the presence information of the UE for the PRA - identified by the praId IE. - PresenceInfoRm: - type: object - properties: - praId: - type: string - description: | - Represents an identifier of the Presence Reporting Area (see clause 28.10 of - 3GPP TS 23.003. This IE shall be present if the Area of Interest subscribed or - reported is a Presence Reporting Area or a Set of Core Network predefined Presence - Reporting Areas. When present, it shall be encoded as a string representing an integer - in the following ranges: - - 0 to 8 388 607 for UE-dedicated PRA - - 8 388 608 to 16 777 215 for Core Network predefined PRA - Examples: - PRA ID 123 is encoded as "123" - PRA ID 11 238 660 is encoded as "11238660" - additionalPraId: - type: string - description: > - This IE may be present if the praId IE is present and if it contains a PRA identifier - referring to a set of Core Network predefined Presence Reporting Areas. - When present, this IE shall contain a PRA Identifier of an individual PRA within the Set - of Core Network predefined Presence Reporting Areas indicated by the praId IE. - - presenceState: - $ref: '#/components/schemas/PresenceState' - trackingAreaList: - type: array - items: - $ref: '#/components/schemas/Tai' - minItems: 0 - description: > - Represents the list of tracking areas that constitutes the area. This IE shall be - present if the subscription or the event report is for tracking UE presence in the - tracking areas. For non 3GPP access the TAI shall be the N3GPP TAI. - - ecgiList: - type: array - items: - $ref: '#/components/schemas/Ecgi' - minItems: 0 - description: > - Represents the list of EUTRAN cell Ids that constitutes the area. This IE shall be - present if the Area of Interest subscribed is a list of EUTRAN cell Ids. - ncgiList: - type: array - items: - $ref: '#/components/schemas/Ncgi' - minItems: 0 - description: > - Represents the list of NR cell Ids that constitutes the area. This IE shall be present - if the Area of Interest subscribed is a list of NR cell Ids. - globalRanNodeIdList: - type: array - items: - $ref: '#/components/schemas/GlobalRanNodeId' - description: > - Represents the list of NG RAN node identifiers that constitutes the area. This IE shall be - present if the Area of Interest subscribed is a list of NG RAN node identifiers. - globaleNbIdList: - type: array - items: - $ref: '#/components/schemas/GlobalRanNodeId' - minItems: 1 - description: > - Represents the list of eNodeB identifiers that constitutes the area. This IE shall be present - if the Area of Interest subscribed is a list of eNodeB identifiers. - nullable: true - description: > - This data type is defined in the same way as the 'PresenceInfo' data type, but with the - OpenAPI 'nullable: true' property. If the additionalPraId IE is present, this IE shall state - the presence information of the UE for the individual PRA identified by the additionalPraId - IE; If the additionalPraId IE is not present, this IE shall state the presence information - of the UE for the PRA identified by the praId IE. - - GlobalRanNodeId: - type: object - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - n3IwfId: - $ref: '#/components/schemas/N3IwfId' - gNbId: - $ref: '#/components/schemas/GNbId' - ngeNbId: - $ref: '#/components/schemas/NgeNbId' - wagfId: - $ref: '#/components/schemas/WAgfId' - tngfId: - $ref: '#/components/schemas/TngfId' - nid: - $ref: '#/components/schemas/Nid' - eNbId: - $ref: '#/components/schemas/ENbId' - oneOf: - - required: [ n3IwfId ] - - required: [ gNbId ] - - required: [ ngeNbId ] - - required: [ wagfId ] - - required: [ tngfId ] - - required: [ eNbId ] - description: > - One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, eNbId shall be present. - required: - - plmnId - GNbId: - description: Provides the G-NB identifier. - type: object - properties: - bitLength: - type: integer - minimum: 22 - maximum: 32 - description: > - Unsigned integer representing the bit length of the gNB ID as defined in clause - 9.3.1.6 of 3GPP TS 38.413 [11], within the range 22 to 32. - gNBValue: - type: string - pattern: '^[A-Fa-f0-9]{6,8}$' - description: > - This represents the identifier of the gNB. The value of the gNB ID shall be encoded - in hexadecimal representation. Each character in the string shall take a value of - "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall - be added to make multiple nibbles, the most significant character representing the - padding 0 if required together with the 4 most significant bits of the gNB ID shall - appear first in the string, and the character representing the 4 least significant bit - of the gNB ID shall appear last in the string. - required: - - bitLength - - gNBValue - - AtsssCapability: - description: > - Containes Capability to support procedures related to Access Traffic Steering, Switching, - Splitting. - type: object - properties: - atsssLL: - type: boolean - default: false - description: > - Indicates the support of Access Traffic Steering, Switching and Splitting procedures - using the ATSSS-LL steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). - true: Supported - false (default): Not Supported - mptcp: - type: boolean - default: false - description: > - Indicates the support of Access Traffic Steering, Switching and Splitting procedures - using the MPTCP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501 - true: Supported - false (default): Not Supported - mpquic: - type: boolean - default: false - description: > - Indicates the support of Access Traffic Steering, Switching and Splitting procedures - using the MPQUIC steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501) - true: Supported - false (default): Not Supported - rttWithoutPmf: - type: boolean - default: false - description: > - This IE is only used by the UPF to indicate whether the UPF supports RTT measurement - without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501 - true: Supported - false (default): Not Supported - PlmnIdNid: - description: > - Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together - with the PLMN ID identifies the SNPN. - type: object - required: - - mcc - - mnc - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - nid: - $ref: '#/components/schemas/Nid' - - PlmnIdNidRm: - anyOf: - - $ref: '#/components/schemas/PlmnIdNid' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'PlmnIdNid' data type, but with the - OpenAPI 'nullable: true' property. - - SmallDataRateStatus: - description: It indicates theSmall Data Rate Control Status - type: object - properties: - remainPacketsUl: - type: integer - minimum: 0 - description: > - When present, it shall contain the number of packets the UE is allowed to send uplink - in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501. - remainPacketsDl: - type: integer - minimum: 0 - description: > - When present it shall contain the number of packets the AF is allowed to send downlink - in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501. - validityTime: - $ref: '#/components/schemas/DateTime' - remainExReportsUl: - type: integer - minimum: 0 - description: > - When present, it shall indicate number of additional exception reports the UE is allowed - to send uplink in the given time unit for the given PDU session (see clause 5.31.14.3 - of 3GPP TS 23.501. - remainExReportsDl: - type: integer - minimum: 0 - description: > - When present, it shall indicate number of additional exception reports the AF is allowed - to send downlink in the given time unit for the given PDU session (see clause 5.31.14.3 - in 3GPP TS 23.501 - - HfcNodeId: - description: REpresents the HFC Node Identifer received over NGAP. - type: object - required: - - hfcNId - properties: - hfcNId: - $ref: '#/components/schemas/HfcNId' - - HfcNodeIdRm: - anyOf: - - $ref: '#/components/schemas/HfcNodeId' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'HfcNodeId' data type, but with the - OpenAPI 'nullable: true' property. - - WirelineArea: - type: object - properties: - globalLineIds: - type: array - items: - $ref: '#/components/schemas/Gli' - minItems: 1 - hfcNIds: - type: array - items: - $ref: '#/components/schemas/HfcNId' - minItems: 1 - areaCodeB: - $ref: '#/components/schemas/AreaCode' - areaCodeC: - $ref: '#/components/schemas/AreaCode' - combGciAndHfcNIds: - type: array - items: - $ref: '#/components/schemas/CombGciAndHfcNIds' - minItems: 1 - description: > - One and only one of the "globLineIds", "hfcNIds", "areaCodeB",d "areaCodeC" and - combGciAndHfcNIds attributes shall be included in a WirelineArea data structure - - WirelineServiceAreaRestriction: - type: object - properties: - restrictionType: - $ref: '#/components/schemas/RestrictionType' - areas: - type: array - items: - $ref: '#/components/schemas/WirelineArea' - description: > - The "restrictionType" attribute and the "areas" attribute shall be either both present - or absent. The empty array of areas is used when service is allowed/restricted nowhere. - - ApnRateStatus: - description: Contains the APN rate control status e.g. of the AMF. - type: object - properties: - remainPacketsUl: - type: integer - minimum: 0 - description: > - When present, it shall contain the number of packets the UE is allowed to send uplink - in the given time unit for the given APN (all PDN connections of the UE to this APN - see clause 4.7.7.3 in 3GPP TS 23.401. - remainPacketsDl: - type: integer - minimum: 0 - description: > - When present, it shall contain the number of packets the UE is allowed to send uplink - in the given time unit for the given APN (all PDN connections of the UE to this APN - see clause 4.7.7.3 in 3GPP TS 23.401. - validityTime: - $ref: '#/components/schemas/DateTime' - remainExReportsUl: - type: integer - minimum: 0 - description: > - When present, it shall indicate the number of additional exception reports the UE is - allowed to send uplink in the given time unit for the given APN (all PDN connections of the UE to this APN, - see clause 4.7.7.3 in 3GPP TS 23.401. - remainExReportsDl: - type: integer - minimum: 0 - description: > - When present, it shall indicate the number of additional exception reports the AF is - allowed to send downlink in the given time unit for the given APN (all PDN connections - of the UE to this APN, see clause 4.7.7.3 in 3GPP TS 23.401. - - ScheduledCommunicationTime: - description: Identifies time and day of the week when the UE is available for communication. - type: object - properties: - daysOfWeek: - type: array - items: - $ref: '#/components/schemas/DayOfWeek' - minItems: 1 - maxItems: 6 - description: > - Identifies the day(s) of the week. If absent, it indicates every day of the week. - timeOfDayStart: - $ref: '#/components/schemas/TimeOfDay' - timeOfDayEnd: - $ref: '#/components/schemas/TimeOfDay' - - ScheduledCommunicationTimeRm: - anyOf: - - $ref: '#/components/schemas/ScheduledCommunicationTime' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'ScheduledCommunicationTime' data type, - but with the OpenAPI 'nullable: true' property. - - BatteryIndication: - type: object - properties: - batteryInd: - type: boolean - description: > - This IE shall indicate whether the UE is battery powered or not. - true: the UE is battery powered; - false or absent: the UE is not battery powered - replaceableInd: - type: boolean - description: > - This IE shall indicate whether the battery of the UE is replaceable or not. - true: the battery of the UE is replaceable; - false or absent: the battery of the UE is not replaceable. - rechargeableInd: - type: boolean - description: > - This IE shall indicate whether the battery of the UE is rechargeable or not. - true: the battery of UE is rechargeable; - false or absent: the battery of the UE is not rechargeable. - description: > - Parameters "replaceableInd" and "rechargeableInd" are only included if the value of - Parameter "batteryInd" is true. - - BatteryIndicationRm: - anyOf: - - $ref: '#/components/schemas/BatteryIndication' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'BatteryIndication' data type, but - with the OpenAPI 'nullable: true' property. - - AcsInfo: - description: The ACS information for the 5G-RG is defined in BBF TR-069 [42] or in BBF TR-369 - type: object - properties: - acsUrl: - $ref: '#/components/schemas/Uri' - acsIpv4Addr: - $ref: '#/components/schemas/Ipv4Addr' - acsIpv6Addr: - $ref: '#/components/schemas/Ipv6Addr' - - AcsInfoRm: - anyOf: - - $ref: '#/components/schemas/AcsInfo' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'AcsInfo' data type, but with the - OpenAPI 'nullable: true' property. - - NrV2xAuth: - description: Contains NR V2X services authorized information. - type: object - properties: - vehicleUeAuth: - $ref: '#/components/schemas/UeAuth' - pedestrianUeAuth: - $ref: '#/components/schemas/UeAuth' - - LteV2xAuth: - description: Contains LTE V2X services authorized information. - type: object - properties: - vehicleUeAuth: - $ref: '#/components/schemas/UeAuth' - pedestrianUeAuth: - $ref: '#/components/schemas/UeAuth' - - Pc5QoSPara: - description: Contains policy data on the PC5 QoS parameters. - type: object - required: - - pc5QosFlowList - properties: - pc5QosFlowList: - type: array - items: - $ref: '#/components/schemas/Pc5QosFlowItem' - pc5LinkAmbr: - $ref: '#/components/schemas/BitRate' - - Pc5QosFlowItem: - description: Contains a PC5 QOS flow. - type: object - required: - - pqi - properties: - pqi: - $ref: '#/components/schemas/5Qi' - - pc5FlowBitRates: - $ref: '#/components/schemas/Pc5FlowBitRates' - range: - $ref: '#/components/schemas/Uinteger' - - Pc5FlowBitRates: - description: it shall represent the PC5 Flow Bit Rates - type: object - properties: - guaFbr: - $ref: '#/components/schemas/BitRate' - maxFbr: - $ref: '#/components/schemas/BitRate' - - UtraLocation: - type: object - oneOf: - - required: - - cgi - - required: - - sai - - required: - - rai - description: Exactly one of cgi, sai or lai shall be present. - properties: - cgi: - $ref: '#/components/schemas/CellGlobalId' - sai: - $ref: '#/components/schemas/ServiceAreaId' - lai: - $ref: '#/components/schemas/LocationAreaId' - rai: - $ref: '#/components/schemas/RoutingAreaId' - ageOfLocationInformation: - type: integer - minimum: 0 - maximum: 32767 - description: > - The value represents the elapsed time in minutes since the last network contact of the - mobile station. Value "0" indicates that the location information was obtained after a - successful paging procedure for Active Location Retrieval when the UE is in idle mode - or after a successful location reporting procedure the UE is in connected mode. Any - other value than "0" indicates that the location information is the last known one. - See 3GPP TS 29.002 clause 17.7.8. - ueLocationTimestamp: - $ref: '#/components/schemas/DateTime' - geographicalInformation: - type: string - pattern: '^[0-9A-F]{16}$' - description: > - Refer to geographical Information.See 3GPP TS 23.032 clause 7.3.2. Only the - description of an ellipsoid point with uncertainty circle is allowed to be used. - geodeticInformation: - type: string - pattern: '^[0-9A-F]{20}$' - description: > - Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause - 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed - to be used. - - GeraLocation: - type: object - oneOf: - - required: - - cgi - - required: - - sai - - required: - - lai - description: Exactly one of cgi, sai or lai shall be present. - properties: - locationNumber: - type: string - description: Location number within the PLMN. See 3GPP TS 23.003, clause 4.5. - cgi: - $ref: '#/components/schemas/CellGlobalId' - sai: - $ref: '#/components/schemas/ServiceAreaId' - lai: - $ref: '#/components/schemas/LocationAreaId' - rai: - $ref: '#/components/schemas/RoutingAreaId' - vlrNumber: - type: string - description: VLR number. See 3GPP TS 23.003 clause 5.1. - mscNumber: - type: string - description: MSC number. See 3GPP TS 23.003 clause 5.1. - ageOfLocationInformation: - type: integer - minimum: 0 - maximum: 32767 - description: > - The value represents the elapsed time in minutes since the last network contact of the - mobile station. Value "0" indicates that the location information was obtained after a - successful paging procedure for Active Location Retrieval when the UE is in idle mode - or after a successful location reporting procedure the UE is in connected mode. Any - other value than "0" indicates that the location information is the last known one. - See 3GPP TS 29.002 clause 17.7.8. - ueLocationTimestamp: - $ref: '#/components/schemas/DateTime' - geographicalInformation: - type: string - pattern: '^[0-9A-F]{16}$' - description: > - Refer to geographical Information.See 3GPP TS 23.032 clause 7.3.2. Only the - description of an ellipsoid point with uncertainty circle is allowed to be used. - geodeticInformation: - type: string - pattern: '^[0-9A-F]{20}$' - description: > - Refers to Calling Geodetic Location.See ITU-T Recommendation Q.763 (1999) clause 3.88.2. - Only the description of an ellipsoid point with uncertainty circle is allowed to be - used. - - CellGlobalId: - description: Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1. - type: object - required: - - plmnId - - lac - - cellId - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - lac: - type: string - pattern: '^[A-Fa-f0-9]{4}$' - cellId: - type: string - pattern: '^[A-Fa-f0-9]{4}$' - - ServiceAreaId: - description: Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5. - type: object - required: - - plmnId - - lac - - sac - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - lac: - type: string - pattern: '^[A-Fa-f0-9]{4}$' - description: Location Area Code. - sac: - type: string - pattern: '^[A-Fa-f0-9]{4}$' - description: Service Area Code. - - LocationAreaId: - description: Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1. - type: object - required: - - plmnId - - lac - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - - lac: - type: string - pattern: '^[A-Fa-f0-9]{4}$' - description: Location Area Code. - - RoutingAreaId: - description: Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2. - type: object - required: - - plmnId - - lac - - rac - properties: - plmnId: - $ref: '#/components/schemas/PlmnId' - lac: - type: string - pattern: '^[A-Fa-f0-9]{4}$' - description: Location Area Code - rac: - type: string - pattern: '^[A-Fa-f0-9]{2}$' - description: Routing Area Code - - DddTrafficDescriptor: - description: Contains a Traffic Descriptor. - type: object - properties: - ipv4Addr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' - ipv6Addr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' - portNumber: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - macAddr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' - - MoExpDataCounter: - description: Contain the MO Exception Data Counter. - type: object - required: - - counter - properties: - counter: - type: integer - description: > - Unsigned integer identifying the MO Exception Data Counter, as specified in clause - 5.31.14.3 of 3GPP TS 23.501. - timeStamp: - $ref: '#/components/schemas/DateTime' - - NssaaStatus: - description: contains the Subscribed S-NSSAI subject to NSSAA procedure and the status. - type: object - required: - - snssai - - status - properties: - snssai: - $ref: '#/components/schemas/Snssai' - status: - $ref: '#/components/schemas/AuthStatus' - - NssaaStatusRm: - anyOf: - - $ref: '#/components/schemas/NssaaStatus' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'NssaaStatus' data type, but with - the OpenAPI 'nullable: true' property. - - TnapId: - description: Contain the TNAP Identifier see clause5.6.2 of 3GPP TS 23.501. - type: object - properties: - ssId: - type: string - description: > - This IE shall be present if the UE is accessing the 5GC via a trusted WLAN access - network.When present, it shall contain the SSID of the access point to which the UE - is attached, that is received over NGAP, see IEEE Std 802.11-2012. - - bssId: - type: string - description: > - When present, it shall contain the BSSID of the access point to which the UE is - attached, that is received over NGAP, see IEEE Std 802.11-2012. - - civicAddress: - $ref: '#/components/schemas/Bytes' - - TnapIdRm: - anyOf: - - $ref: '#/components/schemas/TnapId' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'TnapId' data type, but with the - OpenAPI 'nullable: true' property. - - TwapId: - description: > - Contain the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 - or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402. - type: object - required: - - ssId - properties: - ssId: - type: string - description: > - This IE shall contain the SSID of the access point to which the UE is attached, that is - received over NGAP, see IEEE Std 802.11-2012. - - bssId: - type: string - description: > - When present, it shall contain the BSSID of the access point to which the UE is - attached, for trusted WLAN access, see IEEE Std 802.11-2012. - - civicAddress: - $ref: '#/components/schemas/Bytes' - - TwapIdRm: - anyOf: - - $ref: '#/components/schemas/TwapId' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'TwapId' data type, but with the - OpenAPI 'nullable: true' property. - - SnssaiExtension: - description: > - Extensions to the Snssai data type, sdRanges and wildcardSd shall not be present - simultaneously - type: object - not: - required: - - sdRanges - - wildcardSd - properties: - sdRanges: - description: > - When present, it shall contain the range(s) of Slice Differentiator values supported for - the Slice/Service Type value indicated in the sst attribute of the Snssai data type - type: array - items: - $ref: '#/components/schemas/SdRange' - minItems: 1 - wildcardSd: - description: > - When present, it shall be set to true, to indicate that all SD values are supported for - the Slice/Service Type value indicated in the sst attribute of the Snssai data type. - type: boolean - enum: - - true - - SdRange: - description: A range of SDs (Slice Differentiators) - type: object - properties: - start: - type: string - pattern: '^[A-Fa-f0-9]{6}$' - description: > - First value identifying the start of an SD range. This string shall be formatted as - specified for the sd attribute of the Snssai data type in clause 5.4.4.2. - end: - type: string - pattern: '^[A-Fa-f0-9]{6}$' - description: > - Last value identifying the end of an SD range. This string shall be formatted as - specified for the sd attribute of the Snssai data type in clause 5.4.4.2. - - ProseServiceAuth: - description: > - Indicates whether the UE is authorized to use related services. - type: object - properties: - proseDirectDiscoveryAuth: - $ref: '#/components/schemas/UeAuth' - proseDirectCommunicationAuth: - $ref: '#/components/schemas/UeAuth' - proseL2RelayAuth: - $ref: '#/components/schemas/UeAuth' - proseL3RelayAuth: - $ref: '#/components/schemas/UeAuth' - proseL2RemoteAuth: - $ref: '#/components/schemas/UeAuth' - proseL3RemoteAuth: - $ref: '#/components/schemas/UeAuth' - proseMultipathComL2RemoteAuth: - $ref: '#/components/schemas/UeAuth' - proseL2UeRelayAuth: - $ref: '#/components/schemas/UeAuth' - proseL3UeRelayAuth: - $ref: '#/components/schemas/UeAuth' - proseL2EndAuth: - $ref: '#/components/schemas/UeAuth' - proseL3EndAuth: - $ref: '#/components/schemas/UeAuth' - - EcsServerAddr: - description: > - Contains the Edge Configuration Server Address Configuration Information as defined in - clause 5.2.3.6.1 of 3GPP TS 23.502. - type: object - properties: - ecsFqdnList: - type: array - items: - $ref: '#/components/schemas/Fqdn' - minItems: 1 - ecsIpAddressList: - type: array - items: - $ref: '#/components/schemas/IpAddr' - minItems: 1 - ecsUriList: - type: array - items: - $ref: '#/components/schemas/Uri' - minItems: 1 - ecsProviderId: - type: string - - EcsServerAddrRm: - anyOf: - - $ref: '#/components/schemas/EcsServerAddr' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the ' EcsServerAddr ' data type, but with - the OpenAPI 'nullable: true' property. - - IpAddr: - description: Contains an IP adresse. - type: object - oneOf: - - required: - - ipv4Addr - - required: - - ipv6Addr - - required: - - ipv6Prefix - properties: - ipv4Addr: - $ref: '#/components/schemas/Ipv4Addr' - ipv6Addr: - $ref: '#/components/schemas/Ipv6Addr' - ipv6Prefix: - $ref: '#/components/schemas/Ipv6Prefix' - - SACInfo: - description: > - Represents threshold(s) to control the triggering of network slice reporting notifications - or the information contained in the network slice reporting notification. - type: object - properties: - numericValNumUes: - type: integer - numericValNumPduSess: - type: integer - percValueNumUes: - type: integer - minimum: 0 - maximum: 100 - percValueNumPduSess: - type: integer - minimum: 0 - maximum: 100 - uesWithPduSessionInd: - type: boolean - default: false - - SACEventStatus: - description: > - Contains the network slice status information in terms of the current number of UEs - registered with a network slice, the current number of PDU Sessions established on a - network slice or both. - type: object - properties: - reachedNumUes: - $ref: '#/components/schemas/SACInfo' - reachedNumPduSess: - $ref: '#/components/schemas/SACInfo' - - SpatialValidityCond: - description: Contains the Spatial Validity Condition. - type: object - properties: - trackingAreaList: - type: array - items: - $ref: '#/components/schemas/Tai' - minItems: 1 - countries: - type: array - items: - $ref: '#/components/schemas/Mcc' - minItems: 1 - geographicalServiceArea: - $ref: '#/components/schemas/GeoServiceArea' - - SpatialValidityCondRm: - description: Contains the Spatial Validity Condition or the null value. - anyOf: - - $ref: '#/components/schemas/SpatialValidityCond' - - $ref: '#/components/schemas/NullValue' - - ServerAddressingInfo: - description: Contains addressing information (IP addresses and/or FQDNs) of a server. - type: object - anyOf: - - required: - - ipv4Addresses - - required: - - ipv6Addresses - - required: - - fqdnList - properties: - ipv4Addresses: - type: array - items: - $ref: '#/components/schemas/Ipv4Addr' - minItems: 1 - ipv6Addresses: - type: array - items: - $ref: '#/components/schemas/Ipv6Addr' - minItems: 1 - fqdnList: - type: array - items: - $ref: '#/components/schemas/Fqdn' - minItems: 1 - - PcfUeCallbackInfo: - description: > - Contains the PCF for the UE information necessary for the PCF for the PDU session to send - SM Policy Association Establishment and Termination events. - type: object - properties: - callbackUri: - $ref: '#/components/schemas/Uri' - bindingInfo: - type: string - nullable: true - required: - - callbackUri - - PduSessionInfo: - description: indicates the DNN and S-NSSAI combination of a PDU session. - type: object - properties: - snssai: - $ref: '#/components/schemas/Snssai' - dnn: - $ref: '#/components/schemas/Dnn' - required: - - dnn - - snssai - - EasIpReplacementInfo: - description: Contains EAS IP replacement information for a Source and a Target EAS. - type: object - properties: - source: - $ref: '#/components/schemas/EasServerAddress' - target: - $ref: '#/components/schemas/EasServerAddress' - required: - - source - - target - - EasServerAddress: - description: Represents the IP address and port of an EAS server. - type: object - properties: - ip: - $ref: '#/components/schemas/IpAddr' - port: - $ref: '#/components/schemas/Uinteger' - required: - - ip - - port - - RoamingRestrictions: - description: > - Indicates if access is allowed to a given serving network, e.g. a PLMN (MCC, MNC) or an - SNPN (MCC, MNC, NID). - type: object - properties: - accessAllowed: - type: boolean - - GeoServiceArea: - description: List of geographic area or list of civic address info - type: object - properties: - geographicAreaList: - type: array - items: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' - minItems: 1 - civicAddressList: - type: array - items: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' - minItems: 1 - - MutingExceptionInstructions: - description: > - Indicates to an Event producer NF instructions for the subscription and stored events when - an exception (e.g. full buffer) occurs at the Event producer NF while the event is muted. - type: object - properties: - bufferedNotifs: - $ref: '#/components/schemas/BufferedNotificationsAction' - subscription: - $ref: '#/components/schemas/SubscriptionAction' - - MutingNotificationsSettings: - description: > - Indicates the Event producer NF settings to the Event consumer NF - type: object - properties: - maxNoOfNotif: - type: integer - durationBufferedNotif: - $ref: '#/components/schemas/DurationSec' - - CombGciAndHfcNIds: - type: object - properties: - globalCableId: - $ref: '#/components/schemas/Gci' - hfcNId: - $ref: '#/components/schemas/HfcNId' - - - VplmnOffloadingInfo: - description: VPLMN Specific Offloading Information - type: object - nullable: true - properties: - offloadIdentifier: - $ref: '#/components/schemas/OffloadIdentifier' - vplmnId: - $ref: '#/components/schemas/PlmnId' - allowedTraffic: - type: boolean - default: true - ipv4AddressRanges: - type: array - items: - $ref: '#/components/schemas/Ipv4AddressRange' - minItems: 1 - ipv4AddrMasks: - type: array - items: - $ref: '#/components/schemas/Ipv4AddrMask' - minItems: 1 - ipv6AddressRanges: - type: array - items: - $ref: '#/components/schemas/Ipv6AddressRange' - minItems: 1 - ipv6PrefixRanges: - type: array - items: - $ref: '#/components/schemas/Ipv6PrefixRange' - minItems: 1 - fqdnList: - type: array - items: - $ref: '#/components/schemas/Fqdn' - minItems: 1 - fqdnPatterns: - type: array - items: - $ref: '#/components/schemas/FqdnPatternMatchingRule' - minItems: 1 - - PartiallyAllowedSnssai: - description: > - Indicates a S-NSSAI that is partially allowed in the Registration Area. - type: object - properties: - snssai: - $ref: '#/components/schemas/Snssai' - allowedTaiList: - type: array - items: - $ref: '#/components/schemas/Tai' - minItems: 1 - required: - - snssai - - allowedTaiList - - VarRepPeriod: - description: > - Indicates the Variable reporting periodicity for event reporting - type: object - properties: - repPeriod: - $ref: '#/components/schemas/DurationSec' - percValueNfLoad: - allOf: - - $ref: '#/components/schemas/Uinteger' - minimum: 0 - maximum: 100 - required: - - repPeriod - - - RangingSlPosAuth: - description: > - Indicates whether the UE is authorized to use related services. - type: object - properties: - rgSlPosPc5Auth: - $ref: '#/components/schemas/UeAuth' - rgSlPosLocAuth: - $ref: '#/components/schemas/UeAuth' - rgSlPosClientAuth: - $ref: '#/components/schemas/UeAuth' - rgSlPosServerAuth: - $ref: '#/components/schemas/UeAuth' - - - NrA2xAuth: - description: Contains NR A2X services authorized information. - type: object - properties: - uavUeAuth: - $ref: '#/components/schemas/UeAuth' - - LteA2xAuth: - description: Contains LTE A2X services authorized information. - type: object - properties: - uavUeAuth: - $ref: '#/components/schemas/UeAuth' - - SliceUsageControlInfo: - description: The network slice usage control related information - type: object - required: - - sNssai - properties: - sNssai: - $ref: '#/components/schemas/Snssai' - deregInactTimer: - $ref: '#/components/schemas/DurationSec' - sessInactTimer: - $ref: '#/components/schemas/DurationSec' - anyOf: - - required: [ deregInactTimer ] - - required: [ sessInactTimer ] - - SnssaiDnnItem: - description: Combination of S-NSSAIs and DNNs - type: object - properties: - snssaiList: - type: array - items: - $ref: '#/components/schemas/ExtSnssai' - minItems: 1 - dnnList: - type: array - items: - $ref: '#/components/schemas/Dnn' - minItems: 1 - anyOf: - - required: [ snssaiList ] - - required: [ dnnList ] - - - NtnTaiInfo: - type: object - required: - - plmnId - - tacList - properties: - plmnId: - $ref: '#/components/schemas/PlmnIdNid' - tacList: - type: array - items: - $ref: '#/components/schemas/Tac' - minItems: 1 - derivedTac: - $ref: '#/components/schemas/Tac' - - MitigationInfo: - type: object - properties: - percValueNumUes: - type: integer - minimum: 0 - maximum: 100 - newUesInd: - type: boolean - - VplmnDlAmbr: - description: an Authorized DL Session AMBR for Offloading for the VPLMN - type: object - nullable: true - properties: - vplmnId: - $ref: '#/components/schemas/PlmnId' - sessionDlAmbr: - $ref: '#/components/schemas/BitRate' - required: - - vplmnId - - sessionDlAmbr - -# -# Data types describing alternative data types or combinations of data types -# - ExtSnssai: - allOf: - - $ref: '#/components/schemas/Snssai' - - $ref: '#/components/schemas/SnssaiExtension' - description: > - The sdRanges and wildcardSd attributes shall be exclusive from each other. If one of these - attributes is present, the sd attribute shall also be present and it shall contain one Slice - Differentiator value within the range of SD (if the sdRanges attribute is present) or with - any value (if the wildcardSd attribute is present). - - SnssaiReplaceInfo: - description: Indicates the status of an S-NSSAI and an alternative S-NSSAI optionally. - type: object - properties: - snssai: - $ref: '#/components/schemas/Snssai' - status: - $ref: '#/components/schemas/SnssaiStatus' - altSnssai: - $ref: '#/components/schemas/Snssai' - nsReplTerminInd: - $ref: '#/components/schemas/TerminationIndication' - plmnId: - $ref: '#/components/schemas/PlmnId' - mitigationInfo: - $ref: '#/components/schemas/MitigationInfo' - required: - - snssai - - -# -# Data Types related to 5G QoS as defined in clause 5.5 -# - -# -# SIMPLE DATA TYPES -# -# - Qfi: - type: integer - minimum: 0 - maximum: 63 - description: Unsigned integer identifying a QoS flow, within the range 0 to 63. - - QfiRm: - type: integer - minimum: 0 - maximum: 63 - nullable: true - description: > - This data type is defined in the same way as the 'Qfi' data type, but with the - OpenAPI 'nullable: true' property. - - 5Qi: - type: integer - minimum: 0 - maximum: 255 - description: > - Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501, - within the range 0 to 255. - - 5QiRm: - type: integer - minimum: 0 - maximum: 255 - nullable: true - description: > - This data type is defined in the same way as the '5QiPriorityLevel' data type, but with - the OpenAPI 'nullable: true' property. " - - BitRate: - type: string - pattern: '^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$' - description: > - String representing a bit rate; the prefixes follow the standard symbols from The International - System of Units, and represent x1000 multipliers, with the exception that prefix "K" is - used to represent the standard symbol "k". - - BitRateRm: - type: string - pattern: '^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$' - nullable: true - description: > - This data type is defined in the same way as the 'BitRate' data type, but with the OpenAPI - 'nullable: true' property. - - PacketRate: - type: string - pattern: '^\d+(\.\d+)? (pps|kpps|Mpps|Gpps|Tpps)$' - description: > - String representing a packet rate, i.e., packet per second; the prefixes follow the symbols - from The International System of Units, and represent x1000 multipliers. - - PacketRateRm: - type: string - pattern: '^\d+(\.\d+)? (pps|kpps|Mpps|Gpps|Tpps)$' - nullable: true - description: > - This data type is defined in the same way as the 'PacketRate' data type, but with the - OpenAPI 'nullable: true' property. - - TrafficVolume: - type: string - pattern: '^\d+(\.\d+)? (B|kB|MB|GB|TB)$' - description: > - String representing a Traffic Volume measured in bytes; the prefixes follow the symbols - from The International System of Units, and represent x1000 multipliers. - - TrafficVolumeRm: - type: string - pattern: '^\d+(\.\d+)? (B|kB|MB|GB|TB)$' - nullable: true - description: > - This data type is defined in the same way as the 'TrafficVolume' data type, but with the - OpenAPI 'nullable: true' property. - - ArpPriorityLevelRm: - type: integer - minimum: 1 - maximum: 15 - nullable: true - description: > - This data type is defined in the same way as the 'ArpPriorityLevel' data type, but with - the OpenAPI 'nullable: true' property. - - ArpPriorityLevel: - type: integer - minimum: 1 - maximum: 15 - nullable: true - description: > - nullable true shall not be used for this attribute. Unsigned integer indicating the ARP - Priority Level (see clause 5.7.2.2 of 3GPP TS 23.501, within the range 1 to 15.Values are - ordered in decreasing order of priority, i.e. with 1 as the highest priority and 15 as - the lowest priority. - - 5QiPriorityLevel: - type: integer - minimum: 1 - maximum: 127 - description: > - Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP - TS 23.501, within the range 1 to 127.Values are ordered in decreasing order of priority, - i.e. with 1 as the highest priority and 127 as the lowest priority. - - 5QiPriorityLevelRm: - type: integer - minimum: 1 - maximum: 127 - nullable: true - description: > - This data type is defined in the same way as the '5QiPriorityLevel' data type, but with - the OpenAPI 'nullable: true' property. - - PacketDelBudget: - type: integer - minimum: 1 - description: > - Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP - TS 23.501), expressed in milliseconds. - - PacketDelBudgetRm: - type: integer - minimum: 1 - nullable: true - description: > - This data type is defined in the same way as the 'PacketDelBudget' data type, but with - the OpenAPI 'nullable: true' property. - - PacketErrRate: - type: string - pattern: '^([0-9]E-[0-9])$' - description: > - String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501, - expressed as a "scalar x 10-k" where the scalar and the exponent k are each encoded as - one decimal digit. - - PacketErrRateRm: - type: string - pattern: '^([0-9]E-[0-9])$' - nullable: true - description: > - This data type is defined in the same way as the 'PacketErrRate' data type, but with - the OpenAPI 'nullable: true' property. - - PacketLossRate: - type: integer - minimum: 0 - maximum: 1000 - description: > - Unsigned integer indicating Packet Loss Rate (see clauses 5.7.2.8 and 5.7.4 of 3GPP - TS 23.501), expressed in tenth of percent. - - PacketLossRateRm: - type: integer - minimum: 0 - maximum: 1000 - nullable: true - description: > - This data type is defined in the same way as the 'PacketLossRate' data type, but with - the OpenAPI 'nullable: true' property. - - AverWindow: - type: integer - minimum: 1 - maximum: 4095 - default: 2000 - description: > - Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of - 3GPP TS 23.501), expressed in milliseconds. - - AverWindowRm: - type: integer - maximum: 4095 - default: 2000 - minimum: 1 - nullable: true - description: > - This data type is defined in the same way as the 'AverWindow' data type, but with - the OpenAPI 'nullable: true' property. - - MaxDataBurstVol: - type: integer - minimum: 1 - maximum: 4095 - description: > - Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of - 3GPP TS 23.501), expressed in Bytes. - - MaxDataBurstVolRm: - type: integer - minimum: 1 - maximum: 4095 - nullable: true - description: > - This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with - the OpenAPI 'nullable: true' property. - - SamplingRatio: - type: integer - minimum: 1 - maximum: 100 - description: > - Unsigned integer indicating Sampling Ratio (see clauses 4.15.1 of 3GPP TS 23.502), - expressed in percent. - - SamplingRatioRm: - type: integer - minimum: 1 - maximum: 100 - nullable: true - description: > - This data type is defined in the same way as the 'SamplingRatio' data type, but with the - OpenAPI 'nullable: true' property. -# - RgWirelineCharacteristics: - $ref: '#/components/schemas/Bytes' - - RgWirelineCharacteristicsRm: - anyOf: - - $ref: '#/components/schemas/RgWirelineCharacteristics' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'RgWirelineCharacteristics' data type, - but with the OpenAPI 'nullable: true' property. - - ExtMaxDataBurstVol: - type: integer - minimum: 4096 - maximum: 2000000 - description: > - Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of - 3GPP TS 23.501), expressed in Bytes. - - ExtMaxDataBurstVolRm: - type: integer - minimum: 4096 - maximum: 2000000 - nullable: true - description: > - This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but - with the OpenAPI 'nullable: true' property. - - ExtPacketDelBudget: - type: integer - minimum: 1 - description: > - Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP - TS 23.501 [8])), expressed in 0.01 milliseconds. - - ExtPacketDelBudgetRm: - type: integer - minimum: 1 - nullable: true - description: > - This data type is defined in the same way as the 'ExtPacketDelBudget' data type, but - with the OpenAPI 'nullable: true' property. " - - Metadata: - format: byte - type: string - nullable: true - description: > - A String which is transparently passed to the UPF to be applied for traffic to SFC. - - -# -# ENUMERATED DATA TYPES -# - - PreemptionCapability: - anyOf: - - type: string - enum: - - NOT_PREEMPT - - MAY_PREEMPT - - type: string - description: > - The enumeration PreemptionCapability indicates the pre-emption capability of a request on - other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It shall comply with the provisions - defined in table 5.5.3.1-1. - PreemptionCapabilityRm: - anyOf: - - $ref: '#/components/schemas/PreemptionCapability' - - $ref: '#/components/schemas/NullValue' - description: > - This enumeration is defined in the same way as the 'PreemptionCapability' enumeration, - but with the OpenAPI 'nullable: true' property. - - PreemptionVulnerability: - anyOf: - - type: string - enum: - - NOT_PREEMPTABLE - - PREEMPTABLE - - type: string - description: > - The enumeration PreemptionVulnerability indicates the pre-emption vulnerability of the QoS - flow to pre-emption from other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It shall - comply with the provisions defined in table 5.5.3.2-1 - - PreemptionVulnerabilityRm: - anyOf: - - $ref: '#/components/schemas/PreemptionVulnerability' - - $ref: '#/components/schemas/NullValue' - description: > - This enumeration is defined in the same way as the 'PreemptionVulnerability' enumeration, - but with the OpenAPI 'nullable: true' property." - - ReflectiveQoSAttribute: - anyOf: - - type: string - enum: - - RQOS - - NO_RQOS - - type: string - description: > - The enumeration ReflectiveQosAttribute indicates whether certain traffic of the QoS flow may - be subject to Reflective QoS (see clause 5.7.2.3 of 3GPP TS 23.501). It shall comply with - the provisions defined in table 5.5.3.3-1. - - ReflectiveQoSAttributeRm: - anyOf: - - $ref: '#/components/schemas/ReflectiveQoSAttribute' - - $ref: '#/components/schemas/NullValue' - description: > - This enumeration is defined in the same way as the 'ReflectiveQosAttribute' enumeration, - but with the OpenAPI 'nullable: true' property. " - - NotificationControl: - anyOf: - - type: string - enum: - - REQUESTED - - NOT_REQUESTED - - type: string - description: > - The enumeration NotificationControl indicates whether notifications are requested from the - RAN when the GFBR can no longer (or again) be fulfilled for a QoS Flow during the lifetime - of the QoS Flow (see clause 5.7.2.4 of 3GPP TS 23.501). - It shall comply with the provisions defined in table 5.5.3.5-1. - - NotificationControlRm: - anyOf: - - $ref: '#/components/schemas/NotificationControl' - - $ref: '#/components/schemas/NullValue' - description: > - This enumeration is defined in the same way as the 'NotificationControl' enumeration, but - with the OpenAPI 'nullable: true' property. - - QosResourceType: - anyOf: - - type: string - enum: - - NON_GBR - - NON_CRITICAL_GBR - - CRITICAL_GBR - - type: string - description: > - The enumeration QosResourceType indicates whether a QoS Flow is non-GBR, delay critical GBR, - or non-delay critical GBR (see clauses 5.7.3.4 and 5.7.3.5 of 3GPP TS 23.501). It shall - comply with the provisions defined in table 5.5.3.6-1. - - QosResourceTypeRm: - anyOf: - - $ref: '#/components/schemas/QosResourceType' - - $ref: '#/components/schemas/NullValue' - description: > - This enumeration is defined in the same way as the 'QosResourceType' enumeration, but - with the OpenAPI 'nullable: true' property. " - - AdditionalQosFlowInfo: - anyOf: - - anyOf: - - type: string - enum: - - MORE_LIKELY - - type: string - - $ref: '#/components/schemas/NullValue' - description: > - The enumeration AdditionalQosFlowInfo provides additional QoS flow information (see clause - 9.3.1.12 3GPP TS 38.413 [11]). It shall comply with the provisions defined in table - 5.5.3.12-1. - - PartitioningCriteria: - anyOf: - - type: string - enum: - - TAC - - SUBPLMN - - GEOAREA - - SNSSAI - - DNN - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Possible values are: - - "TAC": Type Allocation Code - - "SUBPLMN": Subscriber PLMN ID - - "GEOAREA": Geographical area, i.e. list(s) of TAI(s) - - "SNSSAI": S-NSSAI - - "DNN": DNN - - PartitioningCriteriaRm: - anyOf: - - $ref: '#/components/schemas/PartitioningCriteria' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the ' PartitioningCriteria ' data type, but - with the OpenAPI 'nullable: true' property. - - PduSetHandlingInfo: - anyOf: - - type: string - enum: - - ALL_PDUS_NEEDED - - ALL_PDUS_NOT_NEEDED - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - description: | - Possible values are: - - "ALL_PDUS_NEEDED": All PDUs of the PDU Set are needed - - "ALL_PDUS_NOT_NEEDED": All PDUs of the PDU Set are not needed - - MediaTransportProto: - anyOf: - - type: string - enum: - - RTP - - SRTP - - type: string - description: > - The enumeration MediaTransportProto indicates the transport protocol used for a media flow. - - MediaTransportProtoRm: - anyOf: - - $ref: '#/components/schemas/MediaTransportProto' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'MediaTransportProto' data type, - but with the OpenAPI 'nullable: true' property. - - RtpHeaderExtType: - anyOf: - - type: string - enum: - - PDU_SET_MARKING - - type: string - description: > - The enumeration indicates the type of Rtp Header Extension type - - RtpHeaderExtTypeRm: - anyOf: - - $ref: '#/components/schemas/RtpHeaderExtType' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'RtpHeaderExtType' data type, - but with the OpenAPI 'nullable: true' property. - - - RtpPayloadFormat: - anyOf: - - type: string - enum: - - H264 - - H265 - - type: string - description: > - The enumeration RtpPayloadFormat indicates the RTP Payload format - - - RtpPayloadFormatRm: - anyOf: - - $ref: '#/components/schemas/RtpPayloadFormat' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'RtpPayloadFormat' data type, but with the - OpenAPI 'nullable: true' property. - -# -# -# STRUCTURED DATA TYPES -# - - Arp: - description: Contains Allocation and Retention Priority information. - type: object - properties: - priorityLevel: - $ref: '#/components/schemas/ArpPriorityLevel' - preemptCap: - $ref: '#/components/schemas/PreemptionCapability' - preemptVuln: - $ref: '#/components/schemas/PreemptionVulnerability' - required: - - priorityLevel - - preemptCap - - preemptVuln - - Ambr: - description: Contains the maximum aggregated uplink and downlink bit rates. - type: object - properties: - uplink: - $ref: '#/components/schemas/BitRate' - downlink: - $ref: '#/components/schemas/BitRate' - required: - - uplink - - downlink - - Dynamic5Qi: - description: > - It indicates the QoS Characteristics for a Non-standardised or not pre-configured 5QI - for downlink and uplink. - type: object - properties: - resourceType: - $ref: '#/components/schemas/QosResourceType' - priorityLevel: - $ref: '#/components/schemas/5QiPriorityLevel' - packetDelayBudget: - $ref: '#/components/schemas/PacketDelBudget' - packetErrRate: - $ref: '#/components/schemas/PacketErrRate' - averWindow: - $ref: '#/components/schemas/AverWindow' - maxDataBurstVol: - $ref: '#/components/schemas/MaxDataBurstVol' - extMaxDataBurstVol: - $ref: '#/components/schemas/ExtMaxDataBurstVol' - extPacketDelBudget: - $ref: '#/components/schemas/ExtPacketDelBudget' - cnPacketDelayBudgetDl: - $ref: '#/components/schemas/ExtPacketDelBudget' - cnPacketDelayBudgetUl: - $ref: '#/components/schemas/ExtPacketDelBudget' - required: - - resourceType - - priorityLevel - - packetDelayBudget - - packetErrRate - - NonDynamic5Qi: - description: > - It indicates the QoS Characteristics for a standardized or pre-configured 5QI for downlink - and uplink. - type: object - properties: - priorityLevel: - $ref: '#/components/schemas/5QiPriorityLevel' - averWindow: - $ref: '#/components/schemas/AverWindow' - maxDataBurstVol: - $ref: '#/components/schemas/MaxDataBurstVol' - extMaxDataBurstVol: - $ref: '#/components/schemas/ExtMaxDataBurstVol' - cnPacketDelayBudgetDl: - $ref: '#/components/schemas/ExtPacketDelBudget' - cnPacketDelayBudgetUl: - $ref: '#/components/schemas/ExtPacketDelBudget' - minProperties: 0 - - ArpRm: - anyOf: - - $ref: '#/components/schemas/Arp' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'Arp' data type, but with the - OpenAPI 'nullable: true' property. - - AmbrRm: - anyOf: - - $ref: '#/components/schemas/Ambr' - - $ref: '#/components/schemas/NullValue' - description: > - This data type is defined in the same way as the 'Ambr' data type, but with the - OpenAPI 'nullable: true' property." - - SliceMbr: - description: MBR related to slice - type: object - properties: - uplink: - $ref: '#/components/schemas/BitRate' - downlink: - $ref: '#/components/schemas/BitRate' - required: - - uplink - - downlink - - SliceMbrRm: - description: "SliceMbr with nullable: true" - - anyOf: - - $ref: '#/components/schemas/SliceMbr' - - $ref: '#/components/schemas/NullValue' - - PduSetQosPara: - description: Represents the PDU Set level QoS parameters. - type: object - properties: - pduSetDelayBudget: - $ref: '#/components/schemas/ExtPacketDelBudget' - pduSetErrRate: - $ref: '#/components/schemas/PacketErrRate' - pduSetHandlingInfo: - $ref: '#/components/schemas/PduSetHandlingInfo' - anyOf: - - required: [ pduSetDelayBudget, pduSetErrRate ] - - required: [ pduSetHandlingInfo ] -# - - PduSetQosParaRm: - description: "PduSetQosPara contains removable attributes" - type: object - nullable: true - properties: - pduSetDelayBudget: - $ref: '#/components/schemas/ExtPacketDelBudgetRm' - pduSetErrRate: - $ref: '#/components/schemas/PacketErrRateRm' - pduSetHandlingInfo: - $ref: '#/components/schemas/PduSetHandlingInfoRm' - - - ProtocolDescription: - description: ProtocolDescription contains information to derive PDU set information. - type: object - properties: - transportProto: - $ref: '#/components/schemas/MediaTransportProto' - rtpHeaderExtInfo: - $ref: '#/components/schemas/RtpHeaderExtInfo' - rtpPayloadInfoList: - type: array - items: - $ref: '#/components/schemas/RtpPayloadInfo' - minItems: 1 - - ProtocolDescriptionRm: - description: Describes the modifications to the ProtocolDescription data type. - type: object - nullable: true - properties: - transportProto: - $ref: '#/components/schemas/MediaTransportProtoRm' - rtpHeaderExtInfo: - $ref: '#/components/schemas/RtpHeaderExtInfoRm' - rtpPayloadInfoList: - type: array - nullable: true - items: - $ref: '#/components/schemas/RtpPayloadInfo' - minItems: 1 - - - RtpHeaderExtInfo: - description: RTP Header Extension information - type: object - properties: - rtpHeaderExtType: - $ref: '#/components/schemas/RtpHeaderExtType' - rtpHeaderExtId: - type: integer - minimum: 1 - maximum: 255 - longFormat: - type: boolean - pduSetSizeActive: - type: boolean - - RtpHeaderExtInfoRm: - description: Describes the modifications to RtpHeaderExtInfo data type - type: object - nullable: true - properties: - rtpHeaderExtType: - $ref: '#/components/schemas/RtpHeaderExtTypeRm' - rtpHeaderExtId: - type: integer - nullable: true - minimum: 1 - maximum: 255 - longFormat: - type: boolean - nullable: true - pduSetSizeActive: - type: boolean - nullable: true - - RtpPayloadInfo: - description: RtpPayloadInfo contains Rtp payload type and format. - type: object - properties: - rtpPayloadTypeList: - type: array - items: - type: integer - minimum: 1 - maximum: 127 - minItems: 1 - rtpPayloadFormat: - $ref: '#/components/schemas/RtpPayloadFormat' - - RtpPayloadInfoRm: - nullable: true - description: Describes the modifications to the RtpPayloadInfo data type. - type: object - properties: - rtpPayloadTypeList: - type: array - nullable: true - items: - type: integer - minimum: 1 - maximum: 127 - minItems: 1 - rtpPayloadFormat: - $ref: '#/components/schemas/RtpPayloadFormatRm' - - PduSetHandlingInfoRm: - anyOf: - - $ref: '#/components/schemas/PduSetHandlingInfo' - - $ref: '#/components/schemas/NullValue' - description: > - This enumeration is defined in the same way as the 'PduSetHandlingInfo' enumeration, - but with the OpenAPI 'nullable: true' property. - - -# -# Data Types related to 5G Trace as defined in clause 5.6 -# - -# -# SIMPLE DATA TYPES -# - - PhysCellId: - type: integer - minimum: 0 - maximum: 1007 - description: > - Integer value identifying the physical cell identity (PCI), as definition of "PhysCellId" IE - in clause 6.3.2 of 3GPP TS 38.331. - - ArfcnValueNR: - type: integer - minimum: 0 - maximum: 3279165 - description: > - Integer value indicating the ARFCN applicable for a downlink, uplink or bi-directional (TDD) - NR global frequency raster, - as definition of "ARFCN-ValueNR" IE in clause 6.3.2 of 3GPP TS 38.331. - - QoeReference: - description: > - String containing MCC (3 digits), MNC (2 or 3 digits) - and QMC ID (3 octets, encoded as 6 hexadecimal digits). - type: string - pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{6}$' - - MdtAlignmentInfo: - description: | - String containing: - - Trace Reference: MCC (3 digits), MNC (2 or 3 digits), - Trace ID (3 octets, encoded as 6 hexadecimal digits) - - Trace Recording Session Reference (2 octets, encoded as 4 hexadecimal digits) - format: string - pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{6}-[A-Fa-f0-9]{4}$' - -# -# -# Enumerations -# - - TraceDepth: - anyOf: - - type: string - enum: - - MINIMUM - - MEDIUM - - MAXIMUM - - MINIMUM_WO_VENDOR_EXTENSION - - MEDIUM_WO_VENDOR_EXTENSION - - MAXIMUM_WO_VENDOR_EXTENSION - - type: string - description: > - The enumeration TraceDepth defines how detailed information should be recorded - in the trace. See 3GPP TS 32.422 for further description of the values. - It shall comply with the provisions defined in table 5.6.3.1-1 - - TraceDepthRm: - anyOf: - - $ref: '#/components/schemas/TraceDepth' - - $ref: '#/components/schemas/NullValue' - description: > - This enumeration is defined in the same way as the 'TraceDepth' enumeration, but with - the OpenAPI 'nullable: true' property. - - JobType: - anyOf: - - type: string - enum: - - IMMEDIATE_MDT_ONLY - - LOGGED_MDT_ONLY - - TRACE_ONLY - - IMMEDIATE_MDT_AND_TRACE - - LOGGED_MBSFN_MDT - - 5GC_UE_LEVEL_MEASUREMENTS_ONLY - - TRACE_AND_5GC_UE_LEVEL_MEASUREMENTS_ONLY - - IMMEDIATE_MDT_AND_5GC_UE_LEVEL_MEASUREMENTS - - TRACE_IMMEDIATE_MDT_AND_5GC_UE_LEVEL_MEASUREMENTS - - type: string - description: > - The enumeration JobType defines Job Type in the trace. See 3GPP TS 32.422 for further - description of the values. It shall comply with the provisions defined in table 5.6.3.3-1. - - ReportTypeMdt: - anyOf: - - type: string - enum: - - PERIODICAL - - EVENT_TRIGGED - - type: string - description: > - The enumeration ReportTypeMdt defines Report Type for logged MDT in the trace. See 3GPP TS - 32.422 for further description of the values. It shall comply with the provisions defined - in table 5.6.3.4-1. - - MeasurementLteForMdt: - anyOf: - - type: string - enum: - - M1 - - M2 - - M3 - - M4_DL - - M4_UL - - M5_DL - - M5_UL - - M6_DL - - M6_UL - - M7_DL - - M7_UL - - M8 - - M9 - - type: string - description: > - The enumeration MeasurementLteForMdt defines Measurements used for MDT in LTE in the trace. - See 3GPP TS 32.422 for further description of the values. It shall comply with the - provisions defined in table 5.6.3.5-1. - - MeasurementNrForMdt: - anyOf: - - type: string - enum: - - M1 - - M2 - - M3 - - M4_DL - - M4_UL - - M5_DL - - M5_UL - - M6_DL - - M6_UL - - M7_DL - - M7_UL - - M8 - - M9 - - type: string - description: > - The enumeration MeasurementNrForMdt defines Measurements used for MDT in NR in the trace. - See 3GPP TS 32.422 for further description of the values. It shall comply with the - provisions defined in table 5.6.3.6-1. - - SensorMeasurement: - anyOf: - - type: string - enum: - - BAROMETRIC_PRESSURE - - UE_SPEED - - UE_ORIENTATION - - type: string - description: > - The enumeration SensorMeasurement defines sensor measurement type for MDT in the trace. - See 3GPP TS 32.422 for further description of the values. It shall comply with the - provisions defined in table 5.6.3.7-1. - - ReportingTrigger: - anyOf: - - type: string - enum: - - PERIODICAL - - EVENT_A2 - - EVENT_A2_PERIODIC - - ALL_RRM_EVENT_TRIGGERS - - type: string - description: > - The enumeration ReportingTrigger defines Reporting Triggers for MDT in the trace. See 3GPP - TS 32.42] for further description of the values. It shall comply with the provisions - defined in table 5.6.3.8-1. - - ReportIntervalMdt: - anyOf: - - type: string - enum: - - 120 - - 240 - - 480 - - 640 - - 1024 - - 2048 - - 5120 - - 10240 - - 60000 - - 360000 - - 720000 - - 1800000 - - 3600000 - - type: string - description: > - The enumeration ReportIntervalMdt defines Report Interval for MDT in the trace. See 3GPP - TS 32.422 for further description of the values. It shall comply with - the provisions defined in table 5.6.3.9-1. - - ReportAmountMdt: - anyOf: - - type: string - enum: - - 1 - - 2 - - 4 - - 8 - - 16 - - 32 - - 64 - - infinity - - type: string - description: > - The enumeration ReportAmountMdt defines Report Amount for MDT in the trace. See 3GPP - TS 32.422 for further description of the values. It shall comply with the provisions - defined in table 5.6.3.10-1. - - EventForMdt: - anyOf: - - type: string - enum: - - OUT_OF_COVERAG - - A2_EVENT - - type: string - description: > - The enumeration EventForMdt defines events triggered measurement for logged MDT in the - trace. See 3GPP TS 32.422 for further description of the values. It shall comply with - the provisions defined in table 5.6.3.11-1 - - LoggingIntervalMdt: - anyOf: - - type: string - enum: - - 128 - - 256 - - 512 - - 1024 - - 2048 - - 3072 - - 4096 - - 6144 - - type: string - description: > - The enumeration LoggingIntervalMdt defines Logging Interval for MDT in the trace. See 3GPP - TS 32.422 for further description of the values. It shall comply with the provisions - defined in table 5.6.3.12-1. - - LoggingDurationMdt: - anyOf: - - type: string - enum: - - 600 - - 1200 - - 2400 - - 3600 - - 5400 - - 7200 - - type: string - description: > - The enumeration LoggingIntervalMdt defines Logging Interval for MDT in the trace. See 3GPP - TS 32.422 for further description of the values. It shall comply with the provisions - defined in table 5.6.3.12-1. - - PositioningMethodMdt: - anyOf: - - type: string - enum: - - GNSS - - E_CELL_ID - - type: string - description: > - The enumeration LoggingDurationMdt defines Logging Duration for MDT in the trace. See 3GPP - TS 32.422 for further description of the values. It shall comply with the provisions - defined in table 5.6.3.13-1. - - CollectionPeriodRmmLteMdt: - anyOf: - - type: string - enum: - - 1024 - - 1280 - - 2048 - - 2560 - - 5120 - - 10240 - - 60000 - - type: string - description: > - The enumeration CollectionPeriodRmmLteMdt defines Collection period for RRM measurements - LTE for MDT in the trace. See 3GPP TS 32.422 for further description of the values. - It shall comply with the provisions defined in table 5.6.3.15-1. - - MeasurementPeriodLteMdt: - anyOf: - - type: string - enum: - - 1024 - - 1280 - - 2048 - - 2560 - - 5120 - - 10240 - - 60000 - - type: string - description: > - The enumeration MeasurementPeriodLteMdt defines Measurement period LTE for MDT in the - trace. See 3GPP TS 32.422 for further description of the values. It shall comply - with the provisions defined in table 5.6.3.16-1. - - ReportIntervalNrMdt: - anyOf: - - type: string - enum: - - 120 - - 240 - - 480 - - 640 - - 1024 - - 2048 - - 5120 - - 10240 - - 20480 - - 40960 - - 60000 - - 360000 - - 720000 - - 1800000 - - 3600000 - - type: string - description: > - The enumeration ReportIntervalNrMdt defines Report Interval in NR for MDT in the trace. See - 3GPP TS 32.422 for further description of the values. It shall comply with the provisions - defined in table 5.6.3.17-1. - - LoggingIntervalNrMdt: - anyOf: - - type: string - enum: - - 128 - - 256 - - 512 - - 1024 - - 2048 - - 3072 - - 4096 - - 6144 - - 320 - - 640 - - infinity - - type: string - description: > - The enumeration LoggingIntervalNrMdt defines Logging Interval in NR for MDT in the trace. - See 3GPP TS 32.422 for further description of the values. It shall comply with the - provisions defined in table 5.6.3.18-1. - - CollectionPeriodRmmNrMdt: - anyOf: - - type: string - enum: - - 1024 - - 2048 - - 5120 - - 10240 - - 60000 - - type: string - description: > - The enumeration CollectionPeriodRmmNrMdt defines Collection period for RRM measurements NR - for MDT in the trace. See 3GPP TS 32.422 for further description of the values. It shall comply with the provisions defined in table 5.6.3.19-1 - - LoggingDurationNrMdt: - anyOf: - - type: string - enum: - - 600 - - 1200 - - 2400 - - 3600 - - 5400 - - 7200 - - type: string - description: > - The enumeration LoggingDurationMdt defines Logging Duration in NR for MDT in the trace. See - 3GPP TS 32.422 for further description of the values. It shall comply with the provisions - defined in table 5.6.3.20-1. - - QoeServiceType: - description: > - The enumeration QoeServiceType indicates the kind of service that shall be recorded for - QMC. It shall comply with the provisions defined in TS 29.571, table 5.6.3.21-1. - anyOf: - - type: string - enum: - - DASH - - MTSI - - VR - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - but is not used to encode content defined in the present version of this API. - - AvailableRanVisibleQoeMetric: - description: > - The enumeration AvailableRanVisibleQoeMetric indicates different available - RAN-visible QoE metrics to the gNB. It shall comply with the provisions defined - in TS 29.571, table 5.6.3.22-1. - anyOf: - - type: string - enum: - - APPLICATION_LAYER_BUFFER_LEVEL_LIST - - PLAYOUT_DELAY_FOR_MEDIA_STARTUP - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - but is not used to encode content defined in the present version of this API. - - MeasurementType: - anyOf: - - type: string - enum: - - GTP_DELAYDLPSAUPFUEMEAN_SNSSAI_QFI - - GTP_DELAYULPSAUPFUEMEANEXCD1_SNSSAI_QFI - - GTP_DELAYDLPSAUPFUEMEANINCD1_SNSSAI_QFI - - GTP_DELAYULPSAUPFNGRANMEAN_SNSSAI_QFI - - GTP_DELAYDLPSAUPFNGRANMEAN_SNSSAI_QFI - - type: string - description: > - The enumeration MeasurementType defines Measurement Type in the - 5GC UE level measurements trace. - - - -# -# STRUCTURED DATA TYPES -# - - TraceData: - description: contains Trace control and configuration parameters. - type: object - nullable: true - properties: - traceRef: - type: string - pattern: '^[0-9]{3}[0-9]{2,3}-[A-Fa-f0-9]{6}$' - description: > - Trace Reference (see 3GPP TS 32.422).It shall be encoded as the concatenation - of MCC, MNC and Trace ID as follows: - - The Trace ID shall be encoded as a 3 octet string in hexadecimal - representation. Each character in the Trace ID string shall - take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. - The most significant character representing the 4 most significant bits of the - Trace ID shall appear first in the string, and the character representing the - 4 least significant bit of the Trace ID shall appear last in the string. - - traceDepth: - $ref: '#/components/schemas/TraceDepth' - neTypeList: - type: string - pattern: '^[A-Fa-f0-9]+$' - description: > - List of NE Types (see 3GPP TS 32.422). It shall be encoded as an octet string - in hexadecimal representation. Each character in the string shall take a value - of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. - The most significant character representing the 4 most significant bits shall - appear first in the string, and the character representing the 4 least - significant bit shall appear last in the string. Octets shall be coded - according to 3GPP TS 32.422. - eventList: - type: string - pattern: '^[A-Fa-f0-9]+$' - description: > - Triggering events (see 3GPP TS 32.422). It shall be encoded as an octet string in - hexadecimal representation. Each character in the string shall take a value of "0" - to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. - The most significant character representing the 4 most significant bits shall - appear first in the string, and the character representing the 4 least - significant bit shall appear last in the string. Octets shall be coded - according to 3GPP TS 32.422. - collectionEntityIpv4Addr: - $ref: '#/components/schemas/Ipv4Addr' - collectionEntityIpv6Addr: - $ref: '#/components/schemas/Ipv6Addr' - traceReportingConsumerUri: - $ref: '#/components/schemas/Uri' - interfaceList: - type: string - pattern: '^[A-Fa-f0-9]+$' - description: > - List of Interfaces (see 3GPP TS 32.422). It shall be encoded as an octet string in - hexadecimal representation. - Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" - and shall represent 4 bits. The most significant character representing the 4 most - significant bits shall appear first in the string, and the character representing the - 4 least significant bit shall appear last in the string. Octets shall be coded - according to 3GPP TS 32.422. If this attribute is not present, all the interfaces - applicable to the list of NE types indicated in the neTypeList attribute should - be traced. - jobType: - $ref: '#/components/schemas/JobType' - required: - - traceRef - - traceDepth - - neTypeList - - eventList - - MdtConfiguration: - description: contains contain MDT configuration data. - type: object - required: - - jobType - properties: - jobType: - $ref: '#/components/schemas/JobType' - reportType: - $ref: '#/components/schemas/ReportTypeMdt' - areaScope: - $ref: '#/components/schemas/AreaScope' - measurementLteList: - type: array - items: - $ref: '#/components/schemas/MeasurementLteForMdt' - measurementNrList: - type: array - items: - $ref: '#/components/schemas/MeasurementNrForMdt' - minItems: 1 - sensorMeasurementList: - type: array - items: - $ref: '#/components/schemas/SensorMeasurement' - minItems: 1 - reportingTriggerList: - type: array - items: - $ref: '#/components/schemas/ReportingTrigger' - minItems: 1 - reportInterval: - $ref: '#/components/schemas/ReportIntervalMdt' - reportIntervalNr: - $ref: '#/components/schemas/ReportIntervalNrMdt' - reportAmount: - $ref: '#/components/schemas/ReportAmountMdt' - reportAmountPerMeasurementLte: - type: object - additionalProperties: - $ref: '#/components/schemas/ReportAmountMdt' - minProperties: 1 - description: > - A map (list of key-value pairs) where MeasurementLteForMdt serves as key; - reportAmountPerMeasurementNr: - type: object - additionalProperties: - $ref: '#/components/schemas/ReportAmountMdt' - minProperties: 1 - description: > - A map (list of key-value pairs) where MeasurementNrForMdt serves as key; - eventThresholdRsrp: - type: integer - minimum: 0 - maximum: 97 - description: > - This IE shall be present if the report trigger parameter is configured for A2 event - reporting or A2 event triggered periodic reporting and the job type parameter is - configured for Immediate MDT or combined Immediate MDT and Trace in LTE. - When present, this IE shall indicate the Event Threshold for RSRP, and the value shall - be between 0-97. - mnOnlyInd: - type: boolean - default: false - - eventThresholdRsrpNr: - type: integer - minimum: 0 - maximum: 127 - description: > - This IE shall be present if the report trigger parameter is configured for A2 event - reporting or A2 event triggered periodic reporting and the job type parameter is - configured for Immediate MDT, combined Immediate MDT - and Trace, Immediate MDT and 5GC UE level measurements or Trace, Immediate MDT and 5GC - UE level measurements in NR. When present, - this IE shall indicate the Event Threshold for RSRP, and the value shall be - between 0-127. - eventThresholdRsrq: - type: integer - minimum: 0 - maximum: 34 - description: > - This IE shall be present if the report trigger parameter is configured for A2 event - reporting or A2 event triggered periodic reporting and the job type parameter is - configured for Immediate MDT or combined Immediate MDT and Trace in LTE.When present, - this IE shall indicate the Event Threshold for RSRQ, and the value shall be - between 0-34. - eventThresholdRsrqNr: - type: integer - minimum: 0 - maximum: 127 - description: > - This IE shall be present if the report trigger parameter is configured for A2 event - reporting or A2 event triggered periodic reporting and the job type parameter is - configured for Immediate MDT, combined Immediate MDT and Trace, Immediate MDT and 5GC - UE level measurements or Trace, Immediate MDT and 5GC UE level measurements in NR. - When present, - this IE shall indicate the Event Threshold for RSRQ, and the value shall be - between 0-127. - eventList: - type: array - items: - $ref: '#/components/schemas/EventForMdt' - minItems: 1 - loggingInterval: - $ref: '#/components/schemas/LoggingIntervalMdt' - loggingIntervalNr: - $ref: '#/components/schemas/LoggingIntervalNrMdt' - loggingDuration: - $ref: '#/components/schemas/LoggingDurationMdt' - loggingDurationNr: - $ref: '#/components/schemas/LoggingDurationNrMdt' - positioningMethod: - $ref: '#/components/schemas/PositioningMethodMdt' - addPositioningMethodList: - type: array - items: - $ref: '#/components/schemas/PositioningMethodMdt' - minItems: 1 - collectionPeriodRmmLte: - $ref: '#/components/schemas/CollectionPeriodRmmLteMdt' - collectionPeriodRmmNr: - $ref: '#/components/schemas/CollectionPeriodRmmNrMdt' - measurementPeriodLte: - $ref: '#/components/schemas/MeasurementPeriodLteMdt' - mdtAllowedPlmnIdList: - type: array - items: - $ref: '#/components/schemas/PlmnId' - minItems: 1 - maxItems: 16 - mbsfnAreaList: - type: array - items: - $ref: '#/components/schemas/MbsfnArea' - minItems: 1 - maxItems: 8 - interFreqTargetList: - type: array - items: - $ref: '#/components/schemas/InterFreqTargetInfo' - minItems: 1 - maxItems: 8 - - AreaScope: - description: Contain the area based on Cells or Tracking Areas. - type: object - properties: - eutraCellIdList: - type: array - items: - $ref: '#/components/schemas/EutraCellId' - minItems: 1 - nrCellIdList: - type: array - items: - $ref: '#/components/schemas/NrCellId' - minItems: 1 - tacList: - type: array - items: - $ref: '#/components/schemas/Tac' - minItems: 1 - tacInfoPerPlmn: - type: object - additionalProperties: - $ref: '#/components/schemas/TacInfo' - minProperties: 1 - description: > - A map (list of key-value pairs) where PlmnId converted to a string serves as key - cagInfoPerPlmn: - type: object - additionalProperties: - $ref: '#/components/schemas/CagInfo' - minProperties: 1 - description: > - A map (list of key-value pairs) where PlmnId converted to a string serves as key - nidInfoPerPlmn: - type: object - additionalProperties: - $ref: '#/components/schemas/NidInfo' - minProperties: 1 - description: > - A map (list of key-value pairs) where PlmnId converted to a string serves as key - cellIdNidInfoPerPlmn: - type: object - additionalProperties: - $ref: '#/components/schemas/CellIdNidInfo' - minProperties: 1 - description: > - A map (list of key-value pairs) where PlmnId converted to a string serves as key - tacNidInfoPerPlmn: - type: object - additionalProperties: - $ref: '#/components/schemas/TacNidInfo' - minProperties: 1 - description: > - A map (list of key-value pairs) where PlmnId converted to a string serves as key - cagList: - type: array - items: - $ref: '#/components/schemas/CagId' - minItems: 1 - - TacInfo: - description: contains tracking area information (tracking area codes). - type: object - required: - - tacList - properties: - tacList: - type: array - items: - $ref: '#/components/schemas/Tac' - minItems: 1 - - CagInfo: - description: contains CAG IDs. - type: object - required: - - cagList - properties: - cagList: - type: array - items: - $ref: '#/components/schemas/CagId' - minItems: 1 - - NidInfo: - description: contains NIDs. - type: object - required: - - nidList - properties: - nidList: - type: array - items: - $ref: '#/components/schemas/Nid' - minItems: 1 - - CellIdNidInfo: - description: contains a list of the NR Cell Identities in SNPN. - type: object - required: - - cellIdNidList - properties: - cellIdNidList: - type: array - items: - $ref: '#/components/schemas/CellIdNid' - minItems: 1 - - CellIdNid: - description: contains a NR Cell Identity and Network Identity. - type: object - required: - - cellId - - nid - properties: - cellId: - $ref: '#/components/schemas/NrCellId' - nid: - $ref: '#/components/schemas/Nid' - - TacNidInfo: - description: contains a list of the tracking area codes in SNPN. - type: object - required: - - tacNidList - properties: - tacNidList: - type: array - items: - $ref: '#/components/schemas/TacNid' - minItems: 1 - - TacNid: - description: contains a tracking area code and Network Identity. - type: object - required: - - tac - - nid - properties: - tac: - $ref: '#/components/schemas/Tac' - nid: - $ref: '#/components/schemas/Nid' - - MbsfnArea: - description: Contains an MBSFN area information. - type: object - properties: - mbsfnAreaId: - type: integer - minimum: 0 - maximum: 255 - description: This IE shall contain the MBSFN Area ID. - carrierFrequency: - type: integer - minimum: 0 - maximum: 262143 - description: When present, this IE shall contain the Carrier Frequency (EARFCN). - - InterFreqTargetInfo: - description: Indicates the Inter Frequency Target information. - required: - - dlCarrierFreq - type: object - properties: - dlCarrierFreq: - $ref: '#/components/schemas/ArfcnValueNR' - cellIdList: - type: array - items: - $ref: '#/components/schemas/PhysCellId' - minItems: 1 - maxItems: 32 - description: > - When present, this IE shall contain a list of the physical cell identities where the - UE is requested to perform measurement logging for the indicated frequency. - - - QmcConfigInfo: - description: > - It contains the configuration information for signaling-based activation of the - Quality of Experience (QoE) Measurements Collection (QMC) functionality. - type: object - required: - - qoeReference - properties: - qoeReference: - $ref: '#/components/schemas/QoeReference' - serviceType: - $ref: '#/components/schemas/QoeServiceType' - sliceScope: - type: array - items: - $ref: '#/components/schemas/Snssai' - minItems: 1 - areaScope: - $ref: '#/components/schemas/QmcAreaScope' - qoeCollectionEntityAddress: - $ref: '#/components/schemas/IpAddr' - qoeTarget: - $ref: '#/components/schemas/QoeTarget' - mdtAlignmentInfo: - $ref: '#/components/schemas/MdtAlignmentInfo' - availableRanVisibleQoeMetrics: - type: array - items: - $ref: '#/components/schemas/AvailableRanVisibleQoeMetric' - minItems: 1 - containerForAppLayerMeasConfig: - $ref: '#/components/schemas/Bytes' - mbsCommunicationServiceType: - $ref: '#/components/schemas/MbsServiceType' - - QmcAreaScope: - description: > - This IE contains the area in Cells or Tracking Areas where the QMC data collection - shall take place. - type: object - properties: - nrCellIdList: - type: array - items: - $ref: '#/components/schemas/NrCellId' - minItems: 1 - tacList: - type: array - items: - $ref: '#/components/schemas/Tac' - minItems: 1 - taiList: - type: array - items: - $ref: '#/components/schemas/Tai' - minItems: 1 - plmnList: - type: array - items: - $ref: '#/components/schemas/PlmnId' - minItems: 1 - - QoeTarget: - description: > - This parameter specifies the target object (individual UE) for the QMC in case of - signalling based QMC. It shall be able to carry an IMSI or a SUPI. - type: object - properties: - supi: - $ref: '#/components/schemas/Supi' - imsi: - $ref: '#/components/schemas/Imsi' - - - UeLevelMeasurementsConfiguration: - description: 5GC UE Level Measurements configuration. - type: object - required: - - jobType - - ueLevelMeasurementsList - properties: - jobType: - $ref: '#/components/schemas/JobType' - ueLevelMeasurementsList: - type: array - items: - $ref: '#/components/schemas/MeasurementType' - minItems: 1 - granularityPeriod: - $ref: '#/components/schemas/DurationSec' - - - - -# Data Types related to 5G ODB as defined in clause 5.7 - -# -# SIMPLE DATA TYPES -# -# -# -# Enumerations -# - RoamingOdb: - anyOf: - - type: string - enum: - - OUTSIDE_HOME_PLMN - - OUTSIDE_HOME_PLMN_COUNTRY - - type: string - description: > - The enumeration RoamingOdb defines the Barring of Roaming as. See 3GPP TS 23.015 for further - description. It shall comply with the provisions defined in table 5.7.3.1-1. - - OdbPacketServices: - anyOf: - - anyOf: - - type: string - enum: - - ALL_PACKET_SERVICES - - ROAMER_ACCESS_HPLMN_AP - - ROAMER_ACCESS_VPLMN_AP - - type: string - - $ref: '#/components/schemas/NullValue' - description: > - The enumeration OdbPacketServices defines the Barring of Packet Oriented Services. - See 3GPP TS 23.015 for further description. It shall comply with the provisions defined - in table 5.7.3.2-1 - -# -# STRUCTURED DATA TYPES -# - - OdbData: - description: Contains information regarding operater determined barring. - type: object - properties: - roamingOdb: - $ref: '#/components/schemas/RoamingOdb' - -# -# Data Types related to Charging as defined in clause 5.8 -# - -# -# SIMPLE DATA TYPES -# -# - ChargingId: - deprecated: true - type: integer - minimum: 0 - maximum: 4294967295 #(2^32)-1 - description: > - Integer where the allowed values correspond to the value range of an unsigned 32-bit - integer. - - SmfChargingId: - description: String based Charging ID - type: string - pattern: '^(0|([1-9]{1}[0-9]{0,9}))\.smf-([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$' - - ApplicationChargingId: - type: string - description: > - Application provided charging identifier allowing correlation of charging information. - - RatingGroup: - $ref: '#/components/schemas/Uint32' - - ServiceId: - $ref: '#/components/schemas/Uint32' - - -# -# Enumerations -# - -# -# STRUCTURED DATA TYPES -# - SecondaryRatUsageReport: - description: Secondary RAT Usage Report to report usage data for a secondary RAT for QoS flows. - type: object - properties: - secondaryRatType: - $ref: '#/components/schemas/RatType' - qosFlowsUsageData: - type: array - items: - $ref: '#/components/schemas/QosFlowUsageReport' - minItems: 1 - required: - - secondaryRatType - - qosFlowsUsageData - - QosFlowUsageReport: - description: Contains QoS flows usage data information. - type: object - properties: - qfi: - $ref: '#/components/schemas/Qfi' - startTimeStamp: - $ref: '#/components/schemas/DateTime' - endTimeStamp: - $ref: '#/components/schemas/DateTime' - downlinkVolume: - $ref: '#/components/schemas/Int64' - uplinkVolume: - $ref: '#/components/schemas/Int64' - required: - - qfi - - startTimeStamp - - endTimeStamp - - downlinkVolume - - uplinkVolume - - SecondaryRatUsageInfo: - description: > - Secondary RAT Usage Information to report usage data for a secondary RAT for QoS flows - and/or the whole PDU session. - type: object - properties: - secondaryRatType: - $ref: '#/components/schemas/RatType' - qosFlowsUsageData: - type: array - items: - $ref: '#/components/schemas/QosFlowUsageReport' - minItems: 1 - pduSessionUsageData: - type: array - items: - $ref: '#/components/schemas/VolumeTimedReport' - minItems: 1 - required: - - secondaryRatType - - VolumeTimedReport: - description: Contains Usage data information. - type: object - properties: - startTimeStamp: - $ref: '#/components/schemas/DateTime' - endTimeStamp: - $ref: '#/components/schemas/DateTime' - downlinkVolume: - $ref: '#/components/schemas/Int64' - uplinkVolume: - $ref: '#/components/schemas/Int64' - required: - - startTimeStamp - - endTimeStamp - - downlinkVolume - - uplinkVolume - - -# Data Types related to MBS as defined in clause 5.9 -# - -# -# SIMPLE DATA TYPES -# -# - - AreaSessionId: - $ref: '#/components/schemas/Uint16' - - AreaSessionPolicyId: - $ref: '#/components/schemas/Uint16' - - MbsFsaId: - description: MBS Frequency Selection Area Identifier - type: string - pattern: '^[A-Fa-f0-9]{6}$' - - - -# -# Enumerations -# -# - MbsServiceType: - description: Indicates the MBS service type of an MBS session - anyOf: - - type: string - enum: - - MULTICAST - - BROADCAST - - type: string - - MbsSessionActivityStatus: - description: Indicates the MBS session's activity status - anyOf: - - type: string - enum: - - ACTIVE - - INACTIVE - - type: string - - MbsSessionEventType: - description: MBS Session Event Type - anyOf: - - type: string - enum: - - MBS_REL_TMGI_EXPIRY - - BROADCAST_DELIVERY_STATUS - - INGRESS_TUNNEL_ADD_CHANGE - - type: string - - BroadcastDeliveryStatus: - description: Broadcast MBS Session's Delivery Status - anyOf: - - type: string - enum: - - STARTED - - TERMINATED - - type: string - - NrRedCapUeInfo: - description: > - Indicates whether the broadcast MBS session is intended only for NR RedCap UEs, - both for NR RedCap UEs and non-RedCap UEs, or only for non-RedCap UEs. - anyOf: - - type: string - enum: - - NR_REDCAP_UE_ONLY - - BOTH_NR_REDCAP_UE_AND_NON_REDCAP_UE - - NON_REDCAP_UE_ONLY - - type: string - -# -# STRUCTURED DATA TYPES -# - MbsSessionId: - description: MBS Session Identifier - type: object - properties: - tmgi: - $ref: '#/components/schemas/Tmgi' - ssm: - $ref: '#/components/schemas/Ssm' - nid: - $ref: '#/components/schemas/Nid' - anyOf: - - required: [ tmgi ] - - required: [ ssm ] - - Tmgi: - description: Temporary Mobile Group Identity - type: object - properties: - mbsServiceId: - type: string - pattern: '^[A-Fa-f0-9]{6}$' - description: MBS Service ID - plmnId: - $ref: '#/components/schemas/PlmnId' - required: - - mbsServiceId - - plmnId - - Ssm: - description: Source specific IP multicast address - type: object - properties: - sourceIpAddr: - $ref: '#/components/schemas/IpAddr' - destIpAddr: - $ref: '#/components/schemas/IpAddr' - required: - - sourceIpAddr - - destIpAddr - - MbsServiceArea: - description: MBS Service Area - type: object - properties: - ncgiList: - type: array - items: - $ref: '#/components/schemas/NcgiTai' - minItems: 1 - description: List of NR cell Ids - taiList: - type: array - items: - $ref: '#/components/schemas/Tai' - minItems: 1 - description: List of tracking area Ids - anyOf: - - required: [ ncgiList ] - - required: [ taiList ] - - NcgiTai: - description: List of NR cell ids, with their pertaining TAIs - type: object - properties: - tai: - $ref: '#/components/schemas/Tai' - cellList: - type: array - items: - $ref: '#/components/schemas/Ncgi' - minItems: 1 - description: List of List of NR cell ids - required: - - tai - - cellList - - MbsSession: - description: Individual MBS session - type: object - properties: - mbsSessionId: - $ref: '#/components/schemas/MbsSessionId' - tmgiAllocReq: - type: boolean - default: false - writeOnly: true - tmgi: - allOf: - - $ref: '#/components/schemas/Tmgi' - readOnly: true - expirationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - readOnly: true - serviceType: - allOf: - - $ref: '#/components/schemas/MbsServiceType' - writeOnly: true - locationDependent: - type: boolean - default: false - areaSessionId: - allOf: - - $ref: '#/components/schemas/AreaSessionId' - readOnly: true - ingressTunAddrReq: - type: boolean - default: false - writeOnly: true - ingressTunAddr: - type: array - items: - $ref: '#/components/schemas/TunnelAddress' - minItems: 1 - readOnly: true - ssm: - allOf: - - $ref: '#/components/schemas/Ssm' - writeOnly: true - mbsServiceArea: - allOf: - - $ref: '#/components/schemas/MbsServiceArea' - writeOnly: true - extMbsServiceArea: - allOf: - - $ref: '#/components/schemas/ExternalMbsServiceArea' - writeOnly: true - redMbsServArea: - allOf: - - $ref: '#/components/schemas/MbsServiceArea' - readOnly: true - extRedMbsServArea: - allOf: - - $ref: '#/components/schemas/ExternalMbsServiceArea' - readOnly: true - dnn: - allOf: - - $ref: '#/components/schemas/Dnn' - writeOnly: true - snssai: - allOf: - - $ref: '#/components/schemas/Snssai' - writeOnly: true - activationTime: - deprecated: true - format: date-time - type: string - startTime: - $ref: '#/components/schemas/DateTime' - terminationTime: - $ref: '#/components/schemas/DateTime' - mbsServInfo: - $ref: '#/components/schemas/MbsServiceInfo' - mbsSessionSubsc: - $ref: '#/components/schemas/MbsSessionSubscription' - activityStatus: - $ref: '#/components/schemas/MbsSessionActivityStatus' - anyUeInd: - type: boolean - default: false - writeOnly: true - mbsFsaIdList: - type: array - items: - $ref: '#/components/schemas/MbsFsaId' - minItems: 1 - associatedSessionId: - $ref: '#/components/schemas/AssociatedSessionId' - nrRedCapUeInfo: - $ref: '#/components/schemas/NrRedCapUeInfo' - required: - - serviceType - anyOf: - - required: [ mbsSessionId ] - - required: [ tmgiAllocReq ] - not: - required: [redMbsServArea, extRedMbsServArea] - - - MbsSessionSubscription: - description: MBS session subscription - type: object - properties: - mbsSessionId: - $ref: '#/components/schemas/MbsSessionId' - areaSessionId: - $ref: '#/components/schemas/AreaSessionId' - eventList: - type: array - items: - $ref: '#/components/schemas/MbsSessionEvent' - minItems: 1 - notifyUri: - $ref: '#/components/schemas/Uri' - notifyCorrelationId: - type: string - expiryTime: - $ref: '#/components/schemas/DateTime' - nfcInstanceId: - $ref: '#/components/schemas/NfInstanceId' - mbsSessionSubscUri: - allOf: - - $ref: '#/components/schemas/Uri' - readOnly: true - required: - - eventList - - notifyUri - - MbsSessionEventReportList: - description: MBS session event report list - type: object - properties: - eventReportList: - type: array - items: - $ref: '#/components/schemas/MbsSessionEventReport' - minItems: 1 - notifyCorrelationId: - type: string - required: - - eventReportList - - MbsSessionEvent: - description: MBS session event - type: object - properties: - eventType: - $ref: '#/components/schemas/MbsSessionEventType' - required: - - eventType - - MbsSessionEventReport: - description: MBS session event report - type: object - properties: - eventType: - $ref: '#/components/schemas/MbsSessionEventType' - timeStamp: - $ref: '#/components/schemas/DateTime' - ingressTunAddrInfo: - $ref: '#/components/schemas/IngressTunAddrInfo' - broadcastDelStatus: - $ref: '#/components/schemas/BroadcastDeliveryStatus' - required: - - eventType - - ExternalMbsServiceArea: - description: List of geographic area or list of civic address info for MBS Service Area - type: object - properties: - geographicAreaList: - type: array - items: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' - minItems: 1 - civicAddressList: - type: array - items: - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' - minItems: 1 - oneOf: - - required: [ geographicAreaList ] - - required: [ civicAddressList ] - - - MbsSecurityContext: - description: MBS security context consisting of MSK/MTK(s) and associated IDs - type: object - properties: - keyList: - description: > - A map (list of key-value pairs) where a (unique) valid JSON string serves - as key of MbsSecurityContext - type: object - additionalProperties: - $ref: '#/components/schemas/MbsKeyInfo' - minProperties: 1 - required: - - keyList - - MbsKeyInfo: - description: MBS Security Key Data Structure - type: object - properties: - keyDomainId: - $ref: '#/components/schemas/Bytes' - mskId: - $ref: '#/components/schemas/Bytes' - msk: - $ref: '#/components/schemas/Bytes' - mskLifetime: - $ref: '#/components/schemas/DateTime' - mtkId: - $ref: '#/components/schemas/Bytes' - mtk: - $ref: '#/components/schemas/Bytes' - required: - - keyDomainId - - mskId - - IngressTunAddrInfo: - description: Ingress Tunnel Address Information - type: object - properties: - ingressTunAddr: - type: array - items: - $ref: '#/components/schemas/TunnelAddress' - minItems: 1 - required: - - ingressTunAddr - - - MbsServiceAreaInfo: - description: MBS Service Area Information for location dependent MBS session - type: object - properties: - areaSessionId: - $ref: '#/components/schemas/AreaSessionId' - mbsServiceArea: - $ref: '#/components/schemas/MbsServiceArea' - required: - - areaSessionId - - mbsServiceArea - - MbsServiceInfo: - description: Represent MBS Service Information. - type: object - properties: - mbsMediaComps: - description: > - The key of the map is the "mbsMedCompNum" attribute of the corresponding MbsMediaCompRm - data structure provided as a map entry. - type: object - additionalProperties: - $ref: '#/components/schemas/MbsMediaCompRm' - minProperties: 1 - mbsSdfResPrio: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ReservPriority' - afAppId: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AfAppId' - mbsSessionAmbr: - $ref: '#/components/schemas/BitRate' - required: - - mbsMediaComps - - MbsMediaComp: - description: Represents an MBS Media Component. - type: object - properties: - mbsMedCompNum: - type: integer - mbsFlowDescs: - type: array - items: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' - minItems: 1 - mbsSdfResPrio: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ReservPriority' - mbsMediaInfo: - $ref: '#/components/schemas/MbsMediaInfo' - qosRef: - type: string - mbsQoSReq: - $ref: '#/components/schemas/MbsQoSReq' - required: - - mbsMedCompNum - - MbsMediaCompRm: - description: > - This data type is defined in the same way as the MbsMediaComp data type, but with the - OpenAPI nullable property set to true. - anyOf: - - $ref: '#/components/schemas/MbsMediaComp' - - $ref: '#/components/schemas/NullValue' - - MbsQoSReq: - description: Represent MBS QoS requirements. - type: object - properties: - 5qi: - $ref: '#/components/schemas/5Qi' - guarBitRate: - $ref: '#/components/schemas/BitRate' - maxBitRate: - $ref: '#/components/schemas/BitRate' - averWindow: - $ref: '#/components/schemas/AverWindow' - reqMbsArp: - $ref: '#/components/schemas/Arp' - required: - - 5qi - - MbsMediaInfo: - description: Represent MBS Media Information. - type: object - properties: - mbsMedType: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MediaType' - maxReqMbsBwDl: - $ref: '#/components/schemas/BitRate' - minReqMbsBwDl: - $ref: '#/components/schemas/BitRate' - codecs: - type: array - items: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/CodecData' - minItems: 1 - maxItems: 2 - - AssociatedSessionId: - description: an associated Session Id used in MOCN - anyOf: - - $ref: '#/components/schemas/Ssm' - - type: string - - - -# Data Types related to Time Synchronization as defined in clause 5.10 -# - -# -# SIMPLE DATA TYPES -# -# - - -# -# Enumerations -# -# - - SynchronizationState: - description: Indicates the Synchronization State. - anyOf: - - type: string - enum: - - LOCKED - - HOLDOVER - - FREERUN - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - - TimeSource: - description: Indicates the Time Source. - anyOf: - - type: string - enum: - - SYNC_E - - PTP - - GNSS - - ATOMIC_CLOCK - - TERRESTRIAL_RADIO - - SERIAL_TIME_CODE - - NTP - - HAND_SET - - OTHER - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - - ClockQualityDetailLevel: - description: Indicates the Clock Quality Detail Level. - anyOf: - - type: string - enum: - - CLOCK_QUALITY_METRICS - - ACCEPT_INDICATION - - type: string - description: > - This string provides forward-compatibility with future - extensions to the enumeration but is not used to encode - content defined in the present version of this API. - - ClockQualityDetailLevelRm: - description: > - This data type is defined in the same way as the 'ClockQualityDetailLevel' data type, - but with the OpenAPI 'nullable: true' property. - anyOf: - - $ref: '#/components/schemas/ClockQualityDetailLevel' - - $ref: '#/components/schemas/NullValue' - - -# -# STRUCTURED DATA TYPES -# - - ClockQualityAcceptanceCriterion: - description: Contains a Clock Quality Acceptance Criterion. - type: object - properties: - synchronizationState: - type: array - items: - $ref: '#/components/schemas/SynchronizationState' - minItems: 1 - clockQuality: - $ref: '#/components/schemas/ClockQuality' - parentTimeSource: - type: array - items: - $ref: '#/components/schemas/TimeSource' - minItems: 1 - - ClockQualityAcceptanceCriterionRm: - description: Contains a Clock Quality Acceptance Criterion. - type: object - nullable: true - properties: - synchronizationState: - type: array - nullable: true - items: - $ref: '#/components/schemas/SynchronizationState' - minItems: 1 - clockQuality: - $ref: '#/components/schemas/ClockQualityRm' - parentTimeSource: - type: array - nullable: true - items: - $ref: '#/components/schemas/TimeSource' - minItems: 1 - - ClockQuality: - description: Contains Clock Quality. - type: object - properties: - traceabilityToGnss: - type: boolean - traceabilityToUtc: - type: boolean - frequencyStability: - $ref: '#/components/schemas/Uint16' - clockAccuracyIndex: - type: string - pattern: '^[A-Fa-f0-9]{2}$' - clockAccuracyValue: - type: integer - minimum: 1 - maximum: 40000000 - - ClockQualityRm: - description: "ClockQuality with 'nullable: true' property" - type: object - nullable: true - properties: - traceabilityToGnss: - type: boolean - traceabilityToUtc: - type: boolean - frequencyStability: - $ref: '#/components/schemas/Uint16Rm' - clockAccuracyIndex: - type: string - nullable: true - pattern: '^[A-Fa-f0-9]{2}$' - clockAccuracyValue: - type: integer - nullable: true - minimum: 1 - maximum: 40000000 - - - - -# Data Types related to IMS SBA as defined in clause 5.11 -# - -# -# SIMPLE DATA TYPES -# -# - - SessionId: - description: IMS Session Identifier - type: string - - Fingerprint: - description: The certificate fingerprint for the DTLS association. - type: string - pattern: '^(SHA-1|SHA-224|SHA-256|SHA-384|SHA-512|MD5|MD2)\s[0-9A-F]{2}(:[0-9A-F]{2})+$' - - MediaId: - description: IMS Media Flow Identifier - type: string - - MaxMessageSize: - description: Maximum SCTP user message size - type: integer - maximum: 64 - default: 64 - - TlsId: - description: The TLS ID for the media stream. - type: string - pattern: '^[A-Za-z0-9+/_-]{20,255}$' - - -# -# Enumerations -# -# - MediaResourceType: - description: Indicates the Media Resource type - anyOf: - - type: string - enum: - - DC - - AR - - AUDIO - - VIDEO - - type: string - - MediaProxy: - description: Media Proxy Configuration applicable to the media flow - anyOf: - - type: string - enum: - - HTTP_PROXY - - UDP_PROXY - - type: string - - BdcUsedBy: - description: The party uses the bootstrap data channel in the media description - anyOf: - - type: string - enum: - - SENDER - - RECEIVER - - type: string - - AdcEndpointType: - description: The remote endpoint type of the application data channel - anyOf: - - type: string - enum: - - UE - - SERVER - - type: string - - - SecuritySetup: - description: security setup of the DTLS connection - anyOf: - - type: string - enum: - - ACTIVE - - PASSIVE - - ACTPASS - - type: string - -# STRUCTURED DATA TYPES -# - DcEndpoint: - description: Endpoint for Data Channel - type: object - properties: - sctpPort: - type: integer - maximum: 65535 - minimum: 0 - description: Local or remote port for Data Channel - fingerprint: - deprecated: true - allOf: - - $ref: '#/components/schemas/Fingerprint' - fingerprints: - type: array - items: - $ref: '#/components/schemas/Fingerprint' - minItems: 1 - tlsId: - $ref: '#/components/schemas/TlsId' - securitySetup: - $ref: '#/components/schemas/SecuritySetup' - - DcStream: - description: Data Channel mapping and configuration information - type: object - not: - required: [maxRetry, maxTime] - properties: - streamId: - type: integer - maximum: 65535 - default: 0 - description: Stream identifier for Data Channel - subprotocol: - type: string - pattern: '^[A-Fa-f0-9]{20}$' - description: Subprotocol of the SCTP stream - order: - type: boolean - maxRetry: - type: integer - default: 0 - description: maximal number of the times a message will be retransmitted - maxTime: - type: integer - default: 0 - description: > - maximal lifetime in milliseconds after which a message will no longer be - transmitted or retransmitted - priority: - type: integer - default: 256 - description: priority of data channel relative to other data channels - - - ReplaceHttpUrl: - description: replacement HTTP URL per stream - type: object - properties: - replaceHttpUrl: - $ref: '#/components/schemas/Uri' - streamId: - type: integer - maximum: 65535 - default: 0 - description: Stream identifier for Data Channel - - Endpoint: - description: Represents the IP endpoint. - type: object - required: - - ip - - transport - - portNumber - properties: - ip: - $ref: '#/components/schemas/IpAddr' - transport: - $ref: '#/components/schemas/TransportProtocol' - portNumber: - $ref: '#/components/schemas/Uinteger' - - - AppBindingInfo: - description: Represents the application binding information. - type: object - required: - - applicationId - properties: - applicationId: - type: string - description: application binding information of the Data Channel. - appDcInfo: - deprecated: true - allOf: - - $ref: '#/components/schemas/AppDcInfo' - appDcInfoList: - type: array - items: - $ref: '#/components/schemas/AppDcInfo' - minItems: 1 - - - AppDcInfo: - description: Represents the application data channel is intened towards to a server or the remote UE. - type: object - required: - - streamId - properties: - streamId: - type: integer - adcEndpointType: - $ref: '#/components/schemas/AdcEndpointType' - - MdcEndpoint: - description: Endpoint for MDC1 and MDC2 interface - type: object - required: - - ip - - portNumber - properties: - ip: - $ref: '#/components/schemas/IpAddr' - portNumber: - $ref: '#/components/schemas/Uinteger' - sctpPort: - type: integer - maximum: 65535 - minimum: 0 - description: Port number for SCTP connection over DTLS - fingerprint: - deprecated: true - allOf: - - $ref: '#/components/schemas/Fingerprint' - - fingerprints: - type: array - items: - $ref: '#/components/schemas/Fingerprint' - minItems: 1 - - tlsId: - $ref: '#/components/schemas/TlsId' - securitySetup: - $ref: '#/components/schemas/SecuritySetup' - -# -# HTTP responses -# - - responses: - '307': - description: Temporary Redirect - content: - application/json: - schema: - $ref: '#/components/schemas/RedirectResponse' - headers: - Location: - description: 'The URI pointing to the resource located on the redirect target' - required: true - schema: - type: string - 3gpp-Sbi-Target-Nf-Id: - description: > - 'Identifier of target NF (service) instance towards which the request is redirected' - schema: - type: string - '308': - description: Permanent Redirect - content: - application/json: - schema: - $ref: '#/components/schemas/RedirectResponse' - headers: - Location: - description: 'The URI pointing to the resource located on the redirect target' - required: true - schema: - type: string - 3gpp-Sbi-Target-Nf-Id: - description: > - 'Identifier of target NF (service) instance towards which the request is redirected' - schema: - type: string - '400': - description: Bad request - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: Unauthorized - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: Forbidden - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: Not Found - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '405': - description: Method Not Allowed - '408': - description: Request Timeout - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 406 Not Acceptable - '409': - description: Conflict - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '410': - description: Gone - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '411': - description: Length Required - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '412': - description: Precondition Failed - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '413': - description: Content Too Large - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '414': - description: URI Too Long - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '415': - description: Unsupported Media Type - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: Too Many Requests - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '500': - description: Internal Server Error - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '501': - description: Not Implemented - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '502': - description: Bad Gateway - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '503': - description: Service Unavailable - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '504': - description: Gateway Timeout - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - default: - description: Generic Error diff --git a/OpenAPI/TS29594_Nchf_SpendingLimitControl.yaml b/OpenAPI/TS29594_Nchf_SpendingLimitControl.yaml deleted file mode 100644 index d21bf1ec5d4a381c7834fc77634274e89228cdf9..0000000000000000000000000000000000000000 --- a/OpenAPI/TS29594_Nchf_SpendingLimitControl.yaml +++ /dev/null @@ -1,371 +0,0 @@ -openapi: 3.0.0 - -info: - version: 1.3.0 - title: Nchf_SpendingLimitControl - description: | - Nchf Spending Limit Control Service. - © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. - -externalDocs: - description: 3GPP TS 29.594 V18.4.0; 5G System; Spending Limit Control Service. - url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.594/' - -servers: - - url: '{apiRoot}/nchf-spendinglimitcontrol/v1' - variables: - apiRoot: - default: https://example.com - description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 - -security: - - {} - - oAuth2ClientCredentials: - - nchf-spendinglimitcontrol - -paths: - - /subscriptions: - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SpendingLimitContext' - responses: - '201': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SpendingLimitStatus' - headers: - Location: - description: > - Contains the URI of the created individual spending limit resource, - according to the structure - {apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId} - required: true - schema: - type: string - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - callbacks: - statusNotification: - '{$request.body#/notifUri}/notify': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SpendingLimitStatus' - responses: - '204': - description: No Content, Notification was succesfull - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - subscriptionTermination: - '{$request.body#/notifUri}/terminate': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SubscriptionTerminationInfo' - responses: - '204': - description: No Content, Notification was succesfull - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - - /subscriptions/{subscriptionId}: - parameters: - - in: path - name: subscriptionId - description: Identifies an individual spending limit retrieval subscription. - required: true - schema: - type: string - put: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SpendingLimitContext' - responses: - '200': - description: OK. Resource was succesfully modified and representation is returned - content: - application/json: - schema: - $ref: '#/components/schemas/SpendingLimitStatus' - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '411': - $ref: 'TS29571_CommonData.yaml#/components/responses/411' - '413': - $ref: 'TS29571_CommonData.yaml#/components/responses/413' - '415': - $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - delete: - responses: - '204': - description: No Content. Resource was succesfully deleted - '307': - $ref: 'TS29571_CommonData.yaml#/components/responses/307' - '308': - $ref: 'TS29571_CommonData.yaml#/components/responses/308' - '400': - $ref: 'TS29571_CommonData.yaml#/components/responses/400' - '401': - $ref: 'TS29571_CommonData.yaml#/components/responses/401' - '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' - '404': - $ref: 'TS29571_CommonData.yaml#/components/responses/404' - '429': - $ref: 'TS29571_CommonData.yaml#/components/responses/429' - '500': - $ref: 'TS29571_CommonData.yaml#/components/responses/500' - '502': - $ref: 'TS29571_CommonData.yaml#/components/responses/502' - '503': - $ref: 'TS29571_CommonData.yaml#/components/responses/503' - default: - $ref: 'TS29571_CommonData.yaml#/components/responses/default' - - -components: - securitySchemes: - oAuth2ClientCredentials: - type: oauth2 - flows: - clientCredentials: - tokenUrl: '{nrfApiRoot}/oauth2/token' - scopes: - nchf-spendinglimitcontrol: Access to the Nchf_SpendingLimitControl API - - schemas: - SpendingLimitContext: - description: > - Represents the subscription data structure required for an individual CHF spending limit - subscription. - type: object - properties: - supi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - gpsi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - policyCounterIds: - type: array - items: - $ref: '#/components/schemas/PolicyCounterId' - minItems: 1 - description: > - This is a list of policy counter identifier(s), which identifies policy counters - maintained per subscriber within the CHF. - notifUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' - expiry: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - supportedFeatures: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - notifId: - type: string - - SpendingLimitStatus: - description: > - Represents the data structure presenting the statuses of policy counters. - type: object - properties: - supi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - notifId: - type: string - statusInfos: - type: object - additionalProperties: - $ref: '#/components/schemas/PolicyCounterInfo' - minProperties: 1 - description: > - Status of the requested policy counters. The key of the map is the attribute - "policyCounterId". - expiry: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - supportedFeatures: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - - PolicyCounterInfo: - description: Represents the data structure presenting the policy counter status. - type: object - properties: - policyCounterId: - $ref: '#/components/schemas/PolicyCounterId' - currentStatus: - type: string - description: > - Identifies the policy counter status applicable for a specific policy counter identified - by the policyCounterId. The values (e.g. valid, invalid or any other status) are not - specified. The interpretation and actions related to the defined values are out of scope - of 3GPP. - penPolCounterStatuses: - type: array - items: - $ref: '#/components/schemas/PendingPolicyCounterStatus' - minItems: 1 - description: Provides the pending policy counter status. - required: - - policyCounterId - - currentStatus - - PendingPolicyCounterStatus: - description: > - Represents the data structure presenting the pending policy counter status. - type: object - properties: - policyCounterStatus: - type: string - description: > - Identifies the policy counter status applicable for a specific policy counter identified - by the policyCounterId. The values (e.g. valid, invalid or any other status) are not - specified. The interpretation and actions related to the defined values are out of scope - of 3GPP. - activationTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - required: - - policyCounterStatus - - activationTime - - PolicyCounterId: - type: string - description: Identifies a policy counter. - SubscriptionTerminationInfo: - description: > - Represents the data structure presenting the indication of the termination of the - subscription. - type: object - properties: - supi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - notifId: - type: string - termCause: - $ref: '#/components/schemas/TerminationCause' - required: - - supi - -# Simple data types and Enumerations - - TerminationCause: - anyOf: - - type: string - enum: - - REMOVED_SUBSCRIBER - - type: string - description: > - This string provides forward-compatibility with future extensions to the enumeration - and is not used to encode content defined in the present version of this API. - description: | - Represents the cause for requesting the termination of the subscription to policy counter - status changes. - Possible values are: - - REMOVED_SUBSCRIBER: The subscriber identified by the SUPI has been removed from the CHF. diff --git a/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml b/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml index 02482aa096e797f7f184555c3f675c689b5d7fa7..b6207cf4afdb8c1bc4f282ec189d82747612b2fc 100644 --- a/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml +++ b/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml @@ -1,13 +1,13 @@ openapi: 3.0.0 info: title: Nchf_ConvergedCharging - version: 3.2.1 + version: 3.2.2 description: | - ConvergedCharging Service © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + ConvergedCharging Service © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > - 3GPP TS 32.291 V18.7.0: Telecommunication management; Charging management; + 3GPP TS 32.291 V18.9.0: Telecommunication management; Charging management; 5G system, charging service; Stage 3. url: 'http://www.3gpp.org/ftp/Specs/archive/32_series/32.291/' servers: @@ -1096,8 +1096,13 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' recipientGPSI: $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - recipientOtherAddress: + recipientOtherAddress: # Included for backwards compatibility, shall not be used $ref: '#/components/schemas/SMAddressInfo' + recipientOtherAddresses: + type: array + items: + $ref: '#/components/schemas/RecipientAddress' + minItems: 0 recipientReceivedAddress: $ref: '#/components/schemas/SMAddressInfo' recipientSCCPAddress: @@ -2732,13 +2737,13 @@ components: - type: string enum: - EMAIL_ADDRESS - - MSISDN + - MSISDN # Included for backwards compatibility, shall not be used - IPV4_ADDRESS - IPV6_ADDRESS - NUMERIC_SHORTCODE - ALPHANUMERIC_SHORTCODE - OTHER - - IMSI + - IMSI # Included for backwards compatibility, shall not be used - type: string SMAddresseeType: anyOf: