From 4a28306eefaf74e2b4358f994178c43c9a4464bf Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Wed, 25 Sep 2024 03:39:11 +0000 Subject: [PATCH 01/33] Upload the YAML from TS 32.291 19.0.0 --- OpenAPI/TS32291_Nchf_ConvergedCharging.yaml | 3139 +++++++++++++++++++ 1 file changed, 3139 insertions(+) create mode 100644 OpenAPI/TS32291_Nchf_ConvergedCharging.yaml diff --git a/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml b/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml new file mode 100644 index 0000000..02482aa --- /dev/null +++ b/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml @@ -0,0 +1,3139 @@ +openapi: 3.0.0 +info: + title: Nchf_ConvergedCharging + version: 3.2.1 + description: | + ConvergedCharging Service © 2023, 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; + 5G system, charging service; Stage 3. + url: 'http://www.3gpp.org/ftp/Specs/archive/32_series/32.291/' +servers: + - url: '{apiRoot}/nchf-convergedcharging/v3' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501. +security: + - {} + - oAuth2ClientCredentials: + - nchf-convergedcharging +paths: + /chargingdata: + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingDataRequest' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingDataResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Bad request + content: + application/problem+json: + schema: + oneOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ChargingDataResponse' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + oneOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ChargingDataResponse' + '404': + description: Not Found + content: + application/problem+json: + schema: + oneOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ChargingDataResponse' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '408': + $ref: 'TS29571_CommonData.yaml#/components/responses/408' + '410': + $ref: 'TS29571_CommonData.yaml#/components/responses/410' + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + chargingNotification: + '{$request.body#/notifyUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingNotifyRequest' + responses: + '200': + description: OK. + content: + application/ json: + schema: + $ref: '#/components/schemas/ChargingNotifyResponse' + '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/problem+json: + schema: + oneOf: + - $ref: TS29571_CommonData.yaml#/components/schemas/ProblemDetails + - $ref: '#/components/schemas/ChargingNotifyResponse' + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + '/chargingdata/{ChargingDataRef}/update': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingDataRequest' + parameters: + - name: ChargingDataRef + in: path + description: a unique identifier for a charging data resource in a PLMN + required: true + schema: + type: string + responses: + '200': + description: OK. Updated Charging Data resource is returned + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingDataResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Bad request + content: + application/problem+json: + schema: + oneOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ChargingDataResponse' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + oneOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ChargingDataResponse' + '404': + description: Not Found + content: + application/problem+json: + schema: + oneOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ChargingDataResponse' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '408': + $ref: 'TS29571_CommonData.yaml#/components/responses/408' + '410': + $ref: 'TS29571_CommonData.yaml#/components/responses/410' + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + '/chargingdata/{ChargingDataRef}/release': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingDataRequest' + parameters: + - name: ChargingDataRef + in: path + description: a unique identifier for a charging data resource in a PLMN + 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': + description: Not Found + content: + application/problem+json: + schema: + oneOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ChargingDataResponse' + '410': + $ref: 'TS29571_CommonData.yaml#/components/responses/410' + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nchf-convergedcharging: Access to the Nchf_ConvergedCharging API + schemas: + ChargingDataRequest: + type: object + properties: + subscriberIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + tenantIdentifier: + type: string + chargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + mnSConsumerIdentifier: + type: string + nfConsumerIdentification: + $ref: '#/components/schemas/NFIdentification' + invocationTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + invocationSequenceNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + retransmissionIndicator: + type: boolean + oneTimeEvent: + type: boolean + oneTimeEventType: + $ref: '#/components/schemas/oneTimeEventType' + notifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + serviceSpecificationInfo: + type: string + multipleUnitUsage: + type: array + items: + $ref: '#/components/schemas/MultipleUnitUsage' + minItems: 0 + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + easid: + type: string + ednid: + type: string + eASProviderIdentifier: + type: string + aMFId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfId' + pDUSessionChargingInformation: + $ref: '#/components/schemas/PDUSessionChargingInformation' + roamingQBCInformation: + $ref: '#/components/schemas/RoamingQBCInformation' + sMSChargingInformation: + $ref: '#/components/schemas/SMSChargingInformation' + nEFChargingInformation: + $ref: '#/components/schemas/NEFChargingInformation' + registrationChargingInformation: + $ref: '#/components/schemas/RegistrationChargingInformation' + n2ConnectionChargingInformation: + $ref: '#/components/schemas/N2ConnectionChargingInformation' + locationReportingChargingInformation: + $ref: '#/components/schemas/LocationReportingChargingInformation' + nSPAChargingInformation: + $ref: '#/components/schemas/NSPAChargingInformation' + nSMChargingInformation: + $ref: '#/components/schemas/NSMChargingInformation' + mMTelChargingInformation: + $ref: '#/components/schemas/MMTelChargingInformation' + iMSChargingInformation: + $ref: '#/components/schemas/IMSChargingInformation' + edgeInfrastructureUsageChargingInformation: + $ref: '#/components/schemas/EdgeInfrastructureUsageChargingInformation' + eASDeploymentChargingInformation: + $ref: '#/components/schemas/EASDeploymentChargingInformation' + directEdgeEnablingServiceChargingInformation: + $ref: '#/components/schemas/NEFChargingInformation' + exposedEdgeEnablingServiceChargingInformation: + $ref: '#/components/schemas/NEFChargingInformation' + proSeChargingInformation: + $ref: '#/components/schemas/ProseChargingInformation' + mMSChargingInformation: + $ref: '#/components/schemas/MMSChargingInformation' + mBSSessionChargingInformation: + $ref: '#/components/schemas/MBSSessionChargingInformation' + tSNChargingInformation: + $ref: '#/components/schemas/TSNChargingInformation' + interCHFInformation: + $ref: '#/components/schemas/InterCHFInformation' + nSACFChargingInformation: + $ref: '#/components/schemas/NSACFChargingInformation' + nSSAAChargingInformation: + $ref: '#/components/schemas/NSSAAChargingInformation' + required: + - nfConsumerIdentification + - invocationTimeStamp + - invocationSequenceNumber + ChargingDataResponse: + type: object + properties: + invocationTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + invocationSequenceNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + invocationResult: + $ref: '#/components/schemas/InvocationResult' + sessionFailover: + $ref: '#/components/schemas/SessionFailover' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + multipleUnitInformation: + type: array + items: + $ref: '#/components/schemas/MultipleUnitInformation' + minItems: 0 + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + pDUSessionChargingInformation: + $ref: '#/components/schemas/PDUSessionChargingInformation' + roamingQBCInformation: + $ref: '#/components/schemas/RoamingQBCInformation' + locationReportingChargingInformation: + $ref: '#/components/schemas/LocationReportingChargingInformation' + mBSSessionChargingInformation: + $ref: '#/components/schemas/MBSSessionChargingInformation' + interCHFInformation: + $ref: '#/components/schemas/InterCHFInformation' + required: + - invocationTimeStamp + - invocationSequenceNumber + ChargingNotifyRequest: + type: object + properties: + notificationType: + $ref: '#/components/schemas/NotificationType' + reauthorizationDetails: + type: array + items: + $ref: '#/components/schemas/ReauthorizationDetails' + minItems: 0 + required: + - notificationType + ChargingNotifyResponse: + type: object + properties: + invocationResult: + $ref: '#/components/schemas/InvocationResult' + NFIdentification: + type: object + properties: + nFName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nFIPv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + nFIPv6Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + nFPLMNID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + nodeFunctionality: + $ref: '#/components/schemas/NodeFunctionality' + nFFqdn: + type: string + required: + - nodeFunctionality + MultipleUnitUsage: + type: object + properties: + ratingGroup: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup' + requestedUnit: + $ref: '#/components/schemas/RequestedUnit' + allocateUnit: + $ref: '#/components/schemas/AllocateUnit' + usedUnitContainer: + type: array + items: + $ref: '#/components/schemas/UsedUnitContainer' + minItems: 0 + allocatedUnit: + $ref: '#/components/schemas/AllocatedUnit' + uPFID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + multihomedPDUAddress: + $ref: '#/components/schemas/PDUAddress' + mBUPFID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + required: + - ratingGroup + InvocationResult: + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + failureHandling: + $ref: '#/components/schemas/FailureHandling' + Trigger: + type: object + properties: + triggerType: + $ref: '#/components/schemas/TriggerType' + triggerCategory: + $ref: '#/components/schemas/TriggerCategory' + timeLimit: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + volumeLimit: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + volumeLimit64: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + eventLimit: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + maxNumberOfccc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + tariffTimeChange: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - triggerCategory + MultipleUnitInformation: + type: object + properties: + resultCode: + $ref: '#/components/schemas/ResultCode' + ratingGroup: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup' + grantedUnit: + $ref: '#/components/schemas/GrantedUnit' + allocatedUnit: + $ref: '#/components/schemas/AllocatedUnit' + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + quotaHoldingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + finalUnitIndication: + $ref: '#/components/schemas/FinalUnitIndication' + timeQuotaThreshold: + type: integer + volumeQuotaThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + unitQuotaThreshold: + type: integer + uPFID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + announcementInformation: + $ref: '#/components/schemas/AnnouncementInformation' + mBUPFID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + required: + - ratingGroup + RequestedUnit: + type: object + properties: + time: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + totalVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + uplinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + downlinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + serviceSpecificUnits: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + UsedUnitContainer: + type: object + properties: + serviceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceId' + quotaManagementIndicator: + $ref: '#/components/schemas/QuotaManagementIndicator' + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + triggerTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + time: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + totalVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + uplinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + downlinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + serviceSpecificUnits: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + eventTimeStamps: + + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minItems: 0 + localSequenceNumber: + type: integer + pDUContainerInformation: + $ref: '#/components/schemas/PDUContainerInformation' + nSPAContainerInformation: + $ref: '#/components/schemas/NSPAContainerInformation' + pC5ContainerInformation: + $ref: '#/components/schemas/PC5ContainerInformation' + mBSContainerInformation: + $ref: '#/components/schemas/MBSContainerInformation' + required: + - localSequenceNumber + AllocateUnit: + type: object + properties: + allocateUnitIndicator: + $ref: '#/components/schemas/AllocateUnitIndicator' + nSACContainerInformation: + $ref: '#/components/schemas/NSACContainerInformation' + AllocatedUnit: + type: object + properties: + quotaManagementIndicator: + $ref: '#/components/schemas/QuotaManagementIndicator' + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + triggerTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + localSequenceNumber: + type: integer + nSACContainerInformation: + $ref: '#/components/schemas/NSACContainerInformation' + required: + - localSequenceNumber + GrantedUnit: + type: object + properties: + tariffTimeChange: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + time: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + totalVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + uplinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + downlinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + serviceSpecificUnits: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + FinalUnitIndication: + type: object + properties: + finalUnitAction: + $ref: '#/components/schemas/FinalUnitAction' + restrictionFilterRule: + $ref: '#/components/schemas/IPFilterRule' + restrictionFilterRuleList: + type: array + items: + $ref: '#/components/schemas/IPFilterRule' + minItems: 1 + filterId: + type: string + filterIdList: + type: array + items: + type: string + minItems: 1 + redirectServer: + $ref: '#/components/schemas/RedirectServer' + required: + - finalUnitAction + RedirectServer: + type: object + properties: + redirectAddressType: + $ref: '#/components/schemas/RedirectAddressType' + redirectServerAddress: + type: string + required: + - redirectAddressType + - redirectServerAddress + ReauthorizationDetails: + type: object + properties: + serviceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceId' + ratingGroup: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup' + quotaManagementIndicator: + $ref: '#/components/schemas/QuotaManagementIndicator' + PDUSessionChargingInformation: + type: object + properties: + chargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + sMFchargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmfChargingId' + homeProvidedChargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + sMFHomeProvidedChargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmfChargingId' + userInformation: + $ref: '#/components/schemas/UserInformation' + userLocationinfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + iMSSessionInformation: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/CallInfo' + mAPDUNon3GPPUserLocationInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + non3GPPUserLocationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mAPDUNon3GPPUserLocationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + presenceReportingAreaInformation: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 0 + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + pduSessionInformation: + $ref: '#/components/schemas/PDUSessionInformation' + unitCountInactivityTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + rANSecondaryRATUsageReport: + $ref: '#/components/schemas/RANSecondaryRATUsageReport' + UserInformation: + type: object + properties: + servedGPSI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + servedPEI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + unauthenticatedFlag: + type: boolean + roamerInOut: + $ref: '#/components/schemas/RoamerInOut' + PDUSessionInformation: + type: object + properties: + networkSlicingInfo: + $ref: '#/components/schemas/NetworkSlicingInfo' + pduSessionID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + pduType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' + hPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + servingNetworkFunctionID: + $ref: '#/components/schemas/ServingNetworkFunctionID' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + mAPDUNon3GPPRATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + dnnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + dnnSelectionMode: + $ref: '#/components/schemas/dnnSelectionMode' + chargingCharacteristics: + type: string + pattern: '^[0-9a-fA-F]{1,4}$' + chargingCharacteristicsSelectionMode: + $ref: '#/components/schemas/ChargingCharacteristicsSelectionMode' + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + stopTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + 3gppPSDataOffStatus: + $ref: '#/components/schemas/3GPPPSDataOffStatus' + sessionStopIndicator: + type: boolean + pduAddress: + $ref: '#/components/schemas/PDUAddress' + diagnostics: + $ref: '#/components/schemas/Diagnostics' + authorizedQoSInformation: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AuthorizedDefaultQos' + subscribedQoSInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos' + authorizedSessionAMBR: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + subscribedSessionAMBR: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + servingCNPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + mAPDUSessionInformation: + $ref: '#/components/schemas/MAPDUSessionInformation' + enhancedDiagnostics: + $ref: '#/components/schemas/EnhancedDiagnostics5G' + redundantTransmissionType: + $ref: '#/components/schemas/RedundantTransmissionType' + pDUSessionPairID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + cpCIoTOptimisationIndicator: + type: boolean + 5GSControlPlaneOnlyIndicator: + type: boolean + smallDataRateControlIndicator: + type: boolean + 5GLANTypeService: + $ref: '#/components/schemas/5GLANTypeService' + sNPNInformation: + $ref: '#/components/schemas/SNPNInformation' + 5GMulticastService: + $ref: '#/components/schemas/5GMulticastService' + 5GSBridgeInformation: + $ref: '#/components/schemas/5GSBridgeInformation' + satelliteAccessIndicator: + type: boolean + satelliteBackhaulInformation: + $ref: '#/components/schemas/SatelliteBackhaulInformation' + required: + - pduSessionID + - dnnId + PDUContainerInformation: + type: object + properties: + timeofFirstUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeofLastUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qoSInformation: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosData' + qoSCharacteristics: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosCharacteristics' + afChargingIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + afChargingIdString: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationChargingId' + userLocationInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + rATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + servingNodeID: + type: array + items: + $ref: '#/components/schemas/ServingNetworkFunctionID' + minItems: 0 + presenceReportingAreaInformation: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 0 + 3gppPSDataOffStatus: + $ref: '#/components/schemas/3GPPPSDataOffStatus' + sponsorIdentity: + type: string + applicationserviceProviderIdentity: + type: string + chargingRuleBaseName: + type: string + mAPDUSteeringFunctionality: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringFunctionality' + mAPDUSteeringMode: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringMode' + trafficForwardingWay: + $ref: '#/components/schemas/TrafficForwardingWay' + qosMonitoringReport: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 0 + mBSSessionID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + mBSDeliveryMethod: + $ref: '#/components/schemas/MbsDeliveryMethod' + NSPAContainerInformation: + type: object + properties: + uplinkLatency: + type: integer + downlinkLatency: + type: integer + uplinkThroughput: + $ref: '#/components/schemas/Throughput' + downlinkThroughput: + $ref: '#/components/schemas/Throughput' + maximumPacketLossRateUL: + type: integer + maximumPacketLossRateDL: + type: integer + serviceExperienceStatisticsData: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ServiceExperienceInfo' + theNumberOfPDUSessions: + type: integer + theNumberOfRegisteredSubscribers: + type: integer + loadLevel: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NsiLoadLevelInfo' + NSPAChargingInformation: + type: object + properties: + singleNSSAI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - singleNSSAI + NetworkSlicingInfo: + type: object + properties: + sNSSAI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + hPlmnSNSSAI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + alternativeSNSSAI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - sNSSAI + PDUAddress: + type: object + properties: + pduIPv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + pduIPv6AddresswithPrefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + pduAddressprefixlength: + type: integer + iPv4dynamicAddressFlag: + type: boolean + iPv6dynamicPrefixFlag: + type: boolean + addIpv6AddrPrefixes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + addIpv6AddrPrefixList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + ServingNetworkFunctionID: + type: object + properties: + servingNetworkFunctionInformation: + $ref: '#/components/schemas/NFIdentification' + aMFId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfId' + required: + - servingNetworkFunctionInformation + RoamingQBCInformation: + type: object + properties: + multipleQFIcontainer: + type: array + items: + $ref: '#/components/schemas/MultipleQFIcontainer' + minItems: 0 + uPFID: # Included for backwards compatibility and + # can be included based on operators requirement + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + roamingChargingProfile: + $ref: '#/components/schemas/RoamingChargingProfile' + MultipleQFIcontainer: + type: object + properties: + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + triggerTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + time: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + totalVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + uplinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + downlinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + localSequenceNumber: + type: integer + qFIContainerInformation: + $ref: '#/components/schemas/QFIContainerInformation' + required: + - localSequenceNumber + QFIContainerInformation: + type: object + properties: + qFI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + reportTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeofFirstUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeofLastUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qoSInformation: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosData' + qoSCharacteristics: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosCharacteristics' + userLocationInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + presenceReportingAreaInformation: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 0 + rATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + servingNetworkFunctionID: + type: array + items: + $ref: '#/components/schemas/ServingNetworkFunctionID' + minItems: 0 + 3gppPSDataOffStatus: + $ref: '#/components/schemas/3GPPPSDataOffStatus' + 3gppChargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + diagnostics: + $ref: '#/components/schemas/Diagnostics' + enhancedDiagnostics: + type: array + items: + type: string + required: + - reportTime + RoamingChargingProfile: + type: object + properties: + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + partialRecordMethod: + $ref: '#/components/schemas/PartialRecordMethod' + SMSChargingInformation: + type: object + properties: + originatorInfo: + $ref: '#/components/schemas/OriginatorInfo' + recipientInfo: + type: array + items: + $ref: '#/components/schemas/RecipientInfo' + minItems: 0 + userEquipmentInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + roamerInOut: + $ref: '#/components/schemas/RoamerInOut' + userLocationinfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + rATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + sMSCAddress: + type: string + sMDataCodingScheme: + type: integer + sMMessageType: + $ref: '#/components/schemas/SMMessageType' + sMReplyPathRequested: + $ref: '#/components/schemas/ReplyPathRequested' + sMUserDataHeader: + type: string + pattern: '^[0-9a-fA-F]+$' + sMStatus: + type: string + pattern: '^[0-9a-fA-F]+$' + sMDischargeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + numberofMessagesSent: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + sMServiceType: + $ref: '#/components/schemas/SMServiceType' + sMSequenceNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + sMSresult: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + submissionTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + sMPriority: + $ref: '#/components/schemas/SMPriority' + messageReference: + type: string + messageSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + messageClass: + $ref: '#/components/schemas/MessageClass' + deliveryReportRequested: + $ref: '#/components/schemas/DeliveryReportRequested' + OriginatorInfo: + type: object + properties: + originatorSUPI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + originatorGPSI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + originatorOtherAddress: + $ref: '#/components/schemas/SMAddressInfo' + originatorReceivedAddress: + $ref: '#/components/schemas/SMAddressInfo' + originatorSCCPAddress: + type: string + sMOriginatorInterface: + $ref: '#/components/schemas/SMInterface' + sMOriginatorProtocolId: + type: string + RecipientInfo: + type: object + properties: + recipientSUPI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + recipientGPSI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + recipientOtherAddress: + $ref: '#/components/schemas/SMAddressInfo' + recipientReceivedAddress: + $ref: '#/components/schemas/SMAddressInfo' + recipientSCCPAddress: + type: string + sMDestinationInterface: + $ref: '#/components/schemas/SMInterface' + sMrecipientProtocolId: + type: string + SMAddressInfo: + type: object + properties: + sMaddressType: + $ref: '#/components/schemas/SMAddressType' + sMaddressData: + type: string + sMaddressDomain: + $ref: '#/components/schemas/SMAddressDomain' + RecipientAddress: + type: object + properties: + recipientAddressInfo: + $ref: '#/components/schemas/SMAddressInfo' + sMaddresseeType: + $ref: '#/components/schemas/SMAddresseeType' + MessageClass: + type: object + properties: + classIdentifier: + $ref: '#/components/schemas/ClassIdentifier' + tokenText: + type: string + SMAddressDomain: + type: object + properties: + domainName: + type: string + 3GPPIMSIMCCMNC: + type: string + SMInterface: + type: object + properties: + interfaceId: + type: string + interfaceText: + type: string + interfacePort: + type: string + interfaceType: + $ref: '#/components/schemas/InterfaceType' + RANSecondaryRATUsageReport: + type: object + properties: + rANSecondaryRATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + qosFlowsUsageReports: + type: array + items: + $ref: '#/components/schemas/QosFlowsUsageReport' + Diagnostics: + type: integer + IPFilterRule: + type: string + QosFlowsUsageReport: + type: object + properties: + qFI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + startTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + uplinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + downlinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + 5GLANTypeService: + type: object + properties: + internalGroupIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + 5GSBridgeInformation: + type: object + properties: + bridgeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + nWTTPortNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + dSTTPortNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + required: + - bridgeId + NEFChargingInformation: + type: object + properties: + externalIndividualIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + externalIndividualIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + internalIndividualIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + internalIndividualIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + externalGroupIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + groupIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + aPIDirection: + $ref: '#/components/schemas/APIDirection' + aPITargetNetworkFunction: + $ref: '#/components/schemas/NFIdentification' + aPIResultCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + aPIName: + type: string + aPIReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + aPIOperation: + $ref: '#/components/schemas/APIOperation' + aPIContent: + type: string + required: + - aPIName + SNPNInformation: + type: object + properties: + sNPNID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + n3IwfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + required: + - sNPNID + RegistrationChargingInformation: + type: object + properties: + registrationMessagetype: + $ref: '#/components/schemas/RegistrationMessageType' + userInformation: + $ref: '#/components/schemas/UserInformation' + userLocationinfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + pSCellInformation: + $ref: '#/components/schemas/PSCellInformation' + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + rATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + 5GMMCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + mICOModeIndication: + $ref: '#/components/schemas/MICOModeIndication' + smsIndication: + $ref: '#/components/schemas/SmsIndication' + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 0 + serviceAreaRestriction: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' + minItems: 0 + requestedNSSAI: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 0 + allowedNSSAI: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 0 + rejectedNSSAI: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 0 + nSSAIMapList: + type: array + items: + $ref: '#/components/schemas/NSSAIMap' + minItems: 0 + alternativeNSSAIMap: + type: array + items: + $ref: '#/components/schemas/AlternativeNSSAIMap' + minItems: 0 + amfUeNgapId: + type: integer + ranUeNgapId: + type: integer + ranNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + sNPNID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + cAGIDList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CagId' + minItems: 0 + satelliteAccessIndicator: + type: boolean + required: + - registrationMessagetype + PSCellInformation: + type: object + properties: + nrcgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + NSSAIMap: + type: object + properties: + servingSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + homeSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - servingSnssai + - homeSnssai + AlternativeNSSAIMap: + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + alternativeSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - snssai + - alternativeSnssai + N2ConnectionChargingInformation: + type: object + properties: + n2ConnectionMessageType: + $ref: '#/components/schemas/N2ConnectionMessageType' + userInformation: + $ref: '#/components/schemas/UserInformation' + userLocationinfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + pSCellInformation: + $ref: '#/components/schemas/PSCellInformation' + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + rATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + amfUeNgapId: + type: integer + ranUeNgapId: + type: integer + ranNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + restrictedRatList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 0 + forbiddenAreaList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Area' + minItems: 0 + serviceAreaRestriction: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' + minItems: 0 + restrictedCnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CoreNetworkType' + minItems: 0 + allowedNSSAI: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 0 + nSSAIMapList: + type: array + items: + $ref: '#/components/schemas/NSSAIMap' + minItems: 0 + rrcEstCause: + type: string + pattern: '^[0-9a-fA-F]+$' + satelliteAccessIndicator: + type: boolean + required: + - n2ConnectionMessageType + LocationReportingChargingInformation: + type: object + properties: + locationReportingMessageType: + $ref: '#/components/schemas/LocationReportingMessageType' + userInformation: + $ref: '#/components/schemas/UserInformation' + userLocationinfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + pSCellInformation: + $ref: '#/components/schemas/PSCellInformation' + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + rATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + presenceReportingAreaInformation: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 0 + satelliteAccessIndicator: + type: boolean + required: + - locationReportingMessageType + N2ConnectionMessageType: + type: integer + LocationReportingMessageType: + type: integer + NSMChargingInformation: + type: object + properties: + managementOperation: + $ref: '#/components/schemas/ManagementOperation' + idNetworkSliceInstance: + type: string + listOfserviceProfileChargingInformation: + type: array + items: + $ref: '#/components/schemas/ServiceProfileChargingInformation' + minItems: 0 + managementOperationStatus: + $ref: '#/components/schemas/ManagementOperationStatus' + managementOperationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + managementAdministrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + required: + - managementOperation + ServiceProfileChargingInformation: + type: object + properties: + serviceProfileIdentifier: + type: string + sNSSAIList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 0 + sST: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Sst' + latency: + type: integer + availability: + type: number + resourceSharingLevel: + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/SharingLevel' + jitter: + type: integer + reliability: + type: string + maxNumberofUEs: + type: integer + coverageArea: + type: string + uEMobilityLevel: + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/MobilityLevel' + delayToleranceIndicator: + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/Support' + dLThptPerSlice: + $ref: '#/components/schemas/Throughput' + dLThptPerUE: + $ref: '#/components/schemas/Throughput' + uLThptPerSlice: + $ref: '#/components/schemas/Throughput' + uLThptPerUE: + $ref: '#/components/schemas/Throughput' + maxNumberofPDUsessions: + type: integer + kPIMonitoringList: + type: string + supportedAccessTechnology: + type: integer + v2XCommunicationModeIndicator: + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/Support' + addServiceProfileInfo: + type: string + Throughput: + type: object + properties: + guaranteedThpt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + maximumThpt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + MAPDUSessionInformation: + type: object + properties: + mAPDUSessionIndicator: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/MaPduIndication' + aTSSSCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability' + EnhancedDiagnostics5G: + $ref: '#/components/schemas/RanNasCauseList' + RanNasCauseList: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RanNasRelCause' + QosMonitoringReport: + description: Contains reporting information on QoS monitoring. + type: object + properties: + ulDelays: + type: array + items: + type: integer + minItems: 0 + dlDelays: + type: array + items: + type: integer + minItems: 0 + rtDelays: + type: array + items: + type: integer + minItems: 0 + AnnouncementInformation: + type: object + properties: + announcementIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + announcementReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + variableParts: + type: array + items: + $ref: '#/components/schemas/VariablePart' + minItems: 0 + timeToPlay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + quotaConsumptionIndicator: + $ref: '#/components/schemas/QuotaConsumptionIndicator' + announcementPriority: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + playToParty: + $ref: '#/components/schemas/PlayToParty' + announcementPrivacyIndicator: + $ref: '#/components/schemas/AnnouncementPrivacyIndicator' + Language: + $ref: '#/components/schemas/Language' + VariablePart: + type: object + properties: + variablePartType: + $ref: '#/components/schemas/VariablePartType' + variablePartValue: + type: array + items: + type: string + minItems: 1 + variablePartOrder: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + required: + - variablePartType + - variablePartValue + Language: + type: string + MMTelChargingInformation: + type: object + properties: + supplementaryServices: + type: array + items: + $ref: '#/components/schemas/SupplementaryService' + minItems: 1 + SupplementaryService: + type: object + properties: + supplementaryServiceType: + $ref: '#/components/schemas/SupplementaryServiceType' + supplementaryServiceMode: + $ref: '#/components/schemas/SupplementaryServiceMode' + numberOfDiversions: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + associatedPartyAddress: + type: string + conferenceId: + type: string + participantActionType: + $ref: '#/components/schemas/ParticipantActionType' + changeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + numberOfParticipants: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + cUGInformation: + $ref: '#/components/schemas/OctetString' + IMSChargingInformation: + type: object + properties: + eventType: + $ref: '#/components/schemas/SIPEventType' + iMSNodeFunctionality: + $ref: '#/components/schemas/IMSNodeFunctionality' + roleOfNode: + $ref: '#/components/schemas/RoleOfIMSNode' + userInformation: + $ref: '#/components/schemas/UserInformation' + userLocationInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + 3gppPSDataOffStatus: + $ref: '#/components/schemas/3GPPPSDataOffStatus' + isupCause: + $ref: '#/components/schemas/ISUPCause' + controlPlaneAddress: + $ref: '#/components/schemas/IMSAddress' + vlrNumber: + $ref: '#/components/schemas/E164' + mscAddress: + $ref: '#/components/schemas/E164' + userSessionID: + type: string + outgoingSessionID: + type: string + sessionPriority: + $ref: '#/components/schemas/IMSSessionPriority' + callingPartyAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + calledPartyAddress: + type: string + numberPortabilityRoutinginformation: + type: string + carrierSelectRoutingInformation: + type: string + alternateChargedPartyAddress: + type: string + requestedPartyAddress: + type: array + items: + type: string + minItems: 1 + calledAssertedIdentities: + type: array + items: + type: string + minItems: 1 + calledIdentityChanges: + type: array + items: + $ref: '#/components/schemas/CalledIdentityChange' + minItems: 1 + associatedURI: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + timeStamps: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + applicationServerInformation: + type: array + items: + type: string + minItems: 1 + interOperatorIdentifier: + type: array + items: + $ref: '#/components/schemas/InterOperatorIdentifier' + minItems: 1 + imsChargingIdentifier: + type: string + relatedICID: + type: string + relatedICIDGenerationNode: + type: string + transitIOIList: + type: array + items: + type: string + minItems: 1 + earlyMediaDescription: + type: array + items: + $ref: '#/components/schemas/EarlyMediaDescription' + minItems: 1 + sdpSessionDescription: + type: array + items: + type: string + minItems: 1 + sdpMediaComponent: + type: array + items: + $ref: '#/components/schemas/SDPMediaComponent' + minItems: 1 + servedPartyIPAddress: + $ref: '#/components/schemas/IMSAddress' + serverCapabilities: + $ref: '#/components/schemas/ServerCapabilities' + trunkGroupID: + $ref: '#/components/schemas/TrunkGroupID' + bearerService: + type: string + imsServiceId: + type: string + messageBodies: + type: array + items: + $ref: '#/components/schemas/MessageBody' + minItems: 1 + accessNetworkInformation: + type: array + items: + type: string + minItems: 1 + additionalAccessNetworkInformation: + type: string + cellularNetworkInformation: + type: string + accessTransferInformation: + type: array + items: + $ref: '#/components/schemas/AccessTransferInformation' + minItems: 1 + accessNetworkInfoChange: + type: array + items: + $ref: '#/components/schemas/AccessNetworkInfoChange' + minItems: 1 + imsCommunicationServiceID: + type: string + imsApplicationReferenceID: + type: string + causeCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + reasonHeader: + type: array + items: + type: string + minItems: 1 + initialIMSChargingIdentifier: + type: string + nniInformation: + type: array + items: + $ref: '#/components/schemas/NNIInformation' + minItems: 1 + fromAddress: + type: string + imsEmergencyIndication: + type: boolean + imsVisitedNetworkIdentifier: + type: string + sipRouteHeaderReceived: + type: string + sipRouteHeaderTransmitted: + type: string + tadIdentifier: + $ref: '#/components/schemas/TADIdentifier' + feIdentifierList: + type: string + EdgeInfrastructureUsageChargingInformation: + type: object + properties: + meanVirtualCPUUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + meanVirtualMemoryUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + meanVirtualDiskUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + measuredInBytes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + measuredOutBytes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + durationStartTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + durationEndTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + EASDeploymentChargingInformation: + type: object + properties: + eEASDeploymentRequirements: + $ref: '#/components/schemas/EASRequirements' + lCMEventType: + $ref: '#/components/schemas/ManagementOperation' + lCMStartTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + lCMEndTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + satelliteBackhaulInformation: + $ref: '#/components/schemas/SatelliteBackhaulInformation' + MMSChargingInformation: + type: object + properties: + mmOriginatorInfo: + $ref: '#/components/schemas/MMOriginatorInfo' + mmRecipientInfoList: + type: array + items: + $ref: '#/components/schemas/MMRecipientInfo' + minItems: 0 + userLocationinfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + rATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + correlationInformation: + type: string + submissionTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mmContentType: + $ref: '#/components/schemas/MMContentType' + mmPriority: + $ref: '#/components/schemas/SMPriority' + messageID: + type: string + messageType: + type: string + messageSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + messageClass: + type: string + deliveryReportRequested: + type: boolean + readReplyReportRequested: + type: boolean + applicID: + type: string + replyApplicID: + type: string + auxApplicInfo: + type: string + contentClass: + type: string + dRMContent: + type: boolean + adaptations: + type: boolean + vasID: + type: string + vaspID: + type: string + MMOriginatorInfo: + type: object + properties: + originatorSUPI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + originatorGPSI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + originatorOtherAddress: + type: array + items: + $ref: '#/components/schemas/SMAddressInfo' + minItems: 0 + MMRecipientInfo: + type: object + properties: + recipientSUPI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + recipientGPSI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + recipientOtherAddress: + type: array + items: + $ref: '#/components/schemas/SMAddressInfo' + TSNChargingInformation: + type: object + properties: + dNN: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNSSAI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + internalGroupIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + externalIndividualIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 0 + 5GSBridgeInformation: + $ref: '#/components/schemas/5GSBridgeInformation' + tSNQoSInformation: + $ref: '#/components/schemas/TSNQoSInformation' + tSCAssistanceInformation: + $ref: '#/components/schemas/TSCAssistanceInformation' + timeSynchronizationInformation: + $ref: '#/components/schemas/TimeSynchronizationInformation' + + TSNQoSInformation: + type: object + properties: + priority: + type: integer + bridgeDelay: + type: array + items: + type: integer + minItems: 0 + + TSCAssistanceInformation: + type: object + properties: + flowDirection: + $ref: '#/components/schemas/TSCFlowDirection' + periodicity: + type: integer + + TimeSynchronizationInformation: + type: object + properties: + distributionMethod: + $ref: '#/components/schemas/TimeDistributionMethod' + tSNtimeDomainNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + temporalValidityInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + spatialValidityInformation: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 0 + timeSynchronizationErrorBudget: + type: integer + synchronizationState: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SynchronizationState' + clockQuality: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQuality' + parentTimeSource: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeSource' + PC5ContainerInformation: + type: object + properties: + coverageInfoList: + type: array + items: + $ref: '#/components/schemas/CoverageInfo' + radioParameterSetInfoList: + type: array + items: + $ref: '#/components/schemas/RadioParameterSetInfo' + transmitterInfoList: + type: array + items: + $ref: '#/components/schemas/TransmitterInfo' + minItems: 0 + timeOfFirstTransmission: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeOfFirstReception: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + CoverageInfo: + type: object + properties: + coverageStatus: + type: boolean + changeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + locationInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + minItems: 0 + + RadioParameterSetInfo: + type: object + properties: + radioParameterSetValues: + type: array + items: + $ref: '#/components/schemas/OctetString' + minItems: 0 + changeTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + TransmitterInfo: + type: object + properties: + proseSourceIPAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + proseSourceL2Id: + type: string + ProseChargingInformation: + type: object + properties: + announcingPlmnID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + announcingUeHplmnIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + announcingUeVplmnIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + monitoringUeHplmnIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + monitoringUeVplmnIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + discovererUeHplmnIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + discovererUeVplmnIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + discovereeUeHplmnIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + discovereeUeVplmnIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + monitoredPlmnIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + proseApplicationID: + type: string + ApplicationId: + type: string + applicationSpecificDataList: + type: array + items: + type: string + minItems: 0 + proseFunctionality: + $ref: '#/components/schemas/ProseFunctionality' + proseEventType: + $ref: '#/components/schemas/ProseEventType' + directDiscoveryModel: + $ref: '#/components/schemas/DirectDiscoveryModel' + validityPeriod: + type: integer + roleOfUE: + $ref: '#/components/schemas/RoleOfUE' + proseRequestTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + pC3ProtocolCause: + type: integer + monitoringUEIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestedPLMNIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + timeWindow: + type: integer + rangeClass: + $ref: '#/components/schemas/RangeClass' + proximityAlertIndication: + type: boolean + proximityAlertTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + proximityCancellationTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + relayIPAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + proseUEToNetworkRelayUEID : + type: string + proseDestinationLayer2ID: + type: string + pFIContainerInformation: + type: array + items: + $ref: '#/components/schemas/PFIContainerInformation' + minItems: 0 + transmissionDataContainer: + type: array + items: + $ref: '#/components/schemas/PC5DataContainer' + minItems: 0 + receptionDataContainer: + type: array + items: + $ref: '#/components/schemas/PC5DataContainer' + minItems: 0 + required: + - aPIName + InterCHFInformation: + type: object + properties: + remoteCHFResource: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + originalNFConsumerId: + $ref: '#/components/schemas/NFIdentification' + NSACFChargingInformation: + type: object + properties: + nSACChargingIndicator: + type: boolean + NSACContainerInformation: + type: object + properties: + numberOfUEs: + type: integer + numberOfPDUs: + type: integer + NSSAAChargingInformation: + type: object + properties: + nSSAAMessageType: + $ref: '#/components/schemas/NSSAAMessageType' + userIdentification: + $ref: '#/components/schemas/UserInformation' + aAAPAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo' + aAASAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo' + eAPIDResponse: + type: string + eAPauthstatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AuthStatus' + aMFId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfId' + required: + - nSSAAMessageType + - userIdentification + PFIContainerInformation: + type: object + properties: + pFI: + type: string + reportTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeofFirstUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeofLastUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qoSInformation: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosData' + qoSCharacteristics: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosCharacteristics' + userLocationInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + presenceReportingAreaInformation: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 0 + + PC5DataContainer: + type: object + properties: + localSequenceNumber: + type: string + changeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + coverageStatus: + type: boolean + userLocationInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + dataVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + changeCondition: + type: string + radioResourcesId: + $ref: '#/components/schemas/RadioResourcesIndicator' + radioFrequency: + type: string + pC5RadioTechnology: + type: string + + OctetString: + type: string + pattern: '^[0-9a-fA-F]+$' + E164: + type: string + pattern: '^[0-9a-fA-F]+$' + IMSAddress: + type: object + properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + e164: + $ref: '#/components/schemas/E164' + anyOf: + - required: [ ipv4Addr ] + - required: [ ipv6Addr ] + - required: [ e164 ] + ServingNodeAddress: + type: object + properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + anyOf: + - required: [ ipv4Addr ] + - required: [ ipv6Addr ] + SIPEventType: + type: object + properties: + sIPMethod: + type: string + eventHeader: + type: string + expiresHeader: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + ISUPCause: + type: object + properties: + iSUPCauseLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + iSUPCauseValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + iSUPCauseDiagnostics: + $ref: '#/components/schemas/OctetString' + enhancedDiagnostics: + $ref: '#/components/schemas/EnhancedDiagnostics5G' + CalledIdentityChange: + type: object + properties: + calledIdentity: + type: string + changeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + InterOperatorIdentifier: + type: object + properties: + originatingIOI: + type: string + terminatingIOI: + type: string + EarlyMediaDescription: + type: object + properties: + sDPTimeStamps: + $ref: '#/components/schemas/SDPTimeStamps' + sDPMediaComponent: + type: array + items: + $ref: '#/components/schemas/SDPMediaComponent' + minItems: 0 + sDPSessionDescription: + type: array + items: + type: string + minItems: 0 + SDPTimeStamps: + type: object + properties: + sDPOfferTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + sDPAnswerTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + SDPMediaComponent: + type: object + properties: + sDPMediaName: + type: string + SDPMediaDescription: + type: array + items: + type: string + minItems: 0 + localGWInsertedIndication: + type: boolean + ipRealmDefaultIndication: + type: boolean + transcoderInsertedIndication: + type: boolean + mediaInitiatorFlag: + $ref: '#/components/schemas/MediaInitiatorFlag' + mediaInitiatorParty: + type: string + threeGPPChargingId: + $ref: '#/components/schemas/OctetString' + accessNetworkChargingIdentifierValue: + $ref: '#/components/schemas/OctetString' + sDPType: + $ref: '#/components/schemas/SDPType' + ServerCapabilities: + type: object + properties: + mandatoryCapability: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + minItems: 0 + optionalCapability : + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + minItems: 0 + serverName: + type: array + items: + type: string + minItems: 0 + TrunkGroupID: + type: object + properties: + incomingTrunkGroupID: + type: string + outgoingTrunkGroupID: + type: string + MessageBody: + type: object + properties: + contentType: + type: string + contentLength: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + contentDisposition: + type: string + originator: + $ref: '#/components/schemas/OriginatorPartyType' + required: + - contentType + - contentLength + AccessTransferInformation: + type: object + properties: + accessTransferType: + $ref: '#/components/schemas/AccessTransferType' + accessNetworkInformation: + type: array + items: + $ref: '#/components/schemas/OctetString' + minItems: 0 + cellularNetworkInformation: + $ref: '#/components/schemas/OctetString' + interUETransfer: + $ref: '#/components/schemas/UETransferType' + userEquipmentInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + instanceId: + type: string + relatedIMSChargingIdentifier: + type: string + relatedIMSChargingIdentifierNode: + $ref: '#/components/schemas/IMSAddress' + changeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + AccessNetworkInfoChange: + type: object + properties: + accessNetworkInformation: + type: array + items: + $ref: '#/components/schemas/OctetString' + minItems: 0 + cellularNetworkInformation: + $ref: '#/components/schemas/OctetString' + changeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + NNIInformation: + type: object + properties: + sessionDirection: + $ref: '#/components/schemas/NNISessionDirection' + nNIType: + $ref: '#/components/schemas/NNIType' + relationshipMode: + $ref: '#/components/schemas/NNIRelationshipMode' + neighbourNodeAddress: + $ref: '#/components/schemas/IMSAddress' + EASRequirements: + type: object + properties: + requiredEASservingLocation: + $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/ServingLocation' + softwareImageInfo: + $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/SoftwareImageInfo' + affinityAntiAffinity: + $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/AffinityAntiAffinity' + serviceContinuity: + type: boolean + virtualResource: + $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/VirtualResource' + MMContentType: + type: object + properties: + typeNumber: + type: string + addtypeInfo: + type: string + contentSize: + type: integer + mmAddContentInfo: + type: array + items: + $ref: '#/components/schemas/MMAddContentInfo' + minItems: 0 + MMAddContentInfo: + type: object + properties: + typeNumber: + type: string + addtypeInfo: + type: string + contentSize: + type: integer + APIOperation: + type: object + properties: + name: + type: string + description: + type: string + 5GMulticastService: + type: object + properties: + mBSSessionIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + minItems: 1 + MBSSessionChargingInformation: + type: object + properties: + mBSSessionID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + mBSServiceType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceType' + serviceArea: + $ref: '#/components/schemas/ServiceArea' + mBSStartTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mBSEndTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mBSServiceActivityStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionActivityStatus' + servingNetworkFunctionID: + $ref: '#/components/schemas/ServingNetworkFunctionID' + required: + - mBSSessionID + - mBSServiceType + ServiceArea: + type: object + properties: + mBSServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' + uPFIDs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 0 + ranNodeIDs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 0 + MBSContainerInformation: + type: object + properties: + timeofFirstUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeofLastUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qoSInformation: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosData' + establishedConnectionInfo: + $ref: '#/components/schemas/EstablishedConnectionInfo' + EstablishedConnectionInfo: + type: object + properties: + uPFIDs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 0 + ranNodeIDs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 0 + SatelliteBackhaulInformation: + type: object + properties: + satelliteBackhaulCategory: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + minItems: 0 + gEOSatelliteID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GeoSatelliteId' + NotificationType: + anyOf: + - type: string + enum: + - REAUTHORIZATION + - ABORT_CHARGING + - type: string + NodeFunctionality: + anyOf: + - type: string + enum: + - AMF + - SMF + - SMS # Included for backwards compatibility, shall not be used + - SMSF + - PGW_C_SMF + - NEFF # Included for backwards compatibility, shall not be used + - SGW + - I_SMF + - ePDG + - CEF + - NEF + - MnS_Producer + - SGSN + - V_SMF + - 5G_DDNMF + - IMS_Node + - MMS_Node + - EES + - PCF + - UDM + - UPF + - TSN_AF + - TSCTSF + - MB_SMF + - CHF + - type: string + ChargingCharacteristicsSelectionMode: + anyOf: + - type: string + enum: + - HOME_DEFAULT + - ROAMING_DEFAULT + - VISITING_DEFAULT + - type: string + TriggerType: + anyOf: + - type: string + enum: + # SMF TriggerType + - QUOTA_THRESHOLD + - QHT + - FINAL + - QUOTA_EXHAUSTED + - VALIDITY_TIME + - OTHER_QUOTA_TYPE + - FORCED_REAUTHORISATION + - UNUSED_QUOTA_TIMER # Included for backwards compatibility, shall not be used + - UNIT_COUNT_INACTIVITY_TIMER + - ABNORMAL_RELEASE + - QOS_CHANGE + - VOLUME_LIMIT + - TIME_LIMIT + - EVENT_LIMIT + - PLMN_CHANGE + - USER_LOCATION_CHANGE + - RAT_CHANGE + - SESSION_AMBR_CHANGE + - UE_TIMEZONE_CHANGE + - TARIFF_TIME_CHANGE + - MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS + - MANAGEMENT_INTERVENTION + - CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA + - CHANGE_OF_3GPP_PS_DATA_OFF_STATUS + - SERVING_NODE_CHANGE + - REMOVAL_OF_UPF + - ADDITION_OF_UPF + - INSERTION_OF_ISMF + - REMOVAL_OF_ISMF + - CHANGE_OF_ISMF + - START_OF_SERVICE_DATA_FLOW + - ECGI_CHANGE + - TAI_CHANGE + - HANDOVER_CANCEL + - HANDOVER_START + - HANDOVER_COMPLETE + - GFBR_GUARANTEED_STATUS_CHANGE + - ADDITION_OF_ACCESS + - REMOVAL_OF_ACCESS + - START_OF_SDF_ADDITIONAL_ACCESS + - REDUNDANT_TRANSMISSION_CHANGE + - CGI_SAI_CHANGE + - RAI_CHANGE + - JOIN_MULTICAST + - MBS_DELIVERY_METHOD_CHANGE + - LEAVE_MULTICAST + - VSMF_CHANGE + - SNSSAI_REPLACEMENT + - SATELLITE_BACKHAUL_CATEGORY_CHANGE + - GEO_SATELLITE_ID_CHANGE + # IMS TriggerType + - SIP_INVITE + - SIP_RE-INVITE_OR_UPDATE + - SIP_2XX_ACKNOWLEDGING + - SIP_1XX_PROVISIONAL_RESPONSE + - SIP_4XX_5XX_OR_6XX_RESPONSE + - ANY_OTHER_SIP_MESSAGE - SIP_BYE_MESSAGE + - SIP_2XX_ACKNOWLEDGING_A_SIP_BYE + - ABORTING_A_SIP_SESSION_SET-UP + - SIP_3XX_FINAL_OR_REDIRECTION_RESPONSE + - SIP_4XX_5XX_OR_6XX_FINAL_RESPONSE + # MB-SMF TriggerType + - MBS_CONNECTION_ESTABLISHED_WITH_NG-RAN + - MBS_CONNECTION_RELEASED_WITH_NG-RAN + - MBS_CONNECTION_ESTABLISHED_WITH_UPF + - MBS_CONNECTION_RELEASED_WITH_UPF + - MBS_SESSION_ACTIVITY_STATUS_CHANGE_TO_ACTIVE + - MBS_SESSION_ACTIVITY_STATUS_CHANGE_TO_INACTIVE + - MBS_SESSION_CONTEXT_UPDATE + # NSAC TriggerType + - NSAC_THRESHOLD_INITIAL + - NSAC_THRESHOLD_UPWARDS_REACHED + - NSAC_THRESHOLD_UPWARDS_CROSSED + - NSAC_THRESHOLD_DOWNWARDS_CROSSED + - NSAC_QUOTA_THRESHOLD + - NSAC_QUOTA_EXHAUSTED + - NSAC_VALIDITY_TIME + - NSAC_QHT + - NSAC_THRESHOLD_TERMINATION + - NS_TERMINATION + FinalUnitAction: + anyOf: + - type: string + enum: + - TERMINATE + - REDIRECT + - RESTRICT_ACCESS + - type: string + RedirectAddressType: + anyOf: + - type: string + enum: + - IPV4 + - IPV6 + - URL + - URI + - type: string + TriggerCategory: + anyOf: + - type: string + enum: + - IMMEDIATE_REPORT + - DEFERRED_REPORT + - type: string + QuotaManagementIndicator: + anyOf: + - type: string + enum: + - ONLINE_CHARGING + - OFFLINE_CHARGING + - QUOTA_MANAGEMENT_SUSPENDED + - type: string + FailureHandling: + anyOf: + - type: string + enum: + - TERMINATE + - CONTINUE + - RETRY_AND_TERMINATE + - type: string + SessionFailover: + anyOf: + - type: string + enum: + - FAILOVER_NOT_SUPPORTED + - FAILOVER_SUPPORTED + - type: string + 3GPPPSDataOffStatus: + anyOf: + - type: string + enum: + - ACTIVE + - INACTIVE + - type: string + ResultCode: + anyOf: + - type: string + enum: + - SUCCESS + - END_USER_SERVICE_DENIED + - QUOTA_MANAGEMENT_NOT_APPLICABLE + - QUOTA_LIMIT_REACHED + - END_USER_SERVICE_REJECTED + - USER_UNKNOWN #Included for backwards compatibility, shall not be used + - RATING_FAILED + - QUOTA_MANAGEMENT + - type: string + PartialRecordMethod: + anyOf: + - type: string + enum: + - DEFAULT + - INDIVIDUAL + - type: string + RoamerInOut: + anyOf: + - type: string + enum: + - IN_BOUND + - OUT_BOUND + - type: string + SMMessageType: + anyOf: + - type: string + enum: + - SUBMISSION + - DELIVERY_REPORT + - SM_SERVICE_REQUEST + - DELIVERY + - type: string + SMPriority: + anyOf: + - type: string + enum: + - LOW + - NORMAL + - HIGH + - type: string + DeliveryReportRequested: + anyOf: + - type: string + enum: + - YES + - NO + - type: string + InterfaceType: + anyOf: + - type: string + enum: + - UNKNOWN + - MOBILE_ORIGINATING + - MOBILE_TERMINATING + - APPLICATION_ORIGINATING + - APPLICATION_TERMINATING + - type: string + ClassIdentifier: + anyOf: + - type: string + enum: + - PERSONAL + - ADVERTISEMENT + - INFORMATIONAL + - AUTO + - type: string + SMAddressType: + anyOf: + - type: string + enum: + - EMAIL_ADDRESS + - MSISDN + - IPV4_ADDRESS + - IPV6_ADDRESS + - NUMERIC_SHORTCODE + - ALPHANUMERIC_SHORTCODE + - OTHER + - IMSI + - type: string + SMAddresseeType: + anyOf: + - type: string + enum: + - TO + - CC + - BCC + - type: string + SMServiceType: + anyOf: + - type: string + enum: + - VAS4SMS_SHORT_MESSAGE_CONTENT_PROCESSING + - VAS4SMS_SHORT_MESSAGE_FORWARDING + - VAS4SMS_SHORT_MESSAGE_FORWARDING_MULTIPLE_SUBSCRIPTIONS + - VAS4SMS_SHORT_MESSAGE_FILTERING + - VAS4SMS_SHORT_MESSAGE_RECEIPT + - VAS4SMS_SHORT_MESSAGE_NETWORK_STORAGE + - VAS4SMS_SHORT_MESSAGE_TO_MULTIPLE_DESTINATIONS + - VAS4SMS_SHORT_MESSAGE_VIRTUAL_PRIVATE_NETWORK(VPN) + - VAS4SMS_SHORT_MESSAGE_AUTO_REPLY + - VAS4SMS_SHORT_MESSAGE_PERSONAL_SIGNATURE + - VAS4SMS_SHORT_MESSAGE_DEFERRED_DELIVERY + - type: string + ReplyPathRequested: + anyOf: + - type: string + enum: + - NO_REPLY_PATH_SET + - REPLY_PATH_SET + - type: string + oneTimeEventType: + anyOf: + - type: string + enum: + - IEC + - PEC + - type: string + dnnSelectionMode: + anyOf: + - type: string + enum: + - VERIFIED + - UE_DNN_NOT_VERIFIED + - NW_DNN_NOT_VERIFIED + - type: string + APIDirection: + anyOf: + - type: string + enum: + - INVOCATION + - NOTIFICATION + - type: string + RegistrationMessageType: + anyOf: + - type: string + enum: + - INITIAL + - MOBILITY + - PERIODIC + - EMERGENCY + - DEREGISTRATION + - type: string + MICOModeIndication: + anyOf: + - type: string + enum: + - MICO_MODE + - NO_MICO_MODE + - type: string + SmsIndication: + anyOf: + - type: string + enum: + - SMS_SUPPORTED + - SMS_NOT_SUPPORTED + - type: string + ManagementOperation: + anyOf: + - type: string + enum: + - CreateMOI #Included for backwards compatibility, shall not be used + - ModifyMOIAttributes #Included for backwards compatibility, shall not be used + - DeleteMOI #Included for backwards compatibility, shall not be used + - CREATE_MOI + - MODIFY_MOI_ATTR + - DELETE_MOI + - NOTIFY_MOI_CREATION + - NOTIFY_MOI_ATTR_CHANGE + - NOTIFY_MOI_DELETION + - type: string + ManagementOperationStatus: + anyOf: + - type: string + enum: + - OPERATION_SUCCEEDED + - OPERATION_FAILED + - type: string + RedundantTransmissionType: + anyOf: + - type: string + enum: + - NON_TRANSMISSION + - END_TO_END_USER_PLANE_PATHS + - N3_N9 + - TRANSPORT_LAYER + - type: string + VariablePartType: + anyOf: + - type: string + enum: + - INTEGER + - NUMBER + - TIME + - DATE + - CURRENCY + - type: string + QuotaConsumptionIndicator: + anyOf: + - type: string + enum: + - QUOTA_NOT_USED + - QUOTA_IS_USED + - type: string + PlayToParty: + anyOf: + - type: string + enum: + - SERVED + - REMOTE + - type: string + AnnouncementPrivacyIndicator: + anyOf: + - type: string + enum: + - NOT_PRIVATE + - PRIVATE + - type: string + SupplementaryServiceType: + anyOf: + - type: string + enum: + - OIP + - OIR + - TIP + - TIR + - HOLD + - CB + - CDIV + - CW + - MWI + - CONF + - FA + - CCBS + - CCNR + - MCID + - CAT + - CUG + - PNM + - CRS + - ECT + - type: string + SupplementaryServiceMode: + anyOf: + - type: string + enum: + - CFU + - CFB + - CFNR + - CFNL + - CD + - CFNRC + - ICB + - OCB + - ACR + - BLIND_TRANFER + - CONSULTATIVE_TRANFER + - type: string + ParticipantActionType: + anyOf: + - type: string + enum: + - CREATE + - JOIN + - INVITE_INTO + - QUIT + - type: string + TrafficForwardingWay: + anyOf: + - type: string + enum: + - N6 + - N19 + - LOCAL_SWITCH + - type: string + IMSNodeFunctionality: + anyOf: + - type: string + enum: +# The applicable IMS Nodes are MRFC, IMS-GWF (connected to S-CSCF using ISC) and SIP AS. + - S_CSCF + - P_CSCF + - I_CSCF + - MRFC + - MGCF + - BGCF + - AS + - IBCF + - S-GW + - P-GW + - HSGW + - E-CSCF + - MME + - TRF + - TF + - ATCF + - PROXY + - EPDG + - TDF + - TWAG + - SCEF + - IWK_SCEF + - IMS_GWF + - type: string + RoleOfIMSNode: + anyOf: + - type: string + enum: + - ORIGINATING + - TERMINATING + - FORWARDING + - type: string + IMSSessionPriority: + anyOf: + - type: string + enum: + - PRIORITY_0 + - PRIORITY_1 + - PRIORITY_2 + - PRIORITY_3 + - PRIORITY_4 + - type: string + MediaInitiatorFlag: + anyOf: + - type: string + enum: + - CALLED_PARTY + - CALLING_PARTY + - UNKNOWN + - type: string + SDPType: + anyOf: + - type: string + enum: + - OFFER + - ANSWER + - type: string + OriginatorPartyType: + anyOf: + - type: string + enum: + - CALLING + - CALLED + - type: string + AccessTransferType: + anyOf: + - type: string + enum: + - PS_TO_CS + - CS_TO_PS + - PS_TO_PS + - CS_TO_CS + - type: string + UETransferType: + anyOf: + - type: string + enum: + - INTRA_UE + - INTER_UE + - type: string + NNISessionDirection: + anyOf: + - type: string + enum: + - INBOUND + - OUTBOUND + - type: string + NNIType: + anyOf: + - type: string + enum: + - NON_ROAMING + - ROAMING_NO_LOOPBACK + - ROAMING_LOOPBACK + - type: string + NNIRelationshipMode: + anyOf: + - type: string + enum: + - TRUSTED + - NON_TRUSTED + - type: string + TADIdentifier: + anyOf: + - type: string + enum: + - CS + - PS + - type: string + ProseFunctionality: + anyOf: + - type: string + enum: + - DIRECT_DISCOVERY + - DIRECT_COMMUNICATION + - type: string + ProseEventType: + anyOf: + - type: string + enum: + - ANNOUNCING + - MONITORING + - MATCH_REPORT + - type: string + DirectDiscoveryModel: + anyOf: + - type: string + enum: + - MODEL_A + - MODEL_B + - type: string + RoleOfUE: + anyOf: + - type: string + enum: + - ANNOUNCING_UE + - MONITORING_UE + - REQUESTOR_UE + - REQUESTED_UE + - type: string + RangeClass: + anyOf: + - type: string + enum: + - RESERVED + - 50_METER + - 100_METER + - 200_METER + - 500_METER + - 1000_METER + - UNUSED + - type: string + RadioResourcesIndicator: + anyOf: + - type: string + enum: + - OPERATOR_PROVIDED + - CONFIGURED + - type: string + MbsDeliveryMethod: + anyOf: + - type: string + enum: + - SHARED + - INDIVIDUAL + - type: string + TSCFlowDirection: + anyOf: + - type: string + enum: + - UPLINK + - DOWNLINK + - type: string + TimeDistributionMethod: + anyOf: + - type: string + enum: + - GPTP + - ASTI + - type: string + AllocateUnitIndicator: + anyOf: + - type: string + enum: + - CHF_DETERMINED + - CTF_DETERMINED + - type: string + NSSAAMessageType: + anyOf: + - type: string + enum: + - Authenticate + - Re-Authentication-Notification + - Revocation Notification + - type: string + + -- GitLab From c602f0e8f4c985ce9e8d1cd8da869e503b8345d2 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Wed, 25 Sep 2024 03:39:57 +0000 Subject: [PATCH 02/33] Upload YAML from TS 32.291 19.0.0 --- OpenAPI/TS32291_Nchf_OfflineOnlyCharging.yaml | 706 ++++++++++++++++++ 1 file changed, 706 insertions(+) create mode 100644 OpenAPI/TS32291_Nchf_OfflineOnlyCharging.yaml diff --git a/OpenAPI/TS32291_Nchf_OfflineOnlyCharging.yaml b/OpenAPI/TS32291_Nchf_OfflineOnlyCharging.yaml new file mode 100644 index 0000000..0f23704 --- /dev/null +++ b/OpenAPI/TS32291_Nchf_OfflineOnlyCharging.yaml @@ -0,0 +1,706 @@ +openapi: 3.0.0 +info: + title: Nchf_OfflineOnlyCharging + version: 1.2.0 + description: | + OfflineOnlyCharging Service + © 2022, 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; + 5G system, charging service; Stage 3. + url: 'http://www.3gpp.org/ftp/Specs/archive/32_series/32.291/' +servers: + - url: '{apiRoot}/nchf-offlineonlycharging/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501. +security: + - {} + - oAuth2ClientCredentials: + - nchf-offlineonlycharging +paths: + /offlinechargingdata: + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingDataRequest' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingDataResponse' + '400': + description: Bad request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '410': + $ref: 'TS29571_CommonData.yaml#/components/responses/410' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + '/offlinechargingdata/{OfflineChargingDataRef}/update': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingDataRequest' + parameters: + - name: OfflineChargingDataRef + in: path + description: a unique identifier for a charging data resource in a PLMN + required: true + schema: + type: string + responses: + '200': + description: OK. Updated Charging Data resource is returned + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingDataResponse' + '400': + description: Bad request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '410': + $ref: 'TS29571_CommonData.yaml#/components/responses/410' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + '/offlinechargingdata/{OfflineChargingDataRef}/release': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ChargingDataRequest' + parameters: + - name: OfflineChargingDataRef + in: path + description: a unique identifier for a charging data resource in a PLMN + required: true + schema: + type: string + responses: + '204': + description: No Content. + '404': + description: Not Found + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '410': + $ref: 'TS29571_CommonData.yaml#/components/responses/410' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '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: + nchf-offlineonlycharging: Access to the Nchf_OfflineOnlyCharging API + schemas: + ChargingDataRequest: + type: object + properties: + subscriberIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + nfConsumerIdentification: + $ref: '#/components/schemas/NFIdentification' + invocationTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + invocationSequenceNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + retransmissionIndicator: + type: boolean + serviceSpecificationInfo: + type: string + multipleUnitUsage: + type: array + items: + $ref: '#/components/schemas/MultipleUnitUsage' + minItems: 0 + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + pDUSessionChargingInformation: + $ref: '#/components/schemas/PDUSessionChargingInformation' + roamingQBCInformation: + $ref: '#/components/schemas/RoamingQBCInformation' + required: + - nfConsumerIdentification + - invocationTimeStamp + - invocationSequenceNumber + ChargingDataResponse: + type: object + properties: + invocationTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + invocationSequenceNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + invocationResult: + $ref: '#/components/schemas/InvocationResult' + sessionFailover: + $ref: '#/components/schemas/SessionFailover' + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + pDUSessionChargingInformation: + $ref: '#/components/schemas/PDUSessionChargingInformation' + roamingQBCInformation: + $ref: '#/components/schemas/RoamingQBCInformation' + required: + - invocationTimeStamp + - invocationSequenceNumber + NFIdentification: + type: object + properties: + nFName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nFIPv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + nFIPv6Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + nFPLMNID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + nodeFunctionality: + $ref: '#/components/schemas/NodeFunctionality' + nFFqdn: + type: string + required: + - nodeFunctionality + MultipleUnitUsage: + type: object + properties: + ratingGroup: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup' + usedUnitContainer: + type: array + items: + $ref: '#/components/schemas/UsedUnitContainer' + minItems: 0 + uPFID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + multihomedPDUAddress: + $ref: '#/components/schemas/PDUAddress' + required: + - ratingGroup + InvocationResult: + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + failureHandling: + $ref: '#/components/schemas/FailureHandling' + Trigger: + type: object + properties: + triggerType: + $ref: '#/components/schemas/TriggerType' + triggerCategory: + $ref: '#/components/schemas/TriggerCategory' + timeLimit: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + volumeLimit: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + volumeLimit64: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + eventLimit: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + maxNumberOfccc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + required: + - triggerType + - triggerCategory + UsedUnitContainer: + type: object + properties: + serviceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceId' + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + triggerTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + time: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + totalVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + uplinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + downlinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + serviceSpecificUnits: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + eventTimeStamps: + type: array + + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minItems: 0 + localSequenceNumber: + type: integer + pDUContainerInformation: + $ref: '#/components/schemas/PDUContainerInformation' + required: + - localSequenceNumber + PDUSessionChargingInformation: + type: object + properties: + chargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + sMFChargingId: + type: string + userInformation: + $ref: '#/components/schemas/UserInformation' + userLocationinfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + mAPDUNon3GPPUserLocationInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + userLocationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + presenceReportingAreaInformation: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 0 + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + pduSessionInformation: + $ref: '#/components/schemas/PDUSessionInformation' + unitCountInactivityTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + rANSecondaryRATUsageReport: + $ref: '#/components/schemas/RANSecondaryRATUsageReport' + required: + - pduSessionInformation + UserInformation: + type: object + properties: + servedGPSI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + servedPEI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + unauthenticatedFlag: + type: boolean + roamerInOut: + $ref: '#/components/schemas/RoamerInOut' + PDUSessionInformation: + type: object + properties: + networkSlicingInfo: + $ref: '#/components/schemas/NetworkSlicingInfo' + pduSessionID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + pduType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' + hPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + servingNetworkFunctionID: + $ref: '#/components/schemas/ServingNetworkFunctionID' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + mAPDUNon3GPPRATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + dnnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + chargingCharacteristics: + type: string + chargingCharacteristicsSelectionMode: + $ref: '#/components/schemas/ChargingCharacteristicsSelectionMode' + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + stopTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + 3gppPSDataOffStatus: + $ref: '#/components/schemas/3GPPPSDataOffStatus' + sessionStopIndicator: + type: boolean + pduAddress: + $ref: '#/components/schemas/PDUAddress' + diagnostics: + $ref: '#/components/schemas/Diagnostics' + authorizedQoSInformation: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AuthorizedDefaultQos' + subscribedQoSInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos' + authorizedSessionAMBR: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + subscribedSessionAMBR: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + servingCNPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + mAPDUSessionInformation: + $ref: '#/components/schemas/MAPDUSessionInformation' + enhancedDiagnostics: + $ref: '#/components/schemas/EnhancedDiagnostics5G' + required: + - pduSessionID + - dnnId + PDUContainerInformation: + type: object + properties: + timeofFirstUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeofLastUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qoSInformation: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosData' + qoSCharacteristics: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosCharacteristics' + aFCorrelationInformation: + type: string + userLocationInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + rATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + servingNodeID: + type: array + items: + $ref: '#/components/schemas/ServingNetworkFunctionID' + minItems: 0 + presenceReportingAreaInformation: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 0 + 3gppPSDataOffStatus: + $ref: '#/components/schemas/3GPPPSDataOffStatus' + sponsorIdentity: + type: string + applicationserviceProviderIdentity: + type: string + chargingRuleBaseName: + type: string + mAPDUSteeringFunctionality: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringFunctionality' + mAPDUSteeringMode: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringMode' + NetworkSlicingInfo: + type: object + properties: + sNSSAI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - sNSSAI + PDUAddress: + type: object + properties: + pduIPv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + pduIPv6AddresswithPrefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + pduAddressprefixlength: + type: integer + iPv4dynamicAddressFlag: + type: boolean + iPv6dynamicPrefixFlag: + type: boolean + ServingNetworkFunctionID: + type: object + properties: + servingNetworkFunctionInformation: + $ref: '#/components/schemas/NFIdentification' + aMFId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfId' + required: + - servingNetworkFunctionInformation + RoamingQBCInformation: + type: object + properties: + multipleQFIcontainer: + type: array + items: + $ref: '#/components/schemas/MultipleQFIcontainer' + minItems: 0 + uPFID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + roamingChargingProfile: + $ref: '#/components/schemas/RoamingChargingProfile' + MultipleQFIcontainer: + type: object + properties: + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + triggerTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + time: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + totalVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + uplinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + localSequenceNumber: + type: integer + qFIContainerInformation: + $ref: '#/components/schemas/QFIContainerInformation' + required: + - localSequenceNumber + QFIContainerInformation: + type: object + properties: + qFI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + timeofFirstUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeofLastUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qoSInformation: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosData' + qoSCharacteristics: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosCharacteristics' + userLocationInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + uetimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + presenceReportingAreaInformation: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 0 + rATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + servingNetworkFunctionID: + type: array + items: + $ref: '#/components/schemas/ServingNetworkFunctionID' + minItems: 0 + 3gppPSDataOffStatus: + $ref: '#/components/schemas/3GPPPSDataOffStatus' + RoamingChargingProfile: + type: object + properties: + triggers: + type: array + items: + $ref: '#/components/schemas/Trigger' + minItems: 0 + partialRecordMethod: + $ref: '#/components/schemas/PartialRecordMethod' + RANSecondaryRATUsageReport: + type: object + properties: + rANSecondaryRATType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + qosFlowsUsageReports: + type: array + items: + $ref: '#/components/schemas/QosFlowsUsageReport' + Diagnostics: + type: integer + IPFilterRule: + type: string + QosFlowsUsageReport: + type: object + properties: + qFI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + startTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + uplinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + downlinkVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + MAPDUSessionInformation: + type: object + properties: + mAPDUSessionIndicator: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/MaPduIndication' + aTSSSCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability' + EnhancedDiagnostics5G: + $ref: '#/components/schemas/RanNasCauseList' + RanNasCauseList: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RanNasRelCause' + NodeFunctionality: + anyOf: + - type: string + enum: + - SMF + - SMSF # Included for backwards compatibility, shall not be used + - I-SMF + - type: string + ChargingCharacteristicsSelectionMode: + anyOf: + - type: string + enum: + - HOME_DEFAULT + - ROAMING_DEFAULT + - VISITING_DEFAULT + - type: string + TriggerType: + anyOf: + - type: string + enum: + - FINAL + - ABNORMAL_RELEASE + - QOS_CHANGE + - VOLUME_LIMIT + - TIME_LIMIT + - EVENT_LIMIT + - PLMN_CHANGE + - USER_LOCATION_CHANGE + - RAT_CHANGE + - SESSION_AMBR_CHANGE + - UE_TIMEZONE_CHANGE + - TARIFF_TIME_CHANGE + - MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS + - MANAGEMENT_INTERVENTION + - CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA + - CHANGE_OF_3GPP_PS_DATA_OFF_STATUS + - SERVING_NODE_CHANGE + - REMOVAL_OF_UPF + - ADDITION_OF_UPF + - INSERTION_OF_ISMF + - REMOVAL_OF_ISMF + - CHANGE_OF_ISMF + - START_OF_SERVICE_DATA_FLOW + - GFBR_GUARANTEED_STATUS_CHANGE + - HANDOVER_CANCEL + - HANDOVER_START + - HANDOVER_COMPLETE + - ADDITION_OF_ACCESS + - REMOVAL_OF_ACCESS + - START_OF_SDF_ADDITIONAL_ACCESS + - type: string + TriggerCategory: + anyOf: + - type: string + enum: + - IMMEDIATE_REPORT + - DEFERRED_REPORT + - type: string + FailureHandling: + anyOf: + - type: string + enum: + - TERMINATE + - CONTINUE + - RETRY_AND_TERMINATE + - type: string + SessionFailover: + anyOf: + - type: string + enum: + - FAILOVER_NOT_SUPPORTED + - FAILOVER_SUPPORTED + - type: string + 3GPPPSDataOffStatus: + anyOf: + - type: string + enum: + - ACTIVE + - INACTIVE + - type: string + ResultCode: + anyOf: + - type: string + enum: + - SUCCESS + - END_USER_SERVICE_DENIED + - type: string + PartialRecordMethod: + anyOf: + - type: string + enum: + - DEFAULT + - INDIVIDUAL + - type: string + RoamerInOut: + anyOf: + - type: string + enum: + - IN_BOUND + - OUT_BOUND + - type: string + + + -- GitLab From 4ec61d9a6b282683beafa4b932687cba76c4ab02 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Wed, 25 Sep 2024 03:40:50 +0000 Subject: [PATCH 03/33] Upload the Reference --- OpenAPI/TS28538_EdgeNrm.yaml | 477 +++++++++++++++++++++++++++++++++++ 1 file changed, 477 insertions(+) create mode 100644 OpenAPI/TS28538_EdgeNrm.yaml diff --git a/OpenAPI/TS28538_EdgeNrm.yaml b/OpenAPI/TS28538_EdgeNrm.yaml new file mode 100644 index 0000000..83f8674 --- /dev/null +++ b/OpenAPI/TS28538_EdgeNrm.yaml @@ -0,0 +1,477 @@ +openapi: 3.0.1 +info: + title: 3GPP Edge NRM + version: 19.0.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' + EASBundle: + $ref: '#/components/schemas/EASBundle-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' + EASBundle-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + bundleIdentifier: + type: string + bundledEASIdentifier: + type: string + bundleType: + type: string + mainEASIdentifier: + type: string + coordinatedEASDiscovery: + type: boolean + coordinatedACR: + type: boolean + eDNAffinity: + type: string + description: any of enumrated value + enum: + - STRONG + - WEAK + - PREFERRED + +#-------- 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' + EASBundle-Multiple: + type: array + items: + $ref: '#/components/schemas/EASBundle-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' + - $ref: '#/components/schemas/EASBundle-Single' -- GitLab From f46ba8aa14510db85030ebc6a475dee6b0dbe10d Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Wed, 25 Sep 2024 03:41:19 +0000 Subject: [PATCH 04/33] Upload the Reference --- OpenAPI/TS28541_NrNrm.yaml | 2318 ++++++++++++++++++++++++++++++++++++ 1 file changed, 2318 insertions(+) create mode 100644 OpenAPI/TS28541_NrNrm.yaml diff --git a/OpenAPI/TS28541_NrNrm.yaml b/OpenAPI/TS28541_NrNrm.yaml new file mode 100644 index 0000000..3aea8f9 --- /dev/null +++ b/OpenAPI/TS28541_NrNrm.yaml @@ -0,0 +1,2318 @@ +openapi: 3.0.1 +info: + title: NR NRM + version: 19.1.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 + readOnly: true + + 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 + readOnly: true + 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 + default: 0 + rsrqOffsetSSB: + type: integer + default: 0 + sinrOffsetSSB: + type: integer + default: 0 + rsrpOffsetCSI-RS: + type: integer + default: 0 + rsrqOffsetCSI-RS: + type: integer + default: 0 + sinrOffsetCSI-RS: + type: integer + default: 0 + 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 + default: 0 + 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 + default: 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 + default: DISABLE + enablenearfarIndicationRS2: + type: string + enum: + - ENABLE + - DISABLE + default: 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 + default: 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 + default: 0 + minimum: 0 + maximum: 604800 + positionY: + type: integer + default: 0 + minimum: 0 + maximum: 604800 + positionZ: + type: integer + default: 0 + minimum: 0 + maximum: 604800 + velocityVX: + type: integer + default: 0 + minimum: -131072 + maximum: 131071 + velocityVY: + type: integer + default: 0 + minimum: -131072 + maximum: 131071 + velocityVZ: + type: integer + default: 0 + minimum: -131072 + maximum: 131071 + + Orbital: + type: object + properties: + semiMajorAxis: + type: integer + default: 0 + minimum: 0 + maximum: 8589934591 + eccentricity: + type: integer + default: 0 + minimum: -524288 + maximum: 524287 + periapsis: + type: integer + default: 0 + minimum: 0 + maximum: 16777215 + longitude: + type: integer + default: 0 + minimum: 0 + maximum: 2097151 + inclination: + type: integer + default: 0 + minimum: -524288 + maximum: 524287 + meanAnomaly: + type: integer + default: 0 + 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/DnRo' + - $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/DnRo' + 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/DnRo' + - $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/DnRo' + ephemerisInfoSetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + 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/DnRo' + - $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 + readOnly: true + 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 + readOnly: true + beamType: + type: string + readOnly: true + enum: + - SSB_BEAM + beamAzimuth: + type: integer + readOnly: true + minimum: -1800 + maximum: 1800 + beamTilt: + type: integer + readOnly: true + minimum: -900 + maximum: 900 + beamHorizWidth: + type: integer + readOnly: true + minimum: 0 + maximum: 3599 + beamVertWidth: + type: integer + readOnly: true + 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 + default: 0 + 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 + readOnly: true + enum: + - YES + - NO + energySavingState: + type: string + readOnly: true + enum: + - IS_NOT_ENERGY_SAVING + - IS_ENERGY_SAVING + mLModelRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo' + aIMLInferenceFunctionRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo' + 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/DnListRo' + aIMLInferenceFunctionRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo' + 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/DnListRo' + aIMLInferenceFunctionRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo' + 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/DnListRo' + + 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/DnListRo' + + 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/DnListRo' + + 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' + -- GitLab From 298891fb956a400c227b42ea1d8f4f80ca0a6b30 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Wed, 25 Sep 2024 03:42:02 +0000 Subject: [PATCH 05/33] Upload the Reference --- OpenAPI/TS28541_SliceNrm.yaml | 1098 +++++++++++++++++++++++++++++++++ 1 file changed, 1098 insertions(+) create mode 100644 OpenAPI/TS28541_SliceNrm.yaml diff --git a/OpenAPI/TS28541_SliceNrm.yaml b/OpenAPI/TS28541_SliceNrm.yaml new file mode 100644 index 0000000..1dc47d0 --- /dev/null +++ b/OpenAPI/TS28541_SliceNrm.yaml @@ -0,0 +1,1098 @@ +openapi: 3.0.1 +info: + title: Slice NRM + version: 19.0.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 + readOnly: true + PositioningAvailability: + type: array + items: + type: string + enum: + - CIDE_CID + - OTDOA + - RF_FINGERPRINTING + - AECID + - HYBRID_POSITIONING + - NET_RTK + readOnly: true + 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 + readOnly: true + Tagging: + type: array + readOnly: true + items: + type: string + enum: + - PERFORMANCE + - FUNCTION + - OPERATION + readOnly: true + 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 + readOnly: true + 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: 'TS28623_ComDefs.yaml#/components/schemas/FloatRo' + maxThpt: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/FloatRo' + MaxPktSize: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + maxsize: + type: integer + MaxNumberofPDUSessions: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + nOofPDUSessions: + type: integer + readOnly: true + KPIMonitoring: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + kPIList: + type: array + items: + type: string + readOnly: true + 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 + readOnly: true + NsInfo: + type: object + properties: + nsInstanceId: + type: string + readOnly: true + nsName: + type: string + readOnly: true + 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 + readOnly: true + secFunType: + type: string + secRules: + type: array + items: + type: string + readOnly: true + 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 + readOnly: true + 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 + readOnly: true + plmnInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + cNSliceSubnetProfile: + $ref: '#/components/schemas/CNSliceSubnetProfile' + rANSliceSubnetProfile: + $ref: '#/components/schemas/RANSliceSubnetProfile' + topSliceSubnetProfile: + $ref: '#/components/schemas/TopSliceSubnetProfile' + + 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 + readOnly: true + 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 + readOnly: true + 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 + readOnly: true + 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 + readOnly: true + 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 + readOnly: true + 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/DnRo' + 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/DnListRo' + 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/DnListRo' + networkSliceSubnetRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo' + 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/DnListRo' + 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: 'TS28623_ComDefs.yaml#/components/schemas/IpAddrRo' + 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 + readOnly: true + uLlatency: + type: integer + readOnly: true + dLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + uLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + coverageAreaTAList: + $ref: 'TS28541_5GcNrm.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 + readOnly: true + 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/DnRo' + + 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/DnRo' + + 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/DnListRo' + networkSliceSubnetRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo' + +#-------- 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' + -- GitLab From 91101e7696b3a43eba02dc0d675634aedd11c715 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Wed, 25 Sep 2024 03:42:19 +0000 Subject: [PATCH 06/33] Upload the Reference --- OpenAPI/TS28623_ComDefs.yaml | 534 +++++++++++++++++++++++++++++++++++ 1 file changed, 534 insertions(+) create mode 100644 OpenAPI/TS28623_ComDefs.yaml diff --git a/OpenAPI/TS28623_ComDefs.yaml b/OpenAPI/TS28623_ComDefs.yaml new file mode 100644 index 0000000..ff30361 --- /dev/null +++ b/OpenAPI/TS28623_ComDefs.yaml @@ -0,0 +1,534 @@ +openapi: 3.0.1 +info: + title: Common Type Definitions + version: 19.1.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: + description: This datatype is used for writable attribute + type: number + format: float + FloatRo: + description: This datatype is used for readOnly attribute + type: number + format: float + readOnly: true + DateTime: + description: This datatype is used for writable attribute + type: string + format: date-time + DateTimeRo: + description: This datatype is used for readOnly attribute + type: string + format: date-time + readOnly: true + 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: + description: This datatype is used for writable attribute + type: string + DnRo: + description: This datatype is used for readOnly attribute + type: string + readOnly: true + DnList: + description: This datatype is used for writable attribute + type: array + items: + $ref: '#/components/schemas/Dn' + DnListRo: + description: This datatype is used for readOnly attribute + type: array + items: + $ref: '#/components/schemas/DnRo' + + Mcc: + description: This datatype is used for writable attribut + type: string + pattern: '^[0-9]{3}$' + MccRo: + description: This datatype is used for readOnly attribute + type: string + pattern: '^[0-9]{3}$' + readOnly: true + Mnc: + description: This datatype is used for writable attribut + type: string + pattern: '^[0-9]{2,3}$' + MncRo: + description: This datatype is used for readOnly attribute + type: string + pattern: '^[0-9]{2,3}$' + readOnly: true + Nid: + type: string + pattern: '^[A-Fa-f0-9]{11}$' + PlmnId: + description: This datatype is used for writable attribute + type: object + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + PlmnIdRo: + description: This datatype is used for readOnly attribute + type: object + properties: + mcc: + $ref: '#/components/schemas/MccRo' + mnc: + $ref: '#/components/schemas/MncRo' + 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: + description: This datatype is used for writable attribute + 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' + TimeWindowRo: + description: This datatype is used for readOnly attribute + oneOf: + - type: object + properties: + startTime: + $ref: '#/components/schemas/DateTimeRo' + endTime: + $ref: '#/components/schemas/DateTimeRo' + - type: object + properties: + startTime: + $ref: '#/components/schemas/DateTimeRo' + - type: object + properties: + endTime: + $ref: '#/components/schemas/DateTimeRo' + 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 + description: This datatype is used for writable attribute + pattern: '^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$' + minLength: 4 + maxLength: 253 + FqdnRo: + type: string + description: This datatype is used for readOnly attribute + pattern: '^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$' + minLength: 4 + maxLength: 253 + readOnly: true + + Ipv4Addr: + description: This datatype is used for writable attribute + 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' + Ipv4AddrRo: + description: This datatype is used for readOnly attribute + 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' + readOnly: true + Ipv6Addr: + description: This datatype is used for writable attribute + 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' + Ipv6AddrRo: + description: This datatype is used for readOnly attribute + 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' + readOnly: true + Ipv6Prefix: + description: This datatype is used for writable attribute + 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' + Ipv6PrefixRo: + description: This datatype is used for readOnly attribute + 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' + readOnly: true + IpAddr: + description: This datatype is used for writable attribute + oneOf: + - $ref: '#/components/schemas/Ipv4Addr' + - $ref: '#/components/schemas/Ipv6Addr' + - $ref: '#/components/schemas/Ipv6Prefix' + IpAddrRo: + description: This datatype is used for readOnly attribute + oneOf: + - $ref: '#/components/schemas/Ipv4AddrRo' + - $ref: '#/components/schemas/Ipv6AddrRo' + - $ref: '#/components/schemas/Ipv6PrefixRo' + 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: + description: This datatype is used for writable attribute + type: string + UriRo: + type: string + description: This datatype is used for readOnly attribute + readOnly: true + + TimeInterval: + type: object + properties: + intervalStart: + $ref: '#/components/schemas/FullTime' + intervalEnd: + $ref: '#/components/schemas/FullTime' + + AdministrativeState: + type: string + enum: + - LOCKED + - UNLOCKED + default: LOCKED + BasicAdministrativeState: + type: string + enum: + - LOCKED + - UNLOCKED + OperationalState: + type: string + enum: + - ENABLED + - DISABLED + default: DISABLED + readOnly: true + UsageState: + type: string + readOnly: true + enum: + - IDLE + - ACTIVE + - BUSY + AvailabilityStatus: + type: string + enum: + - IN_TEST + - FAILED + - POWER_OFF + - OFF_LINE + - OFF_DUTY + - DEPENDENCY + - DEGRADED + - NOT_INSTALLED + - LOG_FULL + readOnly: true + + 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 -- GitLab From 9243e24dad9e119df781b138d4490f0459b38979 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Wed, 25 Sep 2024 03:42:40 +0000 Subject: [PATCH 07/33] Upload the Reference --- .../TS29520_Nnwdaf_EventsSubscription.yaml | 4084 +++++++++++++++++ 1 file changed, 4084 insertions(+) create mode 100644 OpenAPI/TS29520_Nnwdaf_EventsSubscription.yaml diff --git a/OpenAPI/TS29520_Nnwdaf_EventsSubscription.yaml b/OpenAPI/TS29520_Nnwdaf_EventsSubscription.yaml new file mode 100644 index 0000000..bc75528 --- /dev/null +++ b/OpenAPI/TS29520_Nnwdaf_EventsSubscription.yaml @@ -0,0 +1,4084 @@ +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. -- GitLab From 0d450480e25f6baf0dae84d852661b17b36445c3 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Wed, 25 Sep 2024 03:42:54 +0000 Subject: [PATCH 08/33] Upload the Reference --- OpenAPI/TS29512_Npcf_SMPolicyControl.yaml | 3308 +++++++++++++++++++++ 1 file changed, 3308 insertions(+) create mode 100644 OpenAPI/TS29512_Npcf_SMPolicyControl.yaml diff --git a/OpenAPI/TS29512_Npcf_SMPolicyControl.yaml b/OpenAPI/TS29512_Npcf_SMPolicyControl.yaml new file mode 100644 index 0000000..daa21de --- /dev/null +++ b/OpenAPI/TS29512_Npcf_SMPolicyControl.yaml @@ -0,0 +1,3308 @@ +openapi: 3.0.0 + +info: + title: Npcf_SMPolicyControl API + version: 1.4.0-alpha + 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 V19.0.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' + qosMonCapRepos: + type: array + items: + $ref: '#/components/schemas/CapabilityReportRule' + minItems: 1 + description: QoS monitoring is supported or not for the indicated PCC rule(s). + 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. + + CapabilityReportRule: + description: > + Contains information about whether a capability is supported or + not for one or more PCC rules. + type: object + properties: + refPccRuleIds: + type: array + items: + type: string + minItems: 1 + description: > + Contains the identifier of the PCC rule(s) which are affected of QoS Monitoring + Capability Report. + capReport: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/NotifCap' + required: + - refPccRuleIds + - capReport + + 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 + - QOS_MON_CAP_REPO + - 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. + - QOS_MON_CAP_REPO: Indicates that the NF service consumer notifies the PCF about the + support of QoS Monitoring Capability Report. + - 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. +# + -- GitLab From b0906b4eb89698c7c9c60b47a09de1a8120e9cde Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Wed, 25 Sep 2024 03:43:23 +0000 Subject: [PATCH 09/33] Upload the Reference --- OpenAPI/TS29571_CommonData.yaml | 6805 +++++++++++++++++++++++++++++++ 1 file changed, 6805 insertions(+) create mode 100644 OpenAPI/TS29571_CommonData.yaml diff --git a/OpenAPI/TS29571_CommonData.yaml b/OpenAPI/TS29571_CommonData.yaml new file mode 100644 index 0000000..e361046 --- /dev/null +++ b/OpenAPI/TS29571_CommonData.yaml @@ -0,0 +1,6805 @@ +openapi: 3.0.0 + +info: + version: '1.6.0-alpha.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 19.0.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. + + BluetoothRssi: + anyOf: + - type: string + enum: + - TRUE + - type: string + + WlanRssi: + anyOf: + - type: string + enum: + - TRUE + - type: string + + WlanRtt: + anyOf: + - type: string + enum: + - TRUE + - type: string + + +# +# 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 + sensorMeasurementLteList: + 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 + eventThresholdSinrNr: + type: integer + minimum: 0 + maximum: 127 + bluetoothMeasurementNr: + $ref: '#/components/schemas/BluetoothMeasurement' + bluetoothMeasurementLte: + $ref: '#/components/schemas/BluetoothMeasurement' + wlanMeasurementNr: + $ref: '#/components/schemas/WlanMeasurement' + wlanMeasurementLte: + $ref: '#/components/schemas/WlanMeasurement' + + 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' + + BluetoothMeasurement: + description: contains the bluetooth measurements to be collected for UE. + type: object + properties: + measurementNameList: + type: array + items: + $ref: '#/components/schemas/MeasurementName' + minItems: 1 + maxItems: 4 + bluetoothRssi: + $ref: '#/components/schemas/BluetoothRssi' + + WlanMeasurement: + description: contains the WLAN measurements to be collected for UE. + type: object + properties: + measurementNameList: + type: array + items: + $ref: '#/components/schemas/MeasurementName' + minItems: 1 + maxItems: 4 + wlanRssi: + $ref: '#/components/schemas/WlanRssi' + wlanRtt: + $ref: '#/components/schemas/WlanRtt' + + MeasurementName: + description: contains the measurement name for measurement collection. + type: object + properties: + bluetoothName: + type: string + wlanName: + type: string + + + +# 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 -- GitLab From 113488e41492dfed4dcbac51d0f3e6ffe5a5db27 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Thu, 26 Sep 2024 13:17:54 +0000 Subject: [PATCH 10/33] Upload the CHF-PCF interaction --- .../TS29594_Nchf_SpendingLimitControl.yaml | 371 ++++++++++++++++++ 1 file changed, 371 insertions(+) create mode 100644 OpenAPI/TS29594_Nchf_SpendingLimitControl.yaml diff --git a/OpenAPI/TS29594_Nchf_SpendingLimitControl.yaml b/OpenAPI/TS29594_Nchf_SpendingLimitControl.yaml new file mode 100644 index 0000000..d21bf1e --- /dev/null +++ b/OpenAPI/TS29594_Nchf_SpendingLimitControl.yaml @@ -0,0 +1,371 @@ +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. -- GitLab From 8ab00ac2dde3e3fdb7acf77a5611a1550120790b Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 01:36:31 +0000 Subject: [PATCH 11/33] Upload the YAML for cross reference compile --- OpenAPI/TS29510_Nnrf_AccessToken.yaml | 352 ++++++++++++++++++++++++++ 1 file changed, 352 insertions(+) create mode 100644 OpenAPI/TS29510_Nnrf_AccessToken.yaml diff --git a/OpenAPI/TS29510_Nnrf_AccessToken.yaml b/OpenAPI/TS29510_Nnrf_AccessToken.yaml new file mode 100644 index 0000000..f5b7f8d --- /dev/null +++ b/OpenAPI/TS29510_Nnrf_AccessToken.yaml @@ -0,0 +1,352 @@ +openapi: 3.0.0 + +info: + version: '1.3.1' + title: 'NRF OAuth2' + description: | + NRF OAuth2 Authorization. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.510 V18.8.0; 5G System; Network Function Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' + +servers: + - url: '{nrfApiRoot}' + variables: + nrfApiRoot: + default: https://example.com + description: > + nrfApiRoot represents the concatenation of the "scheme" and "authority" components + (as defined in IETF RFC 3986) of the NRF + +paths: + /oauth2/token: + post: + summary: Access Token Request + operationId: AccessTokenRequest + tags: + - Access Token Request + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AccessTokenReq' + encoding: + requesterPlmn: + contentType: application/json + requesterPlmnList: + contentType: application/json + requesterSnssaiList: + contentType: application/json + requesterSnpnList: + contentType: application/json + targetPlmn: + contentType: application/json + targetSnpn: + contentType: application/json + targetSnssaiList: + contentType: application/json + targetNsiList: + style: form + explode: true + required: true + responses: + '200': + description: Successful Access Token Request + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTokenRsp' + headers: + Cache-Control: + $ref: '#/components/headers/cache-control' + Pragma: + $ref: '#/components/headers/pragma' + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '400': + description: Error in the Access Token Request + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTokenErr' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + headers: + Cache-Control: + $ref: '#/components/headers/cache-control' + Pragma: + $ref: '#/components/headers/pragma' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + headers: + cache-control: + required: true + schema: + type: string + enum: + - no-store + pragma: + required: true + schema: + type: string + enum: + - no-cache + + schemas: + AccessTokenReq: + description: Contains information related to the access token request + type: object + required: + - grant_type + - nfInstanceId + - scope + properties: + grant_type: + type: string + enum: + - client_credentials + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + targetNfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + scope: + type: string + pattern: '^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$' + targetNfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + requesterPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + requesterPlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 2 + requesterSnssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + requesterFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + requesterSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + targetPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + targetSnpn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + targetSnssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + targetNsiList: + type: array + items: + type: string + minItems: 1 + targetNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + targetNfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + hnrfAccessTokenUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + sourceNfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + vendorId: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId' + analyticsIds: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + requesterInterIndList: + type: array + items: + $ref: '#/components/schemas/MlModelInterInd' + minItems: 1 + sourceVendorId: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId' + + AccessTokenRsp: + description: Contains information related to the access token response + type: object + required: + - access_token + - token_type + properties: + access_token: + type: string + description: > + JWS Compact Serialized representation of JWS signed JSON object (AccessTokenClaims) + token_type: + type: string + enum: + - Bearer + expires_in: + type: integer + scope: + type: string + pattern: '^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$' + + AccessTokenClaims: + description: The claims data structure for the access token + type: object + required: + - iss + - sub + - aud + - scope + - exp + properties: + iss: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + sub: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + aud: + anyOf: + - $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + - type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + scope: + type: string + pattern: '^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$' + exp: + type: integer + consumerPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + consumerSnpnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + producerPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + producerSnpnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + producerSnssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + producerNsiList: + type: array + items: + type: string + minItems: 1 + producerNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + producerNfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + sourceNfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + analyticsIdList: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + + AccessTokenErr: + description: Error returned in the access token response message + type: object + required: + - error + properties: + error: + type: string + enum: + - invalid_request + - invalid_client + - invalid_grant + - unauthorized_client + - unsupported_grant_type + - invalid_scope + error_description: + type: string + error_uri: + type: string + + MlModelInterInd: + description: ML Model Interoperability Indicator per Analytics Id + type: object + properties: + analyticsId: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + vendorList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId' + minItems: 1 + required: + - analyticsId + - vendorList -- GitLab From aa48c2ab14e9ea0006444686a1bc2e8614030ea1 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 01:37:01 +0000 Subject: [PATCH 12/33] Upload the YAML for cross reference compile --- OpenAPI/TS29523_Npcf_EventExposure.yaml | 524 ++++++++++++++++++++++++ 1 file changed, 524 insertions(+) create mode 100644 OpenAPI/TS29523_Npcf_EventExposure.yaml diff --git a/OpenAPI/TS29523_Npcf_EventExposure.yaml b/OpenAPI/TS29523_Npcf_EventExposure.yaml new file mode 100644 index 0000000..23368af --- /dev/null +++ b/OpenAPI/TS29523_Npcf_EventExposure.yaml @@ -0,0 +1,524 @@ +openapi: 3.0.0 +info: + version: 1.3.0 + title: Npcf_EventExposure + description: | + PCF Event Exposure Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.523 V18.5.0; 5G System; Policy Control Event Exposure Service; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.523/ + +servers: + - url: '{apiRoot}/npcf-eventexposure/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npcf-eventexposure + +paths: + /subscriptions: + post: + summary: Creates a new Individual Policy Control Events Subscription resource + operationId: PostPcEventExposureSubsc + tags: + - Policy Control Events Subscription (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureSubsc' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureSubsc' + headers: + Location: + description: > + Contains the URI of the created individual policy control events subscription + resource, according to the structure + {apiRoot}/npcf-eventexposure/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: + PcEventNotification: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureNotif' + 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}: + get: + summary: "Reads an existing Individual Policy Control Events Subscription" + operationId: GetPcEventExposureSubsc + tags: + - Individual Policy Control Events Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Policy Control Event Subscription ID. + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureSubsc' + '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' + put: + summary: "Modifies an existing Individual Policy Control Events Subscription " + operationId: PutPcEventExposureSubsc + tags: + - Individual Policy Control Events Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureSubsc' + parameters: + - name: subscriptionId + in: path + description: Policy Control Event Subscription ID. + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was succesfully modified and representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureSubsc' + '204': + description: No Content. Resource was succesfully modified. + '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: + summary: "Cancels an existing Individual Policy Control Events Subscription " + operationId: DeletePcEventExposureSubsc + tags: + - Individual Policy Control Events Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Policy Control Event Subscription ID. + required: true + schema: + type: string + 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: + npcf-eventexposure: Access to the Npcf_EventExposure API. + + schemas: + + PcEventExposureNotif: + description: > + Represents notifications about Policy Control events related to an Individual + Policy Events Subscription resource. + type: object + properties: + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/PcEventNotification' + minItems: 1 + required: + - notifId + - eventNotifs + + + PcEventExposureSubsc: + description: Represents an Individual Policy Events Subscription resource. + type: object + properties: + eventSubs: + type: array + items: + $ref: '#/components/schemas/PcEvent' + minItems: 1 + eventsRepInfo: + $ref: '#/components/schemas/ReportingInformation' + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + filterDnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + filterSnssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + snssaiDnns: + type: array + items: + $ref: '#/components/schemas/SnssaiDnnCombination' + minItems: 1 + filterServices: + type: array + items: + $ref: '#/components/schemas/ServiceIdentification' + minItems: 1 + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/PcEventNotification' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - eventSubs + - notifId + - notifUri + + ReportingInformation: + description: Represents the type of reporting that the subscription requires. + type: object + properties: + immRep: + type: boolean + notifMethod: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NotificationMethod' + maxReportNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + monDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + sampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + partitionCriteria: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartitioningCriteria' + minItems: 1 + description: Criteria for partitioning the UEs before applying the sampling ratio. + grpRepTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + notifFlag: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' + notifFlagInstruct: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' + mutingSetting: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingNotificationsSettings' + + ServiceIdentification: + description: Identifies the service to which the subscription applies. + type: object + properties: + servEthFlows: + type: array + items: + $ref: '#/components/schemas/EthernetFlowInfo' + minItems: 1 + servIpFlows: + type: array + items: + $ref: '#/components/schemas/IpFlowInfo' + minItems: 1 + afAppId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AfAppId' + # All conditions in allOf must be met + allOf: + # First condition is that servEthFlows and servIpFlows are mutually exclusive + - not: + required: [servEthFlows, servIpFlows] + # Second condition is that at least one the servEthFlows, servIpFlows and afAppId shall be present + - anyOf: + - required: [servEthFlows] + - required: [servIpFlows] + - required: [afAppId] + + EthernetFlowInfo: + description: Identifies an UL/DL ethernet flow. + type: object + properties: + ethFlows: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + maxItems: 2 + flowNumber: + type: integer + required: + - flowNumber + + IpFlowInfo: + description: Identifies an UL/DL IP flow. + type: object + properties: + ipFlows: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + maxItems: 2 + flowNumber: + type: integer + required: + - flowNumber + + PcEventNotification: + description: Represents the information reported for a Policy Control event. + type: object + properties: + event: + $ref: '#/components/schemas/PcEvent' + accType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + addAccessInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo' + relAccessInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo' + anGwAddr: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AnGwAddress' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + appliedCov: + $ref: 'TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + pduSessionInfo: + $ref: '#/components/schemas/PduSessionInformation' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + repServices: + $ref: '#/components/schemas/ServiceIdentification' + delivFailure: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/Failure' + required: + - event + - timeStamp + + PduSessionInformation: + description: Represents PDU session identification information. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + ueIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + ipDomain: + type: string + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + required: + - snssai + - dnn + oneOf: + - required: [ueMac] + - anyOf: + - required: [ueIpv4] + - required: [ueIpv6] + SnssaiDnnCombination: + description: Represents a combination of S-NSSAI and DNN(s). + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + +# Simple data types and Enumerations + + PcEvent: + description: Represents the policy control events that can be subscribed. + anyOf: + - type: string + enum: + - AC_TY_CH + - PLMN_CH + - SAC_CH + - SAT_CATEGORY_CH + - SUCCESS_UE_POL_DEL_SP + - UNSUCCESS_UE_POL_DEL_SP + - APPLICATION_START + - APPLICATION_STOP + - 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. -- GitLab From ac8fc18d1a1899a0af2201a66d9a9bfe8ff19109 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 01:37:59 +0000 Subject: [PATCH 13/33] Upload the YAML for cross reference compile --- OpenAPI/TS29502_Nsmf_PDUSession.yaml | 5507 ++++++++++++++++++++++++++ 1 file changed, 5507 insertions(+) create mode 100644 OpenAPI/TS29502_Nsmf_PDUSession.yaml diff --git a/OpenAPI/TS29502_Nsmf_PDUSession.yaml b/OpenAPI/TS29502_Nsmf_PDUSession.yaml new file mode 100644 index 0000000..a2ba0ef --- /dev/null +++ b/OpenAPI/TS29502_Nsmf_PDUSession.yaml @@ -0,0 +1,5507 @@ +openapi: 3.0.0 + +info: + version: '1.4.0-alpha.1' + title: 'Nsmf_PDUSession' + description: | + SMF PDU Session Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.502 V19.0.0; 5G System; Session Management Services; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.502/ + +servers: + - url: '{apiRoot}/nsmf-pdusession/v1' + variables: + apiRoot: + default: https://example.com + description: > + apiRoot as defined in clause 4.4 of 3GPP TS 29.501. The sm-contexts and pdu-sessions + resources can be distributed on different processing instances or hosts. Thus the + authority and/or deployment-specific string of the apiRoot of the created individual + sm context and pdu-session resources' URIs may differ from the authority and/or + deployment-specific string of the apiRoot of the sm-contexts and pdu-sessions + collections' URIs. + +security: + - {} + - oAuth2ClientCredentials: + - nsmf-pdusession + +paths: + /sm-contexts: + post: + summary: Create SM Context + tags: + - SM contexts collection + operationId: PostSmContexts + requestBody: + description: representation of the SM context to be created in the SMF + required: true + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateData' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + binaryDataN2SmInformationExt1: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + callbacks: + smContextStatusNotification: + '{$request.body#/smContextStatusUri}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SmContextStatusNotification' + responses: + '204': + description: successful notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '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' + + responses: + '201': + description: successful creation of an SM context + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreatedData' + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nsmf-pdusession//sm-contexts/{smContextRef} + required: true + schema: + type: string + + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: unsuccessful creation of an SM context - bad request + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '401': + $ref: '#/components/responses/401' + '403': + description: unsuccessful creation of an SM context - forbidden + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '404': + description: unsuccessful creation of an SM context - not found + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: '#/components/responses/413' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + description: unsuccessful creation of an SM context - internal server error + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '502': + $ref: '#/components/responses/502' + '503': + description: unsuccessful creation of an SM context - service unavailable + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '504': + description: unsuccessful creation of an SM context - gateway timeout + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + + /sm-contexts/{smContextRef}/retrieve: + post: + summary: Retrieve SM Context + tags: + - Individual SM context + operationId: RetrieveSmContext + parameters: + - name: smContextRef + in: path + description: SM context reference + required: true + schema: + type: string + requestBody: + description: parameters used to retrieve the SM context + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/SmContextRetrieveData' + responses: + '200': + description: successful retrieval of an SM context + content: + application/json: + schema: + $ref: '#/components/schemas/SmContextRetrievedData' + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /sm-contexts/{smContextRef}/modify: + post: + summary: Update SM Context + tags: + - Individual SM context + operationId: UpdateSmContext + parameters: + - name: smContextRef + in: path + description: SM context reference + required: true + schema: + type: string + requestBody: + description: representation of the updates to apply to the SM context + required: true + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateData' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + binaryDataN2SmInformationExt1: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + responses: + '200': + description: successful update of an SM context with content in the response + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdatedData' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '204': + description: successful update of an SM context without content in the response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: unsuccessful update of an SM context - bad request + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '401': + $ref: '#/components/responses/401' + '403': + description: unsuccessful update of an SM context - forbidden + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '404': + description: unsuccessful update of an SM context - not found + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateError' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: '#/components/responses/413' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + description: unsuccessful update of an SM context - Internal server error + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '502': + $ref: '#/components/responses/502' + '503': + description: unsuccessful update of an SM context - Service Unavailable + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '504': + description: unsuccessful update of an SM context - gateway timeout + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /sm-contexts/{smContextRef}/release: + post: + summary: Release SM Context + tags: + - Individual SM context + operationId: ReleaseSmContext + parameters: + - name: smContextRef + in: path + description: SM context reference + required: true + schema: + type: string + requestBody: + description: representation of the data to be sent to the SMF when releasing the SM context + required: false + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextReleaseData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextReleaseData' + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + + responses: + '200': + description: successful release of a PDU session with content in the response + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextReleasedData' + '204': + description: successful release of an SM context without content in the response + '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-contexts/{smContextRef}/send-mo-data: + post: + summary: Send MO Data + tags: + - Individual SM context + operationId: SendMoData + parameters: + - name: smContextRef + in: path + description: SM context reference + required: true + schema: + type: string + requestBody: + description: representation of the content of Send MO Data Request + required: true + content: + multipart/related: # message with a binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/SendMoDataReqData' + binaryMoData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryMoData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: successful sending of MO data + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: '#/components/responses/413' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + '502': + $ref: '#/components/responses/502' + '503': + $ref: '#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /pdu-sessions: + post: + summary: Create + tags: + - PDU sessions collection + operationId: PostPduSessions + requestBody: + description: representation of the PDU session to be created in the H-SMF or SMF + required: true + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/PduSessionCreateData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/PduSessionCreateData' + binaryDataN1SmInfoFromUe: + type: string + format: binary + binaryDataUnknownN1SmInfo: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoFromUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataUnknownN1SmInfo: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + callbacks: + statusNotification: + '{$request.body#/vsmfPduSessionUri}': + post: + summary: Notify Status + tags: + - Individual PDU session (V-SMF) + operationId: NotifyStatus + requestBody: + $ref: '#/components/requestBodies/NotifyStatusRequestBody' + responses: + '204': + description: successful notificationof the status change + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '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' + statusNotification-ismf: + '{$request.body#/ismfPduSessionUri}': + post: + summary: Notify Status + tags: + - Individual PDU session (I-SMF) + operationId: NotifyStatus-isfm + requestBody: + $ref: '#/components/requestBodies/NotifyStatusRequestBody' + responses: + '204': + description: successful notificationof the status change + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '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' + + + update: + '{$request.body#/vsmfPduSessionUri}/modify': + post: + summary: Update (initiated by H-SMF) + tags: + - Individual PDU session (V-SMF) + operationId: ModifyPduSession + requestBody: + $ref: '#/components/requestBodies/VsmfUpdateRequestBody' + responses: + '200': + $ref: '#/components/responses/VsmfUpdateResponse200' + '204': + description: successful update of a PDU session without content in the response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: '#/components/responses/VsmfUpdateError' + '403': + $ref: '#/components/responses/VsmfUpdateError' + '404': + $ref: '#/components/responses/VsmfUpdateError' + '409': + $ref: '#/components/responses/VsmfUpdateError' + '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: '#/components/responses/VsmfUpdateError' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: '#/components/responses/VsmfUpdateError' + '504': + $ref: '#/components/responses/VsmfUpdateError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + update-ismf: + '{$request.body#/ismfPduSessionUri}/modify': + post: + summary: Update (initiated by SMF) + tags: + - Individual PDU session (I-SMF) + operationId: ModifyPduSession-ismf + requestBody: + $ref: '#/components/requestBodies/VsmfUpdateRequestBody' + responses: + '200': + $ref: '#/components/responses/VsmfUpdateResponse200' + '204': + description: successful update of a PDU session without content in the response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: '#/components/responses/VsmfUpdateError' + '403': + $ref: '#/components/responses/VsmfUpdateError' + '404': + $ref: '#/components/responses/VsmfUpdateError' + '409': + $ref: '#/components/responses/VsmfUpdateError' + '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: '#/components/responses/VsmfUpdateError' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: '#/components/responses/VsmfUpdateError' + '504': + $ref: '#/components/responses/VsmfUpdateError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + transferMtData: + '{$request.body#/vsmfPduSessionUri}/transfer-mt-data': + post: + summary: Transfer MT Data (by H-SMF) + tags: + - Individual PDU session (V-SMF) + operationId: TransferMtData + requestBody: + description: representation of the content of Transfer MT Data Request + required: true + content: + multipart/related: # message with a binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/TransferMtDataReqData' + binaryMtData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryMtData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: successful transfering of MT data + '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' + '504': + description: unsuccessful delivery of mobile terminated data - gateway timeout + content: + application/json: + schema: + $ref: '#/components/schemas/TransferMtDataError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + transferMtData-ismf: + '{$request.body#/ismfPduSessionUri}/transfer-mt-data': + post: + summary: Transfer MT Data (by SMF) + tags: + - Individual PDU session (I-SMF) + operationId: TransferMtData-ismf + requestBody: + description: representation of the content of Transfer MT Data Request + required: true + content: + multipart/related: # message with a binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/TransferMtDataReqData' + binaryMtData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryMtData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: successful transfering of MT data + '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' + '504': + description: unsuccessful delivery of mobile terminated data - gateway timeout + content: + application/json: + schema: + $ref: '#/components/schemas/TransferMtDataError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + responses: + '201': + description: successful creation of a PDU session + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/PduSessionCreatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/PduSessionCreatedData' + binaryDataN1SmInfoToUe: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoToUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nsmf-pdusession//pdu-sessions/{pduSessionRef} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: '#/components/responses/PduSessionCreateError' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: '#/components/responses/PduSessionCreateError' + '404': + $ref: '#/components/responses/PduSessionCreateError' + '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: '#/components/responses/PduSessionCreateError' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: '#/components/responses/PduSessionCreateError' + '504': + $ref: '#/components/responses/PduSessionCreateError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /pdu-sessions/{pduSessionRef}/modify: + post: + summary: Update (initiated by V-SMF or I-SMF) + tags: + - Individual PDU session (H-SMF or SMF) + operationId: UpdatePduSession + parameters: + - name: pduSessionRef + in: path + description: PDU session reference + required: true + schema: + type: string + requestBody: + description: representation of the updates to apply to the PDU session + required: true + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/HsmfUpdateData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/HsmfUpdateData' + binaryDataN1SmInfoFromUe: + type: string + format: binary + binaryDataUnknownN1SmInfo: + type: string + format: binary + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoFromUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataUnknownN1SmInfo: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + responses: + '200': + description: successful update of a PDU session with content in the response + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/HsmfUpdatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/HsmfUpdatedData' + binaryDataN1SmInfoToUe: + type: string + format: binary + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoToUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + '204': + description: successful update of a PDU session without content in the response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: '#/components/responses/HsmfUpdateError' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: '#/components/responses/HsmfUpdateError' + '404': + $ref: '#/components/responses/HsmfUpdateError' + '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: '#/components/responses/HsmfUpdateError' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: '#/components/responses/HsmfUpdateError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /pdu-sessions/{pduSessionRef}/release: + post: + summary: Release + tags: + - Individual PDU session (H-SMF or SMF) + operationId: ReleasePduSession + parameters: + - name: pduSessionRef + in: path + description: PDU session reference + required: true + schema: + type: string + requestBody: + description: data sent to H-SMF or SMF when releasing the PDU session + required: false + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/ReleaseData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/ReleaseData' + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + + responses: + '200': + description: successful release of a PDU session with content in the response + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/ReleasedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/ReleasedData' + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + '204': + description: successful release of a PDU session + '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' + + /pdu-sessions/{pduSessionRef}/retrieve: + post: + summary: Retrieve + tags: + - Individual PDU session (H-SMF or SMF) + operationId: RetrievePduSession + parameters: + - name: pduSessionRef + in: path + description: PDU session reference + required: true + schema: + type: string + requestBody: + description: representation of the content of the Retrieve Request + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RetrieveData' + responses: + '200': + description: successful information retrieval + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/RetrievedData' + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /pdu-sessions/{pduSessionRef}/transfer-mo-data: + post: + summary: Transfer MO Data + tags: + - Individual PDU session (H-SMF or SMF) + operationId: TransferMoData + parameters: + - name: pduSessionRef + in: path + description: PDU session reference + required: true + schema: + type: string + requestBody: + description: representation of the content of Transfer MO Data Request + required: true + content: + multipart/related: # message with a binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/TransferMoDataReqData' + binaryMoData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryMoData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: successful transfering of MO data + '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' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nsmf-pdusession: Access to the nsmf-pdusession API + + schemas: +# +# STRUCTURED DATA TYPES +# + SmContextCreateData: + description: Data within Create SM Context Request + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + unauthenticatedSupi: + type: boolean + default: false + roamingUeInd: + type: boolean + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + selectedDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + hplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altHplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + servingNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + serviceName: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + requestType: + $ref: '#/components/schemas/RequestType' + n1SmMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + additionalAnType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + presenceInLadn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + perLadnDnnSnssaiInd: + type: boolean + default: false + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + smContextStatusUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + hSmfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + hSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + smfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + additionalHsmfUri: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + additionalHsmfId: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + additionalSmfUri: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + additionalSmfId: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + oldPduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + pduSessionsActivateList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + ueEpsPdnConnection: + $ref: '#/components/schemas/EpsPdnCnxContainer' + hoState: + $ref: '#/components/schemas/HoState' + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + nrfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + anchorSmfFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + additionalAnchorSmfFeatures: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + minItems: 1 + selMode: + $ref: '#/components/schemas/DnnSelectionMode' + backupAmfInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' + minItems: 1 + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + routingIndicator: + type: string + hNwPubKeyId: + type: integer + epsInterworkingInd: + $ref: '#/components/schemas/EpsInterworkingIndication' + indirectForwardingFlag: + type: boolean + directForwardingFlag: + type: boolean + targetId: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/NgRanTargetId' + epsBearerCtxStatus: + $ref: '#/components/schemas/EpsBearerContextStatus' + cpCiotEnabled: + type: boolean + default: false + cpOnlyInd: + type: boolean + default: false + invokeNef: + type: boolean + default: false + maRequestInd: + type: boolean + default: false + maNwUpgradeInd: + type: boolean + default: false + n3gPathSwitchSupportInd: + type: boolean + default: false + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + n2SmInfoExt1: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoTypeExt1: + $ref: '#/components/schemas/N2SmInfoType' + smContextRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smContextSmfPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + smContextSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + smContextSmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + smContextSmfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + smContextSmfBinding: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/SbiBindingLevel' + upCnxState: + $ref: '#/components/schemas/UpCnxState' + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + extendedNasSmTimerInd: + type: boolean + default: false + dlDataWaitingInd: + type: boolean + default: false + ddnFailureSubs: + $ref: '#/components/schemas/DdnFailureSubs' + smfTransferInd: + type: boolean + default: false + oldSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + oldSmContextRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + wAgfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/WAgfInfo' + tngfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TngfInfo' + twifInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TwifInfo' + ranUnchangedInd: + type: boolean + samePcfSelectionInd: + type: boolean + default: false + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + nrfManagementUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nrfDiscoveryUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nrfAccessTokenUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nrfOauth2Required: + type: object + description: 'Map indicating whether the NRF requires Oauth2-based authorization for + accessing its services. The key of the map shall be the name of an NRF service, e.g. + "nnrf-nfm" or "nnrf-disc"' + additionalProperties: + type: boolean + minProperties: 1 + smfBindingInfo: + type: string + pvsInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo' + minItems: 1 + onboardingInd: + type: boolean + default: false + oldPduSessionRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smPolicyNotifyInd: + type: boolean + default: false + pcfUeCallbackInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + upipSupported: + type: boolean + default: false + disasterRoamingInd: + type: boolean + default: false + anchorSmfOauth2Required: + type: boolean + smContextSmfOauth2Required: + type: boolean + geoSatelliteId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GeoSatelliteId' + hrsboAllowedInd: + type: boolean + default: false + estabRejectionInd: + type: boolean + enum: + - true + estabRejectionCause: + $ref: '#/components/schemas/EstablishmentRejectionCause' + sliceAreaRestrictInd: + type: boolean + enum: + - true + qosMonitoringPdSupported: + $ref: '#/components/schemas/QosMonitoringPdSupported' + required: + - servingNfId + - servingNetwork + - anType + - smContextStatusUri + + SmContextCreatedData: + description: Data within Create SM Context Response + type: object + properties: + hSmfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + additionalSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + upCnxState: + $ref: '#/components/schemas/UpCnxState' + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + allocatedEbiList: + type: array + items: + $ref: '#/components/schemas/EbiArpMapping' + minItems: 1 + hoState: + $ref: '#/components/schemas/HoState' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + smfServiceInstanceId: + type: string + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + selectedSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + selectedOldSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + + SmContextUpdateData: + description: Data within Update SM Context Request + type: object + properties: + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + servingNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + backupAmfInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' + minItems: 1 + nullable: true + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + additionalAnType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + anTypeToReactivate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + anTypeOfN1N2Info: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + presenceInLadn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + upCnxState: + $ref: '#/components/schemas/UpCnxState' + hoState: + $ref: '#/components/schemas/HoState' + toBeSwitched: + type: boolean + default: false + failedToBeSwitched: + type: boolean + n1SmMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + targetId: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/NgRanTargetId' + targetServingNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + smContextStatusUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + dataForwarding: + type: boolean + default: false + n9ForwardingTunnel: + $ref: '#/components/schemas/TunnelInfo' + n9DlForwardingTnlList: + type: array + items: + $ref: '#/components/schemas/IndirectDataForwardingTunnelInfo' + minItems: 1 + n9UlForwardingTnlList: + type: array + items: + $ref: '#/components/schemas/IndirectDataForwardingTunnelInfo' + minItems: 1 + n9DlForwardingTunnel: + $ref: '#/components/schemas/TunnelInfo' + n9InactivityTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + epsBearerSetup: + type: array + items: + $ref: '#/components/schemas/EpsBearerContainer' + minItems: 0 + revokeEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + release: + type: boolean + default: false + cause: + $ref: '#/components/schemas/Cause' + ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + 5gMmCauseValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + epsInterworkingInd: + $ref: '#/components/schemas/EpsInterworkingIndication' + anTypeCanBeChanged: + type: boolean + default: false + n2SmInfoExt1: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoTypeExt1: + $ref: '#/components/schemas/N2SmInfoType' + maReleaseInd: + $ref: '#/components/schemas/MaReleaseIndication' + maNwUpgradeInd: + type: boolean + default: false + maRequestInd: + type: boolean + default: false + n3gPathSwitchExecutionInd: + type: boolean + enum: + - true + exemptionInd: + $ref: '#/components/schemas/ExemptionInd' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + moExpDataCounter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter' + extendedNasSmTimerInd: + type: boolean + forwardingFTeid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + forwardingBearerContexts: + type: array + items: + $ref: '#/components/schemas/ForwardingBearerContainer' + minItems: 1 + ddnFailureSubs: + $ref: '#/components/schemas/DdnFailureSubs' + skipN2PduSessionResRelInd: + type: boolean + default: false + secondaryRatUsageDataReportContainer: + type: array + items: + $ref: '#/components/schemas/SecondaryRatUsageDataReportContainer' + minItems: 1 + smPolicyNotifyInd: + type: boolean + enum: + - true + pcfUeCallbackInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + cnBasedMt: + type: boolean + enum: + - true + geoSatelliteId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GeoSatelliteId' + altSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altHplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + nsReplTerminInd: + type: boolean + enum: + - true + sliceAreaRestrictInd: + type: boolean + qosMonitoringPdSupported: + $ref: '#/components/schemas/QosMonitoringPdSupported' + + SmContextUpdatedData: + description: Data within Update SM Context Response + type: object + properties: + upCnxState: + $ref: '#/components/schemas/UpCnxState' + hoState: + $ref: '#/components/schemas/HoState' + releaseEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + allocatedEbiList: + type: array + items: + $ref: '#/components/schemas/EbiArpMapping' + minItems: 1 + modifiedEbiList: + type: array + items: + $ref: '#/components/schemas/EbiArpMapping' + minItems: 1 + n1SmMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + epsBearerSetup: + type: array + items: + $ref: '#/components/schemas/EpsBearerContainer' + minItems: 1 + dataForwarding: + type: boolean + n3DlForwardingTnlList: + type: array + items: + $ref: '#/components/schemas/IndirectDataForwardingTunnelInfo' + minItems: 1 + n3UlForwardingTnlList: + type: array + items: + $ref: '#/components/schemas/IndirectDataForwardingTunnelInfo' + minItems: 1 + n9UlForwardingTunnel: + $ref: '#/components/schemas/TunnelInfo' + cause: + $ref: '#/components/schemas/Cause' + maAcceptedInd: + type: boolean + default: false + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + forwardingFTeid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + forwardingBearerContexts: + type: array + items: + $ref: '#/components/schemas/ForwardingBearerContainer' + minItems: 1 + selectedSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + selectedOldSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + anchorSmfFeatures: + $ref: '#/components/schemas/AnchorSmfFeatures' + + SmContextReleaseData: + description: Data within Release SM Context Request + type: object + properties: + cause: + $ref: '#/components/schemas/Cause' + ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + 5gMmCauseValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + vsmfReleaseOnly: + type: boolean + default: false + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + ismfReleaseOnly: + type: boolean + default: false + + SmContextReleasedData: + description: Data within Release SM Context Response + type: object + properties: + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + + SmContextStatusNotification: + description: Data within Notify SM Context Status Request + type: object + properties: + statusInfo: + $ref: '#/components/schemas/StatusInfo' + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + ddnFailureStatus: + type: boolean + default: false + notifyCorrelationIdsForddnFailure: + type: array + items: + type: string + minItems: 1 + newIntermediateSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + newSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + newSmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + oldSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + oldSmContextRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + altAnchorSmfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + altAnchorSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + targetDnaiInfo: + $ref: '#/components/schemas/TargetDnaiInfo' + oldPduSessionRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + required: + - statusInfo + + PduSessionCreateData: + description: Data within Create Request + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + unauthenticatedSupi: + type: boolean + default: false + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + selectedDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + hplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + vsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ismfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + requestType: + $ref: '#/components/schemas/RequestType' + epsBearerId: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + pgwS8cFteid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + vsmfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ismfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + vcnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + icnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + n9ForwardingTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + additionalCnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + additionalAnType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + n1SmInfoFromUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + unknownN1SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + hPcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + hoPreparationIndication: + type: boolean + selMode: + $ref: '#/components/schemas/DnnSelectionMode' + alwaysOnRequested: + type: boolean + default: false + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + routingIndicator: + type: string + hNwPubKeyId: + type: integer + epsInterworkingInd: + $ref: '#/components/schemas/EpsInterworkingIndication' + vSmfServiceInstanceId: + type: string + iSmfServiceInstanceId: + type: string + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + roamingChargingProfile: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile' + chargingId: + type: string + pattern: '^(0|([1-9]{1}[0-9]{0,9}))$' + smfChargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmfChargingId' + oldPduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + epsBearerCtxStatus: + $ref: '#/components/schemas/EpsBearerContextStatus' + amfNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + maxIntegrityProtectedDataRateUl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + cpCiotEnabled: + type: boolean + default: false + cpOnlyInd: + type: boolean + default: false + invokeNef: + type: boolean + default: false + maRequestInd: + type: boolean + default: false + maNwUpgradeInd: + type: boolean + default: false + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + presenceInLadn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + secondaryRatUsageInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo' + minItems: 1 + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + dlServingPlmnRateCtl: + type: integer + minimum: 10 + upSecurityInfo: + $ref: '#/components/schemas/UpSecurityInfo' + vplmnQos: + $ref: '#/components/schemas/VplmnQos' + oldSmContextRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + redundantPduSessionInfo: + $ref: '#/components/schemas/RedundantPduSessionInformation' + oldPduSessionRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smPolicyNotifyInd: + type: boolean + default: false + pcfUeCallbackInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + upipSupported: + type: boolean + default: false + upCnxState: + $ref: '#/components/schemas/UpCnxState' + disasterRoamingInd: + type: boolean + default: false + hrsboInfo: + $ref: '#/components/schemas/HrsboInfoFromVplmn' + ecsAddrConfigInfos: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/EcsAddrConfigInfo' + minItems: 1 + pduSetSupportInd: + type: boolean + default: false + ecnMarkingCongestionInfoStatus: + type: array + items: + $ref: '#/components/schemas/EcnMarkingCongestionInfoStatus' + minItems: 1 + qosMonitoringPdSupported: + $ref: '#/components/schemas/QosMonitoringPdSupported' + required: + - dnn + - servingNetwork + - anType + oneOf: + - required: [ vsmfId, vsmfPduSessionUri ] + - required: [ ismfId, ismfPduSessionUri ] + + PduSessionCreatedData: + description: Data within Create Response + type: object + properties: + pduSessionType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + sscMode: + type: string + pattern: '^[0-7]$' + hcnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + cnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + additionalCnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + qosFlowsSetupList: + type: array + items: + $ref: '#/components/schemas/QosFlowSetupItem' + minItems: 1 + hSmfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + additionalSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + enablePauseCharging: + type: boolean + default: false + ueIpv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + n1SmInfoToUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + epsPdnCnxInfo: + $ref: '#/components/schemas/EpsPdnCnxInfo' + epsBearerInfo: + type: array + items: + $ref: '#/components/schemas/EpsBearerInfo' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + maxIntegrityProtectedDataRate: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + alwaysOnGranted: + type: boolean + default: false + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + upSecurity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity' + roamingChargingProfile: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile' + hSmfServiceInstanceId: + type: string + smfServiceInstanceId: + type: string + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + ipv6MultiHomingInd: + type: boolean + default: false + maAcceptedInd: + type: boolean + default: false + homeProvidedChargingId: + type: string + pattern: '^(0|([1-9]{1}[0-9]{0,9}))$' + homeProvidedSmfChargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmfChargingId' + nefExtBufSupportInd: + type: boolean + default: false + smallDataRateControlEnabled: + type: boolean + default: false + ueIpv6InterfaceId: + type: string + pattern: '^[A-Fa-f0-9]{16}$' + ipv6Index: + $ref: 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex' + dnAaaAddress: + $ref: '#/components/schemas/IpAddress' + redundantPduSessionInfo: + $ref: '#/components/schemas/RedundantPduSessionInformation' + nspuSupportInd: + type: boolean + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + intraPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + hrsboInfo: + $ref: '#/components/schemas/HrsboInfoFromHplmn' + pendingUpdateInfoList: + type: array + items: + $ref: '#/components/schemas/PendingUpdateInfo' + minItems: 1 + required: + - pduSessionType + - sscMode + oneOf: + - required: [ hSmfInstanceId ] + - required: [ smfInstanceId ] + + HsmfUpdateData: + description: Data within Update Request towards H-SMF, or from I-SMF to SMF + type: object + properties: + requestIndication: + $ref: '#/components/schemas/RequestIndication' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + vcnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + icnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + additionalCnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + additionalAnType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + pauseCharging: + type: boolean + pti: + $ref: '#/components/schemas/ProcedureTransactionId' + n1SmInfoFromUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + unknownN1SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + qosFlowsRelNotifyList: + type: array + items: + $ref: '#/components/schemas/QosFlowItem' + minItems: 1 + qosFlowsVsmfRejectedList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + minItems: 1 + qosFlowsNotifyList: + type: array + items: + $ref: '#/components/schemas/QosFlowNotifyItem' + minItems: 1 + NotifyList: + type: array + items: + $ref: '#/components/schemas/PduSessionNotifyItem' + minItems: 1 +# The attribute name does not follow the naming conventions specified in 3GPP TS 29.501. The attribute name is kept though as defined in the current specification for backward compatibility reason. + epsBearerId: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 0 + hoPreparationIndication: + type: boolean + revokeEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + cause: + $ref: '#/components/schemas/Cause' + ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + 5gMmCauseValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' + alwaysOnRequested: + type: boolean + default: false + epsInterworkingInd: + $ref: '#/components/schemas/EpsInterworkingIndication' + secondaryRatUsageReport: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport' + minItems: 1 + secondaryRatUsageInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo' + minItems: 1 + anTypeCanBeChanged: + type: boolean + default: false + maReleaseInd: + $ref: '#/components/schemas/MaReleaseIndication' + maNwUpgradeInd: + type: boolean + default: false + maRequestInd: + type: boolean + default: false + unavailableAccessInd: + $ref: '#/components/schemas/UnavailableAccessIndication' + psaInfo: + type: array + items: + $ref: '#/components/schemas/PsaInformation' + minItems: 1 + ulclBpInfo: + $ref: '#/components/schemas/UlclBpInformation' + n4Info: + $ref: '#/components/schemas/N4Information' + n4InfoExt1: + $ref: '#/components/schemas/N4Information' + n4InfoExt2: + $ref: '#/components/schemas/N4Information' + presenceInLadn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + vsmfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + vsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + vSmfServiceInstanceId: + type: string + ismfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ismfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + iSmfServiceInstanceId: + type: string + dlServingPlmnRateCtl: + type: integer + minimum: 10 + nullable: true + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + roamingChargingProfile: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile' + moExpDataCounter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter' + vplmnQos: + $ref: '#/components/schemas/VplmnQos' + securityResult: + $ref: '#/components/schemas/SecurityResult' + upSecurityInfo: + $ref: '#/components/schemas/UpSecurityInfo' + amfNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + secondaryRatUsageDataReportContainer: + type: array + items: + $ref: '#/components/schemas/SecondaryRatUsageDataReportContainer' + minItems: 1 + smPolicyNotifyInd: + type: boolean + enum: + - true + pcfUeCallbackInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + maxIntegrityProtectedDataRateUl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + upCnxState: + $ref: '#/components/schemas/UpCnxState' + ecsAddrConfigInfos: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/EcsAddrConfigInfo' + minItems: 1 + hrsboInfo: + $ref: '#/components/schemas/HrsboInfoFromVplmn' + altSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + nsReplTerminInd: + type: boolean + enum: + - true + disasterRoamingInd: + type: boolean + enum: + - true + pduSetSupportInd: + type: boolean + ecnMarkingCongestionInfoStatus: + type: array + items: + $ref: '#/components/schemas/EcnMarkingCongestionInfoStatus' + minItems: 1 + qosMonitoringPdSupported: + $ref: '#/components/schemas/QosMonitoringPdSupported' + required: + - requestIndication + + HsmfUpdatedData: + description: Data within Update Response from H-SMF, or from SMF to I-SMF + type: object + properties: + n1SmInfoToUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n4Info: + $ref: '#/components/schemas/N4Information' + n4InfoExt1: + $ref: '#/components/schemas/N4Information' + n4InfoExt2: + $ref: '#/components/schemas/N4Information' + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + roamingChargingProfile: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile' + homeProvidedChargingId: + type: string + pattern: '^(0|([1-9]{1}[0-9]{0,9}))$' + homeProvidedSmfChargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmfChargingId' + upSecurity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity' + maxIntegrityProtectedDataRateUl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + ipv6MultiHomingInd: + type: boolean + default: false + qosFlowsSetupList: + type: array + items: + $ref: '#/components/schemas/QosFlowSetupItem' + minItems: 1 + sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + epsPdnCnxInfo: + $ref: '#/components/schemas/EpsPdnCnxInfo' + epsBearerInfo: + type: array + items: + $ref: '#/components/schemas/EpsBearerInfo' + minItems: 1 + pti: + $ref: '#/components/schemas/ProcedureTransactionId' + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + intraPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + hrsboInfo: + $ref: '#/components/schemas/HrsboInfoFromHplmn' + + ReleaseData: + description: Data within Release Request + type: object + properties: + cause: + $ref: '#/components/schemas/Cause' + ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + 5gMmCauseValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + secondaryRatUsageReport: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport' + minItems: 1 + secondaryRatUsageInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo' + minItems: 1 + n4Info: + $ref: '#/components/schemas/N4Information' + n4InfoExt1: + $ref: '#/components/schemas/N4Information' + n4InfoExt2: + $ref: '#/components/schemas/N4Information' + + ReleasedData: + description: Data within Release Response + type: object + properties: + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + n4Info: + $ref: '#/components/schemas/N4Information' + n4InfoExt1: + $ref: '#/components/schemas/N4Information' + n4InfoExt2: + $ref: '#/components/schemas/N4Information' + + VsmfUpdateData: + description: Data within Update Request towards V-SMF, or from SMF to I-SMF + type: object + properties: + requestIndication: + $ref: '#/components/schemas/RequestIndication' + sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + qosFlowsAddModRequestList: + type: array + items: + $ref: '#/components/schemas/QosFlowAddModifyRequestItem' + minItems: 1 + qosFlowsRelRequestList: + type: array + items: + $ref: '#/components/schemas/QosFlowReleaseRequestItem' + minItems: 1 + epsBearerInfo: + type: array + items: + $ref: '#/components/schemas/EpsBearerInfo' + minItems: 1 + assignEbiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + revokeEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + modifiedEbiList: + type: array + items: + $ref: '#/components/schemas/EbiArpMapping' + minItems: 1 + pti: + $ref: '#/components/schemas/ProcedureTransactionId' + n1SmInfoToUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + alwaysOnGranted: + type: boolean + default: false + hsmfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + newSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + newSmfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + cause: + $ref: '#/components/schemas/Cause' + n1smCause: + type: string + backOffTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + maReleaseInd: + $ref: '#/components/schemas/MaReleaseIndication' + maAcceptedInd: + type: boolean + default: false + additionalCnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + n4Info: + $ref: '#/components/schemas/N4Information' + n4InfoExt1: + $ref: '#/components/schemas/N4Information' + n4InfoExt2: + $ref: '#/components/schemas/N4Information' + n4InfoExt3: + $ref: '#/components/schemas/N4Information' + smallDataRateControlEnabled: + type: boolean + qosMonitoringInfo: + $ref: '#/components/schemas/QosMonitoringInfo' + epsPdnCnxInfo: + $ref: '#/components/schemas/EpsPdnCnxInfo' + n9DataForwardingInd: + type: boolean + default: false + n9InactivityTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + hrsboInfo: + $ref: '#/components/schemas/HrsboInfoFromHplmn' + altHplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + pduSessionRetainInd: + type: boolean + enum: + - true + pendingUpdateInfoList: + type: array + items: + $ref: '#/components/schemas/PendingUpdateInfo' + required: + - requestIndication + + VsmfUpdatedData: + description: Data within Update Response from V-SMF, or from I-SMF to SMF + type: object + properties: + qosFlowsAddModList: + type: array + items: + $ref: '#/components/schemas/QosFlowItem' + minItems: 1 + qosFlowsRelList: + type: array + items: + $ref: '#/components/schemas/QosFlowItem' + minItems: 1 + qosFlowsFailedtoAddModList: + type: array + items: + $ref: '#/components/schemas/QosFlowItem' + minItems: 1 + qosFlowsVsmfRejectedAddModList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + minItems: 1 + qosFlowsFailedtoRelList: + type: array + items: + $ref: '#/components/schemas/QosFlowItem' + minItems: 1 + n1SmInfoFromUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + unknownN1SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + assignedEbiList: + type: array + items: + $ref: '#/components/schemas/EbiArpMapping' + minItems: 1 + failedToAssignEbiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + releasedEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + secondaryRatUsageReport: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport' + minItems: 1 + secondaryRatUsageInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo' + minItems: 1 + n4Info: + $ref: '#/components/schemas/N4Information' + n4InfoExt1: + $ref: '#/components/schemas/N4Information' + n4InfoExt2: + $ref: '#/components/schemas/N4Information' + n4InfoExt3: + $ref: '#/components/schemas/N4Information' + modifiedEbiListNotDelivered: + type: boolean + ecnMarkingCongestionInfoStatus: + type: array + items: + $ref: '#/components/schemas/EcnMarkingCongestionInfoStatus' + minItems: 1 + pduSetSupportInd: + type: boolean + qosMonitoringPdSupported: + $ref: '#/components/schemas/QosMonitoringPdSupported' + + StatusNotification: + description: Data within Notify Status Request + type: object + properties: + statusInfo : + $ref: '#/components/schemas/StatusInfo' + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + targetDnaiInfo: + $ref: '#/components/schemas/TargetDnaiInfo' + oldPduSessionRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + newSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + epsPdnCnxInfo: + $ref: '#/components/schemas/EpsPdnCnxInfo' + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + intraPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + required: + - statusInfo + + QosFlowItem: + description: Individual QoS flow + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + cause: + $ref: '#/components/schemas/Cause' + currentQosProfileIndex: + type: integer + minimum: 1 + maximum: 8 + nullQoSProfileIndex: + type: boolean + ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + required: + - qfi + + QosFlowSetupItem: + description: Individual QoS flow to setup + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + qosRules: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + protocDesc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + ebi: + $ref: '#/components/schemas/EpsBearerId' + qosFlowDescription: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + qosFlowProfile: + $ref: '#/components/schemas/QosFlowProfile' + associatedAnType: + $ref: '#/components/schemas/QosFlowAccessType' + defaultQosRuleInd: + type: boolean + ecnMarkingCongestInfoReq: + $ref: '#/components/schemas/EcnMarkingCongestionInfoReq' + required: + - qfi + - qosRules + + QosFlowAddModifyRequestItem: + description: Individual QoS flow requested to be created or modified + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + ebi: + $ref: '#/components/schemas/EpsBearerId' + qosRules: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + protocDesc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + qosFlowDescription: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + qosFlowProfile: + $ref: '#/components/schemas/QosFlowProfile' + associatedAnType: + $ref: '#/components/schemas/QosFlowAccessType' + ecnMarkingCongestInfoReq: + $ref: '#/components/schemas/EcnMarkingCongestionInfoReq' + tscaiUl: + $ref: '#/components/schemas/TscAssistanceInformation' + tscaiDl: + $ref: '#/components/schemas/TscAssistanceInformation' + required: + - qfi + + QosFlowReleaseRequestItem: + description: Individual QoS flow requested to be released + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + qosRules: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + qosFlowDescription: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + required: + - qfi + + QosFlowProfile: + description: QoS flow profile + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + nonDynamic5Qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NonDynamic5Qi' + dynamic5Qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dynamic5Qi' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + gbrQosFlowInfo: + $ref: '#/components/schemas/GbrQosFlowInformation' + rqa: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReflectiveQoSAttribute' + additionalQosFlowInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AdditionalQosFlowInfo' + qosMonitoringReq: + $ref: '#/components/schemas/QosMonitoringReq' + qosRepPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + pduSetQosDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' + pduSetQosUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' + required: + - 5qi + + GbrQosFlowInformation: + description: GBR QoS flow information + type: object + properties: + maxFbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxFbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + guaFbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + guaFbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + notifControl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationControl' + maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + maxPacketLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + alternativeQosProfileList: + type: array + items: + $ref: '#/components/schemas/AlternativeQosProfile' + required: + - maxFbrDl + - maxFbrUl + - guaFbrDl + - guaFbrUl + + QosFlowNotifyItem: + description: Notification related to a QoS flow + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + notificationCause: + $ref: '#/components/schemas/NotificationCause' + currentQosProfileIndex: + type: integer + minimum: 1 + maximum: 8 + nullQoSProfileIndex: + type: boolean + required: + - qfi + - notificationCause + + + SmContextRetrieveData: + description: Data within Retrieve SM Context Request + type: object + properties: + targetMmeCap: + $ref: '#/components/schemas/MmeCapabilities' + smContextType: + $ref: '#/components/schemas/SmContextType' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + notToTransferEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + ranUnchangedInd: + type: boolean + default: false + hrsboSupportInd: + type: boolean + default: false + storedOffloadIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OffloadIdentifier' + minItems: 1 + + SmContextRetrievedData: + description: Data within Retrieve SM Context Response + type: object + properties: + ueEpsPdnConnection: + $ref: '#/components/schemas/EpsPdnCnxContainer' + smContext: + $ref: '#/components/schemas/SmContext' + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + dlDataWaitingInd: + type: boolean + default: false + afCoordinationInfo: + $ref: '#/components/schemas/AfCoordinationInfo' + required: + - ueEpsPdnConnection + + MmeCapabilities: + description: MME capabilities + type: object + properties: + nonIpSupported: + type: boolean + default: false + ethernetSupported: + type: boolean + default: false + upipSupported: + type: boolean + default: false + + TunnelInfo: + description: Tunnel Information + type: object + properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + gtpTeid: + $ref: '#/components/schemas/Teid' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - gtpTeid + + StatusInfo: + description: Status of SM context or of PDU session + type: object + properties: + resourceStatus: + $ref: '#/components/schemas/ResourceStatus' + cause: + $ref: '#/components/schemas/Cause' + remoteError: + type: boolean + cnAssistedRanPara: + $ref: '#/components/schemas/CnAssistedRanPara' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - resourceStatus + + + EpsPdnCnxInfo: + description: EPS PDN Connection Information from H-SMF to V-SMF, or from SMF to I-SMF + type: object + properties: + pgwS8cFteid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + pgwNodeName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + pgwChangeInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + linkedBearerId: + $ref: '#/components/schemas/EpsBearerId' + required: + - pgwS8cFteid + + EpsBearerInfo: + description: EPS Bearer Information from H-SMF to V-SMF, or from SMF to I-SMF + type: object + properties: + ebi: + $ref: '#/components/schemas/EpsBearerId' + pgwS8uFteid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + bearerLevelQoS: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + required: + - ebi + - pgwS8uFteid + - bearerLevelQoS + + PduSessionNotifyItem: + description: Notification related to a PDU session + type: object + properties: + notificationCause: + $ref: '#/components/schemas/NotificationCause' + required: + - notificationCause + + EbiArpMapping: + description: EBI to ARP mapping + type: object + properties: + epsBearerId: + $ref: '#/components/schemas/EpsBearerId' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + required: + - epsBearerId + - arp + + SmContextCreateError: + description: Error within Create SM Context Response + type: object + properties: + error: + $ref: '#/components/schemas/ExtProblemDetails' + n1SmMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - error + + SmContextUpdateError: + description: Error within Update SM Context Response + type: object + properties: + error: + $ref: '#/components/schemas/ExtProblemDetails' + n1SmMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + upCnxState: + $ref: '#/components/schemas/UpCnxState' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - error + + PduSessionCreateError: + description: Error within Create Response + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + n1smCause: + type: string + pattern: '^[A-F0-9]{2}$' + n1SmInfoToUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + backOffTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - error + + HsmfUpdateError: + description: Error within Update Response from H-SMF, or from SMF to I-SMF + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + pti: + $ref: '#/components/schemas/ProcedureTransactionId' + n1smCause: + type: string + pattern: '^[A-F0-9]{2}$' + n1SmInfoToUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + backOffTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - error + + VsmfUpdateError: + description: Error within Update Response from V-SMF, or from I-SMF to SMF + type: object + properties: + error: + $ref: '#/components/schemas/ExtProblemDetails' + pti: + $ref: '#/components/schemas/ProcedureTransactionId' + n1smCause: + type: string + pattern: '^[A-F0-9]{2}$' + n1SmInfoFromUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + unknownN1SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + failedToAssignEbiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + 5gMmCauseValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + n4Info: + $ref: '#/components/schemas/N4Information' + n4InfoExt1: + $ref: '#/components/schemas/N4Information' + n4InfoExt2: + $ref: '#/components/schemas/N4Information' + n4InfoExt3: + $ref: '#/components/schemas/N4Information' + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + required: + - error + + SmContext: + description: Complete SM Context + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + selectedDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + hplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altHplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + pduSessionType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + hSmfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + pduSessionRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + intraPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + selMode: + $ref: '#/components/schemas/DnnSelectionMode' + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + routingIndicator: + type: string + hNwPubKeyId: + type: integer + sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + qosFlowsList: + type: array + items: + $ref: '#/components/schemas/QosFlowSetupItem' + minItems: 1 + hSmfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pduSessionSmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + pduSessionSmfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + pduSessionSmfBinding: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/SbiBindingLevel' + enablePauseCharging: + type: boolean + default: false + ueIpv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + epsPdnCnxInfo: + $ref: '#/components/schemas/EpsPdnCnxInfo' + epsBearerInfo: + type: array + items: + $ref: '#/components/schemas/EpsBearerInfo' + minItems: 1 + maxIntegrityProtectedDataRate: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + alwaysOnGranted: + type: boolean + default: false + upSecurity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity' + hSmfServiceInstanceId: + type: string + smfServiceInstanceId: + type: string + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + forwardingInd: + type: boolean + default: false + psaTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + chargingId: + type: string + pattern: '^(0|([1-9]{1}[0-9]{0,9}))$' + smfChargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmfChargingId' + chargingInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ChargingInformation' + roamingChargingProfile: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile' + nefExtBufSupportInd: + type: boolean + default: false + ipv6Index: + $ref: 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex' + dnAaaAddress: + $ref: '#/components/schemas/IpAddress' + redundantPduSessionInfo: + $ref: '#/components/schemas/RedundantPduSessionInformation' + ranTunnelInfo: + $ref: '#/components/schemas/QosFlowTunnel' + addRanTunnelInfo: + type: array + items: + $ref: '#/components/schemas/QosFlowTunnel' + minItems: 1 + redRanTunnelInfo: + $ref: '#/components/schemas/QosFlowTunnel' + addRedRanTunnelInfo: + type: array + items: + $ref: '#/components/schemas/QosFlowTunnel' + minItems: 1 + nspuSupportInd: + type: boolean + smfBindingInfo: + type: string + satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + sscMode: + type: string + pattern: '^[0-7]$' + dlsetSupportInd: + type: boolean + n9fscSupportInd: + type: boolean + anchorSmfOauth2Required: + type: boolean + fullDnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + hrsboAuthReqInd: + type: boolean + hDnsAddr: + $ref: '#/components/schemas/IpAddress' + hPlmnAddr: + $ref: '#/components/schemas/IpAddress' + vplmnOffloadingInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnOffloadingInfo' + minItems: 1 + vplmnDlAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnDlAmbr' + offloadIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OffloadIdentifier' + minItems: 1 + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + trafficInfluInfo: + $ref: '#/components/schemas/TrafficInfluenceInfo' + pendingUpdateInfoList: + type: array + items: + $ref: '#/components/schemas/PendingUpdateInfo' + minItems: 1 + easInfoToRefresh: + $ref: '#/components/schemas/EasInfoToRefresh' + required: + - pduSessionId + - dnn + - sNssai + - pduSessionType + - sessionAmbr + - qosFlowsList + + ExemptionInd: + description: Exemption Indication + type: object + properties: + dnnCongestion: + type: boolean + default: false + snssaiOnlyCongestion: + type: boolean + default: false + snssaiDnnCongestion: + type: boolean + default: false + + PsaInformation: + description: PSA Information + type: object + properties: + psaInd: + $ref: '#/components/schemas/PsaIndication' + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + ueIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + psaUpfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + + DnaiInformation: + description: DNAI Information + type: object + properties: + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + noDnaiChangeInd: + type: boolean + noLocalPsaChangeInd: + type: boolean + required: + - dnai + + N4Information: + description: N4 Information + type: object + properties: + n4MessageType: + $ref: '#/components/schemas/N4MessageType' + n4MessagePayload: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n4DnaiInfo: + $ref: '#/components/schemas/DnaiInformation' + psaUpfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ulClBpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + n9UlPdrIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + minItems: 1 + required: + - n4MessageType + - n4MessagePayload + + IndirectDataForwardingTunnelInfo: + description: Indirect Data Forwarding Tunnel Information + type: object + properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + gtpTeid: + $ref: '#/components/schemas/Teid' + drbId: + $ref: '#/components/schemas/DrbId' + additionalTnlNb: + $ref: '#/components/schemas/AdditionalTnlNb' + required: + - gtpTeid + not: + required: [ drbId, additionalTnlNb ] + + SendMoDataReqData: + description: Data within Send MO Data Request + type: object + properties: + moData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + moExpDataCounter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + required: + - moData + + CnAssistedRanPara: + description: SMF derived CN assisted RAN parameters tuning + type: object + properties: + stationaryIndication: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StationaryIndication' + communicationDurationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + periodicTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + scheduledCommunicationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime' + scheduledCommunicationType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationType' + trafficProfile: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficProfile' + batteryIndication: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BatteryIndication' + + UlclBpInformation: + description: UL CL or BP Information + type: object + properties: + ulclBpUpfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + + TransferMoDataReqData: + description: Data within Transfer MO Data Request + type: object + properties: + moData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + moExpDataCounter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + required: + - moData + + TransferMtDataReqData: + description: Data within Transfer MT Data Request + type: object + properties: + mtData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + required: + - mtData + + TransferMtDataError: + description: Transfer MT Data Error Response + allOf: + - $ref: '#/components/schemas/ExtProblemDetails' + - $ref: '#/components/schemas/TransferMtDataAddInfo' + + TransferMtDataAddInfo: + description: Transfer MT Data Error Response Additional Information + type: object + properties: + maxWaitingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + + VplmnQos: + description: VPLMN QoS + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + maxFbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxFbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + guaFbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + guaFbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + 5qiPL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel' + + DdnFailureSubs: + description: DDN Failure Subscription + type: object + properties: + ddnFailureSubsInd: + type: boolean + default: false + ddnFailureSubsInfoList: + type: array + items: + $ref: '#/components/schemas/DdnFailureSubInfo' + minItems: 1 + + DdnFailureSubInfo: + description: DDN Failure Subscription Information + type: object + required: + - notifyCorrelationId + properties: + notifyCorrelationId: + type: string + dddTrafficDescriptorList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + minItems: 1 + + RetrieveData: + description: Data within Retrieve Request + type: object + properties: + smallDataRateStatusReq: + type: boolean + default: false + pduSessionContextType: + $ref: '#/components/schemas/PduSessionContextType' + + RetrievedData: + description: Data within Retrieve Response + type: object + properties: + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + afCoordinationInfo: + $ref: '#/components/schemas/AfCoordinationInfo' + + SecurityResult: + description: Security Result + type: object + properties: + integrityProtectionResult: + $ref: '#/components/schemas/ProtectionResult' + confidentialityProtectionResult: + $ref: '#/components/schemas/ProtectionResult' + + UpSecurityInfo: + description: User Plane Security Information + type: object + properties: + upSecurity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity' + maxIntegrityProtectedDataRateUl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + securityResult: + $ref: '#/components/schemas/SecurityResult' + required: + - upSecurity + + AlternativeQosProfile: + description: Alternative QoS Profile + type: object + properties: + index: + type: integer + minimum: 1 + maximum: 8 + guaFbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + guaFbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + packetDelayBudget: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + packetErrRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + maxDataBurstVol: + type: integer + minimum: 1 + maximum: 2000000 + required: + - index + + ExtProblemDetails: + description: Extended Problem Details + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ProblemDetailsAddInfo' + + ProblemDetailsAddInfo: + description: Problem Details Additional Information + type: object + properties: + remoteError: + type: boolean + + QosMonitoringInfo: + description: QoS Monitoring Information + type: object + properties: + qosMonitoringInd: + type: boolean + default: false + + IpAddress: + description: IP Address + type: object + oneOf: + - required: + - ipv4Addr + - required: + - ipv6Addr + - required: + - ipv6Prefix + properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + + RedundantPduSessionInformation: + description: Redundant PDU Session Information + type: object + properties: + rsn: + $ref: '#/components/schemas/Rsn' + pduSessionPairId: + type: integer + minimum: 0 + maximum: 255 + required: + - rsn + + QosFlowTunnel: + description: Tunnel Information per QoS Flow + type: object + properties: + qfiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + minItems: 1 + tunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + required: + - qfiList + - tunnelInfo + + TargetDnaiInfo: + description: Target DNAI Information + type: object + properties: + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + smfSelectionType: + $ref: '#/components/schemas/SmfSelectionType' + required: + - smfSelectionType + + AfCoordinationInfo: + description: AF Coordination Information + type: object + properties: + sourceDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + sourceUeIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + sourceUeIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + notificationInfoList: + type: array + items: + $ref: '#/components/schemas/NotificationInfo' + minItems: 1 + + NotificationInfo: + description: > + Notification Correlation ID and Notification URI provided by the NF service consumer + type: object + properties: + notifId: + type: string + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + upBufferInd: + type: boolean + default: false + required: + - notifId + - notifUri + + AnchorSmfFeatures: + description: Anchor SMF supported features + type: object + properties: + psetrSupportInd: + type: boolean + + HrsboInfoFromVplmn: + description: HR-SBO Information in request message + type: object + properties: + hrsboAuthReqInd: + type: boolean + enum: + - true + vEasdfAddr: + $ref: '#/components/schemas/IpAddress' + localDnsAddr: + $ref: '#/components/schemas/IpAddress' + easRediscoveryInd: + type: boolean + enum: + - true + easInfoToRefresh: + $ref: '#/components/schemas/EasInfoToRefresh' + storedOffloadIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OffloadIdentifier' + minItems: 1 + easIpReplSupportInd: + type: boolean + default: false + vEasdfSecurityInfo: + type: array + items: + $ref: '#/components/schemas/DnsServerSecurityInformation' + minItems: 1 + localDnsSecurityInfo: + type: array + items: + $ref: '#/components/schemas/DnsServerSecurityInformation' + minItems: 1 + + HrsboInfoFromHplmn: + description: HR-SBO Information in response message + type: object + properties: + hrsboAuthResult: + type: boolean + hDnsAddr: + $ref: '#/components/schemas/IpAddress' + hPlmnAddr: + $ref: '#/components/schemas/IpAddress' + vplmnOffloadingInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnOffloadingInfo' + vplmnDlAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnDlAmbr' + offloadIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OffloadIdentifier' + internalGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + trafficInfluInfo: + $ref: '#/components/schemas/TrafficInfluenceInfo' + + EasInfoToRefresh: + description: EAS information to be refreshed for EAS re-discovery + type: object + properties: + ipv4AddressRanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6AddressRanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6AddressRange' + minItems: 1 + fqdnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + + EcnMarkingCongestionInfoReq: + description: ECN Marking or Congestion Information Request + type: object + properties: + ecnMarkingRanReq: + $ref: '#/components/schemas/EcnMarkingReq' + ecnMarkingUpfReq: + $ref: '#/components/schemas/EcnMarkingReq' + congestionInfoReq: + $ref: '#/components/schemas/CongestionInfoReq' + oneOf: + - required: [ ecnMarkingRanReq ] + - required: [ ecnMarkingUpfReq ] + - required: [ congestionInfoReq ] + + EcnMarkingCongestionInfoStatus: + description: ECN Marking or Congestion Information Status + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + activationStatus: + $ref: '#/components/schemas/ActivationStatus' + required: + - qfi + - activationStatus + + TscAssistanceInformation: + description: TSC Assistance Information + type: object + properties: + periodicity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + n6JitterInformation: + $ref: '#/components/schemas/N6JitterInformation' + + N6JitterInformation: + description: Jitter information associated with the Periodicity in downlink + type: object + properties: + lowerJitterInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Int32' + higherJitterInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Int32' + + TrafficInfluenceInfo: + description: Traffic influence information applicable at the VPLMN for an HR-SBO PDU session + type: object + properties: + traffInfluData: + type: array + items: + $ref: '#/components/schemas/TrafficInfluenceData' + minItems: 1 + traffContDecs: + type: object + 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. + additionalProperties: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/TrafficControlData' + minProperties: 1 + + TrafficInfluenceData: + description: > + Traffic influence data comprising the Service Data Flow description and the Application + Function influence on traffic routing Enforcement Control parameters of a PCC rule. + type: object + properties: + flowInfos: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/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. + precedence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + 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 of 3GPP TS 29.512 [30]. + + +# +# SIMPLE DATA TYPES +# + ProcedureTransactionId: + description: Procedure Transaction Identifier + type: integer + minimum: 0 + maximum: 255 + + EpsBearerId: + description: EPS Bearer Identifier + type: integer + minimum: 0 + maximum: 15 + + EpsPdnCnxContainer: + description: UE EPS PDN Connection container from SMF to AMF + type: string + format: byte + + EpsBearerContainer: + description: EPS Bearer container from SMF to AMF + type: string + format: byte + + Teid: + type: string + description: GTP Tunnel Endpoint Identifier + pattern: '^[A-Fa-f0-9]{8}$' + + EpsBearerContextStatus: + description: EPS bearer context status + type: string + pattern: '^[A-Fa-f0-9]{4}$' + + DrbId: + description: Data Radio Bearer Identity + type: integer + minimum: 1 + maximum: 32 + + AdditionalTnlNb: + description: indicates first, second or third additional indirect data forwarding tunnel + type: integer + minimum: 1 + maximum: 3 + + ForwardingBearerContainer: + description: Forwarding Bearer Container + type: string + format: byte + + SecondaryRatUsageDataReportContainer: + description: Secondary Rat Usage Data Report Container + type: string + format: byte + + DnsServerSecurityInformation: + description: DNS server security information + type: string + format: byte + +# +# ENUMERATIONS +# + UpCnxState: + anyOf: + - type: string + enum: + - ACTIVATED + - DEACTIVATED + - ACTIVATING + - SUSPENDED + - 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: | + User Plane Connection State. Possible values are + - ACTIVATED + - DEACTIVATED + - ACTIVATING + - SUSPENDED + + HoState: + anyOf: + - type: string + enum: + - NONE + - PREPARING + - PREPARED + - COMPLETED + - CANCELLED + - 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: | + Handover state. Possible values are + - NONE + - PREPARING + - PREPARED + - COMPLETED + - CANCELLED + + RequestType: + anyOf: + - type: string + enum: + - INITIAL_REQUEST + - EXISTING_PDU_SESSION + - INITIAL_EMERGENCY_REQUEST + - EXISTING_EMERGENCY_PDU_SESSION + - 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: | + Request Type in Create (SM context) service operation. Possible values are + - INITIAL_REQUEST + - EXISTING_PDU_SESSION + - INITIAL_EMERGENCY_REQUEST + - EXISTING_EMERGENCY_PDU_SESSION + + RequestIndication: + anyOf: + - type: string + enum: + - UE_REQ_PDU_SES_MOD + - UE_REQ_PDU_SES_REL + - PDU_SES_MOB + - NW_REQ_PDU_SES_AUTH + - NW_REQ_PDU_SES_MOD + - NW_REQ_PDU_SES_REL + - EBI_ASSIGNMENT_REQ + - REL_DUE_TO_5G_AN_REQUEST + - 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: | + Request Indication in Update (SM context) service operation. Possible values are + - UE_REQ_PDU_SES_MOD + - UE_REQ_PDU_SES_REL + - PDU_SES_MOB + - NW_REQ_PDU_SES_AUTH + - NW_REQ_PDU_SES_MOD + - NW_REQ_PDU_SES_REL + - EBI_ASSIGNMENT_REQ + - REL_DUE_TO_5G_AN_REQUEST + + NotificationCause: + anyOf: + - type: string + enum: + - QOS_FULFILLED + - QOS_NOT_FULFILLED + - UP_SEC_FULFILLED + - UP_SEC_NOT_FULFILLED + - 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: | + Cause for generating a notification. Possible values are + - QOS_FULFILLED + - QOS_NOT_FULFILLED + - UP_SEC_FULFILLED + - UP_SEC_NOT_FULFILLED + + Cause: + anyOf: + - type: string + enum: + - REL_DUE_TO_HO + - EPS_FALLBACK + - REL_DUE_TO_UP_SEC + - DNN_CONGESTION + - S_NSSAI_CONGESTION + - REL_DUE_TO_REACTIVATION + - 5G_AN_NOT_RESPONDING + - REL_DUE_TO_SLICE_NOT_AVAILABLE + - REL_DUE_TO_DUPLICATE_SESSION_ID + - PDU_SESSION_STATUS_MISMATCH + - HO_FAILURE + - INSUFFICIENT_UP_RESOURCES + - PDU_SESSION_HANDED_OVER + - PDU_SESSION_RESUMED + - CN_ASSISTED_RAN_PARAMETER_TUNING + - ISMF_CONTEXT_TRANSFER + - SMF_CONTEXT_TRANSFER + - REL_DUE_TO_PS_TO_CS_HO + - REL_DUE_TO_SUBSCRIPTION_CHANGE + - HO_CANCEL + - REL_DUE_TO_SLICE_NOT_AUTHORIZED + - PDU_SESSION_HAND_OVER_FAILURE + - DDN_FAILURE_STATUS + - REL_DUE_TO_CP_ONLY_NOT_APPLICABLE + - NOT_SUPPORTED_WITH_ISMF + - CHANGED_ANCHOR_SMF + - CHANGED_INTERMEDIATE_SMF + - TARGET_DNAI_NOTIFICATION + - REL_DUE_TO_VPLMN_QOS_FAILURE + - REL_DUE_TO_SMF_NOT_SUPPORT_PSETR + - REL_DUE_TO_SNPN_SNPN_MOBILITY + - REL_DUE_TO_NO_HR_AGREEMENT + - REL_DUE_TO_UNSPECIFIED_REASON + - REL_DUE_TO_MOB_ACCESS_RESTRICTIONS + - REL_DUE_TO_SLICE_INACTIVITY + - REL_DUE_TO_NSI_NOT_AVAILABLE + - REL_DUE_TO_DNN_DENIED + - REL_DUE_TO_PDUTYPE_DENIED + - REL_DUE_TO_SSC_DENIED + - REL_DUE_TO_SUBSCRIPTION_DENIED + - REL_DUE_TO_DNN_NOT_SUPPORTED + - REL_DUE_TO_PDUTYPE_NOT_SUPPORTED + - REL_DUE_TO_SSC_NOT_SUPPORTED + - REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE + - REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE_DNN + - REL_DUE_TO_DNN_CONGESTION + - REL_DUE_TO_S_NSSAI_CONGESTION + - REL_DUE_TO_PEER_NOT_RESPONDING + - REL_DUE_TO_NETWORK_FAILURE + - REL_DUE_TO_UPF_NOT_RESPONDING + - REL_DUE_TO_NO_EPS_5GS_CONTINUITY + - REL_DUE_TO_NOT_SUPPORTED_WITH_ISMF + - REL_DUE_TO_EXCEEDED_UE_SLICE_DATA_RATE + - REL_DUE_TO_EXCEEDED_SLICE_DATA_RATE + - REL_DUE_TO_CONTEXT_NOT_FOUND + - REL_DUE_TO_MBSR_NOT_AUTHORIZED + - DEACT_DUE_TO_UE_OUT_OF_SLICE_SUPPORT_AREA + - REJECT_DUE_TO_N1_SM_ERROR + - REL_DUE_TO_DUPLICATE_SESSION_EPDG + - 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: | + Cause information. Possible values are + - REL_DUE_TO_HO + - EPS_FALLBACK + - REL_DUE_TO_UP_SEC + - DNN_CONGESTION + - S_NSSAI_CONGESTION + - REL_DUE_TO_REACTIVATION + - 5G_AN_NOT_RESPONDING + - REL_DUE_TO_SLICE_NOT_AVAILABLE + - REL_DUE_TO_DUPLICATE_SESSION_ID + - PDU_SESSION_STATUS_MISMATCH + - HO_FAILURE + - INSUFFICIENT_UP_RESOURCES + - PDU_SESSION_HANDED_OVER + - PDU_SESSION_RESUMED + - CN_ASSISTED_RAN_PARAMETER_TUNING + - ISMF_CONTEXT_TRANSFER + - SMF_CONTEXT_TRANSFER + - REL_DUE_TO_PS_TO_CS_HO + - REL_DUE_TO_SUBSCRIPTION_CHANGE + - HO_CANCEL + - REL_DUE_TO_SLICE_NOT_AUTHORIZED + - PDU_SESSION_HAND_OVER_FAILURE + - DDN_FAILURE_STATUS + - REL_DUE_TO_CP_ONLY_NOT_APPLICABLE + - NOT_SUPPORTED_WITH_ISMF + - CHANGED_ANCHOR_SMF + - CHANGED_INTERMEDIATE_SMF + - TARGET_DNAI_NOTIFICATION + - REL_DUE_TO_VPLMN_QOS_FAILURE + - REL_DUE_TO_SMF_NOT_SUPPORT_PSETR + - REL_DUE_TO_SNPN_SNPN_MOBILITY + - REL_DUE_TO_NO_HR_AGREEMENT + - REL_DUE_TO_UNSPECIFIED_REASON + - REL_DUE_TO_MOB_ACCESS_RESTRICTIONS + - REL_DUE_TO_SLICE_INACTIVITY + - REL_DUE_TO_NSI_NOT_AVAILABLE + - REL_DUE_TO_DNN_DENIED + - REL_DUE_TO_PDUTYPE_DENIED + - REL_DUE_TO_SSC_DENIED + - REL_DUE_TO_SUBSCRIPTION_DENIED + - REL_DUE_TO_DNN_NOT_SUPPORTED + - REL_DUE_TO_PDUTYPE_NOT_SUPPORTED + - REL_DUE_TO_SSC_NOT_SUPPORTED + - REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE + - REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE_DNN + - REL_DUE_TO_DNN_CONGESTION + - REL_DUE_TO_S_NSSAI_CONGESTION + - REL_DUE_TO_PEER_NOT_RESPONDING + - REL_DUE_TO_NETWORK_FAILURE + - REL_DUE_TO_UPF_NOT_RESPONDING + - REL_DUE_TO_NO_EPS_5GS_CONTINUITY + - REL_DUE_TO_NOT_SUPPORTED_WITH_ISMF + - REL_DUE_TO_EXCEEDED_UE_SLICE_DATA_RATE + - REL_DUE_TO_EXCEEDED_SLICE_DATA_RATE + - REL_DUE_TO_CONTEXT_NOT_FOUND + - REL_DUE_TO_MBSR_NOT_AUTHORIZED + - DEACT_DUE_TO_UE_OUT_OF_SLICE_SUPPORT_AREA + - REJECT_DUE_TO_N1_SM_ERROR + - REL_DUE_TO_DUPLICATE_SESSION_EPDG + + ResourceStatus: + anyOf: + - type: string + enum: + - RELEASED + - UNCHANGED + - TRANSFERRED + - UPDATED + - ALT_ANCHOR_SMF + - 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: | + Status of SM context or PDU session resource. Possible values are + - RELEASED + - UNCHANGED + - TRANSFERRED + - UPDATED + - ALT_ANCHOR_SMF + + DnnSelectionMode: + anyOf: + - type: string + enum: + - VERIFIED + - UE_DNN_NOT_VERIFIED + - NW_DNN_NOT_VERIFIED + - 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: | + DNN Selection Mode. Possible values are + - VERIFIED + - UE_DNN_NOT_VERIFIED + - NW_DNN_NOT_VERIFIED + + EpsInterworkingIndication: + anyOf: + - type: string + enum: + - NONE + - WITH_N26 + - WITHOUT_N26 + - IWK_NON_3GPP + - 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: | + EPS Interworking Indication. Possible values are + - NONE + - WITH_N26 + - WITHOUT_N26 + - IWK_NON_3GPP + + N2SmInfoType: + anyOf: + - type: string + enum: + - PDU_RES_SETUP_REQ + - PDU_RES_SETUP_RSP + - PDU_RES_SETUP_FAIL + - PDU_RES_REL_CMD + - PDU_RES_REL_RSP + - PDU_RES_MOD_REQ + - PDU_RES_MOD_RSP + - PDU_RES_MOD_FAIL + - PDU_RES_NTY + - PDU_RES_NTY_REL + - PDU_RES_MOD_IND + - PDU_RES_MOD_CFM + - PATH_SWITCH_REQ + - PATH_SWITCH_SETUP_FAIL + - PATH_SWITCH_REQ_ACK + - PATH_SWITCH_REQ_FAIL + - HANDOVER_REQUIRED + - HANDOVER_CMD + - HANDOVER_PREP_FAIL + - HANDOVER_REQ_ACK + - HANDOVER_RES_ALLOC_FAIL + - SECONDARY_RAT_USAGE + - PDU_RES_MOD_IND_FAIL + - UE_CONTEXT_RESUME_REQ + - UE_CONTEXT_RESUME_RSP + - UE_CONTEXT_SUSPEND_REQ + - 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: | + N2 SM Information Type. Possible values are + - PDU_RES_SETUP_REQ + - PDU_RES_SETUP_RSP + - PDU_RES_SETUP_FAIL + - PDU_RES_REL_CMD + - PDU_RES_REL_RSP + - PDU_RES_MOD_REQ + - PDU_RES_MOD_RSP + - PDU_RES_MOD_FAIL + - PDU_RES_NTY + - PDU_RES_NTY_REL + - PDU_RES_MOD_IND + - PDU_RES_MOD_CFM + - PATH_SWITCH_REQ + - PATH_SWITCH_SETUP_FAIL + - PATH_SWITCH_REQ_ACK + - PATH_SWITCH_REQ_FAIL + - HANDOVER_REQUIRED + - HANDOVER_CMD + - HANDOVER_PREP_FAIL + - HANDOVER_REQ_ACK + - HANDOVER_RES_ALLOC_FAIL + - SECONDARY_RAT_USAGE + - PDU_RES_MOD_IND_FAIL + - UE_CONTEXT_RESUME_REQ + - UE_CONTEXT_RESUME_RSP + - UE_CONTEXT_SUSPEND_REQ + + MaxIntegrityProtectedDataRate: + anyOf: + - type: string + enum: + - 64_KBPS + - MAX_UE_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: | + Maximum Integrity Protected Data Rate. Possible values are + - 64_KBPS + - MAX_UE_RATE + + MaReleaseIndication: + anyOf: + - type: string + enum: + - REL_MAPDU_OVER_3GPP + - REL_MAPDU_OVER_N3GPP + - 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: | + Multi-Access PDU session release Indication. Possible values are + - REL_MAPDU_OVER_3GPP + - REL_MAPDU_OVER_N3GPP + + SmContextType: + anyOf: + - type: string + enum: + - EPS_PDN_CONNECTION + - SM_CONTEXT + - AF_COORDINATION_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: | + Type of SM Context information. Possible values are + - EPS_PDN_CONNECTION + - SM_CONTEXT + - AF_COORDINATION_INFO + + PsaIndication: + anyOf: + - type: string + enum: + - PSA_INSERTED + - PSA_REMOVED + - PSA_INSERTED_ONLY + - PSA_REMOVED_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: | + Indication of whether a PSA is inserted or removed. Possible values are + - PSA_INSERTED + - PSA_REMOVED + - PSA_INSERTED_ONLY + - PSA_REMOVED_ONLY + + N4MessageType: + anyOf: + - type: string + enum: + - PFCP_SES_EST_REQ + - PFCP_SES_EST_RSP + - PFCP_SES_MOD_REQ + - PFCP_SES_MOD_RSP + - PFCP_SES_DEL_REQ + - PFCP_SES_DEL_RSP + - PFCP_SES_REP_REQ + - PFCP_SES_REP_RSP + - 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: | + N4 Message Type. Possible values are + - PFCP_SES_EST_REQ + - PFCP_SES_EST_RSP + - PFCP_SES_MOD_REQ + - PFCP_SES_MOD_RSP + - PFCP_SES_DEL_REQ + - PFCP_SES_DEL_RSP + - PFCP_SES_REP_REQ + - PFCP_SES_REP_RSP + + QosFlowAccessType: + anyOf: + - type: string + enum: + - 3GPP + - NON_3GPP + - 3GPP_AND_NON_3GPP + - 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: | + Access type associated with a QoS Flow. Possible values are + - 3GPP + - NON_3GPP + - 3GPP_AND_NON_3GPP + + UnavailableAccessIndication: + anyOf: + - type: string + enum: + - 3GA_UNAVAILABLE + - N3GA_UNAVAILABLE + - 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 access type of a MA PDU session that is unavailable. Possible values are + - 3GA_UNAVAILABLE + - N3GA_UNAVAILABLE + + ProtectionResult: + anyOf: + - type: string + enum: + - PERFORMED + - NOT_PERFORMED + - 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: | + Protection Result of the security policy indicated as "preferred". Possible values are + - PERFORMED + - NOT_PERFORMED + + QosMonitoringReq: + anyOf: + - type: string + enum: + - UL + - DL + - BOTH + - NONE + - 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: | + QoS monitoring request. Possible values are + - UL + - DL + - BOTH + - NONE + + Rsn: + anyOf: + - type: string + enum: + - V1 + - V2 + - NONE + - 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: | + Redundancy Sequence Number. Possible values are + - V1 + - V2 + - NONE + + SmfSelectionType: + anyOf: + - type: string + enum: + - CURRENT_PDU_SESSION + - NEXT_PDU_SESSION + - 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: | + Smf Selection Type. Possible values are + - CURRENT_PDU_SESSION + - NEXT_PDU_SESSION + + PduSessionContextType: + anyOf: + - type: string + enum: + - AF_COORDINATION_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: | + Type of PDU Session information. Possible values are + - AF_COORDINATION_INFO + + PendingUpdateInfo: + anyOf: + - type: string + enum: + - UE_LOCATION + - TIMEZONE + - ACCESS_TYPE + - RAT_TYPE + - AMF_ID + - 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: | + Pending Update Information. Possible values are + - UE_LOCATION + - TIMEZONE + - ACCESS_TYPE + - RAT_TYPE + - AMF_ID + + EstablishmentRejectionCause: + anyOf: + - type: string + enum: + - OPERATOR_DETERMINED_BARRING + - 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: | + PDU Session Establishment Rejection Cause. Possible values are + - OPERATOR_DETERMINED_BARRING + + EcnMarkingReq: + anyOf: + - type: string + enum: + - UL + - DL + - BOTH + - STOP + - 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: | + ECN Marking Request Type. Possible values are + - UL + - DL + - BOTH + - STOP + + CongestionInfoReq: + anyOf: + - type: string + enum: + - UL + - DL + - BOTH + - STOP + - 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: | + Congestion Information Request Type. Possible values are + - UL + - DL + - BOTH + - STOP + + ActivationStatus: + anyOf: + - type: string + enum: + - ACTIVE + - NOT_ACTIVE + - 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: | + Activation Status. Possible values are + - ACTIVE + - NOT_ACTIVE + + QosMonitoringPdSupported: + anyOf: + - type: string + enum: + - SUPPORTED + - NOT_SUPPORTED + - UNKNOWN + - 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: > + QoS Monitoring for packet delay supported information. Possible values are + - SUPPORTED + - NOT_SUPPORTED + - UNKNOWN + +# +# HTTP request bodies +# + requestBodies: + 'VsmfUpdateRequestBody': + description: representation of updates to apply to the PDU session + required: true + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/VsmfUpdateData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/VsmfUpdateData' + binaryDataN1SmInfoToUe: + type: string + format: binary + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + binaryDataN4InformationExt3: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoToUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt3: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + + 'NotifyStatusRequestBody': + description: representation of the status notification + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/StatusNotification' + +# +# HTTP responses +# + responses: + 'VsmfUpdateResponse200': + description: successful update of a PDU session with content in the response + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/VsmfUpdatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/VsmfUpdatedData' + binaryDataN1SmInfoFromUe: + type: string + format: binary + binaryDataUnknownN1SmInfo: + type: string + format: binary + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + binaryDataN4InformationExt3: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoFromUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataUnknownN1SmInfo: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt3: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + + 'PduSessionCreateError': + description: unsuccessful creation of a PDU session + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/PduSessionCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/PduSessionCreateError' + binaryDataN1SmInfoToUe: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoToUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + + 'HsmfUpdateError': + description: unsuccessful update of a PDU session + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/HsmfUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/HsmfUpdateError' + binaryDataN1SmInfoToUe: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoToUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + + 'VsmfUpdateError': + description: unsuccessful update of a PDU session + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/VsmfUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/VsmfUpdateError' + binaryDataN1SmInfoFromUe: + type: string + format: binary + binaryDataUnknownN1SmInfo: + type: string + format: binary + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + binaryDataN4InformationExt3: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoFromUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataUnknownN1SmInfo: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt3: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + + '400': + description: Bad request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '401': + description: Unauthorized + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '404': + description: Not Found + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '413': + description: Content Too Large + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '415': + description: Unsupported Media Type + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '429': + description: Too Many Requests + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '502': + description: Bad Gateway + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + -- GitLab From a7fefcfcf7b53455ed40ba4c38ec869d6e973285 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 01:38:58 +0000 Subject: [PATCH 14/33] Upload the YAML for cross reference compile --- OpenAPI/TS28623_GenericNrm.yaml | 650 ++++++++++++++++++++++++++++++++ 1 file changed, 650 insertions(+) create mode 100644 OpenAPI/TS28623_GenericNrm.yaml diff --git a/OpenAPI/TS28623_GenericNrm.yaml b/OpenAPI/TS28623_GenericNrm.yaml new file mode 100644 index 0000000..1346cf3 --- /dev/null +++ b/OpenAPI/TS28623_GenericNrm.yaml @@ -0,0 +1,650 @@ +openapi: 3.0.1 +info: + title: Generic NRM + version: 19.1.0 + description: >- + OAS 3.0.1 definition of 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 + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + + VnfParameter: + type: object + properties: + vnfInstanceId: + type: string + vnfdId: + type: string + flavourId: + type: string + autoScalable: + type: boolean + PeeParameter: + type: object + properties: + siteIdentification: + type: string + siteDescription: + type: string + siteLatitude: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Latitude' + siteLongitude: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Longitude' + siteAltitude: + type: number + format: float + equipmentType: + type: string + environmentType: + type: string + powerInterface: + type: string + + TransportProtocol: + anyOf: + - type: string + enum: + - TCP + - type: string + SupportedPerfMetricGroup: + type: object + properties: + performanceMetrics: + type: array + items: + type: string + readOnly: true + granularityPeriods: + type: array + items: + type: integer + minimum: 1 + readOnly: true + reportingMethods: + type: array + items: + type: string + enum: + - FILE_BASED_LOC_SET_BY_PRODUCER + - FILE_BASED_LOC_SET_BY_CONSUMER + - STREAM_BASED + readOnly: true + reportingPeriods: + type: array + items: + type: integer + minimum: 1 + readOnly: true + ReportingCtrl: + oneOf: + - type: object + properties: + fileReportingPeriod: + type: integer + - type: object + properties: + fileReportingPeriod: + type: integer + notificationRecipientAddress: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + - type: object + properties: + fileReportingPeriod: + type: integer + fileLocation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + - type: object + properties: + streamTarget: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + ProcessMonitor: + description: >- + This data type is the "ProcessMonitor" data type without specialisations. + type: object + properties: + jobId: + type: string + readOnly: true + status: + type: string + enum: + - NOT_STARTED + - RUNNING + - FINSHED + - FAILED + - PARTIALLY_FAILED + - CANCELLING + - CANCELLED + readOnly: true + progressPercentage: + type: integer + minimum: 0 + maximum: 100 + readOnly: true + progressStateInfo: + type: string + readOnly: true + resultStateInfo: + type: string + readOnly: true + startTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo' + endTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo' + timer: + type: integer + AreaScope: + allOf: + - type: array + items: + $ref: '#/components/schemas/NpnId-Type' + - oneOf: + - type: array + items: + $ref: '#/components/schemas/EutraCellId' + - type: array + items: + $ref: '#/components/schemas/NrCellId' + - type: array + items: + $ref: '#/components/schemas/Tac' + - type: array + items: + $ref: '#/components/schemas/Tai' + Tai: + type: object + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + tac: + $ref: '#/components/schemas/Tac' + Tac: + type: string + pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' + EutraCellId: + type: string + pattern: '^[A-Fa-f0-9]{7}$' + NrCellId: + type: string + pattern: '^[A-Fa-f0-9]{9}$' + IpAddr: + oneOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + + SchedulingTime: + oneOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' + - type: object + properties: + timeIntervals: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeInterval' + - type: object + properties: + timeIntervals: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeInterval' + daysOfWeek: + type: array + items: + type: string + enum: + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + - type: object + properties: + timeIntervals: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeInterval' + daysOfMonth: + type: array + items: + type: integer + minimum: 0 + maximum: 31 + NpnId-Type: + type: object + properties: + plmnId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + cAGIdList: + type: array + items: + type: string + minItems: 1 + maxItems: 256 + nIDList: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Nid' + minItems: 1 + maxItems: 16 + oneOf: + - required: [plmnId, cAGIdList] + - required: [plmnId, nIDList] + +#-------- Definition of abstract IOC Top ----------------------------------------- + + Top-Attr: + # This definition will be deprecated, when all occurances of Top-Attr + # are replaced by Top. + type: object + properties: + id: + type: string + nullable: true + objectClass: + type: string + objectInstance: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + required: + - id + Top: + type: object + properties: + id: + type: string + nullable: true + objectClass: + type: string + objectInstance: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + required: + - id + +#-------- Definition of IOCs with new name-containments defined in other TS ------ + + SubNetwork-Attr: + type: object + properties: + dnPrefix: + type: string + userLabel: + type: string + userDefinedNetworkType: + type: string + setOfMcc: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + readOnly: true + priorityLabel: + type: integer + readOnly: true + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + supportedTraceMetrics: + type: array + items: + type: string + ManagedElement-Attr: + type: object + properties: + dnPrefix: + type: string + managedElementTypeList: + type: array + items: + type: string + userLabel: + type: string + locationName: + type: string + managedBy: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + vendorName: + type: string + readOnly: true + userDefinedState: + type: string + swVersion: + type: string + readOnly: true + priorityLabel: + type: integer + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + supportedTraceMetrics: + type: array + items: + type: string + readOnly: true + + SubNetwork-ncO: + type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + ManagementNode: + $ref: '#/components/schemas/ManagementNode-Multiple' + MnsAgent: + $ref: '#/components/schemas/MnsAgent-Multiple' + MeContext: + $ref: '#/components/schemas/MeContext-Multiple' + AlarmList: + $ref: 'TS28111_FaultNrm.yaml#/components/schemas/AlarmList-Single' + Scheduler: + $ref: '#/components/schemas/Scheduler-Multiple' + ConditionMonitor: + $ref: '#/components/schemas/ConditionMonitor-Multiple' + SupportedNotifications: + $ref: '#/components/schemas/SupportedNotifications-Single' + + + ManagedElement-ncO: + type: object + properties: + MnsAgent: + $ref: '#/components/schemas/MnsAgent-Multiple' + AlarmList: + $ref: 'TS28111_FaultNrm.yaml#/components/schemas/AlarmList-Single' + Scheduler: + $ref: '#/components/schemas/Scheduler-Multiple' + ConditionMonitor: + $ref: '#/components/schemas/ConditionMonitor-Multiple' + SupportedNotifications: + $ref: '#/components/schemas/SupportedNotifications-Single' + + +#-------- Definition of abstract IOCs -------------------------------------------- + + ManagedFunction-Attr: + type: object + properties: + userLabel: + type: string + vnfParametersList: + type: array + items: + $ref: '#/components/schemas/VnfParameter' + peeParametersList: + type: array + items: + $ref: '#/components/schemas/PeeParameter' + priorityLabel: + type: integer + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + supportedTraceMetrics: + type: array + items: + type: string + EP_RP-Attr: + type: object + properties: + userLabel: + type: string + farEndEntity: + type: string + readOnly: true + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + + ManagedFunction-ncO: + type: object + properties: + PerfMetricJob: + $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/PerfMetricJob-Multiple' + ThresholdMonitor: + $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdMonitor-Multiple' + TraceJob: + $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/TraceJob-Multiple' + +#-------- Definition of concrete IOCs -------------------------------------------- + + VsDataContainer-Single: + type: object + properties: + id: + type: string + attributes: + type: object + properties: + vsDataType: + type: string + readOnly: true + vsDataFormatVersion: + type: string + readOnly: true + vsData: + nullable: true + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + + ManagementNode-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + userLabel: + type: string + managedElements: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + vendorName: + type: string + readOnly: true + userDefinedState: + type: string + locationName: + type: string + readOnly: true + swVersion: + type: string + readOnly: true + MnsAgent: + $ref: '#/components/schemas/MnsAgent-Multiple' + MnsAgent-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + systemDN: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + MeContext-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + dnPrefix: + type: string + readOnly: true + Scheduler-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + schedulingTimes: + type: array + items: + $ref: '#/components/schemas/SchedulingTime' + minItems: 1 + schedulerStatus: + type: boolean + readOnly: true + ConditionMonitor-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + condition: + type: string + conditionStatus: + type: boolean + readOnly: true + + SupportedNotifications-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + notificationTypes: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationType' + notificationProtocols: + type: array + items: + type: string + enum: + - HTTP + - HTTP_VES_ENCAPS + minItems: 1 + readOnly: true + + + SubNetwork-Single: + allOf: + - $ref: '#/components/schemas/Top' + - $ref: '#/components/schemas/SubNetwork-Attr' + - $ref: '#/components/schemas/SubNetwork-ncO' + - $ref: '#/components/schemas/SubNetwork-Multiple' + - $ref: '#/components/schemas/ManagedElement-Multiple' + - $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/SubNetwork-ncO-FileManagementNrm' + - $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/SubNetwork-ncO-PmControlNrm' + - $ref: 'TS28623_SubscriptionControlNrm.yaml#/components/schemas/SubNetwork-ncO-SubscriptionControlNrm' + - $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/SubNetwork-ncO-ThresholdMonitorNrm' + - $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/SubNetwork-ncO-TraceControlNrm' + - $ref: 'TS28623_QoEMeasurementCollectionNrm.yaml#/components/schemas/SubNetwork-ncO-QoEMeasurementCollectionNrm' + - $ref: 'TS28623_ManagementDataCollectionNrm.yaml#/components/schemas/SubNetwork-ncO-ManagementDataCollectionNrm' + - $ref: 'TS28623_MnSRegistryNrm.yaml#/components/schemas/SubNetwork-ncO-MnSRegistryNrm' + - $ref: 'TS28104_MdaNrm.yaml#/components/schemas/SubNetwork-ncO-MdaNrm' + - $ref: 'TS28105_AiMlNrm.yaml#/components/schemas/SubNetwork-ncO-AiMlNrm' + - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/SubNetwork-ncO-IntentNrm' + - $ref: 'TS28317_RanScNrm.yaml#/components/schemas/SubNetwork-ncO-RanScNrm' + - $ref: 'TS28536_CoslaNrm.yaml#/components/schemas/SubNetwork-ncO-CoslaNrm' + - $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/SubNetwork-ncO-EdgeNrm' + - $ref: 'TS28541_SliceNrm.yaml#/components/schemas/SubNetwork-ncO-SliceNrm' + - $ref: 'TS28541_NrNrm.yaml#/components/schemas/SubNetwork-ncO-NrNrm' + - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/SubNetwork-ncO-5GcNrm' + - $ref: 'TS28318_DsoNrm.yaml#/components/schemas/SubNetwork-ncO-DsoNrm' + + + ManagedElement-Single: + allOf: + - $ref: '#/components/schemas/Top' + - $ref: '#/components/schemas/ManagedElement-Attr' + - $ref: '#/components/schemas/ManagedElement-ncO' + - $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/ManagedElement-ncO-FileManagementNrm' + - $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/ManagedElement-PmControlNrm' + - $ref: 'TS28623_SubscriptionControlNrm.yaml#/components/schemas/ManagedElement-ncO-SubscriptionControlNrm' + - $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ManagedElement-ncO-ThresholdMonitorNrm' + - $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/SubNetwork-ncO-TraceControlNrm' + - $ref: 'TS28623_QoEMeasurementCollectionNrm.yaml#/components/schemas/ManagedElement-ncO-QoEMeasurementCollectionNrm' + - $ref: 'TS28104_MdaNrm.yaml#/components/schemas/ManagedElement-ncO-MdaNrm' + - $ref: 'TS28105_AiMlNrm.yaml#/components/schemas/ManagedElement-ncO-AiMlNrm' + - $ref: 'TS28536_CoslaNrm.yaml#/components/schemas/ManagedElement-ncO-CoslaNrm' + - $ref: 'TS28541_NrNrm.yaml#/components/schemas/ManagedElement-ncO-NrNrm' + - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/ManagedElement-ncO-5GcNrm' + + NrmRoot: + oneOf: + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + - type: object + properties: + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + +#-------- Definition of YAML arrays for name-contained IOCs ---------------------- + + VsDataContainer-Multiple: + type: array + items: + $ref: '#/components/schemas/VsDataContainer-Single' + ManagementNode-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagementNode-Single' + MnsAgent-Multiple: + type: array + items: + $ref: '#/components/schemas/MnsAgent-Single' + MeContext-Multiple: + type: array + items: + $ref: '#/components/schemas/MeContext-Single' + Scheduler-Multiple: + type: array + items: + $ref: '#/components/schemas/Scheduler-Single' + ConditionMonitor-Multiple: + type: array + items: + $ref: '#/components/schemas/ConditionMonitor-Single' + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + ManagedElement-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedElement-Single' + + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + + resources-genericNrm: + oneOf: + - $ref: '#/components/schemas/NrmRoot' + - $ref: '#/components/schemas/VsDataContainer-Single' + - $ref: '#/components/schemas/ManagementNode-Single' + - $ref: '#/components/schemas/MnsAgent-Single' + - $ref: '#/components/schemas/MeContext-Single' + - $ref: '#/components/schemas/Scheduler-Single' + - $ref: '#/components/schemas/ConditionMonitor-Single' + - $ref: '#/components/schemas/SupportedNotifications-Single' + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' -- GitLab From acee4246e64cbc0aefc245116dfe5d5c31bbc820 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 01:47:43 +0000 Subject: [PATCH 15/33] Upload the YAML for cross reference compile --- OpenAPI/TS29508_Nsmf_EventExposure.yaml | 988 ++++++++++++++++++++++++ 1 file changed, 988 insertions(+) create mode 100644 OpenAPI/TS29508_Nsmf_EventExposure.yaml diff --git a/OpenAPI/TS29508_Nsmf_EventExposure.yaml b/OpenAPI/TS29508_Nsmf_EventExposure.yaml new file mode 100644 index 0000000..f5b6d50 --- /dev/null +++ b/OpenAPI/TS29508_Nsmf_EventExposure.yaml @@ -0,0 +1,988 @@ +openapi: 3.0.0 + +info: + version: 1.3.0 + title: Nsmf_EventExposure + description: | + Session Management Event Exposure Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.508 V18.6.0; 5G System; Session Management Event Exposure Service. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.508/ + +servers: + - url: '{apiRoot}/nsmf-event-exposure/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nsmf-event-exposure + +paths: + /subscriptions: + post: + operationId: CreateIndividualSubcription + summary: Create an individual subscription for event notifications from the SMF + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + responses: + '201': + description: Created. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + '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#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposureNotification' + 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' + callbacks: + afAcknowledgement: + '{$request.body#/ackUri}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AckOfNotify' + responses: + '204': + description: No Content (successful acknowledgement) + '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/{subId}: + get: + operationId: GetIndividualSubcription + summary: Read an individual subscription for event notifications from the SMF + tags: + - IndividualSubscription (Document) + parameters: + - name: subId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + '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' + put: + operationId: ReplaceIndividualSubcription + summary: Replace an individual subscription for event notifications from the SMF + tags: + - IndividualSubscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + parameters: + - name: subId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/NsmfEventExposure' + '204': + description: No Content. Resource was successfully modified + '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: + operationId: DeleteIndividualSubcription + summary: Delete an individual subscription for event notifications from the SMF + tags: + - IndividualSubscription (Document) + parameters: + - name: subId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully 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: + nsmf-event-exposure: Access to the Nsmf_EventExposure API + + schemas: + + NsmfEventExposure: + description: > + Represents an Individual SMF Notification Subscription resource. The serviveName property + corresponds to the serviceName in the main body of the specification. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + anyUeInd: + type: boolean + description: > + Any UE indication. This IE shall be present if the event subscription is applicable to + any UE. Default value "false" is used, if not present. + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + pduSeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + ssId: + type: string + description: SSID that the PDU session is related to. + bssId: + type: string + description: BSSID that the PDU session is related to. + upfId: + type: string + description: UPF identity. + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + subId: + $ref: '#/components/schemas/SubId' + notifId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + altNotifIpv4Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + description: Alternate or backup IPv4 address(es) where to send Notifications. + minItems: 1 + altNotifIpv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + description: Alternate or backup IPv6 address(es) where to send Notifications. + minItems: 1 + altNotifFqdns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + description: Alternate or backup FQDN(s) where to send Notifications. + eventSubs: + type: array + items: + $ref: '#/components/schemas/EventSubscription' + minItems: 1 + description: Subscribed events + eventNotifs: + type: array + items: + $ref: '#/components/schemas/EventNotification' + minItems: 1 + ImmeRep: + type: boolean + notifMethod: + $ref: '#/components/schemas/NotificationMethod' + maxReportNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + serviveName: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + sampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + partitionCriteria: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartitioningCriteria' + minItems: 1 + description: Criteria for partitioning the UEs before applying the sampling ratio. + grpRepTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + notifFlag: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' + notifFlagInstruct: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' + mutingSetting: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingNotificationsSettings' + defQosSupp: + type: boolean + description: > + Indicates whether the NF service consumer requests to receive QoS Flow performance + information for the QoS Flow associated with the default QoS rule if there are no + measurements available for the provided Application Identifier included in the appIds + attribute. + qosMonPending: + type: boolean + description: > + Indicates that the reporting will be activated when the measurements are enabled by a + PCC rule. It shall always be set to true when present. It may only be provided in the + response. + required: + - notifId + - notifUri + - eventSubs + + NsmfEventExposureNotification: + description: Represents notifications on events that occurred. + type: object + properties: + notifId: + type: string + description: Notification correlation ID + eventNotifs: + type: array + items: + $ref: '#/components/schemas/EventNotification' + minItems: 1 + description: Notifications about Individual Events + ackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + required: + - notifId + - eventNotifs + + EventSubscription: + description: Represents a subscription to a single event. + type: object + properties: + event: + $ref: '#/components/schemas/SmfEvent' + dnaiChgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' + dddTraDescriptors: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + minItems: 1 + dddStati: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + minItems: 1 + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + targetPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + transacDispInd: + type: boolean + description: > + Indicates the subscription for UE transaction dispersion collectionon, if it is included + and set to "true". Default value is "false". + transacMetrics: + type: array + items: + $ref: '#/components/schemas/TransactionMetric' + description: Indicates Session Management Transaction metrics. + minItems: 1 + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + upfEvents: + type: array + items: + $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/UpfEvent' + description: Indicates UPF event exposure information. + minItems: 1 + required: + - event + + EventNotification: + description: Represents a notification related to a single event that occurred. + type: object + properties: + event: + $ref: '#/components/schemas/SmfEvent' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + transacInfos: + type: array + items: + $ref: '#/components/schemas/TransactionInfo' + description: Transaction Information. + minItems: 1 + sourceDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + dnaiChgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' + candidateDnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + description: The candidate DNAI(s) for the PDU Session. + candDnaisPrioInd: + type: boolean + description: > + If provided and set to true, it indicates that the candidate DNAIs provided + in the candidateDnais attribute are in descending priority order, i.e., + the lower the array index the higher the priority of the respective DNAI. + If omitted, the default value is false. + easRediscoverInd: + type: boolean + description: > + Indication of EAS re-discovery. If present and set to "true", it indicates the EAS + re-discovery is performed, e.g. due to change of common EAS. Default value is "false" if + omitted. + trafCorreInfo: + $ref: '#/components/schemas/TrafficCorrelationNotification' + sourceUeIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + sourceUeIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + targetUeIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + targetUeIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + sourceTraRouting: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + targetTraRouting: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + adIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + adIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + reIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + reIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + accType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + pduAccTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + pduSeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + dddStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + dddTraDescriptor: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + maxWaitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + commFailure: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CommunicationFailure' + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + ipv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + pduSessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ethFlowDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + description: > + Descriptor(s) for non-IP traffic. It allows the encoding of multiple UL and/or DL flows. + Each entry of the array describes a single Ethernet flow. + ethfDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + maxItems: 2 + description: > + Contains the UL and/or DL Ethernet flows. Each entry of the array describes a single + Ethernet flow. + flowDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + description: > + Descriptor(s) for IP traffic. It allows the encoding of multiple UL and/or DL flows. + Each entry of the array describes a single IP flow. + fDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + maxItems: 2 + description: > + Contains the UL and/or DL IP flows. Each entry of the array describes a single + IP flow. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + ulDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minItems: 1 + dlDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minItems: 1 + rtDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minItems: 1 + ulCongInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + dlCongInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + ulDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + timeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + smNasFromUe: + $ref: '#/components/schemas/SmNasFromUe' + smNasFromSmf: + $ref: '#/components/schemas/SmNasFromSmf' + upRedTrans: + type: boolean + description: > + Indicates whether the redundant transmission is setup or terminated. Set to "true" if + the redundant transmission is setup, otherwise set to "false" if the redundant + transmission is terminated. Default value is set to "false". + ssId: + type: string + bssId: + type: string + startWlan: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endWlan: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + pduSessInfos: + type: array + items: + $ref: '#/components/schemas/PduSessionInformation' + minItems: 1 + upfInfo: + $ref: '#/components/schemas/UpfInformation' + pdmf: + type: boolean + description: Represents the packet delay measurement failure indicator. + satBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + targetAfId: + type: string + description: Identifier of the Application Function responsible for the target DNAI. + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + required: + - event + - timeStamp + not: + required: [ipv6Prefixes,ipv6Addrs] + + SubId: + type: string + format: SubId + description: > + Identifies an Individual SMF Notification Subscription. To enable that the value is used as + part of a URI, the string shall only contain characters allowed according to the + "lower-with-hyphen" naming convention defined in 3GPP TS 29.501. In an OpenAPI schema, the + format shall be designated as "SubId". + + AckOfNotify: + description: Represents an acknowledgement information of an event notification. + type: object + properties: + notifId: + type: string + ackResult: + $ref: 'TS29522_TrafficInfluence.yaml#/components/schemas/AfResultInfo' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + required: + - notifId + - ackResult + + SmNasFromUe: + description: > + Represents information on the SM NAS messages that SMF receives from UE for PDU Session. + type: object + properties: + smNasType: + type: string + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - smNasType + - timeStamp + + SmNasFromSmf: + description: > + Represents information on the SM congestion control applied SM NAS messages that SMF sends + to UE for PDU Session. + type: object + properties: + smNasType: + type: string + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + backoffTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + appliedSmccType: + $ref: '#/components/schemas/AppliedSmccType' + required: + - smNasType + - timeStamp + - backoffTimer + - appliedSmccType + + TransactionInfo: + description: Represents SMF Transaction Information. + type: object + properties: + transaction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + transacMetrics: + type: array + items: + $ref: '#/components/schemas/TransactionMetric' + minItems: 1 + required: + - transaction + + PduSessionInformation: + description: Represents the PDU session related information. + type: object + properties: + pduSessId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + sessInfo: + $ref: '#/components/schemas/PduSessionInfo' + + PduSessionInfo: + description: Represents session information. + type: object + properties: + n4SessId: + type: string + description: The identifier of the N4 session for the reported PDU Session. + sessInactiveTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + pduSessStatus: + $ref: '#/components/schemas/PduSessionStatus' + + UpfInformation: + description: Represents the ID/address/FQDN of the UPF. + type: object + properties: + upfId: + type: string + upfAddr: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' + + TrafficCorrelationNotification: + description: Represents notifications for 5GC determined Traffic Correlation Information. + type: object + properties: + smfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + tfcCorrId: + type: string + description: > + Identification of a set of UEs accessing the application identified by the + Application Identifier or traffic filtering information. + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + easFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + easIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + pduSessionNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + required: + - smfId + - pduSessionNbr + - tfcCorrId + anyOf: + - required: [dnais] + - oneOf: + - required: [easFqdn] + - required: [easIpAddr] + + SmfEvent: + anyOf: + - type: string + enum: + - AC_TY_CH + - UP_PATH_CH + - PDU_SES_REL + - PLMN_CH + - UE_IP_CH + - RAT_TY_CH + - DDDS + - COMM_FAIL + - PDU_SES_EST + - QFI_ALLOC + - QOS_MON + - SMCC_EXP + - DISPERSION + - RED_TRANS_EXP + - WLAN_INFO + - UPF_INFO + - UP_STATUS_INFO + - UPF_EVENT + - SATB_CH + - TRAFFIC_CORRELATION + - 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 types of events that can be subscribed. + Possible values are: + - AC_TY_CH: Access Type Change. + - UP_PATH_CH: UP Path Change. + - PDU_SES_REL: PDU Session Release. + - PLMN_CH: PLMN Change. + - UE_IP_CH: UE IP address change. + - RAT_TY_CH: RAT Type Change. + - DDDS: Downlink data delivery status. + - COMM_FAIL: Communication Failure. + - PDU_SES_EST: PDU Session Establishment. + - QFI_ALLOC: QFI allocation. + - QOS_MON: QoS Monitoring. + - SMCC_EXP: SM congestion control experience for PDU Session. + - DISPERSION: Session Management transaction dispersion. + - RED_TRANS_EXP: Redundant transmission experience for PDU Session. + - WLAN_INFO: WLAN information on PDU session for which Access Type is NON_3GPP_ACCESS and + RAT Type is TRUSTED_WLAN. + - UPF_INFO: The UPF information, including the UPF ID/address/FQDN information. + - UP_STATUS_INFO: The User Plane status information. + - UPF_EVENT: UPF event subscribed via SMF. + - SATB_CH: Satellite backhaul category change. + - TRAFFIC_CORRELATION: Indicates that the SMF provides 5GC determined traffic correlation + information for a set of UEs identified by Traffic Correlation ID. + + NotificationMethod: + anyOf: + - type: string + enum: + - PERIODIC + - ONE_TIME + - ON_EVENT_DETECTION + - 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 notification methods that can be subscribed. + Possible values are: + - PERIODIC + - ONE_TIME + - ON_EVENT_DETECTION + + AppliedSmccType: + anyOf: + - type: string + enum: + - DNN_CC + - SNSSAI_CC + description: > + This string indicates the type of applied SM congestion control. + - 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 type of applied SM congestion control. + Possible values are: + - DNN_CC: Indicates the DNN based congestion control. + - SNSSAI_CC: Indicates the S-NSSAI based congestion control. + + TransactionMetric: + anyOf: + - type: string + enum: + - PDU_SES_EST + - PDU_SES_AUTH + - PDU_SES_MODIF + - PDU_SES_REL + - 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 metric on UE Session Management transactions. + Possible values are: + - PDU_SES_EST: PDU Session Establishment + - PDU_SES_AUTH: PDU Session Authentication + - PDU_SES_MODIF: PDU Session Modification + - PDU_SES_REL: PDU Session Release + + PduSessionStatus: + anyOf: + - type: string + enum: + - ACTIVATED + - DEACTIVATED + - 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 status of the PDU Session. + Possible values are: + - ACTIVATED: PDU Session status is activated. + - DEACTIVATED: PDU Session status is deactivated. -- GitLab From 90e2f0798e46dadf8bfab2024e0bd20844279da7 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 01:48:00 +0000 Subject: [PATCH 16/33] Upload the YAML for cross reference compile --- OpenAPI/TS29525_Npcf_UEPolicyControl.yaml | 1170 +++++++++++++++++++++ 1 file changed, 1170 insertions(+) create mode 100644 OpenAPI/TS29525_Npcf_UEPolicyControl.yaml diff --git a/OpenAPI/TS29525_Npcf_UEPolicyControl.yaml b/OpenAPI/TS29525_Npcf_UEPolicyControl.yaml new file mode 100644 index 0000000..82527b0 --- /dev/null +++ b/OpenAPI/TS29525_Npcf_UEPolicyControl.yaml @@ -0,0 +1,1170 @@ +openapi: 3.0.0 + +info: + version: 1.3.1 + title: Npcf_UEPolicyControl + description: | + UE Policy Control Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.525 V18.7.0; 5G System; UE Policy Control Service. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.525/' + +servers: + - url: '{apiRoot}/npcf-ue-policy-control/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npcf-ue-policy-control + +paths: + /policies: + post: + operationId: CreateIndividualUEPolicyAssociation + summary: Create individual UE policy association. + tags: + - UE Policy Associations (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyAssociationRequest' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyAssociation' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/npcf-ue-policy-control/v1/policies/{polAssoId}' + 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: + policyUpdateNotification: + '{$request.body#/notificationUri}/update': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyUpdate' + responses: + '200': + description: > + OK. The current applicable values corresponding to the policy control request + trigger is reported + content: + application/json: + schema: + $ref: '#/components/schemas/UeRequestedValueRep' + '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' + policyAssocitionTerminationRequestNotification: + '{$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' + + /policies/{polAssoId}: + get: + operationId: ReadIndividualUEPolicyAssociation + summary: Read individual UE policy association. + tags: + - Individual UE Policy Association (Document) + parameters: + - name: polAssoId + 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/PolicyAssociation' + '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' + delete: + operationId: DeleteIndividualUEPolicyAssociation + summary: Delete individual UE policy association. + tags: + - Individual UE Policy Association (Document) + parameters: + - name: polAssoId + in: path + description: Identifier of a policy association + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully 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' + + /policies/{polAssoId}/update: + post: + operationId: ReportObservedEventTriggersForIndividualUEPolicyAssociation + summary: > + Report observed event triggers and possibly obtain updated policies for an individual UE + policy association. + tags: + - Individual UE Policy Association (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyAssociationUpdateRequest' + parameters: + - name: polAssoId + 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/PolicyUpdate' + '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' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcf-ue-policy-control: Access to the Npcf_UEPolicyControl API + + schemas: + PolicyAssociation: + description: > + Contains the description of a policy association that is returned by the PCF when a policy + Association is created, updated, or read. + type: object + properties: + request: + $ref: '#/components/schemas/PolicyAssociationRequest' + uePolicy: + $ref: '#/components/schemas/UePolicy' + n2Pc5Pol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + n2Pc5PolA2x: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + n2Pc5ProSePol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + triggers: + type: array + items: + $ref: '#/components/schemas/RequestTrigger' + minItems: 1 + description: > + Request Triggers that the PCF subscribes. + pras: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfoRm' + minProperties: 1 + description: > + Contains the presence reporting area(s) for which reporting was requested. + The praId attribute within the PresenceInfoRm data type is the key of the map. + andspDelInd: + $ref: '#/components/schemas/PolicyStatus' + andspInd: + description: > + Indication of UE support of ANDSP. When set to true, it indicates the UE supports ANDSP, + when set to false it indicates the UE does not support ANDSP. + type: boolean + pduSessions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + minItems: 1 + description: Combination of DNN and S-NSSAIs for which LBO information is requested. + chfInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ChargingInformation' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + n2Pc5RsppPol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + pcfUeInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + matchPdus: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + minItems: 1 + required: + - suppFeat + + PolicyAssociationRequest: + description: > + Represents information that the NF service consumer provides when requesting the creation of + a policy association. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + altNotifIpv4Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + description: Alternate or backup IPv4 Address(es) where to send Notifications. + altNotifIpv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + description: Alternate or backup IPv6 Address(es) where to send Notifications. + altNotifFqdns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + description: Alternate or backup FQDN(s) where to send Notifications. + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + accessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + description: > + The Access Type(s) where the served UE is camping. + It shall be provided, if available, for trigger "ACCESS_TYPE_CH. + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + userLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + servingPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + ratTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + description: > + The RAT Type(s), if available, for the reported "accessTypes" where the served UE is + camping. It shall be provided, if available, for trigger "ACCESS_TYPE_CH. + groupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + hPcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + hPcfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + hPcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + uePolReq: + $ref: '#/components/schemas/UePolicyRequest' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + serviceName: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + servingNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pc5Capab: + $ref: '#/components/schemas/Pc5Capability' + a2xCapab: + type: array + items: + $ref: '#/components/schemas/A2xCapability' + minItems: 1 + proSeCapab: + type: array + items: + $ref: '#/components/schemas/ProSeCapability' + minItems: 1 + confSnssais: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/ConfiguredSnssai' + minItems: 1 + description: > + The Configured NSSAI for the serving PLMN, and the mapped S-NSSAI value of home + network corresponding to the configured S-NSSAI in the serving PLMN. + n3gNodeReSel: + $ref: '#/components/schemas/Non3gppAccess' + sliceN3gNodeSelCap: + $ref: '#/components/schemas/SliceSpecificN3gNodeSelectionCapability' + satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + 5gsToEpsMob: + type: boolean + description: > + It indicates the UE Policy Association is triggered by a 5GS to EPS mobility + scenario. + vpsUePolGuidance: + type: object + additionalProperties: + $ref: '#/components/schemas/UePolicyParameters' + minProperties: 1 + description: > + Contains the service parameter used to guide the VPLMN-specific URSP and may contain + the subscription to VPLMN-specific URSP delivery outcome. + The key of the map represents the AF request to guide VPLMN-specific URSP rules. + This attribute only applies in roaming and when the V-PCF is the NF service consumer. + lboRoamInfo: + type: array + items: + $ref: '#/components/schemas/LboRoamingInformation' + minItems: 1 + description: > + Contains LBO roaming information for DNN and S-NSSAI combination(s). + This attribute only applies in roaming and when the AMF is the NF service consumer. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + rangSlCapab: + type: array + items: + $ref: '#/components/schemas/RangSLCapability' + minItems: 1 + required: + - notificationUri + - suppFeat + - supi + + PolicyAssociationUpdateRequest: + description: > + Represents Information that the NF service consumer provides when requesting the update of + a policy association. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + altNotifIpv4Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + description: Alternate or backup IPv4 Address(es) where to send Notifications. + altNotifIpv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + description: Alternate or backup IPv6 Address(es) where to send Notifications. + altNotifFqdns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + description: Alternate or backup FQDN(s) where to send Notifications. + triggers: + type: array + items: + $ref: '#/components/schemas/RequestTrigger' + minItems: 1 + description: Request Triggers that the NF service consumer observes. + praStatuses: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + description: > + Contains the UE presence status for tracking area for which changes of the UE presence + occurred. The praId attribute within the PresenceInfo data type is the key of the map. + minProperties: 1 + userLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + uePolDelResult: + $ref: '#/components/schemas/UePolicyDeliveryResult' + uePolTransFailNotif: + $ref: '#/components/schemas/UePolicyTransferFailureNotification' + uePolReq: + $ref: '#/components/schemas/UePolicyRequest' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + servingNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + connectState: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmState' + groupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + pc5Capab: + $ref: '#/components/schemas/Pc5Capability' + a2xCapab: + type: array + items: + $ref: '#/components/schemas/A2xCapability' + minItems: 1 + proSeCapab: + type: array + items: + $ref: '#/components/schemas/ProSeCapability' + minItems: 1 + confSnssais: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/ConfiguredSnssai' + minItems: 1 + description: > + The Configured NSSAI for the serving PLMN, and the mapped S-NSSAI value of home + network corresponding to the configured S-NSSAI in the serving PLMN. + n3gNodeReSel: + $ref: '#/components/schemas/Non3gppAccess' + sliceN3gNodeSelCap: + $ref: '#/components/schemas/SliceSpecificN3gNodeSelectionCapability' + satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + urspEnfRep: + type: object + additionalProperties: + $ref: '#/components/schemas/UrspEnforcementPduSession' + description: > + Contains information about the enforced URSP rule(s) in one or more PDU sessions. + The key of the map is a character string that represents an integer value. + minProperties: 1 + vpsUePolGuidance: + type: object + additionalProperties: + $ref: '#/components/schemas/UePolicyParameters' + minProperties: 1 + description: > + Contains the service parameter used to guide the VPLMN-specific URSP and may contain + the subscription to VPLMN-specific URSP delivery outcome. + The key of the map represents the AF request to guide VPLMN-specific URSP rules. + This attribute only applies in roaming and when the V-PCF is the NF service consumer. + nullable: true + lboRoamInfo: + type: array + items: + $ref: '#/components/schemas/LboRoamingInformation' + minItems: 1 + description: > + Contains LBO roaming information for DNN and S-NSSAI combination(s). + This attribute only applies in roaming and when the AMF is the NF service consumer. + accessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + description: > + The Access Type(s) where the served UE is camping. + It shall be provided, if available, for trigger "ACCESS_TYPE_CH. + ratTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + description: > + The RAT Type(s), if available, for the reported "accessTypes" where the served UE is + camping. It shall be provided, if available, for trigger "ACCESS_TYPE_CH. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + rangSlCapab: + type: array + items: + $ref: '#/components/schemas/RangSLCapability' + minItems: 1 + description: > + Contains the Ranging/SL related UE capabilities. + + PolicyUpdate: + description: > + Represents updated policies that the PCF provides in a notification or in the reply to an + Update Request. + type: object + properties: + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + uePolicy: + $ref: '#/components/schemas/UePolicy' + n2Pc5Pol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + n2Pc5PolA2x: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + n2Pc5ProSePol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + triggers: + type: array + items: + $ref: '#/components/schemas/RequestTrigger' + minItems: 1 + nullable: true + description: > + Request Triggers that the PCF subscribes. + pras: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + description: > + Contains the presence reporting area(s) for which reporting was requested. + The praId attribute within the PresenceInfo data type is the key of the map. + minProperties: 1 + nullable: true + andspDelInd: + $ref: '#/components/schemas/PolicyStatus' + delivReport: + type: object + additionalProperties: + $ref: '#/components/schemas/UePolicyNotification' + minProperties: 1 + description: > + Contains the delivery outcome of the VPLMN-specific URSP. + The key of the map represents the AF request of the corresponding subscription, i.e. its + value shall match the key that was previously provided by the V-PCF in the + vpsUePolGuidance attribute. + This attribute only applies in roaming and when the V-PCF is the NF service consumer. + pduSessions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + minItems: 1 + description: > + Combination of DNN and S-NSSAIs for which LBO information is requested. + nullable: true + pcfUeInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + matchPdus: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + minItems: 1 + nullable: true + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + n2Pc5RsppPol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + required: + - resourceUri + + TerminationNotification: + description: > + Represents a request to terminate a policy association that the PCF provides in a + notification. + type: object + properties: + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + cause: + $ref: '#/components/schemas/PolicyAssociationReleaseCause' + required: + - resourceUri + - cause + + UePolicyTransferFailureNotification: + description: > + Represents information on the failure of a UE policy transfer to the UE because the UE is + not reachable. + type: object + properties: + cause: + $ref: '#/components/schemas/UePolicyTransferFailureCause' + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + ptis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minItems: 1 + description: > + This contains a list of PTI assigned by the H-PCF corresponding to the UE policy(s) + which could not be transferred by the AMF. + required: + - cause + - ptis + + UeRequestedValueRep: + description: > + Contains the current applicable values corresponding to the policy control request triggers. + type: object + properties: + userLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + praStatuses: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Contains the UE presence statuses for tracking areas. The praId attribute within the + PresenceInfo data type is the key of the map. + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + connectState: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmState' + confSnssais: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/ConfiguredSnssai' + minItems: 1 + description: > + The Configured NSSAI for the serving PLMN, and the mapped S-NSSAI value of home + network corresponding to the configured S-NSSAI in the serving PLMN. + satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + urspEnfRep: + type: object + additionalProperties: + $ref: '#/components/schemas/UrspEnforcementPduSession' + description: > + Contains information about the enforced URSP rule(s) in one or more PDU sessions. + The key of the map is a character string that represents an integer value. + minProperties: 1 + lboRoamInfo: + type: array + items: + $ref: '#/components/schemas/LboRoamingInformation' + minItems: 1 + description: > + Contains LBO roaming information for DNN and S-NSSAI combination(s). + accessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + description: > + The Access Type(s) where the served UE is camping. + It shall be provided, if available, for trigger "ACCESS_TYPE_CH. + ratTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + description: > + The RAT Type(s), if available, for the reported "accessTypes" where the served UE is + camping. It shall be provided, if available, for trigger "ACCESS_TYPE_CH. + + UePolicyParameters: + description: > + Contains the service parameters used to guide the VPLMN-specific URSP rule determination. + type: object + properties: + urspGuidance: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/UrspRuleRequest' + minItems: 1 + description: > + Contains the service parameter used to guide the VPLMN-specific URSP. + deliveryEvents: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/Event' + minItems: 1 + description: > + AF subscribed event(s) notifications related to AF provisioned guidance + for VPLMN-specific URSP rules. + nullable: true + nullable: true + + LboRoamingInformation: + description: > + Contains LBO roaming information for a DNN and S-NSSAI. + type: object + properties: + lboRoamAllowed: + type: boolean + description: > + Indicates whether LBO for the DNN and S-NSSAI is allowed when roaming. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - dnn + - snssai + + UrspEnforcementPduSession: + description: > + Represents URSP rule enforcement information for a PDU session. + type: object + required: + - urspEnfInfo + properties: + urspEnfInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/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' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + + UePolicyNotification: + description: > + Contains the delivery outcome of VPLMN-specific URSP rules. + type: object + required: + - eventNotifs + properties: + eventNotifs: + type: array + items: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/PcEventNotification' + minItems: 1 + description: > + Represents the events to be reported according to the subscription to notifications + of VPLMN-specific URSP delivery outcome events. + + UePolicy: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + UePolicyDeliveryResult: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + UePolicyRequest: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + RequestTrigger: + anyOf: + - type: string + enum: + - LOC_CH + - PRA_CH + - UE_POLICY + - PLMN_CH + - CON_STATE_CH + - GROUP_ID_LIST_CHG + - UE_CAP_CH + - SAT_CATEGORY_CHG + - NON_3GPP_NODE_RESELECTION + - CONF_NSSAI_CH + - LBO_INFO_CH + - FEAT_RENEG + - URSP_ENF_INFO + - ACCESS_TYPE_CH + - 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 possible request triggers. + Possible values are: + - LOC_CH: Location change (tracking area). The tracking area of the UE has changed. + - PRA_CH: Change of UE presence in PRA. The AMF reports the current presence status + of the UE in a Presence Reporting Area, and notifies that the UE enters/leaves the + Presence Reporting Area. + - UE_POLICY: A MANAGE UE POLICY COMPLETE message or a MANAGE UE POLICY COMMAND REJECT + message, as defined in Annex D.5 of 3GPP TS 24.501 or a "UE POLICY PROVISIONING REQUEST" + message, as defined in clause 7.2.1.1 of 3GPP TS 24.587, has been received by the AMF + and is being forwarded. + - PLMN_CH: PLMN change. the serving PLMN of UE has changed. + - CON_STATE_CH: Connectivity state change: the connectivity state of UE has changed. + - GROUP_ID_LIST_CHG: UE Internal Group Identifier(s) has changed. This policy + control request + trigger does not require a subscription. + - UE_CAP_CH: UE Capabilities change: the UE provided 5G ProSe capabilities have changed. + This policy control request trigger does not require subscription. + - SAT_CATEGORY_CHG: Indicates that the AMF has detected a change between different satellite + category, or non-satellite backhaul. + - NON_3GPP_NODE_RESELECTION: The UE has connected to a wrong non-3GPP access node that + does not match its subscribed S-NSSAI(s). This policy control request trigger does not + require a subscription. + - CONF_NSSAI_CH: Configured NSSAI change. Indicates that the configured NSSAI has changed. + - LBO_INFO_CH: LBO information change. The AMF reports LBO roaming allowed or not allowed + for the requested DNN(s) and S-NSSAI(s). This policy control request trigger only applies + in roaming scenarios when the NF service consumer is the AMF. + - FEAT_RENEG: The NF service consumer notifies that the target AMF is requesting feature + re-negotiation. + - URSP_ENF_INFO: The V-PCF has received URSP rule enforcement information about the enforced + URSP rule(s) in one or more PDU sessions. This trigger applies in roaming scenarios and + to the V-PCF. + - ACCESS_TYPE_CH: Access Type change. The registered access type and RAT type + has changed, an access type and RAT type is added or removed. + + PolicyAssociationReleaseCause: + anyOf: + - type: string + enum: + - UNSPECIFIED + - UE_SUBSCRIPTION + - INSUFFICIENT_RES + - 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 why the PCF requests the policy association termination. + Possible values are: + - UNSPECIFIED: This value is used for unspecified reasons. + - UE_SUBSCRIPTION: This value is used to indicate that the policy association needs to be + terminated because the subscription of UE has changed (e.g. was removed). + - INSUFFICIENT_RES: This value is used to indicate that the server is overloaded and needs + to abort the policy association. + + Pc5Capability: + anyOf: + - type: string + enum: + - LTE_PC5 + - NR_PC5 + - LTE_NR_PC5 + - 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 specific PC5 RAT(s) which the UE supports for V2X communications over + PC5 reference point. + Possible values are: + - LTE_PC5: This value is used to indicate that UE supports PC5 LTE RAT for V2X + communications over the PC5 reference point + - NR_PC5: This value is used to indicate that UE supports PC5 NR RAT for V2X communications + over the PC5 reference point. + - LTE_NR_PC5: This value is used to indicate that UE supports both PC5 LTE and NR RAT for + V2X communications over the PC5 reference point. + + ProSeCapability: + anyOf: + - type: string + enum: + - PROSE_DD + - PROSE_DC + - PROSE_L2_U2N_RELAY + - PROSE_L3_U2N_RELAY + - PROSE_L2_REMOTE_UE + - PROSE_L3_REMOTE_UE + - PROSE_L2_U2U_RELAY + - PROSE_L3_U2U_RELAY + - PROSE_L2_END_UE + - PROSE_L3_END_UE + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + the content defined in the present version of this API. + description: | + Represents the 5G ProSe capabilities. + Possible values are: + - PROSE_DD: This value is used to indicate that 5G ProSe Direct Discovery is supported + by the UE. + - PROSE_DC: This value is used to indicate that 5G ProSe Direct Communication is supported + by the UE. + - PROSE_L2_U2N_RELAY: This value is used to indicate that Layer-2 5G ProSe UE-to-Network + Relay is supported by the UE. + - PROSE_L3_U2N_RELAY: This value is used to indicate that Layer-3 5G ProSe UE-to-Network + Relay is supported by the UE. + - PROSE_L2_REMOTE_UE: This value is used to indicate that Layer-2 5G ProSe Remote UE is + supported by the UE. + - PROSE_L3_REMOTE_UE: This value is used to indicate that Layer-3 5G ProSe Remote UE is + supported by the UE. + - PROSE_L2_U2U_RELAY: This value is used to indicate that Layer-2 5G ProSe UE-to-UE + Relay is supported by the UE. + - PROSE_L3_U2U_RELAY: This value is used to indicate that Layer-3 5G ProSe UE-to-UE + Relay is supported by the UE. + - PROSE_L2_END_UE: This value is used to indicate that Layer-2 5G ProSe End UE is + supported by the UE. + - PROSE_L3_END_UE: This value is used to indicate that Layer-3 5G ProSe End UE is + supported by the UE. + + Non3gppAccess: + anyOf: + - type: string + enum: + - N3IWF + - TNGF + - 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 a non-3gpp access node. + Possible values are: + - N3IWF: Non-3gpp Interworking Function. + - TNGF: Trusted Non-3gpp Gateway Function. + + N1N2MessTransferErrorReply: + anyOf: + - type: string + enum: + - UE_NOT_REACHABLE + - UNSPECIFIED + - 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 an N1N2 Message Transfer error. + Possible values are: + - UE_NOT_REACHABLE: The UE is not reachable for paging. + - UNSPECIFIED: Unspecified error. + + RangSLCapability: + anyOf: + - type: string + enum: + - PC5_RANGING_SL + - 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 Ranging and Sidelink Capability. + Possible values are: + - PC5_RANGING_SL: Indicates that the PC5 Capability for Ranging and Sidelink is supported + by the UE. + + PolicyStatus: + anyOf: + - type: string + enum: + - CONFIGURED + - NOT_CONFIGURED + - 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 configuration status of a UE Policy in the UE. + Possible values are: + - CONFIGURED: The UE Policy is configured in the UE. + - NOT_CONFIGURED: The UE Policy is not configured in the UE. + + A2xCapability: + anyOf: + - type: string + enum: + - EUTRA_PC5 + - NR_PC5 + - UU + - 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 A2X capabilities the UE supports for A2X communication. + Possible values are: + - EUTRA_PC5: This value is used to indicate that the UE supports PC5 EUTRA RAT for A2X + communications over the PC5 reference point + - NR_PC5: This value is used to indicate that the UE supports PC5 NR RAT for A2X + communications over the PC5 reference point. + - UU: This value is used to indicate that UE supports A2X communications over the PC5 + reference point. + + SliceSpecificN3gNodeSelectionCapability: + anyOf: + - type: string + enum: + - ONLY_N3IWF_SS_SEL + - ONLY_TNGF_SS_SEL + - TNGF_N3IWF_SS_SEL + - 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 UE capabilities with regard to slice-specific non-3gpp node selection. + Possible values are: + - ONLY_N3IWF_SS_SEL: Indicates that the UE supports N3IWF selection based on the slices + the UE wishes to use over untrusted non-3GPP access. + - ONLY_TNGF_SS_SEL: Indicates that the UE supports TNGF selection based on the slices + the UE wishes to use over trusted non-3GPP access. + - TNGF_N3IWF_SS_SEL: Indicates that the UE supports N3IWF selection based on the slices + the UE wishes to use over untrusted non-3GPP access and TNGF selection based on the + slices the UE wishes to use over trusted non-3GPP access. +# + UePolicyTransferFailureCause: + description: UE Policy Transfer Failure Cause. + anyOf: + - $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N1N2MessageTransferCause' + - $ref: '#/components/schemas/N1N2MessTransferErrorReply' + + -- GitLab From b10d6137480de91c205e55f7d9173501ad21cdd5 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 01:48:18 +0000 Subject: [PATCH 17/33] Upload the YAML for cross reference compile --- OpenAPI/TS29510_Nnrf_NFManagement.yaml | 5984 ++++++++++++++++++++++++ 1 file changed, 5984 insertions(+) create mode 100644 OpenAPI/TS29510_Nnrf_NFManagement.yaml diff --git a/OpenAPI/TS29510_Nnrf_NFManagement.yaml b/OpenAPI/TS29510_Nnrf_NFManagement.yaml new file mode 100644 index 0000000..a7ab573 --- /dev/null +++ b/OpenAPI/TS29510_Nnrf_NFManagement.yaml @@ -0,0 +1,5984 @@ +openapi: 3.0.0 + +info: + version: '1.4.0-alpha.1' + title: 'NRF NFManagement Service' + description: | + NRF NFManagement Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.510 V19.0.0; 5G System; Network Function Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' + +servers: + - url: '{apiRoot}/nnrf-nfm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + +paths: + /nf-instances: + get: + summary: Retrieves a collection of NF Instances + operationId: GetNFInstances + tags: + - NF Instances (Store) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instances:read + parameters: + - name: nf-type + in: query + description: Type of NF + required: false + schema: + $ref: '#/components/schemas/NFType' + - name: limit + in: query + description: How many items to return at one time + required: false + schema: + type: integer + minimum: 1 + - name: page-number + in: query + description: Page number where the response shall start + required: false + schema: + type: integer + minimum: 1 + - name: page-size + in: query + description: Maximum number of items in each returned page + schema: + type: integer + minimum: 1 + responses: + '200': + description: Expected response to a valid request + content: + application/3gppHal+json: + schema: + $ref: '#/components/schemas/UriList' + headers: + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + 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' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + options: + summary: Discover communication options supported by NRF for NF Instances + operationId: OptionsNFInstances + tags: + - NF Instances (Store) + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OptionsResponse' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '204': + description: No Content + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + 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' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /nf-instances/{nfInstanceID}: + get: + summary: Read the profile of a given NF Instance + operationId: GetNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instances:read + parameters: + - name: nfInstanceID + in: path + description: Unique ID of the NF Instance + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + - name: requester-features + in: query + description: Features supported by the NF Service Consumer + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + headers: + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + 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' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + put: + summary: Register a new NF Instance + operationId: RegisterNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instance:write + parameters: + - name: nfInstanceID + in: path + required: true + description: Unique ID of the NF Instance to register + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + required: true + responses: + '200': + description: OK (Profile Replacement) + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnrf-nfm/v1/nf-instances/{nfInstanceId} + required: true + schema: + type: string + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '400': + description: Bad Request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/NFProfileRegistrationError' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + patch: + summary: Update NF Instance profile + operationId: UpdateNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instance:write + parameters: + - name: nfInstanceID + in: path + required: true + description: Unique ID of the NF Instance to update + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: If-Match + in: header + description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.1 + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '204': + description: Expected response with empty body + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '412': + $ref: 'TS29571_CommonData.yaml#/components/responses/412' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + delete: + summary: Deregisters a given NF Instance + operationId: DeregisterNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instance:write + parameters: + - name: nfInstanceID + in: path + required: true + description: Unique ID of the NF Instance to deregister + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + responses: + '204': + description: Expected response to a successful deregistration + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + 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' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /shared-data: + get: + summary: Retrieves a collection of Shared Data + operationId: GetSharedDataCollection + tags: + - Shared Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:shared-data:read + parameters: + - name: shared-data-ids + in: query + description: List of shared data IDs + required: true + style: form + explode: false + schema: + $ref: '#/components/schemas/SharedDataIdList' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SharedData' + '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' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /shared-data/{sharedDataId}: + get: + summary: Read the shared data identified by a given NF sharedDataId + operationId: GetSharedData + tags: + - Shared Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:shared-data:read + parameters: + - name: sharedDataId + in: path + description: Unique ID of the Shared Data + required: true + schema: + type: string + format: uuid + - name: requester-features + in: query + description: Features supported by the NF Service Consumer + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + headers: + ETag: + description: Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SharedData' + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + 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' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + put: + summary: Register new Shared Data + operationId: RegisterSharedData + tags: + - Shared Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:shared-data:write + parameters: + - name: sharedDataId + in: path + required: true + description: Unique ID of the Shared Data to register + schema: + type: string + format: uuid + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SharedData' + required: true + responses: + '200': + description: OK (Shared Data Replacement) + content: + application/json: + schema: + $ref: '#/components/schemas/SharedData' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + ETag: + description: Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SharedData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnrf-nfm//shared-data/{sharedDataId} + required: true + schema: + type: string + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + ETag: + description: Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + '204': + description: No Content (Shared Data Replacement) + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + 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' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + patch: + summary: Update Shared Data + operationId: UpdateSharedData + tags: + - Shared Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:shared-data:write + parameters: + - name: sharedDataId + in: path + required: true + description: Unique ID of shared data to update + schema: + type: string + format: uuid + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: If-Match + in: header + description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.1 + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SharedData' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + ETag: + description: Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '204': + description: Expected response with empty body + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '412': + $ref: 'TS29571_CommonData.yaml#/components/responses/412' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + delete: + summary: Delete Shared Data identified by a given sharedDataId + operationId: DeleteSharedData + tags: + - Shared Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:shared-data:write + parameters: + - name: sharedDataId + in: path + required: true + description: Unique ID of the Shared Data to deregister + schema: + type: string + format: uuid + responses: + '204': + description: Expected response to a successful deregistration + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + 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' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /subscriptions: + post: + summary: Create a new subscription + operationId: CreateSubscription + tags: + - Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:subscriptions:subs-complete-profile + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnrf-nfm/v1/subscriptions/{subscriptionId} + required: true + schema: + type: string + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + 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' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + onNFStatusEvent: + '{$request.body#/nfStatusNotificationUri}': + post: + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: Notification content + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationData' + responses: + '204': + description: Expected response to a successful callback processing + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: > + The URI pointing to the resource located on another NF service + consumer instance + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: > + The URI pointing to the resource located on another NF service + consumer instance + 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' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /subscriptions/{subscriptionID}: + patch: + summary: Updates a subscription + operationId: UpdateSubscription + tags: + - Subscription ID (Document) + parameters: + - name: subscriptionID + in: path + required: true + description: Unique ID of the subscription to update + schema: + type: string + pattern: '^([0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?)?[^-]+$' + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '204': + description: No Content + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + delete: + summary: Deletes a subscription + operationId: RemoveSubscription + tags: + - Subscription ID (Document) + parameters: + - name: subscriptionID + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string + pattern: '^([0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?)?[^-]+$' + responses: + '204': + description: Expected response to a successful subscription removal + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + 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' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '/oauth2/token' + scopes: + nnrf-nfm: Access to the Nnrf_NFManagement API + nnrf-nfm:nf-instances:read: > + Access to read the nf-instances resource, or an individual NF Instance ID resource + nnrf-nfm:subscriptions:subs-complete-profile: > + Access to subscribe to the complete profile of NF instances + nnrf-nfm:nf-instance:write: > + Access to write (create, update, delete) an individual NF Instance ID resource + nnrf-nfm:shared-data:read: > + Access to read shared data + nnrf-nfm:shared-data:write: > + Access to write (create, update, delete) shared data + + schemas: + + NFProfile: + description: Information of an NF Instance registered in the NRF + type: object + required: + - nfInstanceId + - nfType + - nfStatus + anyOf: + - required: [ fqdn ] + - required: [ ipv4Addresses ] + - required: [ ipv6Addresses ] + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfInstanceName: + type: string + nfType: + $ref: '#/components/schemas/NFType' + nfStatus: + $ref: '#/components/schemas/NFStatus' + collocatedNfInstances: + type: array + items: + $ref: '#/components/schemas/CollocatedNfInstance' + minItems: 1 + heartBeatTimer: + type: integer + minimum: 1 + plmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + snpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + perPlmnSnssaiList: + type: array + items: + $ref: '#/components/schemas/PlmnSnssai' + minItems: 1 + nsiList: + type: array + items: + type: string + minItems: 1 + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + ipv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + allowedSnpns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + allowedNfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + allowedNfDomains: + type: array + items: + type: string + minItems: 1 + allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + allowedRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/RuleSet' + minProperties: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + capacity: + type: integer + minimum: 0 + maximum: 65535 + load: + type: integer + minimum: 0 + maximum: 100 + loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + locality: + type: string + extLocality: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string serves + as key representing a type of locality + type: object + additionalProperties: + type: string + minProperties: 1 + udrInfo: + $ref: '#/components/schemas/UdrInfo' + udrInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdrInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UdrInfo' + minProperties: 1 + udmInfo: + $ref: '#/components/schemas/UdmInfo' + udmInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdmInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UdmInfo' + minProperties: 1 + ausfInfo: + $ref: '#/components/schemas/AusfInfo' + ausfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AusfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/AusfInfo' + minProperties: 1 + amfInfo: + $ref: '#/components/schemas/AmfInfo' + amfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AmfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/AmfInfo' + minProperties: 1 + smfInfo: + $ref: '#/components/schemas/SmfInfo' + smfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of SmfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/SmfInfo' + minProperties: 1 + upfInfo: + $ref: '#/components/schemas/UpfInfo' + upfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UpfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UpfInfo' + minProperties: 1 + pcfInfo: + $ref: '#/components/schemas/PcfInfo' + pcfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PcfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/PcfInfo' + minProperties: 1 + bsfInfo: + $ref: '#/components/schemas/BsfInfo' + bsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of BsfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/BsfInfo' + minProperties: 1 + chfInfo: + $ref: '#/components/schemas/ChfInfo' + chfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of ChfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/ChfInfo' + minProperties: 1 + nefInfo: + $ref: '#/components/schemas/NefInfo' + nrfInfo: + $ref: '#/components/schemas/NrfInfo' + udsfInfo: + $ref: '#/components/schemas/UdsfInfo' + udsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdsfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UdsfInfo' + minProperties: 1 + nwdafInfo: + $ref: '#/components/schemas/NwdafInfo' + nwdafInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NwdafInfo + additionalProperties: + $ref: '#/components/schemas/NwdafInfo' + minProperties: 1 + pcscfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PcscfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/PcscfInfo' + minProperties: 1 + hssInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of HssInfo + type: object + additionalProperties: + $ref: '#/components/schemas/HssInfo' + minProperties: 1 + customInfo: + type: object + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + nfServicePersistence: + type: boolean + default: false + nfServices: + deprecated: true + type: array + items: + $ref: '#/components/schemas/NFService' + minItems: 1 + nfServiceList: + description: > + A map (list of key-value pairs) where serviceInstanceId serves as key of NFService + type: object + additionalProperties: + $ref: '#/components/schemas/NFService' + minProperties: 1 + nfProfileChangesSupportInd: + type: boolean + default: false + writeOnly: true + nfProfilePartialUpdateChangesSupportInd: + type: boolean + default: false + writeOnly: true + nfProfileChangesInd: + type: boolean + default: false + readOnly: true + defaultNotificationSubscriptions: + type: array + items: + $ref: '#/components/schemas/DefaultNotificationSubscription' + lmfInfo: + $ref: '#/components/schemas/LmfInfo' + gmlcInfo: + $ref: '#/components/schemas/GmlcInfo' + nfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + servingScope: + type: array + items: + type: string + minItems: 1 + lcHSupportInd: + type: boolean + default: false + olcHSupportInd: + type: boolean + default: false + nfSetRecoveryTimeList: + description: A map (list of key-value pairs) where NfSetId serves as key of DateTime + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minProperties: 1 + serviceSetRecoveryTimeList: + description: > + A map (list of key-value pairs) where NfServiceSetId serves as key of DateTime + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minProperties: 1 + scpDomains: + type: array + items: + type: string + minItems: 1 + scpInfo: + $ref: '#/components/schemas/ScpInfo' + seppInfo: + $ref: '#/components/schemas/SeppInfo' + vendorId: + $ref: '#/components/schemas/VendorId' + supportedVendorSpecificFeatures: + description: > + The key of the map is the IANA-assigned SMI Network Management Private Enterprise Codes + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + aanfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AanfInfo + additionalProperties: + $ref: '#/components/schemas/AanfInfo' + minProperties: 1 + 5gDdnmfInfo: + $ref: '#/components/schemas/5GDdnmfInfo' + mfafInfo: + $ref: '#/components/schemas/MfafInfo' + easdfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of EasdfInfo + additionalProperties: + $ref: '#/components/schemas/EasdfInfo' + minProperties: 1 + dccfInfo: + $ref: '#/components/schemas/DccfInfo' + nsacfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NsacfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/NsacfInfo' + minProperties: 1 + mbSmfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbSmfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/MbSmfInfo' + minProperties: 1 + tsctsfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of TsctsfInfo + additionalProperties: + $ref: '#/components/schemas/TsctsfInfo' + minProperties: 1 + mbUpfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbUpfInfo + additionalProperties: + $ref: '#/components/schemas/MbUpfInfo' + minProperties: 1 + trustAfInfo: + $ref: '#/components/schemas/TrustAfInfo' + nssaafInfo: + $ref: '#/components/schemas/NssaafInfo' + hniList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + iwmscInfo: + $ref: '#/components/schemas/IwmscInfo' + mnpfInfo: + $ref: '#/components/schemas/MnpfInfo' + smsfInfo: + $ref: '#/components/schemas/SmsfInfo' + dcsfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of DcsfInfo + additionalProperties: + $ref: '#/components/schemas/DcsfInfo' + minProperties: 1 + mrfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfInfo + additionalProperties: + $ref: '#/components/schemas/MrfInfo' + minProperties: 1 + mrfpInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfpInfo + additionalProperties: + $ref: '#/components/schemas/MrfpInfo' + minProperties: 1 + mfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MfInfo + additionalProperties: + $ref: '#/components/schemas/MfInfo' + minProperties: 1 + adrfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AdrfInfo + additionalProperties: + $ref: '#/components/schemas/AdrfInfo' + minProperties: 1 + selectionConditions: + $ref: '#/components/schemas/SelectionConditions' + canaryRelease: + type: boolean + default: false + exclusiveCanaryReleaseSelection: + type: boolean + default: false + sharedProfileDataId: + type: string + format: uuid + + SharedData: + description: Shared Data + type: object + required: + - sharedDataId + properties: + sharedDataId: + type: string + format: uuid + sharedProfileData: + $ref: '#/components/schemas/NFProfile' + sharedServiceData: + $ref: '#/components/schemas/NFService' + authorizedWriteScope: + $ref: '#/components/schemas/SharedScope' + + SharedScope: + description: Authorized Scope for a Shared Data + type: object + properties: + nfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + + NFProfileRegistrationError: + description: NF Profile Registration Error. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/SharedDataIdList' + + SharedDataIdList: + description: Shared Data IDs + type: object + required: + - sharedDataIds + properties: + sharedDataIds: + type: array + items: + type: string + format: uuid + minItems: 1 + + NFService: + description: > + Information of a given NF Service Instance; it is part of the NFProfile of an NF Instance + type: object + required: + - serviceInstanceId + - serviceName + - versions + - scheme + - nfServiceStatus + properties: + serviceInstanceId: + type: string + serviceName: + $ref: '#/components/schemas/ServiceName' + versions: + type: array + items: + $ref: '#/components/schemas/NFServiceVersion' + minItems: 1 + scheme: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UriScheme' + nfServiceStatus: + $ref: '#/components/schemas/NFServiceStatus' + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + ipEndPoints: + type: array + items: + $ref: '#/components/schemas/IpEndPoint' + minItems: 1 + apiPrefix: + type: string + callbackUriPrefixList: + type: array + items: + $ref: '#/components/schemas/CallbackUriPrefixItem' + minItems: 1 + defaultNotificationSubscriptions: + type: array + items: + $ref: '#/components/schemas/DefaultNotificationSubscription' + minItems: 1 + allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + allowedSnpns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + allowedNfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + allowedNfDomains: + type: array + items: + type: string + minItems: 1 + allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + allowedOperationsPerNfType: + description: A map (list of key-value pairs) where NF Type serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 + allowedOperationsPerNfInstance: + description: A map (list of key-value pairs) where NF Instance Id serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 + allowedOperationsPerNfInstanceOverrides: + type: boolean + default: false + allowedScopesRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/RuleSet' + minProperties: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + capacity: + type: integer + minimum: 0 + maximum: 65535 + load: + type: integer + minimum: 0 + maximum: 100 + loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + nfServiceSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + minItems: 1 + sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + perPlmnSnssaiList: + type: array + items: + $ref: '#/components/schemas/PlmnSnssai' + minItems: 1 + vendorId: + $ref: '#/components/schemas/VendorId' + supportedVendorSpecificFeatures: + description: > + A map (list of key-value pairs) where IANA-assigned SMI Network Management + Private Enterprise Codes serves as key + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + oauth2Required: + type: boolean + perPlmnOauth2ReqList: + $ref: '#/components/schemas/PlmnOauth2' + selectionConditions: + $ref: '#/components/schemas/SelectionConditions' + canaryRelease: + type: boolean + default: false + exclusiveCanaryReleaseSelection: + type: boolean + default: false + sharedServiceDataId: + type: string + format: uuid + + NFType: + description: NF types known to NRF + anyOf: + - type: string + enum: + - NRF + - UDM + - AMF + - SMF + - AUSF + - NEF + - PCF + - SMSF + - NSSF + - UDR + - LMF + - GMLC + - 5G_EIR + - SEPP + - UPF + - N3IWF + - AF + - UDSF + - BSF + - CHF + - NWDAF + - PCSCF + - CBCF + - HSS + - UCMF + - SOR_AF + - SPAF + - MME + - SCSAS + - SCEF + - SCP + - NSSAAF + - ICSCF + - SCSCF + - DRA + - IMS_AS + - AANF + - 5G_DDNMF + - NSACF + - MFAF + - EASDF + - DCCF + - MB_SMF + - TSCTSF + - ADRF + - GBA_BSF + - CEF + - MB_UPF + - NSWOF + - PKMF + - MNPF + - SMS_GMSC + - SMS_IWMSC + - MBSF + - MBSTF + - PANF + - IP_SM_GW + - SMS_ROUTER + - DCSF + - MRF + - MRFP + - MF + - SLPKMF + - RH + - type: string + + NefId: + description: Identity of the NEF + type: string + + IpEndPoint: + description: > + IP addressing information of a given NFService; + it consists on, e.g. IP address, TCP port, transport protocol... + type: object + not: + required: [ ipv4Address, ipv6Address ] + properties: + ipv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + transport: + $ref: '#/components/schemas/TransportProtocol' + port: + type: integer + minimum: 0 + maximum: 65535 + + SubscriptionData: + description: > + Information of a subscription to notifications to NRF events, + included in subscription requests and responses + type: object + required: + - nfStatusNotificationUri + properties: + nfStatusNotificationUri: + type: string + reqNfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + sharedDataIds: + type: array + items: + type: string + minItems: 1 + subscrCond: + $ref: '#/components/schemas/SubscrCond' + subscriptionId: + type: string + pattern: '^([0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?)?[^-]+$' + readOnly: true + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reqNotifEvents: + type: array + items: + $ref: '#/components/schemas/NotificationEventType' + minItems: 1 + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + notifCondition: + $ref: '#/components/schemas/NotifCondition' + reqNfType: + $ref: '#/components/schemas/NFType' + reqNfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + reqSnssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + reqPerPlmnSnssais: + type: array + items: + $ref: '#/components/schemas/PlmnSnssai' + minItems: 1 + reqPlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + reqSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + servingScope: + type: array + items: + type: string + minItems: 1 + requesterFeatures: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + nrfSupportedFeatures: + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + hnrfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + onboardingCapability: + type: boolean + default: false + targetHni: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + preferredLocality: + type: string + extPreferredLocality: + description: > + A map (list of key-value pairs) where the key of the map represents the relative + priority, for the requester, of each locality description among the list of locality + descriptions in this query parameter, encoded as "1" (highest priority"), "2", "3", …, + "n" (lowest priority) + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/LocalityDescription' + minItems: 1 + minProperties: 1 + completeProfileSubscription: + type: boolean + default: false + writeOnly: true + + SubscrCond: + description: > + Condition to determine the set of NFs to monitor under a certain subscription in NRF + oneOf: + - $ref: '#/components/schemas/NfInstanceIdCond' + - $ref: '#/components/schemas/NfInstanceIdListCond' + - $ref: '#/components/schemas/NfTypeCond' + - $ref: '#/components/schemas/ServiceNameCond' + - $ref: '#/components/schemas/ServiceNameListCond' + - $ref: '#/components/schemas/AmfCond' + - $ref: '#/components/schemas/GuamiListCond' + - $ref: '#/components/schemas/NetworkSliceCond' + - $ref: '#/components/schemas/NfGroupCond' + - $ref: '#/components/schemas/NfGroupListCond' + - $ref: '#/components/schemas/NfSetCond' + - $ref: '#/components/schemas/NfServiceSetCond' + - $ref: '#/components/schemas/UpfCond' + - $ref: '#/components/schemas/ScpDomainCond' + - $ref: '#/components/schemas/NwdafCond' + - $ref: '#/components/schemas/NefCond' + - $ref: '#/components/schemas/DccfCond' + + NfInstanceIdCond: + description: Subscription to a given NF Instance Id + type: object + required: + - nfInstanceId + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + + NfInstanceIdListCond: + description: Subscription to a list of NF Instances + type: object + required: + - nfInstanceIdList + properties: + nfInstanceIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + + NfTypeCond: + description: Subscription to a set of NFs based on their NF Type + type: object + required: + - nfType + allOf: + - not: + required: [ nfGroupId ] + - not: + required: [ conditionType, nfGroupIdList ] + properties: + nfType: + $ref: '#/components/schemas/NFType' + + ServiceNameCond: + description: Subscription to a set of NFs based on their support for a given Service Name + type: object + required: + - serviceName + properties: + serviceName: + $ref: '#/components/schemas/ServiceName' + + ServiceNameListCond: + description: > + Subscription to a set of NFs based on their support for a Service Name + in the Servic Name list + type: object + required: + - conditionType + - serviceNameList + properties: + conditionType: + type: string + enum: [ SERVICE_NAME_LIST_COND ] + serviceNameList: + type: array + items: + $ref: '#/components/schemas/ServiceName' + minItems: 1 + + AmfCond: + description: Subscription to a set of AMFs, based on AMF Set Id and/or AMF Region Id + type: object + anyOf: + - required: [ amfSetId ] + - required: [ amfRegionId ] + properties: + amfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' + amfRegionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' + + GuamiListCond: + description: Subscription to a set of AMFs, based on their GUAMIs + type: object + required: + - guamiList + properties: + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + + NetworkSliceCond: + description: Subscription to a set of NFs, based on the slices (S-NSSAI and NSI) they support + type: object + required: + - snssaiList + properties: + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + nsiList: + type: array + items: + type: string + + NfGroupCond: + description: Subscription to a set of NFs based on their Group Id + type: object + required: + - nfType + - nfGroupId + properties: + nfType: + type: string + enum: + - UDM + - AUSF + - UDR + - PCF + - CHF + - HSS + - BSF + - UDSF + nfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + + NfGroupListCond: + description: Subscription to a set of NFs based on their Group Ids + type: object + required: + - conditionType + - nfType + - nfGroupIdList + properties: + conditionType: + type: string + enum: [ NF_GROUP_LIST_COND ] + nfType: + type: string + enum: + - UDM + - AUSF + - UDR + - PCF + - CHF + - HSS + - BSF + - UDSF + nfGroupIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + minItems: 1 + + NotifCondition: + description: > + Condition (list of attributes in the NF Profile) to determine whether a notification + must be sent by NRF + type: object + not: + required: [ monitoredAttributes, unmonitoredAttributes ] + properties: + monitoredAttributes: + type: array + items: + type: string + minItems: 1 + unmonitoredAttributes: + type: array + items: + type: string + minItems: 1 + + UdrInfo: + description: Information of an UDR NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + supportedDataSets: + type: array + items: + $ref: '#/components/schemas/DataSetId' + minItems: 1 + sharedDataIdRanges: + type: array + items: + $ref: '#/components/schemas/SharedDataIdRange' + minItems: 1 + + SharedDataIdRange: + description: A range of SharedDataIds based on regular-expression matching + type: object + properties: + pattern: + type: string + + SupiRange: + description: > + A range of SUPIs (subscriber identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]+$' + end: + type: string + pattern: '^[0-9]+$' + pattern: + type: string + + IdentityRange: + description: > + A range of GPSIs (subscriber identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]+$' + end: + type: string + pattern: '^[0-9]+$' + pattern: + type: string + + InternalGroupIdRange: + description: > + A range of Group IDs (internal group identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + pattern: + type: string + + DataSetId: + description: Types of data sets and subsets stored in UDR + anyOf: + - type: string + enum: + - SUBSCRIPTION + - POLICY + - EXPOSURE + - APPLICATION + - A_PFD + - A_AFTI + - A_AFQOS + - A_IPTV + - A_BDT + - A_SPD + - A_EASD + - A_EACI + - A_AMI + - A_DEM + - A_ALIM + - P_UE + - P_SCD + - P_BDT + - P_PLMNUE + - P_NSSCD + - P_PDTQ + - P_MBSCD + - P_GROUP + - type: string + + UdmInfo: + description: Information of an UDM NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + minItems: 1 + suciInfos: + type: array + items: + $ref: '#/components/schemas/SuciInfo' + minItems: 1 + + AusfInfo: + description: Information of an AUSF NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + suciInfos: + type: array + items: + $ref: '#/components/schemas/SuciInfo' + minItems: 1 + + AmfInfo: + description: Information of an AMF NF Instance + type: object + required: + - amfSetId + - amfRegionId + - guamiList + properties: + amfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' + amfRegionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + backupInfoAmfFailure: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + backupInfoAmfRemoval: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + n2InterfaceAmfInfo: + $ref: '#/components/schemas/N2InterfaceAmfInfo' + amfOnboardingCapability: + type: boolean + default: false + highLatencyCom: + type: boolean + + SmfInfo: + description: Information of an SMF NF Instance + type: object + required: + - sNssaiSmfInfoList + properties: + sNssaiSmfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiSmfInfoItem' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pgwIpAddrList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + accessType: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + vsmfSupportInd: + type: boolean + pgwFqdnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + smfOnboardingCapability: + type: boolean + default: false + deprecated: true + ismfSupportInd: + type: boolean + smfUPRPCapability: + type: boolean + default: false + + SnssaiSmfInfoItem: + description: Set of parameters supported by SMF for a given S-NSSAI + type: object + required: + - sNssai + anyOf: + - required: [ dnnSmfInfoList ] + - required: [ dnnSmfInfoListId ] + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnSmfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnSmfInfoItem' + minItems: 1 + dnnSmfInfoListId: + type: integer + + DnnSmfInfoItem: + description: Set of parameters supported by SMF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + dnaiList: + type: array + items: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + - $ref: '#/components/schemas/WildcardDnai' + minItems: 1 + uePlmnRangeList: + type: array + items: + $ref: '#/components/schemas/PlmnRange' + minItems: 1 + + UpfInfo: + description: Information of an UPF NF Instance + type: object + required: + - sNssaiUpfInfoList + properties: + sNssaiUpfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiUpfInfoItem' + minItems: 1 + smfServingArea: + type: array + items: + type: string + minItems: 1 + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + n6TunnelInfoList: + description: > + A map of InterfaceUpfInfoItems containing the N6 tunnelling information for establishing + a N6 tunnel between the V-UPF and the V-EASDF, where a valid JSON string serves as key. + type: object + additionalProperties: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minProperties: 1 + iwkEpsInd: + type: boolean + default: false + sxaInd: + type: boolean + pduSessionTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + atsssCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability' + ueIpAddrInd: + type: boolean + default: false + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + wAgfInfo: + $ref: '#/components/schemas/WAgfInfo' + tngfInfo: + $ref: '#/components/schemas/TngfInfo' + twifInfo: + $ref: '#/components/schemas/TwifInfo' + preferredEpdgInfoList: + type: array + items: + $ref: '#/components/schemas/EpdgInfo' + minItems: 1 + preferredWAgfInfoList: + type: array + items: + $ref: '#/components/schemas/WAgfInfo' + minItems: 1 + preferredTngfInfoList: + type: array + items: + $ref: '#/components/schemas/TngfInfo' + minItems: 1 + preferredTwifInfoList: + type: array + items: + $ref: '#/components/schemas/TwifInfo' + minItems: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + redundantGtpu: + type: boolean + default: false + ipups: + type: boolean + default: false + dataForwarding: + type: boolean + default: false + supportedPfcpFeatures: + type: string + upfEvents: + type: array + items: + $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/EventType' + minItems: 1 + + SnssaiUpfInfoItem: + description: Set of parameters supported by UPF for a given S-NSSAI + type: object + required: + - sNssai + anyOf: + - required: [ dnnUpfInfoList ] + - required: [ dnnUpfInfoListId ] + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnUpfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnUpfInfoItem' + minItems: 1 + redundantTransport: + type: boolean + default: false + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + dnnUpfInfoListId: + type: integer + + DnnUpfInfoItem: + description: Set of parameters supported by UPF for a given DNN + type: object + required: + - dnn + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + pduSessionTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + ipv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + natedIpv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + natedIpv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + ipv4IndexList: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' + minItems: 1 + ipv6IndexList: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' + minItems: 1 + networkInstance: + description: > + The N6 Network Instance associated with the S-NSSAI and DNN. + type: string + dnaiNwInstanceList: + description: > + Map of network instance per DNAI for the DNN, where the key of the map is the DNAI. + When present, the value of each entry of the map shall contain a N6 network instance + that is configured for the DNAI indicated by the key. + type: object + additionalProperties: + type: string + minProperties: 1 + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + not: + required: [ networkInstance, dnaiNwInstanceList ] + + InterfaceUpfInfoItem: + description: Information of a given IP interface of an UPF + type: object + required: + - interfaceType + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + interfaceType: + $ref: '#/components/schemas/UPInterfaceType' + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + networkInstance: + type: string + portRangeList: + type: array + items: + $ref: '#/components/schemas/PortRange' + minItems: 1 + + UPInterfaceType: + description: Types of User-Plane interfaces of the UPF + anyOf: + - type: string + enum: + - N3 + - N6 + - N9 + - DATA_FORWARDING + - N3MB + - N6MB + - N19MB + - NMB9 + - S1U + - S5U + - S8U + - S11U + - S12 + - S2AU + - S2BU + - N3TRUSTEDN3GPP + - N3UNTRUSTEDN3GPP + - N9ROAMING + - SGI + - N19 + - SXAU + - SXBU + - N4U + - type: string + + WAgfInfo: + description: Information of the W-AGF end-points + type: object + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + + TngfInfo: + description: Infomation of the TNGF endpoints + type: object + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + + PcfInfo: + description: Information of a PCF NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + rxDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + rxDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + v2xSupportInd: + type: boolean + default: false + proseSupportInd: + type: boolean + default: false + proseCapability: + $ref: '#/components/schemas/ProSeCapability' + v2xCapability: + $ref: '#/components/schemas/V2xCapability' + a2xSupportInd: + type: boolean + default: false + a2xCapability: + $ref: '#/components/schemas/A2xCapability' + rangingSlPosSupportInd: + type: boolean + default: false + urspEpsSupport: + description: URSP delivery in EPS is supported by the PCF + type: boolean + default: false + vplmnRuleSupport: + description: VPLMN specific rules is supported by the PCF + type: boolean + default: false + urspEnforceSupport: + description: URSP rule enforcement is supported by the PCF + type: boolean + default: false + + BsfInfo: + description: Information of a BSF NF Instance + type: object + properties: + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + ipDomainList: + type: array + items: + type: string + minItems: 1 + ipv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + rxDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + rxDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + + ChfInfo: + description: Information of a CHF NF Instance + type: object + not: + required: [ primaryChfInstance, secondaryChfInstance ] + properties: + supiRangeList: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + plmnRangeList: + type: array + items: + $ref: '#/components/schemas/PlmnRange' + minItems: 1 + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + primaryChfInstance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + secondaryChfInstance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + + Ipv4AddressRange: + description: Range of IPv4 addresses + type: object + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + + Ipv6PrefixRange: + description: Range of IPv6 prefixes + type: object + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + + DefaultNotificationSubscription: + description: > + Data structure for specifying the notifications the NF service subscribes by default, + along with callback URI + type: object + required: + - notificationType + - callbackUri + properties: + notificationType: + $ref: '#/components/schemas/NotificationType' + callbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + interPlmnCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + n1MessageClass: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N1MessageClass' + n2InformationClass: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InformationClass' + versions: + type: array + items: + type: string + minItems: 1 + binding: + type: string + acceptedEncoding: + type: string + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + serviceInfoList: + description: > + A map of service specific information. The name of the corresponding service (as + specified in ServiceName data type) is the key. + type: object + additionalProperties: + $ref: '#/components/schemas/DefSubServiceInfo' + minProperties: 1 + callbackUriPrefix: + type: string + + NfSetCond: + description: Subscription to a set of NFs based on their Set Id + type: object + required: + - nfSetId + properties: + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + + NfServiceSetCond: + description: Subscription to a set of NFs based on their Service Set Id + type: object + required: + - nfServiceSetId + properties: + nfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + + UpfCond: + description: > + Subscription to a set of NF Instances (UPFs), able to serve a certain service area + (i.e. SMF serving area or TAI list) + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ UPF_COND ] + smfServingArea: + type: array + items: + type: string + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + + NwdafCond: + description: > + Subscription to a set of NF Instances (NWDAFs), identified by Analytics ID(s), + S-NSSAI(s) or NWDAF Serving Area information, i.e. list of TAIs for which the NWDAF + can provide analytics. + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ NWDAF_COND ] + analyticsIds: + type: array + items: + type: string + minItems: 1 + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + mlAnalyticsList: + type: array + items: + $ref: '#/components/schemas/MlAnalyticsInfo' + minItems: 1 + + NefCond: + description: > + Subscription to a set of NF Instances (NEFs), identified by Event ID(s) provided by AF, + S-NSSAI(s), AF Instance ID, Application Identifier, External Identifier, + External Group Identifier, or domain name. + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ NEF_COND ] + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' + minItems: 1 + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + pfdData: + $ref: '#/components/schemas/PfdData' + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + servedFqdnList: + type: array + items: + type: string + minItems: 1 + + NotificationType: + description: > + Types of notifications used in Default Notification URIs in the NF Profile of an NF Instance + anyOf: + - type: string + enum: + - N1_MESSAGES + - N2_INFORMATION + - LOCATION_NOTIFICATION + - DATA_REMOVAL_NOTIFICATION + - DATA_CHANGE_NOTIFICATION + - LOCATION_UPDATE_NOTIFICATION + - NSSAA_REAUTH_NOTIFICATION + - NSSAA_REVOC_NOTIFICATION + - MATCH_INFO_NOTIFICATION + - DATA_RESTORATION_NOTIFICATION + - TSCTS_NOTIFICATION + - LCS_KEY_DELIVERY_NOTIFICATION + - UUAA_MM_AUTH_NOTIFICATION + - DC_SESSION_EVENT_NOTIFICATION + - type: string + + TransportProtocol: + description: Types of transport protocol used in a given IP endpoint of an NF Service Instance + anyOf: + - type: string + enum: + - TCP + - type: string + + NotificationEventType: + description: Types of events sent in notifications from NRF to subscribed NF Instances + anyOf: + - type: string + enum: + - NF_REGISTERED + - NF_DEREGISTERED + - NF_PROFILE_CHANGED + - SHARED_DATA_CHANGED + - type: string + + NotificationData: + description: Data sent in notifications from NRF to subscribed NF Instances + type: object + required: + - event + - nfInstanceUri + allOf: + # + # Condition: If 'event' takes value 'NF_PROFILE_CHANGED', + # then one of 'nfProfile', 'profileChanges' or 'completeNfProfile' must be present + # + - anyOf: + - not: + properties: + event: + type: string + enum: + - NF_PROFILE_CHANGED + - oneOf: + - required: [ nfProfile ] + - required: [ profileChanges ] + - required: [ completeNfProfile ] + # + # Condition: If 'event' takes value 'NF_REGISTERED', + # then one of 'nfProfile' or 'completeNfProfile' must be present + # + - anyOf: + - not: + properties: + event: + type: string + enum: + - NF_REGISTERED + - oneOf: + - required: [ nfProfile ] + - required: [ completeNfProfile ] + # + # Condition: If 'event' takes value 'SHARED_DATA_CHANGED', + # then 'sharedDataChanges' must be present + # + - anyOf: + - not: + properties: + event: + type: string + enum: + - SHARED_DATA_CHANGED + - required: [ sharedDataChanges ] + properties: + event: + $ref: '#/components/schemas/NotificationEventType' + nfInstanceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nfProfile: + allOf: + - $ref: '#/components/schemas/NFProfile' + - not: + required: [ allowedPlmns ] + - not: + required: [ allowedSnpns ] + - not: + required: [ allowedNfTypes ] + - not: + required: [ allowedNfDomains ] + - not: + required: [ allowedNssais ] + - properties: + nfServices: + type: array + items: + allOf: + - $ref: '#/components/schemas/NFService' + - not: + required: [ allowedPlmns ] + - not: + required: [ allowedSnpns ] + - not: + required: [ allowedNfTypes ] + - not: + required: [ allowedNfDomains ] + - not: + required: [ allowedNssais ] + nfServiceList: + type: object + additionalProperties: + allOf: + - $ref: '#/components/schemas/NFService' + - not: + required: [ allowedPlmns ] + - not: + required: [ allowedSnpns ] + - not: + required: [ allowedNfTypes ] + - not: + required: [ allowedNfDomains ] + - not: + required: [ allowedNssais ] + profileChanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChangeItem' + minItems: 1 + sharedDataChanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChangeItem' + minItems: 1 + conditionEvent: + $ref: '#/components/schemas/ConditionEventType' + subscriptionContext: + $ref: '#/components/schemas/SubscriptionContext' + completeNfProfile: + $ref: '#/components/schemas/NFProfile' + + NFStatus: + description: Status of a given NF Instance stored in NRF + anyOf: + - type: string + enum: + - REGISTERED + - SUSPENDED + - UNDISCOVERABLE + - CANARY_RELEASE + - type: string + + NFServiceVersion: + description: Contains the version details of an NF service + type: object + required: + - apiVersionInUri + - apiFullVersion + properties: + apiVersionInUri: + type: string + apiFullVersion: + type: string + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + + ServiceName: + description: Service names known to NRF + anyOf: + - type: string + enum: + - nnrf-nfm + - nnrf-disc + - nnrf-oauth2 + - nudm-sdm + - nudm-uecm + - nudm-ueau + - nudm-ee + - nudm-pp + - nudm-niddau + - nudm-mt + - nudm-ssau + - nudm-rsds + - nudm-ueid + - namf-comm + - namf-evts + - namf-mt + - namf-loc + - namf-mbs-comm + - namf-mbs-bc + - nsmf-pdusession + - nsmf-event-exposure + - nsmf-nidd + - nausf-auth + - nausf-sorprotection + - nausf-upuprotection + - nnef-pfdmanagement + - nnef-smcontext + - nnef-eventexposure + - nnef-eas-deployment + - nnef-dnai-mapping + - nnef-traffic-influence-data + - nnef-ecs-addr-cfg-info + - nnef-ueid + - 3gpp-cp-parameter-provisioning + - 3gpp-device-triggering + - 3gpp-bdt + - 3gpp-traffic-influence + - 3gpp-chargeable-party + - 3gpp-as-session-with-qos + - 3gpp-msisdn-less-mo-sms + - 3gpp-service-parameter + - 3gpp-monitoring-event + - 3gpp-nidd-configuration-trigger + - 3gpp-nidd + - 3gpp-analyticsexposure + - 3gpp-racs-parameter-provisioning + - 3gpp-ecr-control + - 3gpp-applying-bdt-policy + - 3gpp-mo-lcs-notify + - 3gpp-time-sync + - 3gpp-am-influence + - 3gpp-am-policyauthorization + - 3gpp-akma + - 3gpp-eas-deployment + - 3gpp-iptvconfiguration + - 3gpp-mbs-tmgi + - 3gpp-mbs-session + - 3gpp-authentication + - 3gpp-asti + - 3gpp-pdtq-policy-negotiation + - 3gpp-musa + - npcf-am-policy-control + - npcf-smpolicycontrol + - npcf-policyauthorization + - npcf-bdtpolicycontrol + - npcf-eventexposure + - npcf-ue-policy-control + - npcf-am-policyauthorization + - npcf-pdtq-policy-control + - npcf-mbspolicycontrol + - npcf-mbspolicyauth + - nsmsf-sms + - nnssf-nsselection + - nnssf-nssaiavailability + - nudr-dr + - nudr-group-id-map + - nlmf-loc + - nlmf-broadcast + - n5g-eir-eic + - nbsf-management + - nchf-spendinglimitcontrol + - nchf-convergedcharging + - nchf-offlineonlycharging + - nnwdaf-eventssubscription + - nnwdaf-analyticsinfo + - nnwdaf-datamanagement + - nnwdaf-mlmodelprovision + - nnwdaf-mlmodeltraining + - nnwdaf-mlmodelmonitor + - nnwdaf-roamingdata + - nnwdaf-roaminganalytics + - ngmlc-loc + - nucmf-provisioning + - nucmf-uecapabilitymanagement + - nhss-sdm + - nhss-uecm + - nhss-ueau + - nhss-ee + - nhss-ims-sdm + - nhss-ims-uecm + - nhss-ims-ueau + - nhss-gba-sdm + - nhss-gba-ueau + - nsepp-telescopic + - nsoraf-sor + - nspaf-secured-packet + - nudsf-dr + - nudsf-timer + - nnssaaf-nssaa + - nnssaaf-aiw + - naanf-akma + - n5gddnmf-discovery + - nmfaf-3dadatamanagement + - nmfaf-3cadatamanagement + - neasdf-dnscontext + - neasdf-baselinednspattern + - ndccf-datamanagement + - ndccf-contextmanagement + - nnsacf-nsac + - nnsacf-slice-ee + - nmbsmf-tmgi + - nmbsmf-mbssession + - nadrf-datamanagement + - nadrf-mlmodelmanagement + - nbsp-gba + - ntsctsf-time-sync + - ntsctsf-qos-tscai + - ntsctsf-asti + - npkmf-keyreq + - npkmf-userid + - npkmf-discovery + - nmnpf-npstatus + - niwmsc-smservice + - nmbsf-mbs-us + - nmbsf-mbs-ud-ingest + - nmbstf-distsession + - npanf-prosekey + - npanf-userid + - nupf-ee + - nupf-gueip + - naf-prose + - naf-eventexposure + - type: string + + N2InterfaceAmfInfo: + description: AMF N2 interface information + type: object + anyOf: + - required: [ ipv4EndpointAddress ] + - required: [ ipv6EndpointAddress ] + properties: + ipv4EndpointAddress: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddress: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + amfName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + + NFServiceStatus: + description: Status of a given NF Service Instance of an NF Instance stored in NRF + anyOf: + - type: string + enum: + - REGISTERED + - SUSPENDED + - UNDISCOVERABLE + - CANARY_RELEASE + - type: string + + TaiRange: + description: Range of TAIs (Tracking Area Identities) + type: object + required: + - plmnId + - tacRangeList + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + tacRangeList: + type: array + items: + $ref: '#/components/schemas/TacRange' + minItems: 1 + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + + TacRange: + description: Range of TACs (Tracking Area Codes) + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^([A-Fa-f0-9]{4}|[A-Fa-f0-9]{6})$' + end: + type: string + pattern: '^([A-Fa-f0-9]{4}|[A-Fa-f0-9]{6})$' + pattern: + type: string + + PlmnRange: + description: Range of PLMN IDs + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}$' + end: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}$' + pattern: + type: string + + NrfInfo: + description: Information of an NRF NF Instance, used in hierarchical NRF deployments + type: object + properties: + servedUdrInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdrInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUdrInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdrInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedUdmInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdmInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUdmInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdmInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedAusfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AusfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedAusfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AusfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedAmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedAmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedSmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/SmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedSmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/SmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedUpfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UpfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUpfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UpfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedPcfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PcfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedPcfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PcfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedBsfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/BsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedBsfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/BsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedChfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/ChfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedChfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/ChfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedNefInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/NefInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedNwdafInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/NwdafInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedNwdafInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/NwdafInfo' + minProperties: 1 + minProperties: 1 + servedPcscfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PcscfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedGmlcInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/GmlcInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedLmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/LmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedNfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/NfInfo' + minProperties: 1 + servedHssInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/HssInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedUdsfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUdsfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedScpInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/ScpInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedSeppInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/SeppInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedAanfInfoList: + description: A map (list of key-value pairs) where NF Instance Id serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AanfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + served5gDdnmfInfo: + type: object + additionalProperties: + $ref: '#/components/schemas/5GDdnmfInfo' + minProperties: 1 + servedMfafInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/MfafInfo' + minProperties: 1 + servedEasdfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/EasdfInfo' + minProperties: 1 + servedDccfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/DccfInfo' + minProperties: 1 + servedMbSmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/MbSmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedTsctsfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/TsctsfInfo' + minProperties: 1 + minProperties: 1 + servedMbUpfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/MbUpfInfo' + minProperties: 1 + minProperties: 1 + servedTrustAfInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/TrustAfInfo' + minProperties: 1 + servedNssaafInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/NssaafInfo' + minProperties: 1 + servedDcsfInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/DcsfInfo' + minProperties: 1 + servedMfInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/MfInfo' + minProperties: 1 + servedMrfInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/MrfInfo' + minProperties: 1 + servedMrfpInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/MrfpInfo' + minProperties: 1 + + PlmnSnssai: + description: List of network slices (S-NSSAIs) for a given PLMN ID + type: object + required: + - plmnId + - sNssaiList + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + sNssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + + NefInfo: + description: Information of an NEF NF Instance + type: object + properties: + nefId: + $ref: '#/components/schemas/NefId' + pfdData: + $ref: '#/components/schemas/PfdData' + afEeData: + $ref: '#/components/schemas/AfEventExposureData' + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + servedFqdnList: + type: array + items: + type: string + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + unTrustAfInfoList: + type: array + items: + $ref: '#/components/schemas/UnTrustAfInfo' + minItems: 1 + uasNfFunctionalityInd: + type: boolean + default: false + multiMemAfSessQosInd: + type: boolean + default: false + memberUESelAssistInd: + type: boolean + default: false + + PfdData: + description: List of Application IDs and/or AF IDs managed by a given NEF Instance + type: object + properties: + appIds: + type: array + items: + type: string + minItems: 1 + afIds: + type: array + items: + type: string + minItems: 1 + + NwdafInfo: + description: Information of a NWDAF NF Instance + type: object + properties: + eventIds: + type: array + items: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId' + minItems: 1 + nwdafEvents: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + nwdafCapability: + $ref: '#/components/schemas/NwdafCapability' + analyticsDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + mlAnalyticsList: + type: array + items: + $ref: '#/components/schemas/MlAnalyticsInfo' + minItems: 1 + + LmfInfo: + description: Information of an LMF NF Instance + type: object + properties: + servingClientTypes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' + minItems: 1 + lmfId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + servingAccessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + servingAnNodeTypes: + type: array + items: + $ref: '#/components/schemas/AnNodeType' + minItems: 1 + servingRatTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + supportedGADShapes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes' + minItems: 1 + pruExistenceInfo: + $ref: '#/components/schemas/PruExistenceInfo' + pruSupportInd: + type: boolean + default: false + rangingslposSupportInd: + type: boolean + default: false + upPositioningInd: + description: user plane positioning capability is supported by the LMF + type: boolean + default: false + + GmlcInfo: + description: Information of a GMLC NF Instance + type: object + properties: + servingClientTypes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' + minItems: 1 + gmlcNumbers: + type: array + items: + type: string + pattern: '^[0-9]{5,15}$' + minItems: 1 + + AfEventExposureData: + description: AF Event Exposure data managed by a given NEF Instance + type: object + required: + - afEvents + properties: + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' + minItems: 1 + afIds: + type: array + items: + type: string + minItems: 1 + appIds: + type: array + items: + type: string + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + + PcscfInfo: + description: Information of a P-CSCF NF Instance + type: object + properties: + accessType: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + gmFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + gmIpv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + gmIpv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + mwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + mwIpv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + mwIpv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + servedIpv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + servedIpv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + + NfInfo: + description: Information of a generic NF Instance + type: object + properties: + nfType: + $ref: '#/components/schemas/NFType' + + HssInfo: + description: Information of an HSS NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + imsiRanges: + type: array + items: + $ref: '#/components/schemas/ImsiRange' + minItems: 1 + imsPrivateIdentityRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + imsPublicIdentityRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + hssDiameterAddress: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/NetworkNodeDiameterAddress' + additionalDiamAddresses: + type: array + items: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/NetworkNodeDiameterAddress' + minItems: 1 + + ImsiRange: + description: > + A range of IMSIs (subscriber identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]+$' + end: + type: string + pattern: '^[0-9]+$' + pattern: + type: string + + TwifInfo: + description: Addressing information (IP addresses, FQDN) of the TWIF + type: object + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + + VendorId: + description: Vendor ID of the NF Service instance (Private Enterprise Number assigned by IANA) + type: string + pattern: '^[0-9]{6}$' + + VendorSpecificFeature: + description: Information about a vendor-specific feature + type: object + required: + - featureName + - featureVersion + properties: + featureName: + type: string + featureVersion: + type: string + + AnNodeType: + description: Access Network Node Type (gNB, ng-eNB...) + anyOf: + - type: string + enum: + - GNB + - NG_ENB + - type: string + + UdsfInfo: + description: Information related to UDSF + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + storageIdRanges: + description: > + A map (list of key-value pairs) where realmId serves as key and each value in the map + is an array of IdentityRanges. Each IdentityRange is a range of storageIds. + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + minProperties: 1 + + ScpInfo: + description: Information of an SCP Instance + type: object + properties: + scpDomainInfoList: + description: > + A map (list of key-value pairs) where the key of the map shall be the string + identifying an SCP domain + type: object + additionalProperties: + $ref: '#/components/schemas/ScpDomainInfo' + minProperties: 1 + scpPrefix: + type: string + scpPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + addressDomains: + type: array + items: + type: string + minItems: 1 + ipv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + ipv4AddrRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + servedNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + remotePlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + remoteSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + ipReachability: + $ref: '#/components/schemas/IpReachability' + scpCapabilities: + type: array + items: + $ref: '#/components/schemas/ScpCapability' + + ScpDomainInfo: + description: SCP Domain specific information + type: object + properties: + scpFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + scpIpEndPoints: + type: array + items: + $ref: '#/components/schemas/IpEndPoint' + minItems: 1 + scpPrefix: + type: string + scpPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + + ScpDomainCond: + description: > + Subscription to a set of NF or SCP or SEPP instances belonging to certain SCP domains + type: object + required: + - scpDomains + properties: + scpDomains: + type: array + items: + type: string + minItems: 1 + nfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + + OptionsResponse: + description: Communication options of the NRF sent in response content of OPTIONS method + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + ConditionEventType: + description: > + Indicates whether a notification is due to the NF Instance to start or stop + being part of a condition for a subscription to a set of NFs + anyOf: + - type: string + enum: + - NF_ADDED + - NF_REMOVED + - type: string + + SuciInfo: + description: SUCI information containing Routing Indicator and Home Network Public Key ID + type: object + properties: + routingInds: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + hNwPubKeyIds: + type: array + items: + type: integer + minItems: 1 + + SeppInfo: + description: Information of a SEPP Instance + type: object + properties: + seppPrefix: + type: string + seppPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + remotePlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + remoteSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + n32Purposes: + description: N32 purposes supported by the SEPP + type: array + items: + $ref: 'TS29573_N32_Handshake.yaml#/components/schemas/N32Purpose' + minItems: 1 + + IpReachability: + description: Indicates the type(s) of IP addresses reachable via an SCP + anyOf: + - type: string + enum: + - IPV4 + - IPV6 + - IPV4V6 + - type: string + + UriList: + description: > + Represents a set of URIs following the 3GPP hypermedia format + (containing a "_links" attribute). + type: object + properties: + _links: + type: object + description: > + List of the URI of NF instances. It has two members whose names are item and self. + The item attribute contains an array of URIs. + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' + minProperties: 1 + totalItemCount: + type: integer + + AanfInfo: + description: Represents the information relative to an AAnF NF Instance. + type: object + properties: + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + + 5GDdnmfInfo: + description: Information of an 5G DDNMF NF Instance + type: object + required: + - plmnId + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + + WildcardDnai: + description: Wildcard DNAI + type: string + pattern: '^[*]$' + + MfafInfo: + description: Information of a MFAF NF Instance + type: object + properties: + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + + NwdafCapability: + description: Indicates the capability supported by the NWDAF + type: object + properties: + analyticsAggregation: + type: boolean + default: false + analyticsMetadataProvisioning: + type: boolean + default: false + mlModelAccuracyChecking: + type: boolean + default: false + analyticsAccuracyChecking: + type: boolean + default: false + roamingExchange: + type: boolean + default: false + + EasdfInfo: + description: Information of an EASDF NF Instance + type: object + properties: + sNssaiEasdfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiEasdfInfoItem' + minItems: 1 + easdfN6IpAddressList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + upfN6IpAddressList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + n6TunnelInfoList: + description: > + A map of InterfaceUpfInfoItems containing the N6 tunnelling information for establishing + a N6 tunnel between the V-UPF and the V-EASDF, where a valid JSON string serves as key. + type: object + additionalProperties: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minProperties: 1 + dnsSecurityProtocols: + type: array + items: + $ref: '#/components/schemas/DnsSecurityProtocol' + minItems: 1 + + SnssaiEasdfInfoItem: + description: Set of parameters supported by EASDF for a given S-NSSAI + type: object + required: + - sNssai + - dnnEasdfInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnEasdfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnEasdfInfoItem' + minItems: 1 + + DnnEasdfInfoItem: + description: Set of parameters supported by EASDF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + + DccfInfo: + description: Information of a DCCF NF Instance + type: object + properties: + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + dataSubsRelocInd: + type: boolean + default: false + + ScpCapability: + description: Indicates the capabilities supported by an SCP + anyOf: + - type: string + enum: + - INDIRECT_COM_WITH_DELEG_DISC + - type: string + + NsacfInfo: + description: Information of a NSACF NF Instance + type: object + required: + - nsacfCapability + properties: + nsacfCapability: + $ref: '#/components/schemas/NsacfCapability' + snssaiListForEntirePlmn: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + taiList: + deprecated: true + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + deprecated: true + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + nsacSaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsacSai' + minItems: 1 + + NsacfCapability: + description: > + NSACF service capabilities (e.g. to monitor and control the number of registered UEs + or established PDU sessions per network slice) + type: object + properties: + supportUeSAC: + description: | + Indicates the service capability of the NSACF to monitor and control the number of + registered UEs per network slice for the network slice that is subject to NSAC + true: Supported + false (default): Not Supported + type: boolean + default: false + supportPduSAC: + description: | + Indicates the service capability of the NSACF to monitor and control the number of + established PDU sessions per network slice for the network slice that is subject to NSAC + true: Supported + false (default): Not Supported + type: boolean + default: false + supportUeWithPduSAC: + description: | + Indicates the service capability of the NSACF to control the number of registered UEs + with at least one PDU session / PDN connection per network slice for the network slice + that is subject to NSAC, if EPS counting is supported by the NSACF. + true: Supported + false (default): Not Supported + type: boolean + default: false + + DccfCond: + description: > + Subscription to a set of NF Instances (DCCFs), identified by NF types, NF Set Id(s) + or DCCF Serving Area information, i.e. list of TAIs served by the DCCF + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ DCCF_COND ] + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + + MlAnalyticsInfo: + description: ML Analytics Filter information supported by the Nnwdaf_MLModelProvision service + type: object + properties: + mlAnalyticsIds: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + trackingAreaList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + mlModelInterInfo: + $ref: '#/components/schemas/MlModelInterInfo' + flCapabilityType: + $ref: '#/components/schemas/FlCapabilityType' + flTimeInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + nfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + nfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + + MbSmfInfo: + description: Information of an MB-SMF NF Instance + type: object + properties: + sNssaiInfoList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/SnssaiMbSmfInfoItem' + minProperties: 1 + tmgiRangeList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/TmgiRange' + minProperties: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + mbsSessionList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/MbsSession' + minProperties: 1 + + TmgiRange: + description: Range of TMGIs + type: object + required: + - mbsServiceIdStart + - mbsServiceIdEnd + - plmnId + properties: + mbsServiceIdStart: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + mbsServiceIdEnd: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + + MbsSession: + description: MBS Session currently served by an MB-SMF + type: object + required: + - mbsSessionId + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + mbsAreaSessions: + description: A map (list of key-value pairs) where the key identifies an areaSessionId + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' + minProperties: 1 + + SnssaiMbSmfInfoItem: + description: Parameters supported by an MB-SMF for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnMbSmfInfoItem' + minItems: 1 + + DnnMbSmfInfoItem: + description: Parameters supported by an MB-SMF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + + TsctsfInfo: + description: Information of a TSCTSF NF Instance + type: object + properties: + sNssaiInfoList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/SnssaiTsctsfInfoItem' + minProperties: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + minItems: 1 + + SnssaiTsctsfInfoItem: + description: Set of parameters supported by TSCTSF for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnTsctsfInfoItem' + minItems: 1 + + DnnTsctsfInfoItem: + description: Parameters supported by an TSCTSF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + + MbUpfInfo: + description: Information of an MB-UPF NF Instance + type: object + required: + - sNssaiMbUpfInfoList + properties: + sNssaiMbUpfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiUpfInfoItem' + minItems: 1 + mbSmfServingArea: + type: array + items: + type: string + minItems: 1 + interfaceMbUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + supportedPfcpFeatures: + type: string + + UnTrustAfInfo: + description: Information of a untrusted AF Instance + type: object + required: + - afId + properties: + afId: + type: string + sNssaiInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiInfoItem' + minItems: 1 + mappingInd: + type: boolean + default: false + + TrustAfInfo: + description: Information of a trusted AF Instance + type: object + properties: + sNssaiInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiInfoItem' + minItems: 1 + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' + minItems: 1 + appIds: + type: array + items: + type: string + minItems: 1 + internalGroupId: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + mappingInd: + type: boolean + default: false + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + + SnssaiInfoItem: + description: > + Parameters supported by an NF for a given S-NSSAI Set of parameters supported by NF + for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnInfoItem' + minItems: 1 + + DnnInfoItem: + description: Set of parameters supported by NF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + + CollocatedNfInstance: + description: Information of an collocated NF Instance registered in the NRF + type: object + required: + - nfInstanceId + - nfType + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfType: + $ref: '#/components/schemas/CollocatedNfType' + + CollocatedNfType: + description: NF types for a collocated NF + anyOf: + - type: string + enum: + - UPF + - SMF + - MB_UPF + - MB_SMF + - type: string + + PlmnOauth2: + description: Oauth2.0 required indication for a given PLMN ID + type: object + properties: + oauth2RequiredPlmnIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + oauth2NotRequiredPlmnIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + + V2xCapability: + description: Indicate the supported V2X Capability by the PCF. + type: object + properties: + lteV2x: + type: boolean + default: false + nrV2x: + type: boolean + default: false + + NssaafInfo: + description: Information of a NSSAAF Instance + type: object + properties: + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + minItems: 1 + + ProSeCapability: + description: Indicate the supported ProSe Capability by the PCF. + type: object + properties: + proseDirectDiscovey: + type: boolean + default: false + proseDirectCommunication: + type: boolean + default: false + proseL2UetoNetworkRelay: + type: boolean + default: false + proseL3UetoNetworkRelay: + type: boolean + default: false + proseL2RemoteUe: + type: boolean + default: false + proseL3RemoteUe: + type: boolean + default: false + proseL2UetoUeRelay: + type: boolean + default: false + proseL3UetoUeRelay: + type: boolean + default: false + proseL2EndUe: + type: boolean + default: false + proseL3EndUe: + type: boolean + default: false + + SubscriptionContext: + description: > + Context data related to a created subscription, to be included in notifications sent by NRF + type: object + required: + - subscriptionId + properties: + subscriptionId: + type: string + subscrCond: + $ref: '#/components/schemas/SubscrCond' + + IwmscInfo: + description: Information of an SMS-IWMSC NF Instance + type: object + properties: + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + scNumber: + type: string + pattern: '^[0-9]{5,15}$' + + MnpfInfo: + description: Information of an MNPF Instance + type: object + properties: + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + required: + - msisdnRanges + + DefSubServiceInfo: + description: Service Specific information for Default Notification Subscription. + type: object + properties: + versions: + type: array + items: + type: string + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + LocalityDescriptionItem: + description: Locality description item + type: object + properties: + localityType: + $ref: '#/components/schemas/LocalityType' + localityValue: + type: string + required: + - localityType + - localityValue + + LocalityDescription: + description: Locality description + type: object + properties: + localityType: + $ref: '#/components/schemas/LocalityType' + localityValue: + type: string + addlLocDescrItems: + type: array + items: + $ref: '#/components/schemas/LocalityDescriptionItem' + minItems: 1 + required: + - localityType + - localityValue + + LocalityType: + description: > + Type of locality description. An operator may define custom locality type values other + than those listed in this enumeration. + anyOf: + - type: string + enum: + - DATA_CENTER + - CITY + - COUNTY + - DISTRICT + - STATE + - CANTON + - REGION + - PROVINCE + - PREFECTURE + - COUNTRY + - type: string + + SmsfInfo: + description: Specific Data for SMSF + type: object + properties: + roamingUeInd: + type: boolean + remotePlmnRangeList: + type: array + items: + $ref: '#/components/schemas/PlmnRange' + minItems: 1 + + DcsfInfo: + description: Information of a DCSF NF Instance + type: object + properties: + imsDomianNameList: + type: array + items: + $ref: '#/components/schemas/ImsDomainName' + imsiRanges: + type: array + items: + $ref: '#/components/schemas/ImsiRange' + minItems: 1 + imsPrivateIdentityRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + imsPublicIdentityRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + + ImsDomainName: + description: IMS Domain Name + type: string + + MlModelInterInfo: + description: ML Model Interoperability Information + type: object + properties: + vendorList: + type: array + items: + $ref: '#/components/schemas/VendorId' + minItems: 1 + + PruExistenceInfo: + description: PRU Existence Information + type: object + properties: + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + + FlCapabilityType: + description: > + Type of Federated Learning Capability. + anyOf: + - type: string + enum: + - FL_SERVER + - FL_CLIENT + - FL_SERVER_AND_CLIENT + - type: string + + MrfInfo: + description: Information of a Mrf NF Instance + type: object + properties: + mediaCapabilityList: + type: array + items: + $ref: '#/components/schemas/MediaCapability' + minItems: 1 + + MrfpInfo: + description: Information of a Mrfp NF Instance + type: object + properties: + mediaCapabilityList: + type: array + items: + $ref: '#/components/schemas/MediaCapability' + minItems: 1 + + MfInfo: + description: Information of a MF NF Instance + type: object + properties: + mediaCapabilityList: + type: array + items: + $ref: '#/components/schemas/MediaCapability' + minItems: 1 + + EpdgInfo: + description: Information of the ePDG end-points + type: object + anyOf: + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + + MediaCapability: + description: media capability offered by NF instance + type: string + pattern: '^[a-zA-Z0-9_]+$' + + A2xCapability: + description: Indicate the supported A2X Capability by the PCF. + type: object + properties: + lteA2x: + type: boolean + default: false + nrA2x: + type: boolean + default: false + + RuleSet: + description: > + List of rules specifying whether access/scopes are allowed/denied for NF-Consumers. + type: object + required: + - priority + - action + properties: + priority: + type: integer + minimum: 0 + maximum: 65535 + plmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + snpns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + nfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + nfDomains: + type: array + items: + type: string + minItems: 1 + nssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + nfInstances: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + scopes: + type: array + items: + type: string + minItems: 1 + action: + $ref: '#/components/schemas/RuleSetAction' + + RuleSetAction: + description: > + Specifies whether access/scope is allowed or denied for a specific NF-Consumer. + anyOf: + - type: string + enum: + - ALLOW + - DENY + - type: string + + AdrfInfo: + description: Information of an ADRF NF Instance + type: object + properties: + mlModelStorageInd: + type: boolean + default: false + dataStorageInd: + type: boolean + default: false + + SelectionConditions: + description: > + It contains the set of conditions that shall be evaluated to determine whether a consumer + shall select a given producer. The producer shall only be selected if the evaluation of + the conditions is . The set of conditions can be represented by a single + ConditionItem or by a ConditionGroup, where the latter contains a (recursive) list of + conditions joined by the "and" or "or" logical relationships. + oneOf: + - $ref: '#/components/schemas/ConditionItem' + - $ref: '#/components/schemas/ConditionGroup' + + ConditionGroup: + description: > + List (array) of conditions (joined by the "and" or "or" logical relationship), + under which an NF Instance with an NFStatus or NFServiceStatus value set to, + "CANARY_RELEASE", or with a "canaryRelease" attribute set to true, + shall be selected by an NF Service Consumer. + type: object + oneOf: + - required: [ and ] + - required: [ or ] + properties: + and: + type: array + items: + $ref: '#/components/schemas/SelectionConditions' + minItems: 1 + or: + type: array + items: + $ref: '#/components/schemas/SelectionConditions' + minItems: 1 + + ConditionItem: + description: > + A ConditionItem consists of a number of attributes representing individual conditions + (e.g. a SUPI range, or a TAI list). If several attributes/conditions are present, + the evaluation of the ConditionItem is if all attributes/conditions are evaluated + as (i.e., it follows the AND logical relationship). + type: object + allOf: + - not: + required: [ and ] + - not: + required: [ or ] + properties: + consumerNfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + serviceFeature: + type: integer + minimum: 1 + vsServiceFeature: + type: integer + minimum: 1 + supiRangeList: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + impuRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + impiRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + peiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + + CallbackUriPrefixItem: + description: callback URI prefix value to be used for specific notification types + type: object + properties: + callbackUriPrefix: + type: string + notificationTypes: + type: array + items: + type: string + required: + - callbackUriPrefix + - notificationTypes + + PortRange: + description: Range of port numbers + type: object + properties: + start: + type: integer + minimum: 0 + maximum: 65535 + end: + type: integer + minimum: 0 + maximum: 65535 + required: + - start + - end + + DnsSecurityProtocol: + description: DNS security protocol + anyOf: + - type: string + enum: + - TLS + - DTLS + - type: string -- GitLab From e1b01eb6811a405f84fdf4d8916c7487fc4137cc Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 01:48:40 +0000 Subject: [PATCH 18/33] Upload the YAML for cross reference compile --- OpenAPI/TS29510_Nnrf_NFDiscovery.yaml | 2562 +++++++++++++++++++++++++ 1 file changed, 2562 insertions(+) create mode 100644 OpenAPI/TS29510_Nnrf_NFDiscovery.yaml diff --git a/OpenAPI/TS29510_Nnrf_NFDiscovery.yaml b/OpenAPI/TS29510_Nnrf_NFDiscovery.yaml new file mode 100644 index 0000000..a93a8ac --- /dev/null +++ b/OpenAPI/TS29510_Nnrf_NFDiscovery.yaml @@ -0,0 +1,2562 @@ +openapi: 3.0.0 + +info: + version: '1.4.0-alpha.1' + title: 'NRF NFDiscovery Service' + description: | + NRF NFDiscovery Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.510 V19.0.0; 5G System; Network Function Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' + +servers: + - url: '{apiRoot}/nnrf-disc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:nf-instances:read-complete-profile + +paths: + /nf-instances: + get: + summary: Search a collection of NF Instances + operationId: SearchNFInstances + tags: + - NF Instances (Store) + parameters: + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: target-nf-type + in: query + description: Type of the target NF + required: true + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + - name: requester-nf-type + in: query + description: Type of the requester NF + required: true + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + - name: preferred-collocated-nf-types + in: query + description: collocated NF types that candidate NFs should preferentially support + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/CollocatedNfType' + minItems: 1 + style: form + explode: false + - name: requester-nf-instance-id + in: query + description: NfInstanceId of the requester NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + - name: service-names + in: query + description: Names of the services offered by the NF + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + minItems: 1 + uniqueItems: true + style: form + explode: false + - name: requester-nf-instance-fqdn + in: query + description: FQDN of the requester NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + - name: target-plmn-list + in: query + description: > + Id of the PLMN of either the target NF, or in SNPN scenario the Credentials Holder + in the PLMN + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + - name: requester-plmn-list + in: query + description: Id of the PLMN where the NF issuing the Discovery request is located + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + - name: target-nf-instance-id + in: query + description: Identity of the NF instance being discovered + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + - name: target-nf-instance-id-list + in: query + description: Identities of the NF instances being discovered + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 2 + style: form + explode: false + - name: target-nf-fqdn + in: query + description: FQDN of the NF instance being discovered + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + - name: hnrf-uri + in: query + description: Uri of the home NRF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + - name: snssais + in: query + description: Slice info of the target NF + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + - name: additional-snssais + in: query + description: Additional Slices supported by the target NF (Service) instances + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + - name: requester-snssais + in: query + description: Slice info of the requester NF + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + - name: plmn-specific-snssai-list + in: query + description: PLMN specific Slice info of the target NF + content: + application/json: + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' + minItems: 1 + - name: requester-plmn-specific-snssai-list + in: query + description: PLMN-specific slice info of the NF issuing the Discovery request + content: + application/json: + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' + minItems: 1 + - name: dnn + in: query + description: Dnn supported by the BSF, SMF or UPF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: ipv4-index + in: query + description: The IPv4 Index supported by the candidate UPF. + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' + - name: ipv6-index + in: query + description: The IPv6 Index supported by the candidate UPF. + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' + - name: nsi-list + in: query + description: NSI IDs that are served by the services being discovered + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: smf-serving-area + in: query + schema: + type: string + - name: mbsmf-serving-area + in: query + schema: + type: string + - name: tai + in: query + description: Tracking Area Identity + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + - name: amf-region-id + in: query + description: AMF Region Identity + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' + - name: amf-set-id + in: query + description: AMF Set Identity + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' + - name: guami + in: query + description: Guami used to search for an appropriate AMF + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + - name: supi + in: query + description: SUPI of the user + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: ue-ipv4-address + in: query + description: IPv4 address of the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + - name: ip-domain + in: query + description: IP domain of the UE, which supported by BSF + schema: + type: string + - name: ue-ipv6-prefix + in: query + description: IPv6 prefix of the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + - name: pgw-ind + in: query + description: Combined PGW-C and SMF or a standalone SMF + schema: + type: boolean + - name: preferred-pgw-ind + in: query + description: Indicates combined PGW-C+SMF or standalone SMF are preferred + schema: + type: boolean + - name: pgw + in: query + description: PGW FQDN of a combined PGW-C and SMF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + - name: pgw-ip + in: query + description: PGW IP Address of a combined PGW-C and SMF + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + - name: gpsi + in: query + description: GPSI of the user + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + - name: external-group-identity + in: query + description: external group identifier of the user + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: internal-group-identity + in: query + description: internal group identifier of the user + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + - name: pfd-data + in: query + description: PFD data + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PfdData' + - name: data-set + in: query + description: data set supported by the NF + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DataSetId' + - name: routing-indicator + in: query + description: routing indicator in SUCI + schema: + type: string + pattern: '^[0-9]{1,4}$' + - name: group-id-list + in: query + description: Group IDs of the NFs being discovered + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + minItems: 1 + style: form + explode: false + - name: dnai-list + in: query + description: Data network access identifiers of the NFs being discovered + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + style: form + explode: false + - name: pdu-session-types + in: query + description: list of PDU Session Type required to be supported by the target NF + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + style: form + explode: false + - name: event-id-list + in: query + description: > + Analytics event(s) requested to be supported by the Nnwdaf_AnalyticsInfo service + schema: + type: array + items: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId' + minItems: 1 + style: form + explode: false + - name: nwdaf-event-list + in: query + description: > + Analytics event(s) requested to be supported by the Nnwdaf_EventsSubscription service. + schema: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + style: form + explode: false + - name: upf-event-list + in: query + description: > + Event(s) requested to be supported by the Nupf_EventExposure service. + schema: + type: array + items: + $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/EventType' + minItems: 1 + style: form + explode: false + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: upf-iwk-eps-ind + in: query + description: UPF supporting interworking with EPS or not + schema: + type: boolean + - name: chf-supported-plmn + in: query + description: PLMN ID supported by a CHF + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + - name: preferred-locality + in: query + description: preferred target NF location + schema: + type: string + - name: ext-preferred-locality + in: query + description: > + preferred target NF location + A map (list of key-value pairs) where the key of the map represents the relative + priority, for the requester, of each locality description among the list of locality + descriptions in this query parameter, encoded as "1" (highest priority"), "2", "3", …, + "n" (lowest priority) + content: + application/json: + schema: + type: object + additionalProperties: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/LocalityDescription' + minItems: 1 + minProperties: 1 + - name: access-type + in: query + description: AccessType supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + - name: limit + in: query + description: Maximum number of NFProfiles to return in the response + required: false + schema: + type: integer + minimum: 1 + - name: required-features + in: query + description: Features required to be supported by the target NF + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + minItems: 1 + style: form + explode: false + - name: complex-query + in: query + description: the complex query condition expression + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ComplexQuery' + - name: max-payload-size + in: query + description: Maximum content size of the response expressed in kilo octets + required: false + schema: + type: integer + maximum: 2000 + default: 124 + - name: max-payload-size-ext + in: query + description: > + Extended query for maximum content size of the response expressed in kilo octets + required: false + schema: + type: integer + default: 124 + - name: atsss-capability + in: query + description: ATSSS Capability + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability' + - name: upf-ue-ip-addr-ind + in: query + description: UPF supporting allocating UE IP addresses/prefixes + schema: + type: boolean + - name: client-type + in: query + description: Requested client type served by the NF + content: + application/json: + schema: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' + - name: lmf-id + in: query + description: LMF identification to be discovered + content: + application/json: + schema: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + - name: an-node-type + in: query + description: Requested AN node type served by the NF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AnNodeType' + - name: rat-type + in: query + description: Requested RAT type served by the NF + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + - name: preferred-tai + in: query + description: preferred Tracking Area Identity + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + - name: preferred-nf-instances + in: query + description: preferred NF Instances + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + style: form + explode: false + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.2 + schema: + type: string + - name: target-snpn + in: query + description: Target SNPN Identity, or the Credentials Holder in the SNPN + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: requester-snpn-list + in: query + description: SNPN ID(s) of the NF instance issuing the Discovery request + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + - name: af-ee-data + in: query + description: NEF exposured by the AF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AfEventExposureData' + - name: w-agf-info + in: query + description: UPF collocated with W-AGF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/WAgfInfo' + - name: tngf-info + in: query + description: UPF collocated with TNGF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TngfInfo' + - name: twif-info + in: query + description: UPF collocated with TWIF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TwifInfo' + - name: upf-select-epdg-info + in: query + description: The ePDG information to find a preferred UPF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/EpdgInfo' + - name: target-nf-set-id + in: query + description: Target NF Set ID + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + - name: target-nf-service-set-id + in: query + description: Target NF Service Set ID + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + - name: nef-id + in: query + description: NEF ID + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefId' + - name: notification-type + in: query + description: Notification Type + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NotificationType' + - name: n1-msg-class + in: query + description: N1 Message Class + schema: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N1MessageClass' + - name: n2-info-class + in: query + description: N2 Information Class + schema: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InformationClass' + - name: serving-scope + in: query + description: areas that can be served by the target NF + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: imsi + in: query + description: IMSI of the requester UE to search for an appropriate NF (e.g. HSS, DCSF) + schema: + type: string + pattern: '^[0-9]{5,15}$' + - name: ims-private-identity + in: query + description: IMPI of the requester UE to search for a target HSS or DCSF + schema: + type: string + - name: ims-public-identity + in: query + description: IMS Public Identity of the requester UE to search for a target HSS or DCSF + schema: + type: string + - name: msisdn + in: query + description: MSISDN of the requester UE to search for a target HSS or DCSF + schema: + type: string + - name: preferred-api-versions + in: query + description: Preferred API version of the services to be discovered + content: + application/json: + schema: + description: A map (list of key-value pairs) where ServiceName serves as key + type: object + additionalProperties: + type: string + minProperties: 1 + - name: v2x-support-ind + in: query + description: PCF supports V2X + schema: + type: boolean + - name: redundant-gtpu + in: query + description: UPF supports redundant gtp-u to be discovered + schema: + type: boolean + - name: redundant-transport + in: query + description: UPF supports redundant transport path to be discovered + schema: + type: boolean + - name: ipups + in: query + description: UPF which is configured for IPUPS functionality to be discovered + schema: + type: boolean + - name: sxa-ind + in: query + description: UPF which is configured to support sxa interface + schema: + type: boolean + - name: scp-domain-list + in: query + description: SCP domains the target SCP or SEPP belongs to + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: address-domain + in: query + description: Address domain reachable through the SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + - name: ipv4-addr + in: query + description: IPv4 address reachable through the SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + - name: ipv6-prefix + in: query + description: IPv6 prefix reachable through the SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + - name: served-nf-set-id + in: query + description: NF Set ID served by the SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + - name: remote-plmn-id + in: query + description: Id of the PLMN reachable through the SCP or SEPP + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + - name: remote-snpn-id + in: query + description: Id of the SNPN reachable through the SCP or SEPP + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: data-forwarding + in: query + description: UPF Instance(s) configured for data forwarding are requested + schema: + type: boolean + - name: preferred-full-plmn + in: query + description: NF Instance(s) serving the full PLMN are preferred + schema: + type: boolean + - name: requester-features + in: query + description: > + Features supported by the NF Service Consumer that is invoking + the Nnrf_NFDiscovery service + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: realm-id + in: query + description: realm-id to search for an appropriate UDSF + schema: + type: string + - name: storage-id + in: query + description: storage-id to search for an appropriate UDSF + schema: + type: string + - name: vsmf-support-ind + in: query + description: V-SMF capability supported by the target NF instance(s) + schema: + type: boolean + - name: ismf-support-ind + in: query + description: I-SMF capability supported by the target NF instance(s) + schema: + type: boolean + - name: nrf-disc-uri + in: query + description: Uri of the NRF holding the NF profile of a target NF Instance + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + - name: preferred-vendor-specific-features + in: query + description: Preferred vendor specific features of the services to be discovered + content: + application/json: + schema: + description: A map (list of key-value pairs) where ServiceName serves as key + type: object + additionalProperties: + description: > + A map (list of key-value pairs) where IANA-assigned SMI Network Management + Private Enterprise Codes serves as key + type: object + additionalProperties: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + minProperties: 1 + - name: preferred-vendor-specific-nf-features + in: query + description: Preferred vendor specific features of the network function to be discovered + content: + application/json: + schema: + description: > + A map (list of key-value pairs) where IANA-assigned SMI Network Management Private + Enterprise Codes serves as key + type: object + additionalProperties: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + - name: required-pfcp-features + in: query + description: PFCP features required to be supported by the target UPF + schema: + type: string + - name: home-pub-key-id + in: query + description: > + Indicates the Home Network Public Key ID which shall be able to be served + by the NF instance + schema: + type: integer + - name: prose-support-ind + in: query + description: PCF supports ProSe Capability + schema: + type: boolean + - name: analytics-aggregation-ind + in: query + description: analytics aggregation is supported by NWDAF or not + schema: + type: boolean + - name: serving-nf-set-id + in: query + description: NF Set Id served by target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + - name: serving-nf-type + in: query + description: NF type served by the target NF + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + - name: ml-analytics-info-list + in: query + description: Lisf of ML Analytics Filter information of Nnwdaf_MLModelProvision service + content: + application/json: + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MlAnalyticsInfo' + minItems: 1 + - name: analytics-metadata-prov-ind + in: query + description: analytics matadata provisioning is supported by NWDAF or not + schema: + type: boolean + - name: nsacf-capability + in: query + description: the service capability supported by the target NSACF + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NsacfCapability' + - name: mbs-session-id-list + in: query + description: List of MBS Session ID(s) + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + minItems: 1 + - name: area-session-id + in: query + description: Area Session ID + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' + - name: gmlc-number + in: query + description: The GMLC Number supported by the GMLC + schema: + type: string + pattern: '^[0-9]{5,15}$' + - name: upf-n6-ip + in: query + description: N6 IP address of PSA UPF supported by the EASDF + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + - name: tai-list + in: query + description: Tracking Area Identifiers of the NFs being discovered + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + - name: nf-tai-list-ind + in: query + description: the NF service consumer supports candidate nfs supporting a subset of TAIs + schema: + type: boolean + enum: + - true + - name: preferences-precedence + in: query + description: > + Indicates the precedence of the preference query parameters (from higher to lower) + schema: + type: array + items: + type: string + minItems: 2 + style: form + explode: false + - name: support-onboarding-capability + in: query + description: Indicating the support for onboarding. + schema: + type: boolean + default: false + - name: uas-nf-functionality-ind + in: query + description: UAS NF functionality is supported by NEF or not + schema: + type: boolean + - name: multi-mem-af-sess-qos-ind + in: query + description: Multi-member AF session with required QoS is supported by NEF or not + schema: + type: boolean + enum: + - true + - name: member-ue-sel-assist-ind + in: query + description: member UE selection assistance functionality is supported by NEF or not + schema: + type: boolean + enum: + - true + - name: v2x-capability + in: query + description: indicates the V2X capability that the target PCF needs to support. + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/V2xCapability' + - name: prose-capability + in: query + description: indicates the ProSe capability that the target PCF needs to support. + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ProSeCapability' + - name: shared-data-id + in: query + description: Identifier of shared data stored in the NF being discovered + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedDataId' + - name: target-hni + in: query + description: Home Network Identifier query. + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + - name: target-nw-resolution + in: query + description: Resolution of the identity of the target PLMN based on the GPSI of the UE + schema: + type: boolean + - name: exclude-nfinst-list + in: query + description: NF Instance IDs to be excluded from the NF Discovery procedure + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + style: form + explode: false + - name: exclude-nfservinst-list + in: query + description: NF service instance IDs to be excluded from the NF Discovery procedure + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NfServiceInstance' + minItems: 1 + - name: exclude-nfserviceset-list + in: query + description: NF Service Set IDs to be excluded from the NF Discovery procedure + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + minItems: 1 + style: form + explode: false + - name: exclude-nfset-list + in: query + description: NF Set IDs to be excluded from the NF Discovery procedure + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + style: form + explode: false + - name: preferred-analytics-delays + in: query + description: Preferred analytics delays supported by the NWDAF to be discovered + content: + application/json: + schema: + description: > + A map (list of key-value pairs) where EventId or NwdafEvent serves as key + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + minProperties: 1 + - name: high-latency-com + in: query + description: Indicating the support for High Latency communication. + schema: + type: boolean + enum: + - true + - name: nsac-sai + in: query + description: NSAC Service Area Identifier + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsacSai' + - name: complete-profile + in: query + description: request to discover the complete profile of NF instances + schema: + type: boolean + enum: + - true + - name: n32-purposes + in: query + description: N32 purposes to be supported by the SEPP + schema: + type: array + items: + $ref: 'TS29573_N32_Handshake.yaml#/components/schemas/N32Purpose' + minItems: 1 + style: form + explode: false + - name: preferred-features + in: query + description: Preferred features to be supported by the target Network Function. + content: + application/json: + schema: + description: > + A map (list of key-value pairs) where Service Name serves as the key. + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + minProperties: 1 + - name: remote-plmn-id-roaming + in: query + description: Id of the remote PLMN served by the target NF service producer + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + - name: pru-tai + in: query + description: LMF(s) serving the TAI with PRU(s) existence + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + - name: pru-support-ind + in: query + description: Indicating the support of PRU function + schema: + type: boolean + - name: af-data + in: query + description: events supported by the trusted AFs being discovered + content: + application/json: + schema: + $ref: '#/components/schemas/AfData' + - name: ml-accuracy-checking-ind + in: query + description: Indicating the support for ML Model Accuracy checking. + schema: + type: boolean + enum: + - true + - name: analytics-accuracy-checking-ind + in: query + description: Indicating the support for Analytics Accuracy checking. + schema: + type: boolean + enum: + - true + - name: a2x-support-ind + in: query + description: PCF supports A2X + schema: + type: boolean + enum: + - true + - name: a2x-capability + in: query + description: indicates the A2X capability that the target PCF needs to support. + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/A2xCapability' + - name: ml-model-storage-ind + in: query + description: Indicating the support for ML model storage and retrieval capability. + schema: + type: boolean + enum: + - true + - name: data-storage-ind + in: query + description: > + Indicating the support for data and analytics storage and retrieval capability. + schema: + type: boolean + enum: + - true + - name: data-subscription-relocation-support-ind + in: query + description: Indicating the support for relocation of data subscription. + schema: + type: boolean + enum: + - true + - name: ims-domain-name + in: query + description: Indicating the IMS domain name to search for a target DCSF. + schema: + type: string + - name: media-capability-list + in: query + description: Indicating the media capability list to search for a target MF, MRF or MRFP. + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MediaCapability' + minItems: 1 + style: form + explode: false + - name: roaming-exchange-ind + in: query + description: Indicating the support for roaming exchange. + schema: + type: boolean + enum: + - true + - name: ranging-sl-pos-support-ind + in: query + description: PCF or LMF supports ranging and sidelink positioning Capability + schema: + type: boolean + enum: + - true + - name: preferred-up-positioning-ind + in: query + description: LMF supporting user plane positioning capability + schema: + type: boolean + enum: + - true + - name: complete-search-result + in: query + description: > + Indicates that all the NF profiles or NF Instance IDs matching the query parameters + are requested to be returned + schema: + type: boolean + enum: + - true + - name: ursp-delivery-eps-support-ind + in: query + description: > + Indicates whether a PCF supporting URSP delivery in EPS needs to be discovered + schema: + type: boolean + enum: + - true + - name: dns-sec-protoc + in: query + description: DNS security protocols + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DnsSecurityProtocol' + minItems: 1 + style: form + explode: false + - name: ind-com-with-del-disc + in: query + description: > + Indicates that indirect communication with delegated discovery + with NF selection at target domain feature is supported. + schema: + type: boolean + enum: + - true + - name: ind-com-wo-del-disc + in: query + description: > + Indicates that indirect communication without delegated discovery + with NF selection at target domain feature is supported. + schema: + type: boolean + enum: + - true + + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SearchResult' + links: + search: + operationId: RetrieveStoredSearch + parameters: + searchId: $response.body#/searchId + description: > + The 'searchId' parameter returned in the response can be used as the + 'searchId' parameter in the GET request to '/searches/{searchId}' + completeSearch: + operationId: RetrieveCompleteSearch + parameters: + searchId: $response.body#/searchId + description: > + The 'searchId' parameter returned in the response can be used as the + 'searchId' parameter in the GET request to '/searches/{searchId}/complete' + headers: + Cache-Control: + description: Cache-Control containing max-age, described in IETF RFC 9111, 5.2 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + 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' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /searches/{searchId}: + get: + operationId: RetrieveStoredSearch + tags: + - Stored Search (Document) + parameters: + - $ref: '#/components/parameters/searchId' + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + responses: + '200': + $ref: '#/components/responses/200' + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + + /searches/{searchId}/complete: + get: + operationId: RetrieveCompleteSearch + tags: + - Complete Stored Search (Document) + parameters: + - $ref: '#/components/parameters/searchId' + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + responses: + '200': + $ref: '#/components/responses/200' + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + required: true + schema: + type: string + + /scp-domain-routing-info: + get: + operationId: SCPDomainRoutingInfoGet + tags: + - SCP Domain Routing Information (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:scp-domain:read + parameters: + - name: local + in: query + description: Indication of local SCP Domain Routing Information + required: false + schema: + type: boolean + default: false + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScpDomainRoutingInformation' + headers: + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + description: Temporary Redirect + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF + 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' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /scp-domain-routing-info-subs: + post: + summary: Create a new subscription + operationId: ScpDomainRoutingInfoSubscribe + tags: + - SCP Domain Routing Information Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:scp-domain-subs:write + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScpDomainRoutingInfoSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScpDomainRoutingInfoSubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnrf-disc/v1/scp-domain-routing-info-subs/{subscriptionID} + required: true + schema: + type: string + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + 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' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + onScpDomainRoutingInformationChange: + '{$request.body#/callbackUri}': + post: + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: Notification content + content: + application/json: + schema: + $ref: '#/components/schemas/ScpDomainRoutingInfoNotification' + responses: + '204': + description: Expected response to a successful callback processing + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + 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' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /scp-domain-routing-info-subs/{subscriptionID}: + delete: + summary: Deletes a subscription + operationId: ScpDomainRoutingInfoUnsubscribe + tags: + - Individual SCP Domain Routing Information Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:scp-domain-subs:write + parameters: + - name: subscriptionID + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string + responses: + '204': + description: Expected response to a successful subscription removal + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '/oauth2/token' + scopes: + nnrf-disc: Access to the Nnrf_NFDiscovery API + nnrf-disc:scp-domain:read: Access to read the scp-domain-routing-info resource + nnrf-disc:scp-domain-subs:write: Access to create/delete a scp-domain subscription resource + nnrf-disc:nf-instances:read-complete-profile: > + Access to the Nnrf_NFDiscovery API enabling the discovery of the complete profile + of NF instances + + parameters: + searchId: + name: searchId + in: path + description: Id of a stored search + required: true + schema: + type: string + + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/StoredSearchResult' + headers: + Cache-Control: + description: Cache-Control containing max-age, described in IETF RFC 9111, 5.2 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + + schemas: + + SearchResult: + description: Contains the list of NF Profiles returned in a Discovery response + type: object + required: + - validityPeriod + - nfInstances + not: + required: [ indComWithDelDiscReq, indComWoDelDiscReq ] + properties: + validityPeriod: + type: integer + nfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + completeNfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + minItems: 1 + searchId: + type: string + numNfInstComplete: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + preferredSearch: + $ref: '#/components/schemas/PreferredSearch' + nrfSupportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + nfInstanceList: + description: List of matching NF instances. The key of the map is the NF instance ID. + type: object + additionalProperties: + $ref: '#/components/schemas/NfInstanceInfo' + minProperties: 1 + searchResultInfo: + $ref: '#/components/schemas/SearchResultInfo' + alteredPriorityInd: + type: boolean + noProfileMatchInfo: + $ref: '#/components/schemas/NoProfileMatchInfo' + ignoredQueryParams: + type: array + items: + type: string + minItems: 1 + indComWithDelDiscReq: + type: boolean + enum: + - true + indComWoDelDiscReq: + type: boolean + enum: + - true + indComAddInfo: + $ref: '#/components/schemas/IndComAddInfo' + + StoredSearchResult: + description: > + Contains a complete search result (i.e. a number of discovered NF Instances), + stored by NRF as a consequence of a prior search result + type: object + required: + - nfInstances + properties: + nfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + completeNfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + minItems: 1 + + NFProfile: + description: Information of an NF Instance discovered by the NRF + type: object + required: + - nfInstanceId + - nfType + - nfStatus + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfInstanceName: + type: string + nfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + nfStatus: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFStatus' + collocatedNfInstances: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/CollocatedNfInstance' + minItems: 1 + plmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + perPlmnSnssaiList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' + minItems: 1 + nsiList: + type: array + items: + type: string + minItems: 1 + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + ipv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + allowedSnpns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + allowedNfTypes: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + minItems: 1 + allowedNfDomains: + type: array + items: + type: string + minItems: 1 + allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + allowedRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/RuleSet' + minProperties: 1 + capacity: + type: integer + minimum: 0 + maximum: 65535 + load: + type: integer + minimum: 0 + maximum: 100 + loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + locality: + type: string + extLocality: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string serves + as key representing a type of locality + type: object + additionalProperties: + type: string + minProperties: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + udrInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdrInfo' + udrInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdrInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdrInfo' + minProperties: 1 + udmInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdmInfo' + udmInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdmInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdmInfo' + minProperties: 1 + ausfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AusfInfo' + ausfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AusfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AusfInfo' + minProperties: 1 + amfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AmfInfo' + amfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AmfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AmfInfo' + minProperties: 1 + smfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SmfInfo' + smfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of SmfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SmfInfo' + minProperties: 1 + upfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UpfInfo' + upfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UpfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UpfInfo' + minProperties: 1 + pcfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PcfInfo' + pcfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PcfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PcfInfo' + minProperties: 1 + bsfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/BsfInfo' + bsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of BsfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/BsfInfo' + minProperties: 1 + chfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ChfInfo' + chfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of ChfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ChfInfo' + minProperties: 1 + udsfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdsfInfo' + udsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdsfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdsfInfo' + minProperties: 1 + nwdafInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NwdafInfo' + nwdafInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NwdafInfo + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NwdafInfo' + minProperties: 1 + nefInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefInfo' + pcscfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PcscfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PcscfInfo' + minProperties: 1 + hssInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of HssInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/HssInfo' + minProperties: 1 + customInfo: + type: object + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + nfServicePersistence: + type: boolean + default: false + nfServices: + deprecated: true + type: array + items: + $ref: '#/components/schemas/NFService' + minItems: 1 + nfServiceList: + description: > + A map (list of key-value pairs) where serviceInstanceId serves as key of NFService + type: object + additionalProperties: + $ref: '#/components/schemas/NFService' + minProperties: 1 + defaultNotificationSubscriptions: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DefaultNotificationSubscription' + lmfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/LmfInfo' + gmlcInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/GmlcInfo' + snpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + nfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + servingScope: + type: array + items: + type: string + minItems: 1 + lcHSupportInd: + type: boolean + default: false + olcHSupportInd: + type: boolean + default: false + nfSetRecoveryTimeList: + description: A map (list of key-value pairs) where NfSetId serves as key of DateTime + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minProperties: 1 + serviceSetRecoveryTimeList: + description: > + A map (list of key-value pairs) where NfServiceSetId serves as key of DateTime + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minProperties: 1 + scpDomains: + type: array + items: + type: string + minItems: 1 + scpInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ScpInfo' + seppInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SeppInfo' + vendorId: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId' + supportedVendorSpecificFeatures: + description: > + The key of the map is the IANA-assigned SMI Network Management Private Enterprise Codes + type: object + additionalProperties: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + aanfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AanfInfo + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AanfInfo' + minProperties: 1 + mfafInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MfafInfo' + easdfInfoList: + type: object + description: > + A map(list of key-value pairs) where a (unique) valid JSON string + serves as key of EasdfInfo + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/EasdfInfo' + minProperties: 1 + dccfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DccfInfo' + nsacfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NsacfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NsacfInfo' + minProperties: 1 + mbSmfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbSmfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MbSmfInfo' + minProperties: 1 + tsctsfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of TsctsfInfo + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TsctsfInfo' + minProperties: 1 + mbUpfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbUpfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MbUpfInfo' + minProperties: 1 + trustAfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TrustAfInfo' + nssaafInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NssaafInfo' + hniList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + iwmscInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IwmscInfo' + mnpfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MnpfInfo' + smsfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SmsfInfo' + dcsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of DcsfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DcsfInfo' + mrfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MrfInfo' + mrfpInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfpInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MrfpInfo' + mfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MfInfo' + adrfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AdrfInfo + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AdrfInfo' + minProperties: 1 + selectionConditions: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SelectionConditions' + canaryRelease: + type: boolean + default: false + exclusiveCanaryReleaseSelection: + type: boolean + default: false + sharedProfileDataId: + type: string + format: uuid + + NFService: + description: > + Information of a given NF Service Instance; it is part of the NFProfile + of an NF Instance discovered by the NRF + type: object + required: + - serviceInstanceId + - serviceName + - versions + - scheme + - nfServiceStatus + properties: + serviceInstanceId: + type: string + serviceName: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + versions: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFServiceVersion' + minItems: 1 + scheme: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UriScheme' + nfServiceStatus: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFServiceStatus' + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + ipEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + apiPrefix: + type: string + callbackUriPrefixList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/CallbackUriPrefixItem' + minItems: 1 + defaultNotificationSubscriptions: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DefaultNotificationSubscription' + minItems: 1 + allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + allowedSnpns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + allowedNfTypes: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + minItems: 1 + allowedNfDomains: + type: array + items: + type: string + minItems: 1 + allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + capacity: + type: integer + minimum: 0 + maximum: 65535 + load: + type: integer + minimum: 0 + maximum: 100 + loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + priority: + type: integer + minimum: 0 + maximum: 65535 + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + nfServiceSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + minItems: 1 + sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + perPlmnSnssaiList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' + minItems: 1 + vendorId: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId' + supportedVendorSpecificFeatures: + description: > + The key of the map is the IANA-assigned SMI Network Management Private Enterprise Codes + type: object + additionalProperties: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + oauth2Required: + type: boolean + allowedOperationsPerNfType: + description: A map (list of key-value pairs) where NF Type serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 + allowedOperationsPerNfInstance: + description: A map (list of key-value pairs) where NF Instance Id serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 + allowedOperationsPerNfInstanceOverrides: + type: boolean + default: false + allowedScopesRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/RuleSet' + minProperties: 1 + selectionConditions: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SelectionConditions' + canaryRelease: + type: boolean + default: false + exclusiveCanaryReleaseSelection: + type: boolean + default: false + sharedServiceDataId: + type: string + format: uuid + + PreferredSearch: + description: > + Contains information on whether the returned NFProfiles match the preferred query parameters + type: object + properties: + preferredTaiMatchInd: + type: boolean + default: false + preferredFullPlmnMatchInd: + type: boolean + default: false + preferredApiVersionsMatchInd: + type: boolean + otherApiVersionsInd: + type: boolean + preferredLocalityMatchInd: + type: boolean + default: false + otherLocalityInd: + type: boolean + default: false + preferredVendorSpecificFeaturesInd: + type: boolean + default: false + preferredCollocatedNfTypeInd: + type: boolean + default: false + preferredPgwMatchInd: + type: boolean + preferredAnalyticsDelaysInd: + type: boolean + preferredFeaturesMatchInd: + type: boolean + noPreferredFeaturesInd: + type: boolean + + NfInstanceInfo: + description: Contains information on an NF profile matching a discovery request + type: object + properties: + nrfDiscApiUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + preferredSearch: + $ref: '#/components/schemas/PreferredSearch' + nrfAlteredPriorities: + description: > + The key of the map is the JSON Pointer of the priority IE in the NFProfile data type + that is altered by the NRF + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + nrfSupportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + ScpDomainRoutingInformation: + description: SCP Domain Routing Information + type: object + required: + - scpDomainList + properties: + scpDomainList: + description: | + This IE shall contain a map of SCP domain interconnection information, where + the key of the map is a SCP domain. The value of each entry shall be the + interconnectivity information of the the SCP domain indicated by the key. + An empty map indicates that there is no SCP domain currently registered in + the NRF. + type: object + additionalProperties: + $ref: '#/components/schemas/ScpDomainConnectivity' + + ScpDomainConnectivity: + description: SCP Domain Connectivity Information + type: object + required: + - connectedScpDomainList + properties: + connectedScpDomainList: + type: array + items: + type: string + + ScpDomainRoutingInfoSubscription: + description: SCP Domain Routing Information Subscription + type: object + required: + - callbackUri + properties: + callbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reqInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + localInd: + type: boolean + default: false + + ScpDomainRoutingInfoNotification: + description: SCP Domain Routing Information Notification + type: object + required: + - routingInfo + properties: + routingInfo: + $ref: '#/components/schemas/ScpDomainRoutingInformation' + localInd: + type: boolean + default: false + + NfServiceInstance: + description: NF service instance + type: object + oneOf: + - required: [ nfInstanceId ] + - required: [ nfServiceSetId ] + properties: + serviceInstanceId: + type: string + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + + NoProfileMatchInfo: + description: Provides the reason for not finding NF matching the search criteria + type: object + required: + - reason + properties: + reason: + $ref: '#/components/schemas/NoProfileMatchReason' + queryParamCombinationList: + type: array + items: + $ref: '#/components/schemas/QueryParamCombination' + minItems: 1 + + QueryParamCombination: + description: Contains a list of Query Parameters + type: object + required: + - queryParams + properties: + queryParams: + type: array + items: + $ref: '#/components/schemas/QueryParameter' + minItems: 1 + + QueryParameter: + description: Contains the name and value of a query parameter + type: object + required: + - name + - value + properties: + name: + type: string + value: + type: string + + NoProfileMatchReason: + description: No Profile Match Reason + anyOf: + - type: string + enum: + - REQUESTER_PLMN_NOT_ALLOWED + - TARGET_NF_SUSPENDED + - TARGET_NF_UNDISCOVERABLE + - QUERY_PARAMS_COMBINATION_NO_MATCH + - TARGET_NF_TYPE_NOT_SUPPORTED + - UNSPECIFIED + - type: string + + AfData: + description: Contains information supported by the trusted AF + type: object + properties: + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TaiRange' + minItems: 1 + required: + - afEvents + + SearchResultInfo: + description: Contains additional information to the search result + type: object + properties: + unsatisfiedTaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + + IndComAddInfo: + description: > + Additional Information for Indirect Communication between a source and a target domain + type: object + properties: + allNfTypesInd: + type: boolean + enum: + - true + scpApiRoot: + type: string -- GitLab From 1ed2049fbbd7a6384ad845341cc5a7d2f5870632 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 01:50:19 +0000 Subject: [PATCH 19/33] Upload the YAML for cross reference compile --- OpenAPI/TS28541_5GcNrm.yaml | 6183 +++++++++++++++++++++++++++++++++++ 1 file changed, 6183 insertions(+) create mode 100644 OpenAPI/TS28541_5GcNrm.yaml diff --git a/OpenAPI/TS28541_5GcNrm.yaml b/OpenAPI/TS28541_5GcNrm.yaml new file mode 100644 index 0000000..5fe4522 --- /dev/null +++ b/OpenAPI/TS28541_5GcNrm.yaml @@ -0,0 +1,6183 @@ +openapi: 3.0.1 +info: + title: 3GPP 5GC NRM + version: 19.1.0 + description: >- + OAS 3.0.1 specification of the 5GC NRM + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.541; 5G NRM, 5GC NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + AmfIdentifier: + type: object + description: 'AmfIdentifier comprise of amfRegionId, amfSetId and amfPointer' + properties: + amfRegionId: + $ref: '#/components/schemas/AmfRegionId' + amfSetId: + $ref: '#/components/schemas/AmfSetId' + amfPointer: + $ref: '#/components/schemas/AmfPointer' + AmfRegionId: + type: integer + description: AmfRegionId is defined in TS 23.003 + maximum: 255 + AmfSetId: + type: string + description: AmfSetId is defined in TS 23.003 + maximum: 1023 + AmfPointer: + type: integer + description: AmfPointer is defined in TS 23.003 + maximum: 63 + IpEndPoint: + type: object + properties: + ipv4Address: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + ipv6Address: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + ipv6Prefix: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Prefix' + transport: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/TransportProtocol' + port: + type: integer + NFProfileList: + type: array + description: List of NF profile + items: + $ref: '#/components/schemas/NFProfile' + NFProfile: + type: object + description: 'NF profile stored in NRF, defined in TS 29.510' + properties: + nfInstanceId: + type: string + description: uuid of NF instance + nfType: + $ref: '#/components/schemas/NFType' + nfStatus: + $ref: '#/components/schemas/NFStatus' + plmn: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + sNssais: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + fqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + nfServices: + type: array + items: + $ref: '#/components/schemas/NFService' + NFService: + type: object + description: NF Service is defined in TS 29.510 + properties: + serviceInstanceId: + type: string + serviceName: + type: string + versions: + type: array + items: + type: string + schema: + type: string + fqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + ipEndPoints: + type: array + items: + $ref: '#/components/schemas/IpEndPoint' + apiPrefix: + type: string + allowedPlmns: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + allowedNfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + allowedNssais: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + NFStatus: + type: string + description: any of enumerated value + enum: + - REGISTERED + - SUSPENDED + CNSIIdList: + type: array + items: + $ref: '#/components/schemas/CNSIId' + CNSIId: + type: string + description: CNSI Id is defined in TS 29.531, only for Core Network. + EnergySavingControl: + type: string + description: any of enumerated value + enum: + - TO_BE_ENERGYSAVING + - TO_BE_NOT_ENERGYSAVING + EnergySavingState: + type: string + readOnly: true + description: any of enumerated value + enum: + - IS_NOT_ENERGYSAVING + - IS_ENERGYSAVING + TACList: + type: array + items: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Tac' + WeightFactor: + type: integer + VendorId: + type: string + description: Vendor ID of the NF Service instance (Private Enterprise Number assigned by IANA) + pattern: '^[0-9]{6}$' + AusfInfo: + type: object + properties: + nFSrvGroupId: + type: string + readOnly: true + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + suciInfos: + type: array + items: + $ref: '#/components/schemas/SuciInfo' + minItems: 1 + SupportedDataSet: + type: string + description: any of enumerated value + enum: + - SUBSCRIPTION + - POLICY + - EXPOSURE + - APPLICATION + - A_PFD + - A_AFTI + - A_IPTV + - A_BDT + - A_SPD + - A_EASD + - A_AMI + - P_UE + - P_SCD + - P_BDT + - P_PLMNUE + - P_NSSCD + NotificationType: + type: string + readOnly: true + enum: + - N1_MESSAGES + - N2_INFORMATION + - LOCATION_NOTIFICATION + - DATA_REMOVAL_NOTIFICATION + - DATA_CHANGE_NOTIFICATION + - LOCATION_UPDATE_NOTIFICATION + - NSSAA_REAUTH_NOTIFICATION + - NSSAA_REVOC_NOTIFICATION + DefaultNotificationSubscription: + type: object + properties: + notificationType: + $ref: '#/components/schemas/NotificationType' + callbackURI: + type: string + readOnly: true + n1MessageClass: + type: boolean + readOnly: true + n2InformationClass: + type: boolean + readOnly: true + versions: + type: string + readOnly: true + binding: + type: string + readOnly: true + ManagedNFProfile: + type: object + properties: + hniList: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + nfInstanceID: + type: string + readOnly: true + nfType: + $ref: '#/components/schemas/NFType' + heartbeatTimer: + type: integer + authzInfo: + type: string + hostAddr: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/HostAddr' + allowedPLMNs: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + sNPNList: + type: array + items: + $ref: '#/components/schemas/SnpnId' + allowedSNPNs: + type: array + items: + $ref: '#/components/schemas/SnpnId' + allowedNfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + allowedNfDomains: + type: array + items: + type: string + allowedNSSAIs: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + locality: + type: string + capacity: + type: integer + nfSetIdList: + type: array + items: + type: string + servingScope: + type: array + items: + type: string + lcHSupportInd: + type: boolean + readOnly: true + olcHSupportInd: + type: boolean + readOnly: true + nfSetRecoveryTimeList: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo' + scpDomains: + type: array + items: + type: string + recoveryTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo' + nfServicePersistence: + type: boolean + readOnly: true + nfProfileChangesSupportInd: + type: boolean + defaultNotificationSubscriptions: + type: array + items: + $ref: '#/components/schemas/DefaultNotificationSubscription' + minItems: 1 + serviceSetRecoveryTimeList: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo' + minItems: 1 + vendorId: + $ref: '#/components/schemas/VendorId' + SEPPType: + type: string + readOnly: true + description: any of enumerated value + enum: + - CSEPP + - PSEPP + SupportedFunc: + type: object + properties: + function: + type: string + policy: + type: string + SupportedFuncList: + type: array + items: + $ref: '#/components/schemas/SupportedFunc' + CommModelType: + type: string + description: any of enumerated value + enum: + - DIRECT_COMMUNICATION_WO_NRF + - DIRECT_COMMUNICATION_WITH_NRF + - INDIRECT_COMMUNICATION_WO_DEDICATED_DISCOVERY + - INDIRECT_COMMUNICATION_WITH_DEDICATED_DISCOVERY + CommModel: + type: object + properties: + groupId: + type: integer + commModelType: + $ref: '#/components/schemas/CommModelType' + targetNFServiceList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + commModelConfiguration: + type: string + CommModelList: + type: array + items: + $ref: '#/components/schemas/CommModel' + CapabilityList: + type: array + items: + type: string + FiveQiDscpMapping: + type: object + properties: + fiveQIValues: + type: array + items: + type: integer + dscp: + type: integer + NetworkSliceInfo: + type: object + properties: + sNSSAI: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + cNSIId: + $ref: '#/components/schemas/CNSIId' + networkSliceRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + NetworkSliceInfoList: + type: array + items: + $ref: '#/components/schemas/NetworkSliceInfo' + + PacketErrorRate: + type: object + properties: + scalar: + type: integer + exponent: + type: integer + + GtpUPathDelayThresholdsType: + type: object + properties: + n3AveragePacketDelayThreshold: + type: integer + n3MinPacketDelayThreshold: + type: integer + n3MaxPacketDelayThreshold: + type: integer + n9AveragePacketDelayThreshold: + type: integer + n9MinPacketDelayThreshold: + type: integer + n9MaxPacketDelayThreshold: + type: integer + QFPacketDelayThresholdsType: + type: object + properties: + thresholdDl: + type: integer + thresholdUl: + type: integer + thresholdRtt: + type: integer + + QosData: + type: object + properties: + qosId: + type: string + fiveQIValue: + type: integer + maxbrUl: + $ref: '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' + qosNotificationControl: + type: boolean + reflectiveQos: + type: boolean + sharingKeyDl: + type: string + sharingKeyUl: + type: string + maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPacketLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + extMaxDataBurstVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + + QosDataList: + type: array + items: + $ref: '#/components/schemas/QosData' + + SteeringMode: + type: object + properties: + steerModeValue: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteerModeValue' + active: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + standby: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessTypeRm' + threeGLoad: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + prioAcc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + + TrafficControlData: + type: object + properties: + tcId: + type: string + flowStatus: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus' + redirectInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' + addRedirectInfo: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' + minItems: 1 + muteNotif: + type: boolean + trafficSteeringPolIdDl: + type: string + nullable: true + trafficSteeringPolIdUl: + type: string + nullable: true + routeToLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + traffCorreInd: + type: boolean + upPathChgEvent: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' + steerFun: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringFunctionality' + steerModeDl: + $ref: '#/components/schemas/SteeringMode' + steerModeUl: + $ref: '#/components/schemas/SteeringMode' + mulAccCtrl: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/MulticastAccessControl' + snssaiList: + $ref: '#/components/schemas/SnssaiList' + + TrafficControlDataList: + type: array + items: + $ref: '#/components/schemas/TrafficControlData' + + PccRule: + type: object + properties: + pccRuleId: + type: string + description: Univocally identifies the PCC rule within a PDU session. + flowInfoList: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' + applicationId: + type: string + appDescriptor: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ApplicationDescriptor' + contentVersion: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' + precedence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + afSigProtocol: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' + isAppRelocatable: + type: boolean + isUeAddrPreserved: + type: boolean + qosData: + type: array + items: + $ref: '#/components/schemas/QosDataList' + altQosParams: + type: array + items: + $ref: '#/components/schemas/QosDataList' + trafficControlData: + type: array + items: + $ref: '#/components/schemas/TrafficControlDataList' + conditionData: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ConditionData' + tscaiInputDl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + + SnssaiInfo: + type: object + properties: + plmnInfo: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfo' + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + + NsacfInfoSnssai: + type: object + properties: + SnssaiInfo: + $ref: '#/components/schemas/SnssaiInfo' + isSubjectToNsac: + type: boolean + maxNumberofUEs: + type: integer + eACMode: + type: string + readOnly: true + enum: + - INACTIVE + - ACTIVE + activeEacThreshold: + type: integer + deactiveEacThreshold: + type: integer + numberofUEs: + type: integer + readOnly: true + uEIdList: + type: array + items: + type: string + readOnly: true + maxNumberofPDUSessions: + type: integer + + NRTACRange: + type: object + properties: + nRTACstart: + type: string + nRTACend: + type: string + nRTACpattern: + type: string + + TaiRange: + type: object + properties: + plmnId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + nRTACRangelist: + type: array + items: + $ref: '#/components/schemas/NRTACRange' + + GUAMInfo: + type: object + properties: + pLMNId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + aMFIdentifier: + type: integer + + SupportedBMOList: + type: array + items: + type: string + + ECSAddrConfigInfo: + type: array + items: + type: string + + DnnSmfInfoItem: + type: object + properties: + dnn: + type: string + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + + dnaiSatelliteMapping: + type: object + properties: + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + geoSatelliteId: + type: string + pattern: '^[0-9]{5}$' + + SnssaiSmfInfoItem: + type: object + properties: + sNSSAI: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + dnnSmfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnSmfInfoItem' + + 5GCNfConnEcmInfoList: + type: array + items: + $ref: '#/components/schemas/5GCNfConnEcmInfo' + 5GCNfConnEcmInfo: + type: object + description: 'Store the 5GC NF connection information' + properties: + 5GCNFType: + type: string + readOnly: true + enum: + - PCF + - NEF + - SCEF + 5GCNFIpAddress: + type: string + readOnly: true + 5GCNFRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + + UPFConnectionInfo: + type: object + properties: + uPFIpAddress: + type: string + readOnly: true + uPFRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + SnssaiList: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + SnpnId: + type: object + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + nid: + type: string + TaiList: + type: array + items: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Tai' + SupiRange: + type: object + properties: + start: + type: string + end: + type: string + pattern: + type: string + IdentityRange: + type: object + properties: + start: + type: string + end: + type: string + pattern: + type: string + ProseCapability: + type: object + properties: + proseDirectDiscovery: + type: boolean + proseDirectCommunication: + type: boolean + proseL2UetoNetworkRelay: + type: boolean + proseL3UetoNetworkRelay: + type: boolean + proseL2RemoteUe: + type: boolean + proseL3RemoteUe: + type: boolean + V2xCapability: + type: object + properties: + lteV2x: + type: boolean + nrV2x: + type: boolean + InternalGroupIdRange: + type: object + properties: + start: + type: string + end: + type: string + pattern: + type: string + SuciInfo: + type: object + properties: + routingInds: + type: array + items: + type: string + hNwPubKeyIds: + type: array + items: + type: integer + SuciInfoList: + type: array + items: + $ref: '#/components/schemas/SuciInfo' + SharedDataIdRange: + type: object + properties: + pattern: + type: string + SupiRangeList: + type: array + items: + $ref: '#/components/schemas/SupiRange' + IdentityRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + InternalGroupIdRangeList: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + SupportedDataSetList: + type: array + items: + $ref: '#/components/schemas/SupportedDataSet' + SharedDataIdRangeList: + type: array + items: + $ref: '#/components/schemas/SharedDataIdRange' + InterfaceUpfInfoItem: + type: object + properties: + interfaceType: + type: string + enum: + - N3 + - N6 + - N9 + - DATA_FORWARDING + - N3MB + - N6MB + - N19MB + - NMB9 + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + fqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + networkInstance: + type: string + + AtsssCapability: + type: object + properties: + atsssLL: + type: boolean + mptcp: + type: boolean + rttWithoutPmf: + type: boolean + + IpInterface: + type: object + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + fqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + + Ipv4AddressRange: + description: Range of IPv4 addresses + type: object + properties: + start: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + end: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + Ipv6PrefixRange: + description: Range of IPv6 prefixes + type: object + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + Nid: + type: string + pattern: '^[A-Fa-f0-9]{11}$' + PlmnIdNid: + type: object + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + nid: + $ref: '#/components/schemas/Nid' + ScpCapability: + type: string + enum: + - INDIRECT_COM_WITH_DELEG_DISC + IpReachability: + description: Indicates the type(s) of IP addresses reachable via an SCP + anyOf: + - type: string + enum: + - IPV4 + - IPV6 + - IPV4V6 + - type: string + + ScpDomainInfo: + description: SCP Domain specific information + type: object + properties: + scpFqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + scpIpEndPoints: + type: array + items: + $ref: 'TS28541_5GcNrm.yaml#/components/schemas/IpEndPoint' + minItems: 1 + scpPrefix: + type: string + scpPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + + SeppInfo: + description: Information of a SEPP Instance + type: object + properties: + seppPrefix: + type: string + seppPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + remotePlmnList: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + minItems: 1 + remoteSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + + UdsfInfo: + description: Information related to UDSF + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + storageIdRanges: + description: > + A map (list of key-value pairs) where realmId serves as key and each value in the map + is an array of IdentityRanges. Each IdentityRange is a range of storageIds. + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + minProperties: 1 + + NsacfCapability: + description: > + NSACF service capabilities (e.g. to monitor and control the number of registered UEs + or established PDU sessions per network slice) + type: object + properties: + supportUeSAC: + description: | + Indicates the service capability of the NSACF to monitor and control the number of + registered UEs per network slice for the network slice that is subject to NSAC + true: Supported + false (default): Not Supported + type: boolean + default: false + supportPduSAC: + description: | + Indicates the service capability of the NSACF to monitor and control the number of + established PDU sessions per network slice for the network slice that is subject to NSAC + true: Supported + false (default): Not Supported + type: boolean + default: false + + NsacfInfo: + description: Information of a NSACF NF Instance + type: object + required: + - nsacfCapability + properties: + nsacfCapability: + $ref: '#/components/schemas/NsacfCapability' + taiList: + $ref: '#/components/schemas/TaiList' + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + + NwdafCapability: + description: Indicates the capability supported by the NWDAF + type: object + properties: + analyticsAggregation: + type: boolean + default: false + analyticsMetadataProvisioning: + type: boolean + default: false + MlAnalyticsInfo: + description: ML Analytics Filter information supported by the Nnwdaf_MLModelProvision service + type: object + properties: + mlAnalyticsIds: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + snssaiList: + $ref: '#/components/schemas/SnssaiList' + trackingAreaList: + $ref: '#/components/schemas/TaiList' + mlModelInterInfo: + type: array + items: + $ref: '#/components/schemas/VendorId' + minItems: 0 + flCapabilityType: + type: string + enum: + - FL_SERVER + - FL_CLIENT + - FL_SERVER_AND_CLIENT + flTimeInterval: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' + minItems: 1 + NwdafInfo: + description: Information of a NWDAF NF Instance + type: object + properties: + eventIds: + type: array + items: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId' + minItems: 1 + nwdafEvents: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + taiList: + $ref: '#/components/schemas/TaiList' + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + nwdafCapability: + $ref: '#/components/schemas/NwdafCapability' + analyticsDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + mlAnalyticsList: + type: array + items: + $ref: '#/components/schemas/MlAnalyticsInfo' + minItems: 1 + + ScpInfo: + description: Information of an SCP Instance + type: object + properties: + scpDomainInfoList: + description: > + A map (list of key-value pairs) where the key of the map shall be the string + identifying an SCP domain + type: object + additionalProperties: + $ref: '#/components/schemas/ScpDomainInfo' + minProperties: 1 + scpPrefix: + type: string + scpPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + addressDomains: + type: array + items: + type: string + minItems: 1 + ipv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + ipv4AddrRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + servedNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + remotePlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + remoteSnpnList: + type: array + items: + $ref: '#/components/schemas/PlmnIdNid' + minItems: 1 + ipReachability: + $ref: '#/components/schemas/IpReachability' + scpCapabilities: + type: array + items: + $ref: '#/components/schemas/ScpCapability' + + PfdData: + description: List of Application IDs and/or AF IDs managed by a given NEF Instance + type: object + properties: + appIds: + type: array + items: + type: string + minItems: 1 + readOnly: true + afIds: + type: array + items: + type: string + minItems: 1 + readOnly: true + AfEvent: + description: Represents Application Events. + anyOf: + - type: string + enum: + - SVC_EXPERIENCE + - UE_MOBILITY + - UE_COMM + - EXCEPTIONS + - USER_DATA_CONGESTION + - PERF_DATA + - DISPERSION + - COLLECTIVE_BEHAVIOUR + - MS_QOE_METRICS + - MS_CONSUMPTION + - MS_NET_ASSIST_INVOCATION + - MS_DYN_POLICY_INVOCATION + - MS_ACCESS_ACTIVITY + - 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. + AfEventExposureData: + description: AF Event Exposure data managed by a given NEF Instance + type: object + required: + - afEvents + properties: + afEvents: + type: array + items: + $ref: '#/components/schemas/AfEvent' + minItems: 1 + afIds: + type: array + items: + type: string + minItems: 1 + readOnly: true + appIds: + type: array + items: + type: string + minItems: 1 + readOnly: true + UnTrustAfInfo: + description: Information of a untrusted AF Instance + type: object + required: + - afId + properties: + afId: + type: string + sNssaiInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiInfoItem' + minItems: 1 + mappingInd: + type: boolean + default: false + SnssaiInfoItem: + description: > + Parameters supported by an NF for a given S-NSSAI Set of parameters supported by NF + for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnInfoItem' + minItems: 1 + DnnInfoItem: + description: Set of parameters supported by NF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + EasdfInfo: + description: Information of an EASDF NF Instance + type: object + properties: + sNssaiEasdfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiEasdfInfoItem' + minItems: 1 + easdfN6IpAddressList: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/IpAddr' + minItems: 1 + upfN6IpAddressList: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/IpAddr' + minItems: 1 + + SnssaiEasdfInfoItem: + description: Set of parameters supported by EASDF for a given S-NSSAI + type: object + required: + - sNssai + - dnnEasdfInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnEasdfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnEasdfInfoItem' + minItems: 1 + + DnnEasdfInfoItem: + description: Set of parameters supported by EASDF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + NssaafInfo: + description: Information of a NSSAAF Instance + type: object + properties: + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + minItems: 1 + TrustAfInfo: + description: Information of a trusted AF Instance + type: object + properties: + sNssaiInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiInfoItem' + minItems: 1 + afEvents: + type: array + items: + $ref: '#/components/schemas/AfEvent' + minItems: 1 + appIds: + type: array + items: + type: string + minItems: 1 + internalGroupId: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + mappingInd: + type: boolean + default: False + ExternalClientType: + description: Indicates types of External Clients. + anyOf: + - type: string + enum: + - EMERGENCY_SERVICES + - VALUE_ADDED_SERVICES + - PLMN_OPERATOR_SERVICES + - LAWFUL_INTERCEPT_SERVICES + - PLMN_OPERATOR_BROADCAST_SERVICES + - PLMN_OPERATOR_OM + - PLMN_OPERATOR_ANONYMOUS_STATISTICS + - PLMN_OPERATOR_TARGET_MS_SERVICE_SUPPORT + - type: string + SupportedGADShapes: + description: Indicates supported GAD shapes. + anyOf: + - type: string + enum: + - POINT + - POINT_UNCERTAINTY_CIRCLE + - POINT_UNCERTAINTY_ELLIPSE + - POLYGON + - POINT_ALTITUDE + - POINT_ALTITUDE_UNCERTAINTY + - ELLIPSOID_ARC + - LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE + - LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID + - type: string + AnNodeType: + description: Access Network Node Type (gNB, ng-eNB...) + anyOf: + - type: string + enum: + - GNB + - NG_ENB + - type: string + + TrpMappingInfo: + type: object + properties: + satelliteId: + type: string + pattern: '^[0-9]{5}$' + trpIds: + type: array + items: + type: integer + minimum: 1 + maximum: 65535 + + TrpInfo: + description: The mapping relationship between TRP IDs, gNB ID and Satellite ID. + type: object + properties: + gNBId: + type: integer + minimum: 0 + maximum: 4294967295 + trpMappingInfoList: + type: array + items: + $ref: '#/components/schemas/TrpMappingInfo' + minItems: 1 + + TrpInfoList: + type: array + items: + $ref: '#/components/schemas/TrpInfo' + + LmfInfo: + description: Information of an LMF NF Instance + type: object + properties: + servingClientTypes: + type: array + items: + $ref: '#/components/schemas/ExternalClientType' + minItems: 1 + lmfId: + type: string + servingAccessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + servingAnNodeTypes: + type: array + items: + $ref: '#/components/schemas/AnNodeType' + minItems: 1 + servingRatTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + supportedGADShapes: + type: array + items: + $ref: '#/components/schemas/SupportedGADShapes' + minItems: 1 + UdrInfo: + description: Information of an UDR NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + $ref: '#/components/schemas/IdentityRangeList' + supportedDataSets: + $ref: '#/components/schemas/SupportedDataSetList' + sharedDataIdRanges: + $ref: '#/components/schemas/SharedDataIdRangeList' + UdmInfo: + description: Information of an UDM NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + minItems: 1 + suciInfos: + type: array + items: + $ref: '#/components/schemas/SuciInfo' + minItems: 1 + PlmnRange: + description: Range of PLMN IDs + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}$' + end: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}$' + pattern: + type: string + + SmsfInfo: + description: Specific Data for SMSF + type: object + properties: + roamingUeInd: + type: boolean + remotePlmnRangeList: + type: array + items: + $ref: '#/components/schemas/PlmnRange' + minItems: 1 + + DccfInfo: + description: Specific Data for DCCF + type: object + properties: + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + taiList: + $ref: '#/components/schemas/TaiList' + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + + MfafInfo: + description: Information of a MFAF NF Instance + type: object + properties: + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + taiList: + $ref: '#/components/schemas/TaiList' + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + + ChfInfo: + description: Information of a CHF NF Instance + type: object + not: + required: [ primaryChfInstance, secondaryChfInstance ] + properties: + supiRangeList: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 0 + gpsiRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 0 + plmnRangeList: + type: array + items: + $ref: '#/components/schemas/PlmnRange' + minItems: 0 + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + primaryChfInstance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + secondaryChfInstance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + + N2InterfaceAmfInfo: + description: AMF N2 interface information + type: object + anyOf: + - required: [ ipv4EndpointAddress ] + - required: [ ipv6EndpointAddress ] + properties: + ipv4EndpointAddress: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddress: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + amfName: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + + AmfInfo: + description: Information of an AMF NF Instance + type: object + required: + - amfSetId + - amfRegionId + - guamiList + properties: + amfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' + amfRegionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + backupInfoAmfFailure: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + backupInfoAmfRemoval: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + n2InterfaceAmfInfo: + $ref: '#/components/schemas/N2InterfaceAmfInfo' + amfOnboardingCapability: + type: boolean + default: false + highLatencyCom: + type: boolean + + SmfInfo: + description: Information of an SMF NF Instance + type: object + required: + - sNssaiSmfInfoList + properties: + sNssaiSmfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiSmfInfoItem' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pgwIpAddrList: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/IpAddr' + minItems: 1 + accessType: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + vsmfSupportInd: + type: boolean + pgwFqdnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + smfOnboardingCapability: + type: boolean + default: false + deprecated: true + ismfSupportInd: + type: boolean + smfUPRPCapability: + type: boolean + default: false + + UpfInfo: + description: Information of an UPF NF Instance + type: object + required: + - sNssaiUpfInfoList + properties: + sNssaiUpfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiUpfInfoItem' + minItems: 1 + smfServingArea: + type: array + items: + type: string + minItems: 1 + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + iwkEpsInd: + type: boolean + default: false + readOnly: true + sxaInd: + type: boolean + readOnly: true + pduSessionTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + atsssCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability' + ueIpAddrInd: + type: boolean + default: false + readOnly: true + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + wAgfInfo: + # $ref: '#/components/schemas/WAgfInfo' + $ref: '#/components/schemas/IpInterface' + tngfInfo: + # $ref: '#/components/schemas/TngfInfo' + $ref: '#/components/schemas/IpInterface' + twifInfo: + # $ref: '#/components/schemas/TwifInfo' + $ref: '#/components/schemas/IpInterface' + priority: + type: integer + minimum: 0 + maximum: 65535 + redundantGtpu: + type: boolean + default: false + readOnly: true + ipups: + type: boolean + default: false + dataForwarding: + type: boolean + default: false + supportedPfcpFeatures: + type: string + readOnly: true + # upfEvents: + # type: array + # items: + # $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/EventType' + # minItems: 1 + + PcfInfo: + description: Information of a PCF NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + rxDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + rxDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + v2xSupportInd: + type: boolean + default: false + readOnly: true + proseSupportInd: + type: boolean + default: false + readOnly: true + proseCapability: + $ref: '#/components/schemas/ProseCapability' + v2xCapability: + $ref: '#/components/schemas/V2xCapability' + a2xSupportInd: + type: boolean + default: false + readOnly: true + a2xCapability: + $ref: '#/components/schemas/A2xCapability' + rangingSlPosSupportInd: + type: boolean + default: false + readOnly: true + + A2xCapability: + description: Information of the supported A2X Capability by the PCF + type: object + properties: + lteA2x: + type: boolean + default: false + nrA2x: + type: boolean + default: false + + NefInfo: + description: Information of an NEF NF Instance + type: object + properties: + nefId: + # $ref: '#/components/schemas/NefId' + type: string + pfdData: + $ref: '#/components/schemas/PfdData' + afEeData: + $ref: '#/components/schemas/AfEventExposureData' + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + servedFqdnList: + type: array + items: + type: string + minItems: 1 + taiList: + $ref: '#/components/schemas/TaiList' + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + unTrustAfInfoList: + type: array + items: + $ref: '#/components/schemas/UnTrustAfInfo' + minItems: 1 + uasNfFunctionalityInd: + type: boolean + default: false + multiMemAfSessQosInd: + type: boolean + default: false + memberUESelAssistInd: + type: boolean + default: false + + NrfInfo: + description: Information of an NRF NF Instance, used in hierarchical NRF deployments + type: object + properties: + servedUdrInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdrInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUdrInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdrInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedUdmInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdmInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUdmInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdmInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedAusfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AusfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedAusfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AusfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedAmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedAmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedSmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/SmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedSmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/SmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedUpfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UpfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUpfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UpfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedPcfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PcfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedPcfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PcfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedBsfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/BsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedBsfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/BsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedChfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/ChfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedChfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/ChfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedNefInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/NefInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedNwdafInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/NwdafInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedNwdafInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/NwdafInfo' + minProperties: 1 + minProperties: 1 + servedPcscfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PcscfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedGmlcInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/GmlcInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedLmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/LmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedNfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/NfInfo' + minProperties: 1 + servedHssInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/HssInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedUdsfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUdsfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedScpInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/ScpInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedSeppInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/SeppInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedAanfInfoList: + description: A map (list of key-value pairs) where NF Instance Id serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AanfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + served5gDdnmfInfo: + type: object + additionalProperties: + $ref: '#/components/schemas/5GDdnmfInfo' + minProperties: 1 + servedMfafInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/MfafInfo' + minProperties: 1 + servedEasdfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/EasdfInfo' + minProperties: 1 + servedDccfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/DccfInfo' + minProperties: 1 + servedMbSmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/MbSmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedTsctsfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/TsctsfInfo' + minProperties: 1 + minProperties: 1 + servedMbUpfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/MbUpfInfo' + minProperties: 1 + minProperties: 1 + servedTrustAfInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/TrustAfInfo' + minProperties: 1 + servedNssaafInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/NssaafInfo' + minProperties: 1 + SatelliteBackhaulInfo: + description: defines the list of satellite backhaul information + type: object + properties: + globalRanNodeID: + $ref: '#/components/schemas/GlobalRanNodeID' + SatelliteBackhaulCategory: + anyOf: + - type: string + enum: + - GEO + - MEO + - LEO + - OTHER_SAT + - DYNAMIC_GEO + - DYNAMIC_MEO + - DYNAMIC_LEO + - DYNAMIC_OTHER_SAT + - NON_SATELLITE + - type: string + geoSatelliteId: + type: string + pattern: '^[0-9]{5}$' + GlobalRanNodeID: + description: globally identification of an NG-RAN node + type: object + oneOf: + - required: [ pLmnId, n3IwfId] + - required: [ plmnId, gNbId] + - required: [ pLmnId, ngeNbId] + - required: [ plmnId, wagfId] + - required: [ pLmnId, tngfId] + - required: [ plmnId, twifId] + properties: + pLmnId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + n3IwfId: + type: string + pattern: '^[A-Fa-f0-9]+$' + gNbId: + type: integer + minimum: 0 + maximum: 4294967295 + ngeNbId: + type: string + pattern: '^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$' + wagfId: + type: string + pattern: '^[A-Fa-f0-9]+$' + tngfId: + type: string + pattern: '^[A-Fa-f0-9]+$' + twifId: + type: string + NTNPLMNRestrictionsInfo: + description: restrictions per PLMN that relates to non-terrestrial network access + type: object + properties: + pLMNId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + blockedLocationInfoList: + type: array + items: + $ref: '#/components/schemas/BlockedLocationInfoList' + minItems: 1 + BlockedLocationInfoList: + description: location for which the PLMN access restrictions are to be applied in case of NTN + type: object + properties: + blockedLocation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + blockedDur: + $ref: '#/components/schemas/TimeDuration' + blockedSlice: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + TimeDuration: + description: location for which the PLMN access restrictions are to be applied in case of NTN + type: object + properties: + blockedDurStartTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + blockedDurEndTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + + 5GDdnmfInfo: + description: Information of an 5G DDNMF NF Instance + type: object + required: + - plmnId + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + ImsiRange: + description: > + A range of IMSIs (subscriber identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]+$' + end: + type: string + pattern: '^[0-9]+$' + pattern: + type: string + NetworkNodeDiameterAddress: + description: > + This data type is a part of smsfDiameterAddress and it should be present + whenever smsf supports Diameter protocol. + type: object + required: + - name + - realm + properties: + name: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + realm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + HssInfo: + description: Information of an HSS NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + imsiRanges: + type: array + items: + $ref: '#/components/schemas/ImsiRange' + minItems: 1 + imsPrivateIdentityRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + imsPublicIdentityRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + hssDiameterAddress: + $ref: '#/components/schemas/NetworkNodeDiameterAddress' + additionalDiamAddresses: + type: array + items: + $ref: '#/components/schemas/NetworkNodeDiameterAddress' + minItems: 1 + GmlcInfo: + description: Information of a GMLC NF Instance + type: object + properties: + servingClientTypes: + type: array + items: + $ref: '#/components/schemas/ExternalClientType' + gmlcNumbers: + type: array + items: + type: string + pattern: '^[0-9]{5,15}$' + + SnssaiTsctsfInfoItem: + description: Set of parameters supported by TSCTSF for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnTsctsfInfoItem' + minItems: 1 + DnnTsctsfInfoItem: + description: Parameters supported by an TSCTSF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + TsctsfInfo: + description: Information of a TSCTSF NF Instance + type: object + properties: + sNssaiInfoList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/SnssaiTsctsfInfoItem' + minProperties: 0 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + + BsfInfo: + description: Information of a BSF NF Instance + type: object + properties: + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 0 + ipDomainList: + type: array + items: + type: string + minItems: 0 + ipv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 0 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 0 + rxDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + rxDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 0 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 0 + + MbSmfInfo: + description: Information of an MB-SMF NF Instance + type: object + properties: + sNssaiInfoList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/SnssaiMbSmfInfoItem' + minProperties: 1 + tmgiRangeList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/TmgiRange' + minProperties: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + mbsSessionList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/MbsSession' + minProperties: 1 + + TmgiRange: + description: Range of TMGIs + type: object + required: + - mbsServiceIdStart + - mbsServiceIdEnd + - plmnId + properties: + mbsServiceIdStart: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + mbsServiceIdEnd: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + + MbsSession: + description: MBS Session currently served by an MB-SMF + type: object + required: + - mbsSessionId + properties: + mbsSessionId: + $ref: '#/components/schemas/MbsSessionId' + mbsAreaSessions: + description: A map (list of key-value pairs) where the key identifies an areaSessionId + additionalProperties: + $ref: '#/components/schemas/MbsServiceAreaInfo' + minProperties: 1 + + MbsServiceAreaInfo: + description: MBS Service Area Information for location dependent MBS session + type: object + properties: + areaSessionId: + type: integer + minimum: 0 + maximum: 65535 + mbsServiceArea: + $ref: '#/components/schemas/MbsServiceArea' + required: + - areaSessionId + - mbsServiceArea + + 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: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + required: + - mbsServiceId + - plmnId + + Ssm: + description: Source specific IP multicast address + type: object + properties: + sourceIpAddr: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/IpAddr' + destIpAddr: + $ref: 'TS28623_ComDefs.yaml#/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: 'TS29571_CommonData.yaml#/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: 'TS29571_CommonData.yaml#/components/schemas/Tai' + cellList: + type: array + items: + $ref: '#/components/schemas/Ncgi' + minItems: 1 + description: List of List of NR cell ids + required: + - tai + - cellList + + Ncgi: + description: Contains the NCGI (NR Cell Global Identity), as described in 3GPP 23.003 + type: object + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + nrCellId: + type: string + pattern: '^[A-Fa-f0-9]{9}$' + # $ref: 'TS29571_CommonData.yaml#/components/schemas/NrCellId' + nid: + $ref: '#/components/schemas/Nid' + required: + - plmnId + - nrCellId + + SnssaiMbSmfInfoItem: + description: Parameters supported by an MB-SMF for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnMbSmfInfoItem' + minItems: 1 + + DnnMbSmfInfoItem: + description: Parameters supported by an MB-SMF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + + AanfInfo: + description: Represents the information relative to an AAnF NF Instance. + type: object + properties: + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + + MbUpfInfo: + description: Information of an MB-UPF NF Instance + type: object + required: + - sNssaiMbUpfInfoList + properties: + sNssaiMbUpfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiUpfInfoItem' + minItems: 1 + mbSmfServingArea: + type: array + items: + type: string + minItems: 1 + interfaceMbUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + supportedPfcpFeatures: + type: string + SnssaiUpfInfoItem: + description: Set of parameters supported by UPF for a given S-NSSAI + type: object + required: + - sNssai + - dnnUpfInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnUpfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnUpfInfoItem' + minItems: 1 + redundantTransport: + type: boolean + default: false + IpIndex: + description: Represents the IP Index to be sent from UDM to the SMF (its value can be either an integer or a string) + anyOf: + - type: integer + - type: string + DnnUpfInfoItem: + description: Set of parameters supported by UPF for a given DNN + type: object + required: + - dnn + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + pduSessionTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + ipv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + natedIpv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + natedIpv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + ipv4IndexList: + type: array + items: + $ref: '#/components/schemas/IpIndex' + minItems: 1 + ipv6IndexList: + type: array + items: + $ref: '#/components/schemas/IpIndex' + minItems: 1 + networkInstance: + description: > + The N6 Network Instance associated with the S-NSSAI and DNN. + type: string + dnaiNwInstanceList: + description: > + Map of network instance per DNAI for the DNN, where the key of the map is the DNAI. + When present, the value of each entry of the map shall contain a N6 network instance + that is configured for the DNAI indicated by the key. + type: object + additionalProperties: + type: string + minProperties: 1 + not: + required: [ networkInstance, dnaiNwInstanceList ] + MnpfInfo: + description: Information of an MNPF Instance + type: object + properties: + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + required: + - msisdnRanges + SliceExpiryInfo : + description: Slice validity + type: object + properties: + pLMNInfo: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfo' + expiryTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTimeRo' + PcscfInfo: + description: Information of a P-CSCF NF Instance + type: object + properties: + accessType: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + gmFqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + gmIpv4Addresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + gmIpv6Addresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + mwFqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + mwIpv4Addresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + mwIpv6Addresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + servedIpv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + servedIpv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + NfInfo: + description: Information of a generic NF Instance + type: object + properties: + nfType: + $ref: '#/components/schemas/NFType' + SAP: + type: object + properties: + host: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/HostAddr' + port: + type: integer + NFServiceType: + type: string + enum: + - NAMF_COMMUNICATION + - NAMF_EVENTEXPOSURE + - NAMF_MT + - NAMF_LOCATION + - NSMF_PDUSESSION + - NSMF_EVENTEXPOSURE + - OTHERS + readOnly: true + Operation: + type: object + properties: + name: + type: string + readOnly: true + allowedNFTypes: + $ref: '#/components/schemas/NFType' + operationSemantics: + $ref: '#/components/schemas/OperationSemantics' + NFType: + description: NF name defined in TS 23.501 or TS 29.510'.This datatype is used for writable attribute + type: string + enum: + - NRF + - UDM + - AMF + - SMF + - AUSF + - NEF + - PCF + - SMSF + - NSSF + - UDR + - LMF + - GMLC + - 5G_EIR + - SEPP + - UPF + - N3IWF + - AF + - UDSF + - DN + - BSF + - CHF + - NWDAF + - PCSCF + - CBCF + - HSS + - UCMF + - SOR_AF + - SPAF + - MME + - SCSAS + - SCEF + - SCP + - NSSAAF + - ICSCF + - SCSCF + - DRA + - IMS_AS + - AANF + - 5G_DDNMF + - NSACF + - MFAF + - EASDF + - DCCF + - MB_SMF + - TSCTSF + - ADRF + - GBA_BSF + - CEF + - MB_UPF + - NSWOF + - PKMF + - MNPF + - SMS_GMSC + - SMS_IWMSC + - MBSF + - MBSTF + - PANF + - TNGF + - W_AGF + - TWIF + - TSN_AF + + OperationSemantics: + type: string + readOnly: true + enum: + - REQUEST_RESPONSE + - SUBSCRIBE_NOTIFY + RegistrationState: + type: string + readOnly: true + enum: + - REGISTERED + - DEREGISTERED + +#-------- Definition of types for name-containments ------ + SubNetwork-ncO-5GcNrm: + type: object + properties: + ExternalAmfFunction: + $ref: '#/components/schemas/ExternalAmfFunction-Multiple' + ExternalNrfFunction: + $ref: '#/components/schemas/ExternalNrfFunction-Multiple' + ExternalNssfFunction: + $ref: '#/components/schemas/ExternalNssfFunction-Multiple' + AmfSet: + $ref: '#/components/schemas/AmfSet-Multiple' + AmfRegion: + $ref: '#/components/schemas/AmfRegion-Multiple' + Configurable5QISet: + $ref: '#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '#/components/schemas/Dynamic5QISet-Multiple' + EcmConnectionInfo: + $ref: '#/components/schemas/EcmConnectionInfo-Multiple' + + ManagedElement-ncO-5GcNrm: + type: object + properties: + AmfFunction: + $ref: '#/components/schemas/AmfFunction-Multiple' + SmfFunction: + $ref: '#/components/schemas/SmfFunction-Multiple' + UpfFunction: + $ref: '#/components/schemas/UpfFunction-Multiple' + N3iwfFunction: + $ref: '#/components/schemas/N3iwfFunction-Multiple' + PcfFunction: + $ref: '#/components/schemas/PcfFunction-Multiple' + AusfFunction: + $ref: '#/components/schemas/AusfFunction-Multiple' + UdmFunction: + $ref: '#/components/schemas/UdmFunction-Multiple' + UdrFunction: + $ref: '#/components/schemas/UdrFunction-Multiple' + UdsfFunction: + $ref: '#/components/schemas/UdsfFunction-Multiple' + NrfFunction: + $ref: '#/components/schemas/NrfFunction-Multiple' + NssfFunction: + $ref: '#/components/schemas/NssfFunction-Multiple' + SmsfFunction: + $ref: '#/components/schemas/SmsfFunction-Multiple' + LmfFunction: + $ref: '#/components/schemas/LmfFunction-Multiple' + NgeirFunction: + $ref: '#/components/schemas/NgeirFunction-Multiple' + SeppFunction: + $ref: '#/components/schemas/SeppFunction-Multiple' + NwdafFunction: + $ref: '#/components/schemas/NwdafFunction-Multiple' + ScpFunction: + $ref: '#/components/schemas/ScpFunction-Multiple' + NefFunction: + $ref: '#/components/schemas/NefFunction-Multiple' + Configurable5QISet: + $ref: '#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '#/components/schemas/Dynamic5QISet-Multiple' + EcmConnectionInfo: + $ref: '#/components/schemas/EcmConnectionInfo-Multiple' + EASDFFunction: + $ref: '#/components/schemas/EASDFFunction-Multiple' + NSSAAFFunction: + $ref: '#/components/schemas/NssaafFunction-Multiple' + AFFunction: + $ref: '#/components/schemas/AfFunction-Multiple' + DCCFFunction: + $ref: '#/components/schemas/DccfFunction-Multiple' + ChfFunction: + $ref: '#/components/schemas/ChfFunction-Multiple' + MFAFFunction: + $ref: '#/components/schemas/MfafFunction-Multiple' + GMLCFunction: + $ref: '#/components/schemas/GmlcFunction-Multiple' + TSCTSFFunction: + $ref: '#/components/schemas/TsctsfFunction-Multiple' + AANFFunction: + $ref: '#/components/schemas/AanfFunction-Multiple' + BSFFunction: + $ref: '#/components/schemas/BsfFunction-Multiple' + MBSMFFunction: + $ref: '#/components/schemas/MbSmfFunction-Multiple' + MBUPFFunction: + $ref: '#/components/schemas/MbUpfFunction-Multiple' + MNPFFunction: + $ref: '#/components/schemas/MnpfFunction-Multiple' + +#-------- Definition of concrete IOCs -------------------------------------------- + AmfFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + amfIdentifier: + $ref: '#/components/schemas/AmfIdentifier' + sBIFqdn: + type: string + weightFactor: + $ref: '#/components/schemas/WeightFactor' + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + amfSetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + nTNPLMNInfoList: + $ref: '#/components/schemas/NTNPLMNRestrictionsInfo' + amfInfo: + $ref: '#/components/schemas/AmfInfo' + sliceExpiryInfo: + $ref: '#/components/schemas/SliceExpiryInfo' + SatelliteBackhaulInfoList: + $ref: '#/components/schemas/SatelliteBackhaulInfo' + mappedCellIdInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/MappedCellIdInfoList' + mdtUserConsentReqList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/MdtUserConsentReqList' + + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N2: + $ref: '#/components/schemas/EP_N2-Multiple' + EP_N8: + $ref: '#/components/schemas/EP_N8-Multiple' + EP_N11: + $ref: '#/components/schemas/EP_N11-Multiple' + EP_N12: + $ref: '#/components/schemas/EP_N12-Multiple' + EP_N14: + $ref: '#/components/schemas/EP_N14-Multiple' + EP_N15: + $ref: '#/components/schemas/EP_N15-Multiple' + EP_N17: + $ref: '#/components/schemas/EP_N17-Multiple' + EP_N20: + $ref: '#/components/schemas/EP_N20-Multiple' + EP_N22: + $ref: '#/components/schemas/EP_N22-Multiple' + EP_N26: + $ref: '#/components/schemas/EP_N26-Multiple' + EP_NL1: + $ref: '#/components/schemas/EP_NL1-Multiple' + EP_NL2: + $ref: '#/components/schemas/EP_NL2-Multiple' + EP_N58: + $ref: '#/components/schemas/EP_N58-Multiple' + EP_N41: + $ref: '#/components/schemas/EP_N41-Multiple' + EP_N42: + $ref: '#/components/schemas/EP_N42-Multiple' + EP_N89: + $ref: '#/components/schemas/EP_N89-Multiple' + EP_N11mb: + $ref: '#/components/schemas/EP_N11mb-Multiple' + AmfSet-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: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + amfSetId: + $ref: '#/components/schemas/AmfSetId' + snssaiList: + $ref: '#/components/schemas/SnssaiList' + aMFRegionRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + aMFSetMemberList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + AmfRegion-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: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + amfRegionId: + $ref: '#/components/schemas/AmfRegionId' + snssaiList: + $ref: '#/components/schemas/SnssaiList' + aMFSetListRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + SmfFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + nRTACList: + $ref: '#/components/schemas/TACList' + sBIFqdn: + type: string + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + SmfInfo: + type: array + items: + $ref: '#/components/schemas/SmfInfo' + configurable5QISetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + dnaiSatelliteMappingList: + type: array + items: + $ref: '#/components/schemas/dnaiSatelliteMapping' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + EP_N7: + $ref: '#/components/schemas/EP_N7-Multiple' + EP_N10: + $ref: '#/components/schemas/EP_N10-Multiple' + EP_N11: + $ref: '#/components/schemas/EP_N11-Multiple' + EP_N16: + $ref: '#/components/schemas/EP_N16-Multiple' + EP_S5C: + $ref: '#/components/schemas/EP_S5C-Multiple' + EP_N40: + $ref: '#/components/schemas/EP_N40-Multiple' + EP_N88: + $ref: '#/components/schemas/EP_N88-Multiple' + EP_N16mb: + $ref: '#/components/schemas/EP_N16mb-Multiple' + FiveQiDscpMappingSet: + $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' + GtpUPathQoSMonitoringControl: + $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' + QFQoSMonitoringControl: + $ref: '#/components/schemas/QFQoSMonitoringControl-Single' + PredefinedPccRuleSet: + $ref: '#/components/schemas/PredefinedPccRuleSet-Single' + + UpfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + nRTACList: + $ref: '#/components/schemas/TACList' + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + energySavingControl: + $ref: '#/components/schemas/EnergySavingControl' + energySavingState: + $ref: '#/components/schemas/EnergySavingState' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + supportedBMOList: + $ref: '#/components/schemas/SupportedBMOList' + upfInfo: + type: array + items: + $ref: '#/components/schemas/UpfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N3: + $ref: '#/components/schemas/EP_N3-Multiple' + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + EP_N6: + $ref: '#/components/schemas/EP_N6-Multiple' + EP_N9: + $ref: '#/components/schemas/EP_N9-Multiple' + EP_S5U: + $ref: '#/components/schemas/EP_S5U-Multiple' + N3iwfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N3: + $ref: '#/components/schemas/EP_N3-Multiple' + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + PcfFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + supportedBMOList: + $ref: '#/components/schemas/SupportedBMOList' + PcfInfo: + type: array + items: + $ref: '#/components/schemas/PcfInfo' + configurable5QISetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnRo' + predefinedPccRuleSetRefs: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N5: + $ref: '#/components/schemas/EP_N5-Multiple' + EP_N7: + $ref: '#/components/schemas/EP_N7-Multiple' + EP_N15: + $ref: '#/components/schemas/EP_N15-Multiple' + EP_N16: + $ref: '#/components/schemas/EP_N16-Multiple' + EP_N28: + $ref: '#/components/schemas/EP_N28-Multiple' + EP_Rx: + $ref: '#/components/schemas/EP_Rx-Multiple' + EP_N84: + $ref: '#/components/schemas/EP_N84-Multiple' + + AusfFunction-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: + plmnInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + ausfInfo: + $ref: '#/components/schemas/AusfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N12: + $ref: '#/components/schemas/EP_N12-Multiple' + EP_N13: + $ref: '#/components/schemas/EP_N13-Multiple' + EP_N61: + $ref: '#/components/schemas/EP_N61-Multiple' + UdmFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + eCSAddrConfigInfo: + $ref: '#/components/schemas/ECSAddrConfigInfo' + udmInfo: + $ref: '#/components/schemas/UdmInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N8: + $ref: '#/components/schemas/EP_N8-Multiple' + EP_N10: + $ref: '#/components/schemas/EP_N10-Multiple' + EP_N13: + $ref: '#/components/schemas/EP_N13-Multiple' + EP_N59: + $ref: '#/components/schemas/EP_N13-Multiple' + EP_NL6: + $ref: '#/components/schemas/EP_NL6-Multiple' + EP_N87: + $ref: '#/components/schemas/EP_N87-Multiple' + UdrFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + udrInfo: + $ref: '#/components/schemas/UdrInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + UdsfFunction-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: + plmnInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + udsfInfo: + $ref: '#/components/schemas/UdsfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + NrfFunction-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: + plmnInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + nFProfileList: + $ref: '#/components/schemas/NFProfileList' + nrfInfo: + $ref: '#/components/schemas/NrfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N27: + $ref: '#/components/schemas/EP_N27-Multiple' + EP_N96: + $ref: '#/components/schemas/EP_N96-Multiple' + EP_SM14: + $ref: '#/components/schemas/EP_SM14-Multiple' + NssfFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N22: + $ref: '#/components/schemas/EP_N22-Multiple' + EP_N31: + $ref: '#/components/schemas/EP_N31-Multiple' + EP_N34: + $ref: '#/components/schemas/EP_N34-Multiple' + SmsfFunction-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: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + smsfInfo: + $ref: '#/components/schemas/SmsfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N20: + $ref: '#/components/schemas/EP_N20-Multiple' + EP_N21: + $ref: '#/components/schemas/EP_N21-Multiple' + EP_MAP_SMSC: + $ref: '#/components/schemas/EP_MAP_SMSC-Multiple' + LmfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + lmfInfo: + $ref: '#/components/schemas/LmfInfo' + ephemerisInfos: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/EphemerisInfos' + trpInfoList: + $ref: '#/components/schemas/TrpInfoList' + mappedCellIdInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/MappedCellIdInfoList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_NL1: + $ref: '#/components/schemas/EP_NL1-Multiple' + EP_NL8: + $ref: '#/components/schemas/EP_NL8-Multiple' + EP_NL7: + $ref: '#/components/schemas/EP_NL7-Multiple' + EP_NL10: + $ref: '#/components/schemas/EP_NL10-Multiple' + NgeirFunction-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: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N17: + $ref: '#/components/schemas/EP_N17-Multiple' + SeppFunction-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: + plmnId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnIdRo' + sEPPType: + $ref: '#/components/schemas/SEPPType' + sEPPId: + type: integer + readOnly: true + fqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + seppInfo: + $ref: '#/components/schemas/SeppInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N32: + $ref: '#/components/schemas/EP_N32-Multiple' + NwdafFunction-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: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + networkSliceInfoList: + $ref: '#/components/schemas/NetworkSliceInfoList' + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + nwdafInfo: + $ref: '#/components/schemas/NwdafInfo' + nwdafLogicalFuncSupported: + type: string + readOnly: true + enum: + - NWDAF_WITH_ANLF + - NWDAF_WITH_MTLF + - NWDAF_WITH_ANLF_MTLF + - type: object + properties: + EP_NL3: + $ref: '#/components/schemas/EP_NL3-Multiple' + EP_N34: + $ref: '#/components/schemas/EP_N34-Multiple' + AnLFFunction: + $ref: '#/components/schemas/AnLFFunction-Single' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + ScpFunction-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: + supportedFuncList: + $ref: '#/components/schemas/SupportedFuncList' + address: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/HostAddr' + scpInfo: + $ref: '#/components/schemas/ScpInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_SM13: + $ref: '#/components/schemas/EP_SM13-Multiple' + NefFunction-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: + sBIFqdn: + type: string + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + capabilityList: + $ref: '#/components/schemas/CapabilityList' + isCAPIFSup: + type: boolean + readOnly: true + nefInfo: + $ref: '#/components/schemas/NefInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N33: + $ref: '#/components/schemas/EP_N33-Multiple' + EP_NL5: + $ref: '#/components/schemas/EP_NL5-Multiple' + EP_N85: + $ref: '#/components/schemas/EP_N85-Multiple' + EP_N62: + $ref: '#/components/schemas/EP_N62-Multiple' + EP_N63: + $ref: '#/components/schemas/EP_N63-Multiple' + + NsacfFunction-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: + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + nsacfInfoSnssai: + type: array + items: + $ref: '#/components/schemas/NsacfInfoSnssai' + nsacfInfo: + $ref: '#/components/schemas/NsacfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N60: + $ref: '#/components/schemas/EP_N60-Multiple' + + DDNMFFunction-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: + plmnId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_Npc4: + $ref: '#/components/schemas/EP_Npc4-Multiple' + EP_Npc6: + $ref: '#/components/schemas/EP_Npc6-Multiple' + EP_Npc7: + $ref: '#/components/schemas/EP_Npc7-Multiple' + EP_Npc8: + $ref: '#/components/schemas/EP_Npc8-Multiple' + + EASDFFunction-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: + plmnId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + serverAddr: + type: string + easdfInfo: + $ref: '#/components/schemas/EasdfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N88: + $ref: '#/components/schemas/EP_N88-Multiple' + + EcmConnectionInfo-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + eASServiceArea: + $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/ServingLocation' + eESServiceArea: + $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/ServingLocation' + eDNServiceArea: + $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/ServingLocation' + eASIpAddress: + type: string + eESIpAddress: + type: string + eCSIpAddress: + type: string + ednIdentifier: + type: string + ecmConnectionType: + type: string + enum: + - USERPLANE + - CONTROLPLANE + - BOTH + 5GCNfConnEcmInfoList: + $ref: '#/components/schemas/5GCNfConnEcmInfoList' + uPFConnectionInfo: + $ref: '#/components/schemas/UPFConnectionInfo' + + + ExternalAmfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + amfIdentifier: + $ref: '#/components/schemas/AmfIdentifier' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + ExternalNrfFunction-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: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + ExternalNssfFunction-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: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + ExternalSeppFunction-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: + plmnId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnIdRo' + sEPPId: + type: integer + readOnly: true + fqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/FqdnRo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + EP_N2-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N3-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + epTransportRefs: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnListRo' + EP_N4-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N5-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N6-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N7-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N8-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N9-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N10-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N11-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N12-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N13-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N14-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N15-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N16-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N17-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N20-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N21-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N22-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N26-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N27-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + + EP_N31-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N32-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: + remotePlmnId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + remoteSeppAddress: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/HostAddr' + remoteSeppId: + type: integer + n32cParas: + type: string + n32fPolicy: + type: string + withIPX: + type: boolean + EP_N33-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N34-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_S5C-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_S5U-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Rx-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_MAP_SMSC-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_NL1-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_NL2-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_NL3-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_NL5-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_NL6-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_NL7-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_NL8-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_NL9-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_NL10-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N60-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Npc4-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Npc6-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Npc7-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Npc8-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N88-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + FiveQiDscpMappingSet-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + FiveQiDscpMappingList: + type: array + items: + $ref: '#/components/schemas/FiveQiDscpMapping' + + FiveQICharacteristics-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + fiveQIValue: + type: integer + resourceType: + type: string + enum: + - GBR + - NON_GBR + - DELAY_CRITICAL_GBR + priorityLevel: + type: integer + packetDelayBudget: + type: integer + packetErrorRate: + $ref: '#/components/schemas/PacketErrorRate' + averagingWindow: + type: integer + maximumDataBurstVolume: + type: integer + FiveQICharacteristics-Multiple: + type: array + items: + $ref: '#/components/schemas/FiveQICharacteristics-Single' + Configurable5QISet-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + configurable5QIs: + $ref: '#/components/schemas/FiveQICharacteristics-Multiple' + + Dynamic5QISet-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + dynamic5QIs: + $ref: '#/components/schemas/FiveQICharacteristics-Multiple' + + GtpUPathQoSMonitoringControl-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + gtpUPathQoSMonitoringState: + type: string + enum: + - ENABLED + - DISABLED + gtpUPathMonitoredSNSSAIs: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + monitoredDSCPs: + type: array + items: + type: integer + minimum: 0 + maximum: 255 + isEventTriggeredGtpUPathMonitoringSupported: + type: boolean + readOnly: true + isPeriodicGtpUMonitoringSupported: + type: boolean + readOnly: true + isImmediateGtpUMonitoringSupported: + type: boolean + readOnly: true + gtpUPathDelayThresholds: + $ref: '#/components/schemas/GtpUPathDelayThresholdsType' + gtpUPathMinimumWaitTime: + type: integer + gtpUPathMeasurementPeriod: + type: integer + + QFQoSMonitoringControl-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + qFQoSMonitoringState: + type: string + enum: + - ENABLED + - DISABLED + qFMonitoredSNSSAIs: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + qFMonitored5QIs: + type: array + items: + type: integer + minimum: 0 + maximum: 255 + isEventTriggeredQFMonitoringSupported: + type: boolean + readOnly: true + isPeriodicQFMonitoringSupported: + type: boolean + readOnly: true + isSessionReleasedQFMonitoringSupported: + type: boolean + readOnly: true + qFPacketDelayThresholds: + $ref: '#/components/schemas/QFPacketDelayThresholdsType' + qFMinimumWaitTime: + type: integer + qFMeasurementPeriod: + type: integer + + PredefinedPccRuleSet-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + predefinedPccRules: + type: array + items: + $ref: '#/components/schemas/PccRule' + + AfFunction-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: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + trustAfInfo: + $ref: '#/components/schemas/TrustAfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N5: + $ref: '#/components/schemas/EP_N5-Multiple' + EP_N86: + $ref: '#/components/schemas/EP_N86-Multiple' + EP_N63: + $ref: '#/components/schemas/EP_N63-Multiple' + EP_N62: + $ref: '#/components/schemas/EP_N62-Multiple' + + NssaafFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + nssafInfo: + $ref: '#/components/schemas/NssaafInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + EP_N58-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N59-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + DccfFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + dccfInfo: + $ref: '#/components/schemas/DccfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + + MfafFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + mfafInfo: + $ref: '#/components/schemas/MfafInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + + ChfFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + chfInfo: + $ref: '#/components/schemas/ChfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N28: + $ref: '#/components/schemas/EP_N28-Multiple' + EP_N40: + $ref: '#/components/schemas/EP_N40-Multiple' + EP_N41: + $ref: '#/components/schemas/EP_N41-Multiple' + EP_N42: + $ref: '#/components/schemas/EP_N42-Multiple' + + EP_N28-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N40-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N41-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N42-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + AanfFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + aanfInfo: + $ref: '#/components/schemas/AanfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N61: + $ref: '#/components/schemas/EP_N61-Multiple' + EP_N62: + $ref: '#/components/schemas/EP_N62-Multiple' + EP_N63: + $ref: '#/components/schemas/EP_N63-Multiple' + EP_N61-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N62-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N63-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + + GmlcFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + gmlcInfo: + $ref: '#/components/schemas/GmlcInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_NL2: + $ref: '#/components/schemas/EP_NL2-Multiple' + EP_NL3: + $ref: '#/components/schemas/EP_NL3-Multiple' + EP_NL5: + $ref: '#/components/schemas/EP_NL5-Multiple' + EP_NL6: + $ref: '#/components/schemas/EP_NL6-Multiple' + EP_NL9: + $ref: '#/components/schemas/EP_NL9-Multiple' + EP_NL10: + $ref: '#/components/schemas/EP_NL10-Multiple' + TsctsfFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + tsctsfInfo: + $ref: '#/components/schemas/TsctsfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N84: + $ref: '#/components/schemas/EP_N84-Multiple' + EP_N85: + $ref: '#/components/schemas/EP_N85-Multiple' + EP_N86: + $ref: '#/components/schemas/EP_N86-Multiple' + EP_N87: + $ref: '#/components/schemas/EP_N87-Multiple' + EP_N89: + $ref: '#/components/schemas/EP_N89-Multiple' + EP_N96: + $ref: '#/components/schemas/EP_N96-Multiple' + + EP_N84-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N85-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N86-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N87-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N89-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N96-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + BsfFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + sBIFqdn: + type: string + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + bsfInfo: + type: array + items: + $ref: '#/components/schemas/BsfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + + MbSmfFunction-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: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + mbSmfInfo: + $ref: '#/components/schemas/MbSmfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N11mb: + $ref: '#/components/schemas/EP_N11mb-Multiple' + EP_N16mb: + $ref: '#/components/schemas/EP_N16mb-Multiple' + EP_Nmb1: + $ref: '#/components/schemas/EP_Nmb1-Multiple' + EP_N4mb: + $ref: '#/components/schemas/EP_N4mb-Multiple' + + EP_N11mb-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N16mb-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Nmb1-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + MbUpfFunction-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: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + mbUpfInfo: + $ref: '#/components/schemas/MbUpfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_N3mb: + $ref: '#/components/schemas/EP_N3mb-Multiple' + EP_N4mb: + $ref: '#/components/schemas/EP_N4mb-Multiple' + EP_N19mb: + $ref: '#/components/schemas/EP_N19mb-Multiple' + EP_Nmb9: + $ref: '#/components/schemas/EP_Nmb9-Multiple' + + MnpfFunction-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: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + mnpfInfo: + $ref: '#/components/schemas/MnpfInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: '#/components/schemas/ManagedFunction5GC-nc0' + - type: object + properties: + EP_SM12: + $ref: '#/components/schemas/EP_SM12-Multiple' + EP_SM13: + $ref: '#/components/schemas/EP_SM13-Multiple' + EP_SM14: + $ref: '#/components/schemas/EP_SM14-Multiple' + + EP_N3mb-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N4mb-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N19mb-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Nmb9-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + AnLFFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + activationStatus: + type: string + enum: + - ACTIVATED + - DEACTIVATED + readOnly: true + EP_SM12-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_SM13-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_SM14-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: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' +#-------- Definition of abstract IOCs -------------------------------------------- + ManagedFunction5GC-nc0: + type: object + properties: + ManagedNFService: + $ref: '#/components/schemas/ManagedNFService-Multiple' +#-------- Definition of abstract IOCs -------------------------------------------- + + +#-------- Definition of 5GC common IOCs -------------------------------------------- + ManagedNFService-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + userLabel: + type: string + nFServiceType: + $ref: '#/components/schemas/NFServiceType' + sAP: + $ref: '#/components/schemas/SAP' + operations: + type: array + items: + $ref: '#/components/schemas/Operation' + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + usageState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/UsageState' + registrationState: + $ref: '#/components/schemas/RegistrationState' + +#-------- Definition of 5GC common IOCs -------------------------------------------- + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + AmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfFunction-Single' + SmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SmfFunction-Single' + UpfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UpfFunction-Single' + N3iwfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/N3iwfFunction-Single' + PcfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/PcfFunction-Single' + AusfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AusfFunction-Single' + UdmFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdmFunction-Single' + UdrFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdrFunction-Single' + UdsfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdsfFunction-Single' + NrfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NrfFunction-Single' + NssfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NssfFunction-Single' + SmsfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SmsfFunction-Single' + LmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/LmfFunction-Single' + NgeirFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NgeirFunction-Single' + SeppFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SeppFunction-Single' + NwdafFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NwdafFunction-Single' + ScpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ScpFunction-Single' + NefFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NefFunction-Single' + + NsacfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NsacfFunction-Single' + + ExternalAmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalAmfFunction-Single' + ExternalNrfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalNrfFunction-Single' + ExternalNssfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalNssfFunction-Single' + ExternalSeppFunction-Nultiple: + type: array + items: + $ref: '#/components/schemas/ExternalSeppFunction-Single' + + AmfSet-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfSet-Single' + AmfRegion-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfRegion-Single' + + EASDFFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/EASDFFunction-Single' + + EP_N2-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N2-Single' + EP_N3-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N3-Single' + EP_N4-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N4-Single' + EP_N5-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N5-Single' + EP_N6-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N6-Single' + EP_N7-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N7-Single' + EP_N8-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N8-Single' + EP_N9-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N9-Single' + EP_N10-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N10-Single' + EP_N11-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N11-Single' + EP_N12-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N12-Single' + EP_N13-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N13-Single' + EP_N14-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N14-Single' + EP_N15-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N15-Single' + EP_N16-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N16-Single' + EP_N17-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N17-Single' + + EP_N20-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N20-Single' + EP_N21-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N21-Single' + EP_N22-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N22-Single' + + EP_N26-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N26-Single' + EP_N27-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N27-Single' + EP_N28-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N28-Single' + + EP_N31-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N31-Single' + EP_N32-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N32-Single' + EP_N33-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N33-Single' + EP_N34-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N34-Single' + EP_N40-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N40-Single' + EP_N41-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N41-Single' + EP_N42-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N42-Single' + + EP_S5C-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_S5C-Single' + EP_S5U-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_S5U-Single' + EP_Rx-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Rx-Single' + EP_MAP_SMSC-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_MAP_SMSC-Single' + EP_NL1-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NL1-Single' + EP_NL2-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NL2-Single' + EP_NL3-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NL3-Single' + EP_NL5-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NL5-Single' + EP_NL6-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NL6-Single' + EP_NL7-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NL7-Single' + EP_NL8-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NL8-Single' + EP_NL9-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NL9-Single' + EP_NL10-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NL10-Single' + EP_N60-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N60-Single' + EP_N61-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N61-Single' + EP_N62-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N62-Single' + EP_N63-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N63-Single' + EP_Npc4-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Npc4-Single' + EP_Npc6-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Npc6-Single' + EP_Npc7-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Npc7-Single' + EP_Npc8-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Npc8-Single' + EP_N84-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N84-Single' + EP_N85-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N85-Single' + EP_N86-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N86-Single' + EP_N87-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N87-Single' + EP_N88-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N88-Single' + EP_N89-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N89-Single' + EP_N96-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N96-Single' + EP_N11mb-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N11mb-Single' + EP_N16mb-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N16mb-Single' + EP_Nmb1-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Nmb1-Single' + EP_N3mb-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N3mb-Single' + EP_N4mb-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N4mb-Single' + EP_N19mb-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N19mb-Single' + EP_Nmb9-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Nmb9-Single' + EP_SM12-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_SM12-Single' + EP_SM13-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_SM13-Single' + EP_SM14-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_SM14-Single' + Configurable5QISet-Multiple: + type: array + items: + $ref: '#/components/schemas/Configurable5QISet-Single' + Dynamic5QISet-Multiple: + type: array + items: + $ref: '#/components/schemas/Dynamic5QISet-Single' + EcmConnectionInfo-Multiple: + type: array + items: + $ref: '#/components/schemas/EcmConnectionInfo-Single' + NssaafFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NssaafFunction-Single' + EP_N58-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N58-Single' + EP_N59-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N59-Single' + AfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AfFunction-Single' + DccfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/DccfFunction-Single' + ChfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ChfFunction-Single' + MfafFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/MfafFunction-Single' + GmlcFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/GmlcFunction-Single' + TsctsfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/TsctsfFunction-Single' + AanfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AanfFunction-Single' + BsfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/BsfFunction-Single' + MbSmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/MbSmfFunction-Single' + MbUpfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/MbUpfFunction-Single' + MnpfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/MnpfFunction-Single' + ManagedNFService-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedNFService-Single' +#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- + + resources-5gcNrm: + oneOf: + - $ref: '#/components/schemas/AmfFunction-Single' + - $ref: '#/components/schemas/SmfFunction-Single' + - $ref: '#/components/schemas/UpfFunction-Single' + - $ref: '#/components/schemas/N3iwfFunction-Single' + - $ref: '#/components/schemas/PcfFunction-Single' + - $ref: '#/components/schemas/AusfFunction-Single' + - $ref: '#/components/schemas/UdmFunction-Single' + - $ref: '#/components/schemas/UdrFunction-Single' + - $ref: '#/components/schemas/UdsfFunction-Single' + - $ref: '#/components/schemas/NrfFunction-Single' + - $ref: '#/components/schemas/NssfFunction-Single' + - $ref: '#/components/schemas/SmsfFunction-Single' + - $ref: '#/components/schemas/LmfFunction-Single' + - $ref: '#/components/schemas/NgeirFunction-Single' + - $ref: '#/components/schemas/SeppFunction-Single' + - $ref: '#/components/schemas/NwdafFunction-Single' + - $ref: '#/components/schemas/ScpFunction-Single' + - $ref: '#/components/schemas/NefFunction-Single' + - $ref: '#/components/schemas/NsacfFunction-Single' + - $ref: '#/components/schemas/DDNMFFunction-Single' + - $ref: '#/components/schemas/ManagedNFService-Single' + + - $ref: '#/components/schemas/ExternalAmfFunction-Single' + - $ref: '#/components/schemas/ExternalNrfFunction-Single' + - $ref: '#/components/schemas/ExternalNssfFunction-Single' + - $ref: '#/components/schemas/ExternalSeppFunction-Single' + + - $ref: '#/components/schemas/AmfSet-Single' + - $ref: '#/components/schemas/AmfRegion-Single' + - $ref: '#/components/schemas/QFQoSMonitoringControl-Single' + - $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' + + - $ref: '#/components/schemas/EP_N2-Single' + - $ref: '#/components/schemas/EP_N3-Single' + - $ref: '#/components/schemas/EP_N4-Single' + - $ref: '#/components/schemas/EP_N5-Single' + - $ref: '#/components/schemas/EP_N6-Single' + - $ref: '#/components/schemas/EP_N7-Single' + - $ref: '#/components/schemas/EP_N8-Single' + - $ref: '#/components/schemas/EP_N9-Single' + - $ref: '#/components/schemas/EP_N10-Single' + - $ref: '#/components/schemas/EP_N11-Single' + - $ref: '#/components/schemas/EP_N12-Single' + - $ref: '#/components/schemas/EP_N13-Single' + - $ref: '#/components/schemas/EP_N14-Single' + - $ref: '#/components/schemas/EP_N15-Single' + - $ref: '#/components/schemas/EP_N16-Single' + - $ref: '#/components/schemas/EP_N17-Single' + + - $ref: '#/components/schemas/EP_N20-Single' + - $ref: '#/components/schemas/EP_N21-Single' + - $ref: '#/components/schemas/EP_N22-Single' + + - $ref: '#/components/schemas/EP_N26-Single' + - $ref: '#/components/schemas/EP_N27-Single' + - $ref: '#/components/schemas/EP_N28-Single' + + - $ref: '#/components/schemas/EP_N31-Single' + - $ref: '#/components/schemas/EP_N32-Single' + - $ref: '#/components/schemas/EP_N33-Single' + - $ref: '#/components/schemas/EP_N34-Single' + - $ref: '#/components/schemas/EP_N40-Single' + - $ref: '#/components/schemas/EP_N41-Single' + - $ref: '#/components/schemas/EP_N42-Single' + + - $ref: '#/components/schemas/EP_N58-Single' + - $ref: '#/components/schemas/EP_N59-Single' + - $ref: '#/components/schemas/EP_N60-Single' + - $ref: '#/components/schemas/EP_N61-Single' + - $ref: '#/components/schemas/EP_N62-Single' + - $ref: '#/components/schemas/EP_N63-Single' + - $ref: '#/components/schemas/EP_N84-Single' + - $ref: '#/components/schemas/EP_N85-Single' + - $ref: '#/components/schemas/EP_N86-Single' + - $ref: '#/components/schemas/EP_N87-Single' + - $ref: '#/components/schemas/EP_N88-Single' + - $ref: '#/components/schemas/EP_N89-Single' + - $ref: '#/components/schemas/EP_N96-Single' + + - $ref: '#/components/schemas/EP_Npc4-Single' + - $ref: '#/components/schemas/EP_Npc6-Single' + - $ref: '#/components/schemas/EP_Npc7-Single' + - $ref: '#/components/schemas/EP_Npc8-Single' + + - $ref: '#/components/schemas/EP_N3mb-Single' + - $ref: '#/components/schemas/EP_N4mb-Single' + - $ref: '#/components/schemas/EP_N19mb-Single' + - $ref: '#/components/schemas/EP_Nmb9-Single' + + - $ref: '#/components/schemas/EP_S5C-Single' + - $ref: '#/components/schemas/EP_S5U-Single' + - $ref: '#/components/schemas/EP_Rx-Single' + - $ref: '#/components/schemas/EP_MAP_SMSC-Single' + - $ref: '#/components/schemas/EP_NL1-Single' + - $ref: '#/components/schemas/EP_NL2-Single' + - $ref: '#/components/schemas/EP_NL3-Single' + - $ref: '#/components/schemas/EP_NL5-Single' + - $ref: '#/components/schemas/EP_NL6-Single' + - $ref: '#/components/schemas/EP_NL7-Single' + - $ref: '#/components/schemas/EP_NL8-Single' + - $ref: '#/components/schemas/EP_NL9-Single' + - $ref: '#/components/schemas/EP_NL10-Single' + - $ref: '#/components/schemas/EP_N11mb-Single' + - $ref: '#/components/schemas/EP_N16mb-Single' + - $ref: '#/components/schemas/EP_Nmb1-Single' + + - $ref: '#/components/schemas/EP_SM12-Single' + - $ref: '#/components/schemas/EP_SM13-Single' + - $ref: '#/components/schemas/EP_SM14-Single' + + - $ref: '#/components/schemas/Configurable5QISet-Single' + - $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' + - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' + - $ref: '#/components/schemas/Dynamic5QISet-Single' + - $ref: '#/components/schemas/EASDFFunction-Single' + - $ref: '#/components/schemas/EcmConnectionInfo-Single' + - $ref: '#/components/schemas/NssaafFunction-Single' + - $ref: '#/components/schemas/AfFunction-Single' + - $ref: '#/components/schemas/DccfFunction-Single' + - $ref: '#/components/schemas/ChfFunction-Single' + - $ref: '#/components/schemas/MfafFunction-Single' + - $ref: '#/components/schemas/GmlcFunction-Single' + - $ref: '#/components/schemas/TsctsfFunction-Single' + - $ref: '#/components/schemas/AanfFunction-Single' + - $ref: '#/components/schemas/BsfFunction-Single' + - $ref: '#/components/schemas/MbSmfFunction-Single' + - $ref: '#/components/schemas/MbUpfFunction-Single' + - $ref: '#/components/schemas/MnpfFunction-Single' -- GitLab From 663ce32b4b10bcd7fdac0e0b38162b8b8e9f5ea6 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 01:50:37 +0000 Subject: [PATCH 20/33] Upload the YAML for cross reference compile --- OpenAPI/TS28111_FaultNrm.yaml | 562 ++++++++++++++++++++++++++++++++++ 1 file changed, 562 insertions(+) create mode 100644 OpenAPI/TS28111_FaultNrm.yaml diff --git a/OpenAPI/TS28111_FaultNrm.yaml b/OpenAPI/TS28111_FaultNrm.yaml new file mode 100644 index 0000000..7a525d1 --- /dev/null +++ b/OpenAPI/TS28111_FaultNrm.yaml @@ -0,0 +1,562 @@ +openapi: 3.0.1 +info: + title: Fault Management NRM + version: 18.1.0 + description: >- + OAS 3.0.1 definition of the Fault Supervision MnS + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.111; Fault Management + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.111/ +servers: + - url: '{MnSRoot}/FaultSupervisionMnS/{MnSversion}' + variables: + MnSRoot: + description: See subclause 4.4.3 of TS 32.158 + default: http://example.com/3GPPManagement + MnSversion: + description: Version number of the OpenAPI definition + default: XXX +paths: {} + +components: + schemas: + + #---- Definition of AlarmRecord ----------------------------------------------------# + + AlarmId: + type: string + AlarmType: + type: string + enum: + - COMMUNICATIONS_ALARM + - QUALITY_OF_SERVICE_ALARM + - PROCESSING_ERROR_ALARM + - EQUIPMENT_ALARM + - ENVIRONMENTAL_ALARM + - INTEGRITY_VIOLATION + - OPERATIONAL_VIOLATION + - PHYSICAL_VIOLATION + - SECURITY_SERVICE_OR_MECHANISM_VIOLATION + - TIME_DOMAIN_VIOLATION + ProbableCause: + description: >- + The value of the probable cause may be a specific standardized string, or any + vendor provided string. Probable cause strings are not standardized in the + present document. They may be added in a future version. Up to then the + mapping of the generic probable cause strings "PROBABLE_CAUSE_001" to + "PROBABLE_CAUSE_005" is vendor specific. + The value of the probable cause may also be an integer. The mapping of integer + values to probable causes is vendor specific. + oneOf: + - anyOf: + - type: string + enum: + - PROBABLE_CAUSE_001 + - PROBABLE_CAUSE_002 + - PROBABLE_CAUSE_003 + - PROBABLE_CAUSE_004 + - PROBABLE_CAUSE_005 + - type: string + - type: integer + SpecificProblem: + oneOf: + - type: string + - type: integer + PerceivedSeverity: + type: string + enum: + - INDETERMINATE + - CRITICAL + - MAJOR + - MINOR + - WARNING + - CLEARED + TrendIndication: + type: string + enum: + - MORE_SEVERE + - NO_CHANGE + - LESS_SEVERE + ThresholdHysteresis: + type: object + required: + - high + properties: + high: + oneOf: + - type: integer + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' + low: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' + ThresholdLevelInd: + oneOf: + - type: object + properties: + up: + $ref: '#/components/schemas/ThresholdHysteresis' + - type: object + properties: + down: + $ref: '#/components/schemas/ThresholdHysteresis' + ThresholdInfo: + type: object + properties: + observedMeasurement: + type: string + observedValue: + type: number + thresholdLevel: + $ref: '#/components/schemas/ThresholdLevelInd' + armTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + required: + - observedMeasurement + - observedValue + CorrelatedNotification: + type: object + properties: + sourceObjectInstance: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + notificationIds: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationId' + required: + - sourceObjectInstance + - notificationIds + CorrelatedNotifications: + type: array + items: + $ref: '#/components/schemas/CorrelatedNotification' + AckState: + type: string + enum: + - ACKNOWLEDGED + - UNACKNOWLEDGED + + AlarmRecord: + description: >- + The alarmId is not a property of an alarm record. It is used as key + in the map of alarm records instead. + type: object + properties: + # alarmId: + # $ref: '#/components/schemas/AlarmId' + objectInstance: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + notificationId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationId' + alarmRaisedTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + alarmChangedTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + alarmClearedTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + specificProblem: + $ref: '#/components/schemas/SpecificProblem' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + backedUpStatus: + type: boolean + backUpObject: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + trendIndication: + $ref: '#/components/schemas/TrendIndication' + thresholdinfo: + $ref: '#/components/schemas/ThresholdInfo' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + stateChangeDefinition: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' + monitoredAttributes: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + proposedRepairActions: + type: string + additionalText: + type: string + additionalInformation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + + rootCauseIndicator: + type: boolean + + ackTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + ackUserId: + type: string + ackSystemId: + type: string + ackState: + $ref: '#/components/schemas/AckState' + + clearUserId: + type: string + clearSystemId: + type: string + serviceUser: + type: string + serviceProvider: + type: string + securityAlarmDetector: + type: string + + AlarmList-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + numOfAlarmRecords: + type: integer + lastModification: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + alarmRecords: + description: >- + This resource represents a map of alarm records. + The alarmIds are used as keys in the map. + type: object + additionalProperties: + $ref: '#/components/schemas/AlarmRecord' + unreliableAlarmScope: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + + #---- Definition of alarm notifications --------------------------------------------# + + AlarmNotificationTypes: + type: string + enum: + - notifyNewAlarm + - notifyChangedAlarm + - notifyChangedAlarmGeneral + - notifyAckStateChanged + - notifyCorrelatedNotificationChanged + - notifyComments + - notifyClearedAlarm + - notifyAlarmListRebuilt + - notifyPotentialFaultyAlarmList + AlarmListAlignmentRequirement: + type: string + enum: + - ALIGNMENT_REQUIRED + - ALIGNMENT_NOT_REQUIRED + + NotifyNewAlarm: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + specificProblem: + $ref: '#/components/schemas/SpecificProblem' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + backedUpStatus: + type: boolean + backUpObject: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + trendIndication: + $ref: '#/components/schemas/TrendIndication' + thresholdInfo: + $ref: '#/components/schemas/ThresholdInfo' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + stateChangeDefinition: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' + monitoredAttributes: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + proposedRepairActions: + type: string + additionalText: + type: string + additionalInformation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + NotifyNewSecAlarm: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - serviceUser + - serviceProvider + - securityAlarmDetector + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + specificProblem: + $ref: '#/components/schemas/SpecificProblem' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + additionalText: + type: string + additionalInformation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + serviceUser: + type: string + serviceProvider: + type: string + securityAlarmDetector: + type: string + NotifyClearedAlarm: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + clearUserId: + type: string + clearSystemId: + type: string + NotifyChangedAlarm: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + NotifyChangedAlarmGeneral: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + specificProblem: + $ref: '#/components/schemas/SpecificProblem' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + backedUpStatus: + type: boolean + backUpObject: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + trendIndication: + $ref: '#/components/schemas/TrendIndication' + thresholdInfo: + $ref: '#/components/schemas/ThresholdInfo' + stateChangeDefinition: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' + monitoredAttributes: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + proposedRepairActions: + type: string + additionalText: + type: string + additionalInformation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + changedAlarmAttributes: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + NotifyChangedSecAlarmGeneral: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - serviceUser + - serviceProvider + - securityAlarmDetector + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + additionalText: + type: string + additionalInformation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + rootCauseIndicator: + type: boolean + serviceUser: + type: string + serviceProvider: + type: string + securityAlarmDetector: + type: string + changedAlarmAttributes: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + NotifyCorrelatedNotificationChanged: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - correlatedNotifications + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + correlatedNotifications: + $ref: '#/components/schemas/CorrelatedNotifications' + rootCauseIndicator: + type: boolean + NotifyAckStateChanged: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - ackState + - ackUserId + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + ackState: + $ref: '#/components/schemas/AckState' + ackUserId: + type: string + ackSystemId: + type: string + NotifyComments: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - alarmId + - alarmType + - probableCause + - perceivedSeverity + - comments + properties: + alarmId: + $ref: '#/components/schemas/AlarmId' + alarmType: + $ref: '#/components/schemas/AlarmType' + probableCause: + $ref: '#/components/schemas/ProbableCause' + perceivedSeverity: + $ref: '#/components/schemas/PerceivedSeverity' + comments: + $ref: '#/components/schemas/Comments' + NotifyPotentialFaultyAlarmList: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - reason + properties: + reason: + type: string + NotifyAlarmListRebuilt: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - reason + properties: + reason: + type: string + alarmListAlignmentRequirement: + $ref: '#/components/schemas/AlarmListAlignmentRequirement' + + #---- Definition of resources ------------------------------------------------------# + + Comment: + type: object + properties: + commentTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + commentUserId: + type: string + commentSystemId: + type: string + commentText: + type: string + Comments: + description: >- + Collection of comments. The comment identifiers are allocated by the + MnS producer and used as key in the map. + type: object + additionalProperties: + $ref: '#/components/schemas/Comment' + + #----- Definitions in TS 28.111 for TS 28.532 --------------------------# + resources-faultNrm: + oneOf: + - $ref: '#/components/schemas/AlarmList-Single' + + #----- Definitions in TS 28.111 for TS 28.532 --------------------------# \ No newline at end of file -- GitLab From 018a1e77c6d098ffca4c5d24f6c56ca863ceb0e4 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 06:36:39 +0000 Subject: [PATCH 21/33] Upload the YAML for cross reference compile --- OpenAPI/TS28532_ProvMnS.yaml | 571 +++++++++++++++++++++++++++++++++++ 1 file changed, 571 insertions(+) create mode 100644 OpenAPI/TS28532_ProvMnS.yaml diff --git a/OpenAPI/TS28532_ProvMnS.yaml b/OpenAPI/TS28532_ProvMnS.yaml new file mode 100644 index 0000000..116dfc4 --- /dev/null +++ b/OpenAPI/TS28532_ProvMnS.yaml @@ -0,0 +1,571 @@ +openapi: 3.0.1 +info: + title: Provisioning MnS + version: 18.3.0 + description: >- + OAS 3.0.1 definition of the Provisioning MnS + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.532; Generic management services + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ +servers: + - url: '{MnSRoot}/ProvMnS/{MnSVersion}/{URI-LDN-first-part}' + variables: + MnSRoot: + description: See clause 4.4.2 of TS 32.158 + default: http://example.com/3GPPManagement + MnSVersion: + description: Version number of the OpenAPI definition + default: XXX + URI-LDN-first-part: + description: See clause 4.4.2 of TS 32.158 + default: '' +paths: + '/{className}={id}': + parameters: + - name: className + in: path + required: true + schema: + type: string + - name: id + in: path + required: true + schema: + type: string + put: + summary: Replaces a complete single resource or creates it if it does not exist + description: >- + With HTTP PUT a complete resource is replaced or created if it does not + exist. The target resource is identified by the target URI. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Resource' + responses: + '200': + description: >- + Success case ("200 OK"). + This status code shall be returned when the resource is replaced, and + when the replaced resource representation is not identical to the resource + representation in the request. + This status code may be returned when the resource is updated and when the + updated resource representation is identical to the resource representation + in the request. + The representation of the updated resource is returned in the response + message body. + content: + application/json: + schema: + $ref: '#/components/schemas/Resource' + '201': + description: >- + Success case ("201 Created"). + This status code shall be returned when the resource is created. + The representation of the created resource is returned in the response + message body. + content: + application/json: + schema: + $ref: '#/components/schemas/Resource' + '204': + description: >- + Success case ("204 No Content"). + This status code may be returned only when the replaced resource + representation is identical to the representation in the request. + The response has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseDefault' + callbacks: + notifyMOICreation: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyMoiCreation' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + notifyMOIDeletion: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyMoiDeletion' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + notifyMOIAttributeValueChanges: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyMoiAttributeValueChanges' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + notifyEvent: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyEvent' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + notifyMOIChanges: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyMoiChanges' + application/yang-data+json: + schema: + $ref: '#/components/schemas/NotifyMoiChanges' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + get: + summary: Reads one or multiple resources + description: >- + With HTTP GET resources are read. The resources to be retrieved are + identified with the target URI. The attributes and fields parameter + of the query components allow to select the resource properties to be returned. + parameters: + - name: scope + in: query + description: >- + This parameter extends the set of targeted resources beyond the base + resource identified with the path component of the URI. No scoping + mechanism is specified in the present document. + required: false + schema: + $ref: '#/components/schemas/Scope' + style: form + explode: true + - name: filter + in: query + description: >- + This parameter reduces the targeted set of resources by applying a + filter to the scoped set of resource representations. Only resource + representations for which the filter construct evaluates to "true" + are targeted. + required: false + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' + - name: attributes + in: query + description: >- + This parameter specifies the attributes of the scoped resources that + are returned. + required: false + schema: + type: array + items: + type: string + style: form + explode: false + - name: fields + in: query + description: >- + This parameter specifies the attribute field of the scoped resources + that are returned. + required: false + schema: + type: array + items: + type: string + style: form + explode: false + - name: dataNodeSelector + in: query + description: >- + This parameter contains an expression allowing to conditionally + select data nodes. + required: false + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' + responses: + '200': + description: >- + Success case ("200 OK"). + The resources identified in the request for retrieval are returned + in the response message body. In case the attributes or fields query + parameters are used, only the selected attributes or sub-attributes are + returned. The response message body is constructed according to the + hierarchical response construction method (TS 32.158 [15]). + content: + application/json: + schema: + $ref: '#/components/schemas/Resource' + application/vnd.3gpp.object-tree-hierarchical+json: + schema: + $ref: '#/components/schemas/Resource' + application/vnd.3gpp.object-tree-flat+json: + schema: + type: array + items: + $ref: '#/components/schemas/Resource' + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseGet' + patch: + summary: Patches one or multiple resources + description: >- + With HTTP PATCH resources are created, updated or deleted. The resources + to be modified are identified with the target URI (base resource) and + the patch document included in the request message body. + requestBody: + description: >- + The request body describes changes to be made to the target resources. + The following patch media types are available + - "application/merge-patch+json" (RFC 7396) + - "application/3gpp-merge-patch+json" (TS 32.158) + - "application/json-patch+json" (RFC 6902) + - "application/3gpp-json-patch+json" (TS 32.158) + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/Resource' + application/3gpp-merge-patch+json: + schema: + $ref: '#/components/schemas/Resource' + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/PatchItem' + application/3gpp-json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/PatchItem' + responses: + '200': + description: >- + Success case ("200 OK"). + This status code is returned when the updated the resource representations + shall be returned for some reason. + The resource representations are returned in the response message body. The + response message body is constructed according to the hierarchical response + construction method (TS 32.158 [15]) + content: + application/json: + schema: + $ref: '#/components/schemas/Resource' + '204': + description: >- + Success case ("204 No Content"). + This status code is returned when there is no need to return the updated + resource representations. + The response message body is empty. + default: + description: Error case. + content: + application/json: + schema: + oneOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseDefault' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponsePatch' + delete: + summary: Deletes one resource + description: >- + With HTTP DELETE one resource is deleted. The resources to be deleted is + identified with the target URI. + responses: + '200': + description: >- + Success case ("200 OK"). + This status code is returned, when the resource has been successfully deleted. + The response body is empty. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseDefault' +components: + schemas: + CmNotificationTypes: + type: string + enum: + - notifyMOICreation + - notifyMOIDeletion + - notifyMOIAttributeValueChanges + - notifyEvent + - notifyMOIChanges + SourceIndicator: + type: string + enum: + - RESOURCE_OPERATION + - MANAGEMENT_OPERATION + - SON_OPERATION + - UNKNOWN + ScopeType: + type: string + enum: + - BASE_ONLY + - BASE_NTH_LEVEL + - BASE_SUBTREE + - BASE_ALL + Operation: + type: string + enum: + - add + - remove + - replace + Insert: + type: string + enum: + - before + - after + PatchOperation: + type: string + enum: + - add + - replace + - remove + - copy + - move + - test + + Resource: + oneOf: + - type: object + properties: + id: + type: string + objectClass: + type: string + objectInstance: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + attributes: + type: object + additionalProperties: + type: array + items: + type: object + required: + - id + - anyOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/resources-genericNrm' + - $ref: 'TS28541_NrNrm.yaml#/components/schemas/resources-nrNrm' + - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/resources-5gcNrm' + - $ref: 'TS28541_SliceNrm.yaml#/components/schemas/resources-sliceNrm' + - $ref: 'TS28536_CoslaNrm.yaml#/components/schemas/resources-coslaNrm' + - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/resources-intentNrm' + - $ref: 'TS28104_MdaNrm.yaml#/components/schemas/resources-mdaNrm' + - $ref: 'TS28105_AiMlNrm.yaml#/components/schemas/resources-AiMlNrm' + - $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/resources-edgeNrm' + - $ref: 'TS28317_RanScNrm.yaml#/components/schemas/resources-RanScNrm' + - $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/resources-fileMgmtNrm' + - $ref: 'TS28623_ManagementDataCollectionNrm.yaml#/components/schemas/resources-mgmtDataCollectionNrm' + - $ref: 'TS28623_MnSRegistryNrm.yaml#/components/schemas/resources-mnSRegistryNrm' + - $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/resources-pmControlNrm' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/resources-faultNrm' + - $ref: 'TS28623_QoEMeasurementCollectionNrm.yaml#/components/schemas/resources-qoEMeasuremetCollectionNrm' + - $ref: 'TS28623_SubscriptionControlNrm.yaml#/components/schemas/resources-subscriptionControlNrm' + - $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/resources-thresholdMonitorNrm' + - $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/resources-traceControlNrm' + - $ref: 'TS28319_MsacNrm.yaml#/components/schemas/resources-msacNrm' + - $ref: 'TS28318_DsoNrm.yaml#/components/schemas/resources-DSORecovery' + Scope: + type: object + properties: + scopeType: + $ref: '#/components/schemas/ScopeType' + scopeLevel: + type: integer + CorrelatedNotification: + type: object + properties: + source: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + notificationIds: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationId' + required: + - source + - notificationIds + MoiChange: + type: object + properties: + notificationId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationId' + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/CorrelatedNotification' + additionalText: + type: string + sourceIndicator: + $ref: '#/components/schemas/SourceIndicator' + op: + $ref: '#/components/schemas/Operation' + path: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + insert: + $ref: '#/components/schemas/Insert' + value: {} + oldValue: {} + required: + - notificationId + - op + - path + NotifyMoiCreation: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + properties: + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/CorrelatedNotification' + additionalText: + type: string + sourceIndicator: + $ref: '#/components/schemas/SourceIndicator' + attributeList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + NotifyMoiDeletion: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + properties: + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/CorrelatedNotification' + additionalText: + type: string + sourceIndicator: + $ref: '#/components/schemas/SourceIndicator' + attributeList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + NotifyMoiAttributeValueChanges: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + properties: + correlatedNotifications: + type: array + items: + $ref: '#/components/schemas/CorrelatedNotification' + additionalText: + type: string + sourceIndicator: + $ref: '#/components/schemas/SourceIndicator' + attributeListValueChanges: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' + required: + - attributeListValueChanges + NotifyEvent: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - specificProblem + properties: + specificProblem: + $ref: 'TS28111_FaultNrm.yaml#/components/schemas/SpecificProblem' + additionalText: + type: string + additionalInformation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + NotifyMoiChanges: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + properties: + moiChanges: + type: array + items: + $ref: '#/components/schemas/MoiChange' + required: + - moiChanges + PatchItem: + type: object + properties: + op: + $ref: '#/components/schemas/PatchOperation' + from: + type: string + path: + type: string + value: + nullable: true + required: + - op + - path -- GitLab From 28bfe6e1f88f75be570e777c93ad9cf5c06596fb Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 06:36:53 +0000 Subject: [PATCH 22/33] Upload the YAML for cross reference compile --- OpenAPI/TS29519_Policy_Data.yaml | 3403 ++++++++++++++++++++++++++++++ 1 file changed, 3403 insertions(+) create mode 100644 OpenAPI/TS29519_Policy_Data.yaml diff --git a/OpenAPI/TS29519_Policy_Data.yaml b/OpenAPI/TS29519_Policy_Data.yaml new file mode 100644 index 0000000..ec3df65 --- /dev/null +++ b/OpenAPI/TS29519_Policy_Data.yaml @@ -0,0 +1,3403 @@ +openapi: 3.0.0 + +info: + version: '-' + title: Unified Data Repository Service API file for policy data + description: | + The API version is defined in 3GPP TS 29.504 + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.519 V18.7.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, + Application Data and Structured Data for Exposure. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.519/' + +paths: + /policy-data/ues/{ueId}: + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + get: + summary: Retrieve the policy data for a subscriber + operationId: ReadPolicyData + tags: + - PolicyDataForIndividualUe (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: data-subset-names + in: query + style: form + explode: false + description: List of policy data subset names + required: false + schema: + type: array + items: + $ref: '#/components/schemas/PolicyDataSubset' + minItems: 2 + responses: + '200': + description: Upon success, a response body containing policy data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataForIndividualUe' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /policy-data/ues/{ueId}/am-data: + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + get: + summary: Retrieves the access and mobility policy data for a subscriber + operationId: ReadAccessAndMobilityPolicyData + tags: + - AccessAndMobilityPolicyData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:am-data:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + Upon success, a response body containing access and mobility policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AmPolicyData' + '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' + patch: + summary: Modify the access and mobility policy data for a subscriber. + operationId: UpdateAccessAndMobilityPolicyData + tags: + - AccessAndMobilityPolicyData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:am-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AmPolicyDataPatch' + responses: + '200': + description: > + Upon success, a response body containing access and mobility policies is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AmPolicyData' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content is + to be sent in the response message. + '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' + + /policy-data/ues/{ueId}/ue-policy-set: + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + get: + summary: Retrieves the UE policy set data for a subscriber + operationId: ReadUEPolicySet + tags: + - UEPolicySet (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:ue-policy-set:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Upon success, a response body containing UE policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + '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' + put: + summary: Create or modify the UE policy set data for a subscriber + operationId: CreateOrReplaceUEPolicySet + tags: + - UEPolicySet (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:ue-policy-set:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + responses: + '201': + description: > + Successful case. The resource has been successfully created and a response body + containing a representation of the created UEPolicySet resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '200': + description: > + Successful case. The resource has been successfully created and a response body + containing UE policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content + is to be sent in the response message. + '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' + patch: + summary: Modify the UE policy set data for a subscriber + operationId: UpdateUEPolicySet + tags: + - UEPolicySet (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:ue-policy-set:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/UePolicySetPatch' + responses: + '204': + description: > + Successful case. The resource has been successfully updated and no additional content is + to be sent in the response message. + '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' + + /policy-data/ues/{ueId}/sm-data: + get: + summary: Retrieves the session management policy data for a subscriber + operationId: ReadSessionManagementPolicyData + tags: + - SessionManagementPolicyData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:sm-data:read + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: snssai + in: query + required: false + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + - name: multi-pdu-sess-info + in: query + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + minItems: 2 + - name: dnn + in: query + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Upon success, a response body containing SmPolicyData shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyData' + '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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' + patch: + summary: Modify the session management policy data for a subscriber + operationId: UpdateSessionManagementPolicyData + tags: + - SessionManagementPolicyData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:sm-data:modify + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SmPolicyDataPatch' + responses: + '204': + description: > + Successful case. The resource has been successfully updated and no + additional content is to be sent in the response message. + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyData' + '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' + + /policy-data/ues/{ueId}/sm-data/{usageMonId}: + get: + summary: Retrieve a usage monitoring resource + operationId: ReadUsageMonitoringInformation + tags: + - UsageMonitoringInformation (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:sm-data:read + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: usageMonId + in: path + required: true + schema: + type: string + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Successful case. The usage monitoring data is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UsageMonData' + '204': + description: The resource was found but no usage monitoring data is available. + '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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' + put: + summary: Create a usage monitoring resource + operationId: CreateUsageMonitoringResource + tags: + - UsageMonitoringInformation (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:sm-data:create + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: usageMonId + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UsageMonData' + responses: + '201': + description: > + Successful case. The resource has been successfully created and a response body is + returned containing a representation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/UsageMonData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + 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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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: + summary: Delete a usage monitoring resource + operationId: DeleteUsageMonitoringInformation + tags: + - UsageMonitoringInformation (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:sm-data:modify + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: usageMonId + in: path + required: true + schema: + type: string + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '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' + + /policy-data/sponsor-connectivity-data/{sponsorId}: + parameters: + - name: sponsorId + in: path + required: true + schema: + type: string + get: + summary: Retrieves the sponsored connectivity information for a given sponsorId + operationId: ReadSponsorConnectivityData + tags: + - SponsorConnectivityData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:sponsor-connectivity-data:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + Upon success, a response body containing Sponsor Connectivity Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SponsorConnectivityData' + '204': + description: The resource was found but no Sponsor Connectivity Data is available. + '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' + + /policy-data/bdt-data: + get: + summary: Retrieves the BDT data collection + operationId: ReadBdtData + tags: + - BdtData (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdt-data:read + parameters: + - name: bdt-ref-ids + in: query + description: List of the BDT reference identifiers. + required: false + schema: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + minItems: 1 + style: form + explode: false + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Upon success, a response body containing the BDT data shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BdtData' + '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' + + /policy-data/bdt-data/{bdtReferenceId}: + parameters: + - name: bdtReferenceId + in: path + required: true + schema: + type: string + get: + summary: Retrieves the BDT data information associated with a BDT reference Id + operationId: ReadIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdt-data:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Upon success, a response body containing the BDT data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + '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' + put: + summary: Creates an BDT data resource associated with an BDT reference Id + operationId: CreateIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdt-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + responses: + '201': + description: Successful case. The resource has been successfully created. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + 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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' + patch: + summary: Modifies an BDT data resource associated with an BDT reference Id + operationId: UpdateIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdt-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/BdtDataPatch' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content + is to be sent in the response message. + '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: + summary: Deletes an BDT data resource associated with an BDT reference Id + operationId: DeleteIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdt-data:modify + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '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' + + /policy-data/subs-to-notify: + get: + summary: Retrieves the list of Individual Policy Data Subscription resources + operationId: ReadPolicyDataSubscriptions + tags: + - PolicyDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:subs-to-notify:read + parameters: + - name: mon-resources + in: query + style: form + explode: false + description: List of monitored resources whose subscriptions are requested. + required: false + schema: + type: array + items: + type: string + description: Contains the apiSpecificResourceUriPart of the resource URI. + minItems: 1 + - name: ue-id + in: query + description: Represents the Subscription Identifier SUPI or GPSI. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + Upon success, a response body containing a list of Individual Policy Data + Subscription resources shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PolicyDataSubscription' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + post: + summary: Create a subscription to receive notification of policy data changes + operationId: CreateIndividualPolicyDataSubscription + tags: + - PolicyDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:subs-to-notify:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + responses: + '201': + description: > + Upon success, a response body containing a representation of each Individual + subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource' + 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: + policyDataChangeNotification: + '{$request.body#/notificationUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PolicyDataChangeNotification' + minItems: 1 + responses: + '204': + description: No Content, Notification was successful + '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' + + /policy-data/subs-to-notify/{subsId}: + parameters: + - name: subsId + in: path + required: true + schema: + type: string + get: + summary: Retrieves Individual Policy Subscription data + operationId: ReadIndividualPolicySubscriptionData + tags: + - IndividualPolicySubscriptionData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:subs-to-notify:read + responses: + '200': + description: > + Upon success, a response body containing Policy Data Subscription shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + '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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' + put: + summary: Modify a subscription to receive notification of policy data changes + operationId: ReplaceIndividualPolicyDataSubscription + tags: + - IndividualPolicyDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:subs-to-notify:modify + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + responses: + '200': + description: The individual subscription resource was updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + '204': + description: > + The individual subscription resource was updated successfully and no + additional content is to be sent in the response message. + '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: + summary: Delete the individual Policy Data subscription + operationId: DeleteIndividualPolicyDataSubscription + tags: + - IndividualPolicyDataSubscription (Document) + responses: + '204': + description: Upon success, an empty response body shall be returned. + '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' + + /policy-data/ues/{ueId}/operator-specific-data: + get: + summary: Retrieve the operator specific policy data of an UE + operationId: ReadOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:read + parameters: + - name: ueId + in: path + description: UE Id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + '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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' + + patch: + summary: Modify the operator specific policy data of a UE + operationId: UpdateOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:modify + parameters: + - name: ueId + in: path + description: UE Id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: No content. Response to successful modification. + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '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' + put: + summary: Create or modify the operator specific policy data of a UE + operationId: ReplaceOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:create + parameters: + - name: ueId + in: path + description: UE Id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + '201': + description: > + Successful case. When the feature OSDResource_Create_Delete is supported + and the resource has been successfully created, a response body containing a + representation of the created OperatorSpecificData resource shall be returned. + content: + application/json: + schema: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '204': + description: The resource has been successfully updated. + '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: + summary: When the feature OSDResource_Create_Delete is supported, delete OperatorSpecificData resource + operationId: DeleteOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:modify + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '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' + + /policy-data/plmns/{plmnId}/ue-policy-set: + parameters: + - name: plmnId + in: path + required: true + schema: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/VarPlmnId' + get: + summary: Retrieve the UE policy set data for an H-PLMN + operationId: ReadPlmnUePolicySet + tags: + - PlmnUePolicySet (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:plmns:ue-policy-set:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Upon success, a response body containing UE policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + '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' + '412': + $ref: 'TS29571_CommonData.yaml#/components/responses/412' + '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' + + /policy-data/slice-control-data/{snssai}: + parameters: + - name: snssai + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + get: + summary: Retrieves a network Slice specific policy control data resource + operationId: ReadSlicePolicyControlData + tags: + - SlicePolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:slice-control-data:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + Successful case. The network slice specific policy control data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SlicePolicyData' + '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' + patch: + summary: Modify a network Slice specific policy control data resource + operationId: UpdateSlicePolicyControlData + tags: + - SlicePolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:slice-control-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SlicePolicyDataPatch' + responses: + '200': + description: > + The resource has been successfully updated and a response body containing network + slice specific policy control data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SlicePolicyData' + '204': + description: > + The resource has been successfully updated and no additional content is + to be sent in the response message. + '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' + + /policy-data/mbs-session-pol-data/{polSessionId}: + parameters: + - name: polSessionId + description: > + Represents the identifier of the MBS Session Policy Control Data. + in: path + required: true + schema: + $ref: '#/components/schemas/MbsSessPolDataId' + + get: + summary: Retrieve MBS Session Policy Control Data for an MBS Session. + operationId: GetMBSSessPolCtrlData + tags: + - MBSSessionPolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:mbs-session-pol-data:read + responses: + '200': + description: > + OK. The requested MBS Session Policy Control Data is successfully returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsSessPolCtrlData' + '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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' + + /policy-data/pdtq-data: + get: + summary: Retrieves the PDTQ data collection + operationId: ReadPdtqData + tags: + - PdtqData (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdtq-data:read + parameters: + - name: pdtq-ref-ids + in: query + description: List of the PDTQ reference identifiers. + required: false + schema: + type: array + items: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqReferenceId' + minItems: 1 + style: form + explode: false + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Upon success, a response body containing the PDTQ data shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PdtqData' + '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' + + /policy-data/pdtq-data/{pdtqReferenceId}: + parameters: + - name: pdtqReferenceId + in: path + required: true + schema: + type: string + get: + summary: Retrieves the PDTQ data information associated with a PDTQ reference Id + operationId: ReadIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdtq-data:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Upon success, a response body containing the PDTQ data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' + '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' + put: + summary: Creates a PDTQ data resource associated with a PDTQ reference Id + operationId: CreateIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdtq-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' + responses: + '201': + description: Successful case. The resource has been successfully created. + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + 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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' + patch: + summary: Modifies a PDTQ data resource associated with a PDTQ reference Id + operationId: UpdateIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdtq-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PdtqDataPatch' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content + is to be sent in the response message. + '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: + summary: Deletes a PDTQ data resource associated with a PDTQ reference Id + operationId: DeleteIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdtq-data:modify + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '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' + + /policy-data/group-control-data/{intGroupId}: + parameters: + - name: intGroupId + in: path + required: true + description: > + Represents the identifier of the internal group of subscriber(s). + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + + get: + summary: Retrieves group specific policy control data. + operationId: ReadGroupPolCtrlData + tags: + - GroupPolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:group-control-data:read + parameters: + - name: supp-feat + in: query + description: Represents the supported features. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + Successful case. The requested group specific policy control data for the + targeted 5G VN group shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupPolicyData' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: Modify existing group specific policy control data. + operationId: ModifyGroupPolCtrlData + tags: + - GroupPolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:group-control-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/GroupPolicyDataPatch' + responses: + '200': + description: > + The resource is successfully modified and a representation of the updated resource + (i.e., updated group specific policy control data) is returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupPolicyData' + '204': + description: > + The resource is successfully modified and no content is returned in the response body. + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + schemas: + + PolicyDataForIndividualUe: + description: Contains policy data for a given subscriber. + type: object + properties: + uePolicyDataSet: + $ref: '#/components/schemas/UePolicySet' + smPolicyDataSet: + $ref: '#/components/schemas/SmPolicyData' + amPolicyDataSet: + $ref: '#/components/schemas/AmPolicyData' + umData: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonData' + minProperties: 1 + description: > + Contains UM policies. The value of the limit identifier is used as the key of the map. + operatorSpecificDataSet: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + minProperties: 1 + description: > + Contains Operator Specific Data resource data. The key of the map is operator + specific data element name and the value is the operator specific data of the UE. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + AmPolicyData: + description: Contains the AM policy data for a given subscriber. + type: object + properties: + praInfos: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Contains Presence reporting area information. The praId attribute within the + PresenceInfo data type is the key of the map. + subscCats: + type: array + items: + type: string + minItems: 1 + chfInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ChargingInformation' + subscSpendingLimits: + type: boolean + description: > + Indicates whether the PCF must enforce Access and Mobility management related + policies based on subscriber spending limits. + spendLimInfo: + type: object + additionalProperties: + $ref: 'TS29594_Nchf_SpendingLimitControl.yaml#/components/schemas/PolicyCounterInfo' + minProperties: 1 + description: > + Contains the status of the requested policy counters for UE. + The key of the map is the attribute policyCounterId. + restriStatus: + type: array + items: + $ref: '#/components/schemas/RestrictedStatus' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + AmPolicyDataPatch: + description: Contains the modifiable AM policy data for a given subscriber. + type: object + properties: + restriStatus: + type: array + items: + $ref: '#/components/schemas/RestrictedStatus' + minItems: 1 + description: > + List of restricted status that contains the reason for the status and the time + stamp of when the status was stored. + spendLimInfo: + type: object + additionalProperties: + $ref: '#/components/schemas/PolicyCounterInfoRm' + minProperties: 1 + description: > + Contains the status of the requested policy counters for UE. + The key of the map is the attribute policyCounterId. + + UePolicySet: + description: Contains the UE policy data for a given subscriber. + type: object + properties: + praInfos: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Contains Presence reporting area information. The praId attribute within the + PresenceInfo data type is the key of the map. + subscCats: + type: array + items: + type: string + minItems: 1 + uePolicySections: + type: object + additionalProperties: + $ref: '#/components/schemas/UePolicySection' + minProperties: 1 + description: > + Contains the UE Policy Sections. The UE Policy Section Identifier is used as + the key of the map. + upsis: + type: array + items: + $ref: '#/components/schemas/Upsi' + minItems: 1 + allowedRouteSelDescs: + type: object + additionalProperties: + $ref: '#/components/schemas/PlmnRouteSelectionDescriptor' + minProperties: 1 + description: > + Contains allowed route selection descriptors per serving PLMN for a UE. + The serving PLMN identifier is the key of the map. + andspInd: + type: boolean + epsUrspInd: + type: boolean + description: Indication of UE supporting URSP provisioning in EPS. + vpsUrspInd: + type: boolean + description: Indication of UE supporting VPLMN-specific URSP. + urspEnfInd: + type: boolean + description: Indication of UE supporting URSP enforcement report. + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + osIds: + type: array + items: + $ref: '#/components/schemas/OsId' + minItems: 1 + chfInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ChargingInformation' + subscSpendingLimits: + type: boolean + description: > + Indicates whether the PCF must enforce UE policies based on subscriber spending limits. + spendLimInfo: + type: object + additionalProperties: + $ref: 'TS29594_Nchf_SpendingLimitControl.yaml#/components/schemas/PolicyCounterInfo' + minProperties: 1 + description: > + Contains the status of the requested policy counters for UE. + The key of the map is the attribute policyCounterId. + tracingReq: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + resetIds: + type: array + items: + type: string + minItems: 1 + restriStatus: + type: array + items: + $ref: '#/components/schemas/RestrictedStatus' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + UePolicySetPatch: + description: Contains the UE policy set for a given subscriber. + type: object + properties: + uePolicySections: + type: object + additionalProperties: + $ref: '#/components/schemas/UePolicySection' + minProperties: 1 + description: > + Contains the UE Policy Sections. The UE Policy Section Identifier is used + as the key of the map. + upsis: + type: array + items: + $ref: '#/components/schemas/Upsi' + minItems: 1 + andspInd: + type: boolean + epsUrspInd: + type: boolean + description: Indication of UE supporting URSP provisioning in EPS. + vpsUrspInd: + type: boolean + description: Indication of UE supporting VPLMN-specific URSP. + urspEnfInd: + type: boolean + description: Indication of UE supporting URSP enforcement report. + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + osIds: + type: array + items: + $ref: '#/components/schemas/OsId' + minItems: 1 + restriStatus: + type: array + items: + $ref: '#/components/schemas/RestrictedStatus' + minItems: 1 + spendLimInfo: + type: object + nullable: true + additionalProperties: + $ref: '#/components/schemas/PolicyCounterInfoRm' + minProperties: 1 + description: > + Contains the updated status of the requested policy counters for UE. + The key of the map is the attribute policyCounterId. + + UePolicySection: + description: Contains the UE policy section. + type: object + properties: + uePolicySectionInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + upsi: + $ref: '#/components/schemas/Upsi' + required: + - uePolicySectionInfo + - upsi + + SmPolicyData: + description: Contains the SM policy data for a given subscriber. + type: object + properties: + smPolicySnssaiData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicySnssaiData' + minProperties: 1 + description: > + Contains Session Management Policy data per S-NSSAI for all the SNSSAIs + of the subscriber. The key of the map is the S-NSSAI. + umDataLimits: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonDataLimit' + minProperties: 1 + description: > + Contains a list of usage monitoring profiles associated with the subscriber. + The limit identifier is used as the key of the map. + umData: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonData' + minProperties: 1 + description: > + Contains the remaining allowed usage data associated with the subscriber. + The limit identifier is used as the key of the map. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - smPolicySnssaiData + + SmPolicySnssaiData: + description: Contains the SM policy data for a given subscriber and S-NSSAI. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + smPolicyDnnData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicyDnnData' + minProperties: 1 + description: > + Session Management Policy data per DNN for all the DNNs of the indicated S-NSSAI. + The key of the map is the DNN. + ueSliceMbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbr' + required: + - snssai + + SmPolicyDnnData: + description: Contains the SM policy data for a given DNN (and S-NSSAI). + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + allowedServices: + type: array + items: + type: string + minItems: 1 + subscCats: + type: array + items: + type: string + minItems: 1 + gbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + adcSupport: + type: boolean + subscSpendingLimits: + type: boolean + description: > + Indicates whether the PCF must enforce session management related policies based + on subscriber spending limits. + spendLimInfo: + type: object + additionalProperties: + $ref: 'TS29594_Nchf_SpendingLimitControl.yaml#/components/schemas/PolicyCounterInfo' + minProperties: 1 + description: > + Contains the status of the requested policy counters for the PDU session. + The key of the map is the attribute policyCounterId. + ipv4Index: + $ref: '#/components/schemas/IpIndex' + ipv6Index: + $ref: '#/components/schemas/IpIndex' + offline: + type: boolean + online: + type: boolean + chfInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ChargingInformation' + refUmDataLimitIds: + type: object + additionalProperties: + $ref: '#/components/schemas/LimitIdToMonitoringKey' + minProperties: 1 + description: > + A reference to the UsageMonDataLimit or UsageMonData instances for this DNN and SNSSAI + that may also include the related monitoring key(s). + The key of the map is the limit identifier. + mpsPriority: + type: boolean + mcsPriority: + type: boolean + imsSignallingPrio: + type: boolean + mpsPriorityLevel: + type: integer + mcsPriorityLevel: + type: integer + praInfos: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Contains Presence reporting area information. The praId attribute within the + PresenceInfo data type is the key of the map. + bdtRefIds: + type: object + additionalProperties: + $ref: '#/components/schemas/BdtReferenceIdRm' + minProperties: 1 + description: > + Identifies transfer policies of background data transfer. Any string value can + be used as a key of the map. + nullable: true + locRoutNotAllowed: + type: boolean + sfcNotAllowed: + type: boolean + tnaps: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TnapId' + minItems: 1 + description: Contains the TNAP IDs collocated with the 5G-RG(s) of a specific user. + restriStatus: + type: array + items: + $ref: '#/components/schemas/RestrictedStatus' + minItems: 1 + required: + - dnn + + UsageMonDataLimit: + description: Contains usage monitoring control data for a subscriber. + type: object + properties: + limitId: + type: string + scopes: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonDataScope' + minProperties: 1 + description: > + Identifies the SNSSAI and DNN combinations to which the usage monitoring data + limit applies. The S-NSSAI is the key of the map. + umLevel: + $ref: '#/components/schemas/UsageMonLevel' + startDate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endDate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + usageLimit: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + resetPeriod: + $ref: '#/components/schemas/TimePeriod' + required: + - limitId + + UsageMonData: + description: Contains remain allowed usage data for a subscriber. + type: object + properties: + limitId: + type: string + scopes: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonDataScope' + minProperties: 1 + description: > + Identifies the SNSSAI and DNN combinations for remain allowed usage data + for a subscriber. The S-NSSAI is the key of the map. + umLevel: + $ref: '#/components/schemas/UsageMonLevel' + allowedUsage: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + resetTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + required: + - limitId + + LimitIdToMonitoringKey: + description: > + Contains the limit identifier and the corresponding monitoring key for a given + S-NSSAI and DNN. + type: object + properties: + limitId: + type: string + monkey: + type: array + items: + type: string + minItems: 1 + required: + - limitId + nullable: true + + UsageMonDataScope: + description: > + Contains a SNSSAI and DNN combinations to which the UsageMonData instance belongs to. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + required: + - snssai + + TimePeriod: + description: Contains the periodicity for the defined usage monitoring data limits. + type: object + properties: + period: + $ref: '#/components/schemas/Periodicity' + maxNumPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + required: + - period + + SponsorConnectivityData: + description: > + Contains the sponsored data connectivity related information for a sponsor identifier. + type: object + properties: + aspIds: + type: array + items: + type: string + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - aspIds + + BdtData: + description: Contains the background data transfer data. + type: object + properties: + aspId: + type: string + transPolicy: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/TransferPolicy' + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + numOfUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + volPerUe: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + trafficDes: + $ref: 'TS29122_ResourceManagementOfBdt.yaml#/components/schemas/TrafficDescriptor' + bdtpStatus: + $ref: '#/components/schemas/BdtPolicyStatus' + warnNotifEnabled: + type: boolean + description: > + Indicates whether the BDT warning notification is enabled (true) or not (false). + Default value is false. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + required: + - aspId + - transPolicy + + PolicyDataSubscription: + description: Identifies a subscription to policy data change notification. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifId: + type: string + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monResItems: + type: array + items: + $ref: '#/components/schemas/ResourceItem' + minItems: 1 + excludedResItems: + type: array + items: + $ref: '#/components/schemas/ResourceItem' + minItems: 1 + immRep: + type: boolean + description: > + If provided and set to true, it indicates that existing entries that + match this subscription shall be immediately reported in the response. + immReports: + type: array + items: + $ref: '#/components/schemas/PolicyDataChangeNotification' + minItems: 1 + description: Immediate report with existing UDR entries. + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + subsId: + type: string + required: + - notificationUri + - monitoredResourceUris + + PolicyDataChangeNotification: + description: Contains changed policy data for which notification was requested. + type: object + properties: + amPolicyData: + $ref: '#/components/schemas/AmPolicyData' + uePolicySet: + $ref: '#/components/schemas/UePolicySet' + plmnUePolicySet: + $ref: '#/components/schemas/UePolicySet' + smPolicyData: + $ref: '#/components/schemas/SmPolicyData' + usageMonData: + $ref: '#/components/schemas/UsageMonData' + SponsorConnectivityData: + $ref: '#/components/schemas/SponsorConnectivityData' + bdtData: + $ref: '#/components/schemas/BdtData' + opSpecData: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + opSpecDataMap: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + minProperties: 1 + description: > + Operator Specific Data resource data, if changed and notification was requested. + The key of the map is operator specific data element name and the value is the + operator specific data of the UE. + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + sponsorId: + type: string + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + usageMonId: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + delResources: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + notifId: + type: string + reportedFragments: + type: array + items: + $ref: '#/components/schemas/NotificationItem' + minItems: 1 + slicePolicyData: + $ref: '#/components/schemas/SlicePolicyData' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + pdtqData: + $ref: '#/components/schemas/PdtqData' + pdtqRefId: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqReferenceId' + groupPolicyData: + $ref: '#/components/schemas/GroupPolicyData' + intGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + + PlmnRouteSelectionDescriptor: + description: > + Contains the route selection descriptors (combinations of SNSSAI, DNNs, PDU session types, + SSC modes and ATSSS information) allowed by subscription to the UE for a serving PLMN + type: object + properties: + servingPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + snssaiRouteSelDescs: + type: array + items: + $ref: '#/components/schemas/SnssaiRouteSelectionDescriptor' + minItems: 1 + required: + - servingPlmn + + SnssaiRouteSelectionDescriptor: + description: > + Contains the route selector parameters (DNNs, PDU session types, SSC modes and ATSSS + information) per SNSSAI + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnnRouteSelDescs: + type: array + items: + $ref: '#/components/schemas/DnnRouteSelectionDescriptor' + minItems: 1 + required: + - snssai + + DnnRouteSelectionDescriptor: + description: > + Contains the route selector parameters (PDU session types, SSC modes and ATSSS + information) per DNN + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sscModes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' + minItems: 1 + pduSessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + atsssInfo: + description: > + Indicates whether MA PDU session establishment is allowed for this DNN. + When set to value true MA PDU session establishment is allowed for this DNN. + type: boolean + default: false + lboRoamAllowed: + type: boolean + description: > + Indicates whether LBO for the DNN and S-NSSAI is allowed when roaming. + required: + - dnn + + SmPolicyDataPatch: + description: Contains the SM policy data for a given subscriber. + type: object + properties: + umData: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonData' + minProperties: 1 + description: > + Contains the remaining allowed usage data associated with the subscriber. + The value of the limit identifier is used as the key of the map. + nullable: true + smPolicySnssaiData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicySnssaiDataPatch' + minProperties: 1 + description: > + Modifiable Session Management Policy data per S-NSSAI for all the SNSSAIs + of the subscriber. The key of the map is the S-NSSAI. + + SmPolicySnssaiDataPatch: + description: Contains the SM policy data for a given subscriber and S-NSSAI. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + smPolicyDnnData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicyDnnDataPatch' + minProperties: 1 + description: > + Modifiable Session Management Policy data per DNN for all the DNNs of the + indicated S-NSSAI. The key of the map is the DNN. + required: + - snssai + SmPolicyDnnDataPatch: + description: Contains the SM policy data for a given DNN (and S-NSSAI). + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + bdtRefIds: + type: object + additionalProperties: + $ref: '#/components/schemas/BdtReferenceIdRm' + minProperties: 1 + description: > + Contains updated transfer policies of background data transfer. + Any string value can be used as a key of the map. + nullable: true + restriStatus: + type: array + items: + $ref: '#/components/schemas/RestrictedStatus' + minItems: 1 + spendLimInfo: + type: object + nullable: true + additionalProperties: + $ref: '#/components/schemas/PolicyCounterInfoRm' + minProperties: 1 + description: > + Contains the updated status of the requested policy counters for the PDU session. + The key of the map is the attribute policyCounterId. + required: + - dnn + + ResourceItem: + description: > + Identifies a subscription to policy data change notification when the change occurs + in a fragment (subset of resource data) of a given resource. + type: object + properties: + monResourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + items: + type: array + items: + $ref: '#/components/schemas/ItemPath' + minItems: 1 + required: + - monResourceUri + - items + + NotificationItem: + description: > + Identifies a data change notification when the change occurs in a fragment + (subset of resource data) of a given resource. + type: object + properties: + resourceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifItems: + type: array + items: + $ref: '#/components/schemas/UpdatedItem' + minItems: 1 + required: + - resourceId + - notifItems + + UpdatedItem: + description: Identifies a fragment of a resource. + type: object + properties: + item: + $ref: '#/components/schemas/ItemPath' + value: {} + required: + - item + - value + + BdtDataPatch: + description: Contains the modified background data transfer data. + type: object + properties: + transPolicy: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/TransferPolicy' + bdtpStatus: + $ref: '#/components/schemas/BdtPolicyStatus' + warnNotifEnabled: + type: boolean + description: > + Indicates whether the BDT warning notification is enabled (true) or not (false). + + SlicePolicyData: + description: Contains the network slice specific policy control information. + type: object + properties: + mbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + SlicePolicyDataPatch: + description: Contains the modified network slice specific policy control information. + type: object + properties: + remainMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + oneOf: + - required: [remainMbrUl] + - required: [remainMbrDl] + + MbsSessPolCtrlData: + description: Represents MBS Session Policy Control Data. + type: object + properties: + 5qis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + minItems: 1 + maxMbsArpLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ArpPriorityLevel' + maxMbsSessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxGbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + MbsSessPolDataId: + description: Represents the identifier used to access the MBS Session Policy Control Data. + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + afAppId: + type: string + oneOf: + - required: [mbsSessionId] + - required: [afAppId] + + PdtqData: + description: Contains the planned data transfer data with QoS requirements. + type: object + properties: + aspId: + type: string + pdtqPolicy: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqPolicy' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + pdtqRefId: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqReferenceId' + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + numOfUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + desTimeInts: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + minItems: 1 + description: Identifies the time interval(s). + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altQosParamSets: + type: array + items: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/AltQosParamSet' + minItems: 1 + description: > + Contains the alternative QoS requirements as a list of individual QoS parameter + sets in a prioritized order. + altQosRefs: + type: array + items: + type: string + minItems: 1 + description: > + Contains the alternative QoS requirements as the list of QoS references in a + prioritized order. + qosParamSet: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/QosParameterSet' + qosReference: + type: string + description: > + Requested QoS requirements expressed as the QoS Reference which represents + a pre-defined QoS information. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + warnNotifEnabled: + type: boolean + description: > + Indicates whether the PDTQ warning notification is enabled (true) or not (false). + Default value is false. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + oneOf: + - required: [qosParamSet] + - required: [qosReference] + required: + - aspId + - pdtqPolicy + + PdtqDataPatch: + description: Contains the modified planned data transfer data with QoS requirements. + type: object + properties: + pdtqPolicy: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqPolicy' + warnNotifEnabled: + type: boolean + description: > + Indicates whether the PDTQ warning notification is enabled (true) or not (false). + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + + GroupPolicyData: + description: Contains the group specific policy control data information. + type: object + properties: + maxGroupMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxGroupMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainGroupMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainGroupMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + GroupPolicyDataPatch: + description: > + Contains the requested modifications to the group specific policy control data + information. + type: object + properties: + maxGroupMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxGroupMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainGroupMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainGroupMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + anyOf: + - required: [maxGroupMbrUl] + - required: [maxGroupMbrDl] + - required: [remainGroupMbrUl] + - required: [remainGroupMbrDl] + + RestrictedStatus: + description: > + Contains reason for restricted status and the time stamp of when the status was + stored. + type: object + properties: + exceptionId: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ExceptionId' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - exceptionId + - timeStamp + + PolicyCounterInfoRm: + description: Represents the data structure presenting the policy counter status. + nullable: true + type: object + properties: + currentStatus: + type: string + nullable: true + penPolCounterStatuses: + type: array + items: + $ref: 'TS29594_Nchf_SpendingLimitControl.yaml#/components/schemas/PendingPolicyCounterStatus' + minItems: 1 + description: Provides the pending policy counter status. + nullable: true + +# SIMPLE TYPES: + + IpIndex: + description: > + Represents information that identifies which IP pool or external server + is used to allocate the IP address. + type: integer + + OsId: + description: Represents the Operating System of the served UE. + type: string + format: uuid + + ItemPath: + description: Identifies a fragment (subset of resource data) of a given resource. + type: string + + BdtReferenceIdRm: + type: string + description: > + This data type is defined in the same way as the BdtReferenceId data type defined in + 3GPP TS 29.122, but with the nullable property set to true. + nullable: true + + Upsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +# ENUMS: + + UsageMonLevel: + description: Represents the usage monitoring level. + anyOf: + - type: string + enum: + - SESSION_LEVEL + - SERVICE_LEVEL + - 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. + + Periodicity: + description: Represents the time period. + anyOf: + - type: string + enum: + - YEARLY + - MONTHLY + - WEEKLY + - DAILY + - HOURLY + - 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. + + BdtPolicyStatus: + description: Indicates the validation status of a negotiated BDT policy. + anyOf: + - type: string + enum: + - INVALID + - VALID + - 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. + + PolicyDataSubset: + description: Indicates a policy data subset. + anyOf: + - type: string + enum: + - AM_POLICY_DATA + - SM_POLICY_DATA + - UE_POLICY_DATA + - UM_DATA + - OPERATOR_SPECIFIC_DATA + - 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. -- GitLab From 10391546d04a1a3c019b28194ee7a6695f2193fa Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 06:37:05 +0000 Subject: [PATCH 23/33] Upload the YAML for cross reference compile --- OpenAPI/TS29564_Nupf_EventExposure.yaml | 662 ++++++++++++++++++++++++ 1 file changed, 662 insertions(+) create mode 100644 OpenAPI/TS29564_Nupf_EventExposure.yaml diff --git a/OpenAPI/TS29564_Nupf_EventExposure.yaml b/OpenAPI/TS29564_Nupf_EventExposure.yaml new file mode 100644 index 0000000..e574486 --- /dev/null +++ b/OpenAPI/TS29564_Nupf_EventExposure.yaml @@ -0,0 +1,662 @@ +openapi: 3.0.0 + +info: + title: 'UPF Event Exposure Service' + version: 1.1.1 + description: | + UPF Event Exposure Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.564 V18.6.0; 5G System; User Plane Function Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.564/ + +servers: + - url: '{apiRoot}/nupf-ee/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nupf-ee + +paths: + /ee-subscriptions: + post: + summary: Nupf_EventExposure Subscribe service Operation + operationId: CreateSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateEventSubscription' + responses: + '201': + description: Successful creation of an UPF Event Subscription + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nupf-ee//ee-subscriptions/{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedEventSubscription' + '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' + callbacks: + eeNotification: + '{eventNotificationUri}': + # The URI in {eventNotificationUri} is provided via N4 interface during provisioning of Session Reporting Rule or in the Nupf_EventExposure Subscribe request. + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationData' + responses: + '204': + description: No Content, Notification was succesfull + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target NF service consumer' + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target NF service consumer' + 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' + + /ee-subscriptions/{subscriptionId}: + patch: + summary: Nupf_EventExposure Subscribe Modify service Operation + operationId: ModifySubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be modified + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '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: + summary: Nupf_EventExposure UnSubscribe service Operation + operationId: DeleteSubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be deleted + schema: + type: string + responses: + '204': + description: Subsription deleted 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' + '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: + nupf-ee: Access to the Nupf_EventExposure API + + schemas: + # API specific definitions + +# STRUCTURED DATA TYPES + + NotificationData: + description: the list of NotificationItems + type: object + required: + - notificationItems + properties: + notificationItems: + type: array + items: + $ref: '#/components/schemas/NotificationItem' + minItems: 1 + correlationId: + type: string + achievedSampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + + NotificationItem: + description: represents a report on one subscribed event + type: object + required: + - eventType + - timeStamp + anyOf: + - required: [ ueIpv4Addr ] + - required: [ ueIpv6Prefix ] + - required: [ ueMacAddr ] + properties: + eventType: + $ref: '#/components/schemas/EventType' + ueIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + ueMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qosMonitoringMeasurement: + $ref: '#/components/schemas/QosMonitoringMeasurement' + tscMngtInfo: + $ref: '#/components/schemas/TscManagementInfo' + userDataUsageMeasurements: + type: array + items: + $ref: '#/components/schemas/UserDataUsageMeasurements' + minItems: 1 + + + UpfEventSubscription: + description: UPF Event Subscription + type: object + properties: + eventList: + type: array + items: + $ref: '#/components/schemas/UpfEvent' + minItems: 1 + eventNotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrelationId: + type: string + eventReportingMode: + $ref: '#/components/schemas/UpfEventMode' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ueIpAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + anyUe: + type: boolean + default: false + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - eventList + - eventNotifyUri + - notifyCorrelationId + - eventReportingMode + - nfId + + UpfEventMode: + description: UPF Event Mode + type: object + properties: + trigger: + $ref: '#/components/schemas/UpfEventTrigger' + maxReports: + type: integer + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + sampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + partitioningCriteria: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartitioningCriteria' + minItems: 1 + notifFlag: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' + mutingExcInstructions: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' + mutingNotSettings: + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingNotificationsSettings' + required: + - trigger + + UpfEvent: + description: UPF Event + type: object + properties: + type: + $ref: '#/components/schemas/EventType' + immediateFlag: + type: boolean + default: false + measurementTypes: + type: array + items: + $ref: '#/components/schemas/MeasurementType' + minItems: 1 + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + trafficFilters: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' + minItems: 1 + granularityOfMeasurement: + $ref: '#/components/schemas/GranularityOfMeasurement' + reportingSuggestionInfo: + $ref: '#/components/schemas/ReportingSuggestionInformation' + required: + - type + + CreateEventSubscription: + description: Data within UPF Create Event Subscription Request + type: object + properties: + subscription: + $ref: '#/components/schemas/UpfEventSubscription' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - subscription + + CreatedEventSubscription: + description: Data within UPF Create Event Subscription Response + type: object + properties: + subscription: + $ref: '#/components/schemas/UpfEventSubscription' + subscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reportList: + type: array + items: + $ref: '#/components/schemas/NotificationItem' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - subscription + - subscriptionId + + ReportingSuggestionInformation: + description: Reporting Suggestion Information + type: object + properties: + reportingUrgency: + $ref: '#/components/schemas/ReportingUrgency' + reportingTimeInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + required: + - reportingUrgency + + QosMonitoringMeasurement: + description: QoS Monitoring Measurement information + type: object + properties: + dlPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + ulPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + rtrPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + measureFailure: + type: boolean + enum: + - true + dlAveThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulAveThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlCongestion: + type: integer + minimum: 0 + maximum: 10000 + ulCongestion: + type: integer + minimum: 0 + maximum: 10000 + defaultQosFlowInd: + type: boolean + default: false + + + TscManagementInfo: + description: TSC Management Information + type: object + properties: + pmics: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + umic: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' + + UserDataUsageMeasurements: + description: > + User Data Usage Measurements either for the PDU session, or the app-id, or the data flow + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + flowInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' + volumeMeasurement: + $ref: '#/components/schemas/VolumeMeasurement' + throughputMeasurement: + $ref: '#/components/schemas/ThroughputMeasurement' + applicationRelatedInformation: + $ref: '#/components/schemas/ApplicationRelatedInformation' + throughputStatisticsMeasurement: + $ref: '#/components/schemas/ThroughputStatisticsMeasurement' + + VolumeMeasurement: + description: Volume Measurement information + type: object + properties: + totalVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficVolume' + ulVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficVolume' + dlVolume: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficVolume' + totalNbOfPackets: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + ulNbOfPackets: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + dlNbOfPackets: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + + ThroughputMeasurement: + description: Throughput Measurement information + type: object + properties: + ulThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + dlPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + + ApplicationRelatedInformation: + description: Application Related Information + type: object + properties: + urls: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + domainInfoList: + type: array + items: + $ref: '#/components/schemas/DomainInformation' + minItems: 1 + + + ThroughputStatisticsMeasurement: + description: Throughput Statistics Measurement + type: object + properties: + ulAverageThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlAverageThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulPeakThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlPeakThroughPut: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulAveragePacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + dlAveragePacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + ulPeakPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + dlPeakPacketThroughput: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketRate' + + DomainInformation: + description: Domain Information + type: object + properties: + domainName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + domainNameProtocol: + $ref: '#/components/schemas/DnProtocol' + required: + - domainName + + +# ENUMS + + EventType: + description: Event Type + anyOf: + - type: string + enum: + - QOS_MONITORING + - USER_DATA_USAGE_MEASURES + - USER_DATA_USAGE_TRENDS + - TSC_MNGT_INFO + - type: string + + UpfEventTrigger: + description: Upf Event Trigger + anyOf: + - type: string + enum: + - ONE_TIME + - PERIODIC + - type: string + + + MeasurementType: + description: Measurement Type + anyOf: + - type: string + enum: + - VOLUME_MEASUREMENT + - THROUGHPUT_MEASUREMENT + - APPLICATION_RELATED_INFO + - type: string + + GranularityOfMeasurement: + description: Granularity Of Measurement + anyOf: + - type: string + enum: + - PER_APPLICATION + - PER_SESSION + - PER_FLOW + - type: string + + DnProtocol: + description: Domain Name Protocol + anyOf: + - type: string + enum: + - DNS_QNAME + - TLS_SNI + - TLS_SAN + - TLS_SCN + - type: string + + ReportingUrgency: + description: Reporting Urgency + anyOf: + - type: string + enum: + - DELAY_TOLERANT + - NON_DELAY_TOLERANT + - type: string + + +# SIMPLE TYPES -- GitLab From ee215bbcf1f1b3fffe29736826268856c1df88a8 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 06:37:20 +0000 Subject: [PATCH 24/33] Upload the YAML for cross reference compile --- OpenAPI/TS29503_Nudm_SDM.yaml | 6069 +++++++++++++++++++++++++++++++++ 1 file changed, 6069 insertions(+) create mode 100644 OpenAPI/TS29503_Nudm_SDM.yaml diff --git a/OpenAPI/TS29503_Nudm_SDM.yaml b/OpenAPI/TS29503_Nudm_SDM.yaml new file mode 100644 index 0000000..e758ca0 --- /dev/null +++ b/OpenAPI/TS29503_Nudm_SDM.yaml @@ -0,0 +1,6069 @@ +openapi: 3.0.0 + +info: + version: '2.4.0-alpha.1' + title: 'Nudm_SDM' + description: | + Nudm Subscriber Data Management Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.503 Unified Data Management Services, version 19.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' + +servers: + - url: '{apiRoot}/nudm-sdm/v2' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nudm-sdm + - {} + +paths: + /{supi}: + get: + summary: retrieve multiple data sets + operationId: GetDataSets + tags: + - Retrieval of multiple data sets + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:multi-data-sets:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: dataset-names + in: query + style: form + explode: false + description: List of dataset names + required: true + schema: + $ref: '#/components/schemas/DatasetNames' + - name: plmn-id + in: query + description: serving PLMN ID or SNPN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: adjacent-plmns + in: query + description: List of PLMNs adjacent to the UE's serving PLMN + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + - name: single-nssai + in: query + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + - name: dnn + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: uc-purpose + in: query + description: User consent purpose + schema: + $ref: '#/components/schemas/UcPurpose' + - name: disaster-roaming-ind + in: query + description: Indication whether Disaster Roaming service is applied or not + required: false + schema: + type: boolean + default: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionDataSets' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + /{supi}/nssai: + get: + summary: retrieve a UE's subscribed NSSAI + operationId: GetNSSAI + tags: + - Slice Selection Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:nssai:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID or SNPN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: disaster-roaming-ind + in: query + description: Indication whether Disaster Roaming service is applied or not + required: false + schema: + type: boolean + default: false + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/Nssai' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + /{supi}/ue-context-in-amf-data: + get: + summary: retrieve a UE's UE Context In AMF Data + operationId: GetUeCtxInAmfData + tags: + - UE Context In AMF Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:ue-context-in-amf-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextInAmfData' + '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: + description: Unexpected error + /{supi}/am-data: + get: + summary: retrieve a UE's Access and Mobility Subscription Data + operationId: GetAmData + tags: + - Access and Mobility Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:am-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: Serving PLMN ID or SNPN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: adjacent-plmns + in: query + description: List of PLMNs adjacent to the UE's serving PLMN + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + - name: disaster-roaming-ind + in: query + description: Indication whether Disaster Roaming service is applied or not + required: false + schema: + type: boolean + default: false + - name: shared-data-ids + in: query + description: > + List of IDs identifying shared Access and Mobility Subscription Data already + available at the NF service consumer + schema: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + style: form + explode: false + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AccessAndMobilitySubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + /{supi}/am-data/ecr-data: + get: + summary: retrieve a UE's subscribed Enhanced Coverage Restriction Data + operationId: GetEcrData + tags: + - Enhanced Coverage Restriction Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:ecr-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedCoverageRestrictionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '466': + $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: + description: Unexpected error + /{supi}/smf-select-data: + get: + summary: retrieve a UE's SMF Selection Subscription Data + operationId: GetSmfSelData + tags: + - SMF Selection Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:smf-select-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID or SNPN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: disaster-roaming-ind + in: query + description: Indication whether Disaster Roaming service is applied or not + required: false + schema: + type: boolean + default: false + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmfSelectionSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + /{supi}/ue-context-in-smf-data: + get: + summary: retrieve a UE's UE Context In SMF Data + operationId: GetUeCtxInSmfData + tags: + - UE Context In SMF Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:ue-context-in-smf-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextInSmfData' + '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: + description: Unexpected error + /{supi}/ue-context-in-smsf-data: + get: + summary: retrieve a UE's UE Context In SMSF Data + operationId: GetUeCtxInSmsfData + tags: + - UE Context In SMSF Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:ue-context-in-smsf-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextInSmsfData' + '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: + description: Unexpected error + /{supi}/trace-data: + get: + summary: retrieve a UE's Trace Configuration Data + operationId: GetTraceConfigData + tags: + - Trace Configuration Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:trace-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID or SNPN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/TraceDataResponse' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + /{supi}/sm-data: + get: + summary: retrieve a UE's Session Management Subscription Data + operationId: GetSmData + tags: + - Session Management Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sm-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: single-nssai + in: query + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + - name: dnn + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: plmn-id + in: query + description: serving PLMN ID or SNPN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: disaster-roaming-ind + in: query + description: Indication whether Disaster Roaming service is applied or not + required: false + schema: + type: boolean + default: false + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmSubsData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + /{supi}/sms-data: + get: + summary: retrieve a UE's SMS Subscription Data + operationId: GetSmsData + tags: + - SMS Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sms-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID or SNPN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + /{supi}/sms-mng-data: + get: + summary: retrieve a UE's SMS Management Subscription Data + operationId: GetSmsMngtData + tags: + - SMS Management Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sms-mng-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID or SNPN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsManagementSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + /{ueId}/lcs-privacy-data: + get: + summary: retrieve a UE's LCS Privacy Subscription Data + operationId: GetLcsPrivacyData + tags: + - LCS Privacy Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:lcs-privacy-data:read + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsPrivacyData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /{supi}/lcs-mo-data: + get: + summary: retrieve a UE's LCS Mobile Originated Subscription Data + operationId: GetLcsMoData + tags: + - LCS Mobile Originated Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:lcs-mo-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsMoData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + /{supi}/lcs-bca-data: + get: + summary: retrieve a UE's LCS Broadcast Assistance Data Types Subscription Data + operationId: GetLcsBcaData + tags: + - LCS Broadcast Assistance Data Types Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:lcs-bca-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID or SNPN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsBroadcastAssistanceTypesData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /{supi}/lcs-subscription-data: + get: + summary: retrieve a UE's LCS Subscription Data + operationId: GetLcsSubscriptionData + tags: + - LCS Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:lcs-subscription-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /{supi}/v2x-data: + get: + summary: retrieve a UE's V2X Subscription Data + operationId: GetV2xData + tags: + - V2X Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:v2x-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/V2xSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /{supi}/prose-data: + get: + summary: retrieve a UE's ProSe Subscription Data + operationId: GetProseData + tags: + - Prose Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:prose-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ProseSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /{supi}/5mbs-data: + get: + summary: retrieve a UE's 5MBS Subscription Data + operationId: GetMbsData + tags: + - 5MBS Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:5mbs-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/MbsSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /{supi}/uc-data: + get: + summary: retrieve a UE's User Consent Subscription Data + operationId: GetUcData + tags: + - User Consent Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:uc-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: uc-purpose + in: query + description: User consent purpose + schema: + $ref: '#/components/schemas/UcPurpose' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UcSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /{ueId}/sdm-subscriptions: + post: + summary: subscribe to notifications + operationId: Subscribe + tags: + - Subscription Creation + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sdm-subscriptions:create + parameters: + - name: ueId + in: path + description: Identity of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: shared-data-ids + in: query + description: > + List of IDs identifying shared Data already available at and + subscribed by the NF service consumer + schema: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + style: form + explode: false + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SdmSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SdmSubscription' + headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudm-sdm//{ueId}/sdm-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' + '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: + description: Unexpected error + callbacks: + datachangeNotification: + '{$request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '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: + description: Unexpected error + dataRestorationNotification: + '{$request.body#/dataRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/DataRestorationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + + /{ueId}/sdm-subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications + operationId: Unsubscribe + tags: + - Subscription Deletion + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sdm-subscriptions:modify + parameters: + - name: ueId + in: path + description: Identity of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subscriptionId + in: path + description: Id of the SDM Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '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: + description: Unexpected error + patch: + summary: modify the subscription + operationId: Modify + tags: + - Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sdm-subscriptions:modify + parameters: + - name: ueId + in: path + description: Identity of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subscriptionId + in: path + description: Id of the SDM Subscription + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SdmSubsModification' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SdmSubscription' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '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: + description: Unexpected error + /{ueId}/id-translation-result: + get: + summary: retrieve a UE's SUPI or GPSI + operationId: GetSupiOrGpsi + tags: + - GPSI to SUPI Translation or SUPI to GPSI translation + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:id-translation-result:read + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: af-id + in: query + description: AF identifier + schema: + type: string + - name: app-port-id + in: query + description: Application port identifier + content: + application/json: + schema: + $ref: '#/components/schemas/AppPortId' + - name: af-service-id + in: query + description: AF Service Identifier + schema: + type: string + - name: mtc-provider-info + in: query + description: MTC Provider Information + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + - name: requested-gpsi-type + in: query + description: Requested GPSI Type + schema: + $ref: '#/components/schemas/GpsiType' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/IdTranslationResult' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + /{supi}/am-data/sor-ack: + put: + summary: Nudm_Sdm Info service operation + operationId: SorAckInfo + tags: + - Providing acknowledgement of Steering of Roaming + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sor-ack:write + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcknowledgeInfo' + responses: + '204': + description: Successful acknowledgement + '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: + description: Unexpected error + /{supi}/am-data/upu-ack: + put: + summary: Nudm_Sdm Info for UPU service operation + operationId: UpuAck + tags: + - Providing acknowledgement of UE Parameters Update + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:upu-ack:write + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcknowledgeInfo' + responses: + '204': + description: Successful acknowledgement + '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: + description: Unexpected error + /{supi}/am-data/subscribed-snssais-ack: + put: + summary: Nudm_Sdm Info operation for S-NSSAIs acknowledgement + operationId: S-NSSAIs Ack + tags: + - Providing acknowledgement of S-NSSAIs Update + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:subscribed-nssais-ack:write + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcknowledgeInfo' + responses: + '204': + description: Successful acknowledgement + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + /{supi}/am-data/cag-ack: + put: + summary: Nudm_Sdm Info operation for CAG acknowledgement + operationId: CAG Ack + tags: + - Providing acknowledgement of CAG Update + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:cag-ack:write + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcknowledgeInfo' + responses: + '204': + description: Successful acknowledgement + '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: + description: Unexpected error + /{supi}/am-data/update-sor: + post: + summary: Nudm_Sdm custom operation to trigger SOR info update + operationId: Update SOR Info + tags: + - Trigger SOR info update + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:update-sor:invoke + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SorUpdateInfo' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SorInfo' + '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: + description: Unexpected error + /shared-data: + get: + summary: retrieve shared data + operationId: GetSharedData + tags: + - Retrieval of shared data + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:shared-data:read + parameters: + - name: shared-data-ids + in: query + description: List of shared data ids + required: true + style: form + explode: false + schema: + $ref: '#/components/schemas/SharedDataIds' + - name: supportedFeatures + in: query + deprecated: true + description: Supported Features; this query parameter should not be used + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SharedData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + /shared-data-subscriptions: + post: + summary: subscribe to notifications for shared data + operationId: SubscribeToSharedData + tags: + - Subscription Creation for shared data + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:shared-data-subscriptions:create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SdmSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SdmSubscription' + headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudm-sdm//shared-data-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: + description: Unexpected error + callbacks: + datachangeNotification: + '{$request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '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: + description: Unexpected error + /shared-data-subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications for shared data + operationId: UnsubscribeForSharedData + tags: + - Subscription Deletion for shared data + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:shared-data-subscriptions:modify + parameters: + - name: subscriptionId + in: path + description: Id of the Shared data Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '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: + description: Unexpected error + patch: + summary: modify the subscription + operationId: ModifySharedDataSubs + tags: + - Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:shared-data-subscriptions:modify + parameters: + - name: subscriptionId + in: path + description: Id of the SDM Subscription + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SdmSubsModification' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SdmSubscription' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '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: + description: Unexpected error + + /group-data/group-identifiers: + get: + summary: Mapping of Group Identifiers + operationId: GetGroupIdentifiers + tags: + - Group Identifiers + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:group-identifiers:read + parameters: + - name: ext-group-id + in: query + description: External Group Identifier + required: false + schema: + $ref: '#/components/schemas/ExtGroupId' + - name: int-group-id + in: query + description: Internal Group Identifier + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + - name: ue-id-ind + in: query + description: Indication whether UE identifiers are required or not + required: false + schema: + type: boolean + default: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: af-id + in: query + description: AF identifier + schema: + type: string + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/GroupIdentifiers' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /shared-data/{sharedDataId}: + get: + summary: retrieve the individual shared data + operationId: GetIndividualSharedData + tags: + - Retrieval of the individual shared data + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:shared-data:read + parameters: + - name: sharedDataId + in: path + description: Id of the Shared data + required: true + schema: + $ref: '#/components/schemas/SharedDataIds' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SharedData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /multiple-identifiers: + get: + summary: Mapping of UE Identifiers + operationId: GetMultipleIdentifiers + tags: + - Multiple Identifiers + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:multiple-identifiers:read + parameters: + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: gpsi-list + in: query + description: list of the GPSIs + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + style: form + explode: false + - name: supi-list + in: query + description: list of the SUPIs + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + style: form + explode: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeIdentifiers' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /{supi}/time-sync-data: + get: + summary: retrieve a UE's Time Synchronization Subscription Data + operationId: GetTimeSyncSubscriptionData + tags: + - Time Sync Subscription Data Retrieval + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /{supi}/ranging-slpos-data: + get: + summary: retrieve a UE's Ranging and Sidelink Positioning Subscription Data + operationId: GetRangingSlPosData + tags: + - Ranging and Sidelink Positioning Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:ranging-slpos:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RangingSlPosSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /{supi}/a2x-data: + get: + summary: retrieve a UE's A2X Subscription Data + operationId: GetA2xData + tags: + - A2X Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:a2x-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/A2xSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: > + Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + + /{ueId}/rangingsl-privacy-data: + get: + summary: retrieve a UE's Ranging and Sidelink Positioning Privacy Subscription Data + operationId: GetRangingSlPrivacyData + tags: + - Ranging and Sidelink Positioning Privacy Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:rangingsl-privacy-data:read + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RangingSlPrivacyData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 + 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' + '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: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudm-sdm: Access to the nudm-sdm API + nudm-sdm:multi-data-sets:read: Access to read multiple data sets + nudm-sdm:nssai:read: Access to read NSSAI + nudm-sdm:ue-context-in-amf-data:read: Access to read UE context in AMF data + nudm-sdm:am-data:read: Access to read Access and Mobility Subscription data + nudm-sdm:ecr-data:read: Access to read ECR data + nudm-sdm:smf-select-data:read: Access to read SMF Selection data + nudm-sdm:ue-context-in-smf-data:read: Access to read UE context in SMF data + nudm-sdm:ue-context-in-smsf-data:read: Access to read UE context in SMSF data + nudm-sdm:trace-data:read: Access to read Trace data + nudm-sdm:sm-data:read: Access to read Session Management data + nudm-sdm:sms-data:read: Access to read SMS data + nudm-sdm:sms-mng-data:read: Access to read SMS Management data + nudm-sdm:lcs-privacy-data:read: Access to read LCS privacy data + nudm-sdm:lcs-mo-data:read: Access to read LCS MO data + nudm-sdm:lcs-subscription-data:read: Access to read (other) LCS Subscription data + nudm-sdm:lcs-bca-data:read: Access to read LCS BCA data + nudm-sdm:v2x-data:read: Access to read V2X data + nudm-sdm:prose-data:read: Access to read Prose data + nudm-sdm:5mbs-data:read: Access to read 5MBS data + nudm-sdm:uc-data:read: Access to read User Consent data + nudm-sdm:sdm-subscriptions:create: Access create SDM subscriptions + nudm-sdm:sdm-subscriptions:modify: Access to update SDM subscriptions + nudm-sdm:id-translation-result:read: Access to read ID Translation Results + nudm-sdm:sor-ack:write: Access to write SOR acknowledgements + nudm-sdm:upu-ack:write: Access to write UPU acknowledgements + nudm-sdm:subscribed-nssais-ack:write: Access to write Subscribed NSSAIs acknowledgements + nudm-sdm:cag-ack:write: Access to write CAG acknowledgements + nudm-sdm:update-sor:invoke: Access to invoke SOR info update + nudm-sdm:shared-data:read: Access to read Shared Data + nudm-sdm:shared-data-subscriptions:create: Access to create shared data subscriptions + nudm-sdm:shared-data-subscriptions:modify: Access to update shared data subscriptions + nudm-sdm:group-identifiers:read: Access to read Group Identifiers + nudm-sdm:multiple-identifiers:read: Access to read multiple Identifiers + nudm-sdm:ranging-slpos-data:read: Access to read Ranging and Sidelink Positioning data + nudm-sdm:a2x-data:read: Access to read A2X data + nudm-sdm:rangingsl-privacy-data:read: Access to read Ranging and Sidelink Positioning privacy data + + + schemas: + +# STRUCTURED TYPES: + + DatasetNames: + description: Contains names of data sets + type: array + items: + $ref: '#/components/schemas/DataSetName' + minItems: 2 + uniqueItems: true + + SubscriptionDataSets: + description: Contains Subscription data sets + type: object + properties: + amData: + $ref: '#/components/schemas/AccessAndMobilitySubscriptionData' + smfSelData: + $ref: '#/components/schemas/SmfSelectionSubscriptionData' + uecAmfData: + $ref: '#/components/schemas/UeContextInAmfData' + uecSmfData: + $ref: '#/components/schemas/UeContextInSmfData' + uecSmsfData: + $ref: '#/components/schemas/UeContextInSmsfData' + smsSubsData: + $ref: '#/components/schemas/SmsSubscriptionData' + smData: + $ref: '#/components/schemas/SmSubsData' + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + smsMngData: + $ref: '#/components/schemas/SmsManagementSubscriptionData' + lcsPrivacyData: + $ref: '#/components/schemas/LcsPrivacyData' + lcsMoData: + $ref: '#/components/schemas/LcsMoData' + lcsSubscriptionData: + $ref: '#/components/schemas/LcsSubscriptionData' + v2xData: + $ref: '#/components/schemas/V2xSubscriptionData' + lcsBroadcastAssistanceTypesData: + $ref: '#/components/schemas/LcsBroadcastAssistanceTypesData' + proseData: + $ref: '#/components/schemas/ProseSubscriptionData' + mbsData: + $ref: '#/components/schemas/MbsSubscriptionData' + ucData: + $ref: '#/components/schemas/UcSubscriptionData' + a2xData: + $ref: '#/components/schemas/A2xSubscriptionData' + rangingSlPrivacyData: + $ref: '#/components/schemas/RangingSlPrivacyData' + + + UeContextInSmsfData: + description: Contains SMSF information + type: object + properties: + smsfInfo3GppAccess: + $ref: '#/components/schemas/SmsfInfo' + smsfInfoNon3GppAccess: + $ref: '#/components/schemas/SmsfInfo' + + SmsfInfo: + description: Contains SMSF related information + type: object + required: + - smsfInstanceId + - plmnId + properties: + smsfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + smsfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + + AccessAndMobilitySubscriptionData: + description: Access and Mobility Subscription Data + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + hssGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + internalGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + sharedVnGroupDataIds: + description: A map(list of key-value pairs) where GroupId serves as key of SharedDataId + type: object + additionalProperties: + $ref: '#/components/schemas/SharedDataId' + minProperties: 1 + subscribedUeAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmbrRm' + nssai: + $ref: '#/components/schemas/Nssai' + ratRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true + forbiddenAreas: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Area' + serviceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' + coreNetworkTypeRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CoreNetworkType' + accessTypeRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + maxItems: 2 + rfspIndex: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndexRm' + subsRegTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + ueUsageType: + $ref: '#/components/schemas/UeUsageType' + mpsPriority: + $ref: '#/components/schemas/MpsPriorityIndicator' + mcsPriority: + $ref: '#/components/schemas/McsPriorityIndicator' + activeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + sorInfo: + $ref: '#/components/schemas/SorInfo' + sorInfoExpectInd: + type: boolean + sorafRetrieval: + type: boolean + default: false + sorUpdateIndicatorList: + type: array + items: + $ref: '#/components/schemas/SorUpdateIndicator' + minItems: 1 + upuInfo: + $ref: '#/components/schemas/UpuInfo' + routingIndicator: + type: string + pattern: '^[0-9]{1,4}$' + micoAllowed: + $ref: '#/components/schemas/MicoAllowed' + sharedAmDataIds: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 + odbPacketServices: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OdbPacketServices' + odbExemptedDnnData: + description: A map (list of key-value pairs where dnn serves as key) of odbExemptedDnnInfo + type: object + additionalProperties: + $ref: '#/components/schemas/OdbExemptedDnnInfo' + minProperties: 1 + subscribedDnnList: + type: array + items: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + serviceGapTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + mdtUserConsent: + $ref: '#/components/schemas/MdtUserConsent' + adjacentPlmnMdtUserConsents: + description: A map (list of key-value pairs where PlmnId serves as key) of MdtUserConsent + type: object + additionalProperties: + $ref: '#/components/schemas/MdtUserConsent' + minProperties: 1 + mdtConfiguration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MdtConfiguration' + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + sharedTraceDataId: + $ref: '#/components/schemas/SharedDataId' + cagData: + $ref: '#/components/schemas/CagData' + stnSr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StnSr' + cMsisdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CMsisdn' + nbIoTUePriority: + $ref: '#/components/schemas/NbIoTUePriority' + nssaiInclusionAllowed: + type: boolean + default: false + rgWirelineCharacteristics: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RgWirelineCharacteristics' + aun3DeviceConnectivityAllowed: + type: boolean + default: false + ecRestrictionDataWb: + $ref: '#/components/schemas/EcRestrictionDataWb' + ecRestrictionDataNb: + type: boolean + default: false + expectedUeBehaviourList: + $ref: '#/components/schemas/ExpectedUeBehaviourData' + expectedUeBehaviourData: + description: A map(list of key-value pairs) where a valid JSON pointer serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/ExpectedUeBehaviourData' + minProperties: 1 + primaryRatRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true + secondaryRatRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true + edrxParametersList: + type: array + items: + $ref: '#/components/schemas/EdrxParameters' + minItems: 1 + ptwParametersList: + type: array + items: + $ref: '#/components/schemas/PtwParameters' + minItems: 1 + iabOperationAllowed: + type: boolean + default: false + adjacentPlmnRestrictions: + description: A map (list of key-value pairs where PlmnId serves as key) of PlmnRestriction + type: object + additionalProperties: + $ref: '#/components/schemas/PlmnRestriction' + minProperties: 1 + wirelineForbiddenAreas: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WirelineArea' + wirelineServiceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WirelineServiceAreaRestriction' + pcfSelectionAssistanceInfos: + type: array + items: + $ref: '#/components/schemas/PcfSelectionAssistanceInfo' + minItems: 1 + aerialUeSubInfo: + $ref: '#/components/schemas/AerialUeSubscriptionInfo' + roamingRestrictions: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RoamingRestrictions' + remoteProvInd: + type: boolean + default: false + 3gppChargingCharacteristics: + $ref: '#/components/schemas/3GppChargingCharacteristics' + timeSyncData: + $ref: '#/components/schemas/TimeSyncData' + sharedDataList: + type: array + items: + $ref: '#/components/schemas/SharedData' + minItems: 1 + qmcConfigInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/QmcConfigInfo' + mbsrOperationAllowed: + $ref: '#/components/schemas/MbsrOperationAllowed' + ncrOperationAllowed: + type: boolean + default: false + ladnServiceAreas: + description: > + A map(list of key-value pairs where singleNssai serves as key) of DnnLadnServiceAreas + type: object + additionalProperties: + $ref: '#/components/schemas/DnnLadnServiceAreas' + ueLevelMeasurementsConfiguration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeLevelMeasurementsConfiguration' + allowedRATs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true + minItems: 1 + amPolicyInd: + type: boolean + uePolicyInd: + type: boolean + + DnnLadnServiceAreas: + description: Contains a list of DNN LADN Service Areas + type: object + required: + - dnnLadnServiceAreas + properties: + dnnLadnServiceAreas: + type: array + items: + $ref: '#/components/schemas/DnnLadnServiceArea' + minItems: 1 + + DnnLadnServiceArea: + description: Contains DNN and LADN Service Area + type: object + required: + - dnn + - ladnServiceArea + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + ladnServiceArea: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + + TimeSyncData: + description: Contains Time Synchronization Data + type: object + required: + - authorized + properties: + authorized: + type: boolean + uuTimeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + tempVals: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + coverageArea: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + clockQualityDetailLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityDetailLevel' + clockQualityAcceptanceCriterion: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' + + PcfSelectionAssistanceInfo: + description: Contains DNN and S-NSSAI + type: object + required: + - dnn + - singleNssai + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + + PlmnRestriction: + description: Contains subscribed restrictions + type: object + properties: + ratRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true + forbiddenAreas: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Area' + serviceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' + coreNetworkTypeRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CoreNetworkType' + accessTypeRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + maxItems: 2 + primaryRatRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true + secondaryRatRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true + + ProseSubscriptionData: + description: Contains the ProSe Subscription Data. + type: object + properties: + proseServiceAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProseServiceAuth' + nrUePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + proseAllowedPlmn: + type: array + items: + $ref: '#/components/schemas/ProSeAllowedPlmn' + minItems: 1 + + ProSeAllowedPlmn: + description: > + Contains the PLMN identities where the Prose services are authorised to use and the + authorised Prose services on this given PLMNs. + type: object + required: + - visitedPlmn + properties: + visitedPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + proseDirectAllowed: + type: array + items: + $ref: '#/components/schemas/ProseDirectAllowed' + minItems: 1 + + CagData: + description: Contains Closed Access Group Data + type: object + required: + - cagInfos + properties: + cagInfos: + description: A map (list of key-value pairs where PlmnId serves as key) of CagInfo + type: object + additionalProperties: + $ref: '#/components/schemas/CagInfo' + conditionalCagInfos: + description: A map (list of key-value pairs where PlmnId serves as key) of CagInfo + type: object + additionalProperties: + $ref: '#/components/schemas/ConditionalCagInfo' + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + + CagInfo: + description: Contains Closed Access Group Information + type: object + required: + - allowedCagList + properties: + allowedCagList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CagId' + cagOnlyIndicator: + type: boolean + + SmfSelectionSubscriptionData: + description: Contains SMF selection subscription data + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + subscribedSnssaiInfos: + description: A map(list of key-value pairs) where singleNssai serves as key of SnssaiInfo + type: object + additionalProperties: + $ref: '#/components/schemas/SnssaiInfo' + sharedSnssaiInfosId: + $ref: '#/components/schemas/SharedDataId' + hssGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + + SnssaiInfo: + description: Contains S-NSSAI Information + type: object + required: + - dnnInfos + properties: + dnnInfos: + type: array + items: + $ref: '#/components/schemas/DnnInfo' + minItems: 1 + + DnnInfo: + description: Contains DNN Information + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + defaultDnnIndicator: + $ref: '#/components/schemas/DnnIndicator' + lboRoamingAllowed: + $ref: '#/components/schemas/LboRoamingAllowed' + iwkEpsInd: + $ref: '#/components/schemas/IwkEpsInd' + dnnBarred: + type: boolean + invokeNefInd: + type: boolean + smfList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + sameSmfInd: + type: boolean + hrSboAllowed: + type: boolean + default: false + additionalSmfSelectionInfo: + $ref: '#/components/schemas/AdditionalSmfSelectionInfo' + + AdditionalSmfSelectionInfo: + description: > + Contains the additional parameters for SMF selection in target PLMN. + type: object + properties: + targetPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + + Nssai: + description: Contains Network Slice Selection Assistance Information + type: object + required: + - defaultSingleNssais + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + defaultSingleNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + singleNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + additionalSnssaiData: + description: > + A map(list of key-value pairs) where singleNssai serves as key of AdditionalSnssaiData + type: object + additionalProperties: + $ref: '#/components/schemas/AdditionalSnssaiData' + minProperties: 1 + suppressNssrgInd: + type: boolean + nssaiValidityTimeInfo: + description: > + A map(list of key-value pairs where single Nssai serves as key) + of the current validity time + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minProperties: 1 + nullable: true + + UeContextInAmfData: + description: Contains UE Context In AMF Data + type: object + properties: + epsInterworkingInfo: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/EpsInterworkingInfo' + amfInfo: + description: AMF information + type: array + items: + $ref: '#/components/schemas/AmfInfo' + minItems: 1 + maxItems: 2 + + UeContextInSmfData: + description: Contains UE Context In SMF Data + type: object + properties: + pduSessions: + description: > + A map (list of key-value pairs where PduSessionId serves as key) of PduSessions + type: object + additionalProperties: + $ref: '#/components/schemas/PduSession' + pgwInfo: + type: array + items: + $ref: '#/components/schemas/PgwInfo' + minItems: 1 + emergencyInfo: + $ref: '#/components/schemas/EmergencyInfo' + + EmergencyInfo: + description: Contains Emergency Information + type: object + oneOf: + - required: + - pgwFqdn + - required: + - pgwIpAddress + properties: + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pgwIpAddress: + $ref: '#/components/schemas/IpAddress' + smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + epdgInd: + type: boolean + default: false + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + emergencyRegistrationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + + PduSession: + description: Contains PDU Session + type: object + required: + - dnn + - smfInstanceId + - plmnId + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + + AmfInfo: + description: Contains AMF Information + type: object + required: + - amfInstanceId + - guami + properties: + amfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + + PgwInfo: + description: Contains PGW Information + type: object + required: + - dnn + - pgwFqdn + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pgwIpAddr: + $ref: '#/components/schemas/IpAddress' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + epdgInd: + type: boolean + default: false + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + registrationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + wildcardInd: + type: boolean + + SessionManagementSubscriptionData: + description: Contains Session Management Subscription Data + type: object + required: + - singleNssai + properties: + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnnConfigurations: + description: > + A map (list of key-value pairs where Dnn, or optionally the Wildcard DNN, serves as key) + of DnnConfigurations + type: object + additionalProperties: + $ref: '#/components/schemas/DnnConfiguration' + internalGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + sharedVnGroupDataIds: + description: A map(list of key-value pairs) where GroupId serves as key of SharedDataId + type: object + additionalProperties: + $ref: '#/components/schemas/SharedDataId' + minProperties: 1 + sharedDnnConfigurationsId: + $ref: '#/components/schemas/SharedDataId' + odbPacketServices: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OdbPacketServices' + odbExemptedDnnData: + description: A map (list of key-value pairs where dnn serves as key) of odbExemptedDnnInfo + type: object + additionalProperties: + $ref: '#/components/schemas/OdbExemptedDnnInfo' + minProperties: 1 + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + sharedTraceDataId: + $ref: '#/components/schemas/SharedDataId' + expectedUeBehavioursList: + description: > + A map(list of key-value pairs) where Dnn serves as key of ExpectedUeBehaviourData + type: object + additionalProperties: + $ref: '#/components/schemas/ExpectedUeBehaviourData' + minProperties: 1 + expectedUeBehaviourData: + description: A map(list of key-value pairs) where DNN serves as key + type: object + additionalProperties: + description: A map(list of key-value pairs) where a valid JSON Pointer serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/ExpectedUeBehaviourData' + minProperties: 1 + minProperties: 1 + appSpecificExpectedUeBehaviourData: + description: A map(list of key-value pairs) where DNN serves as key + type: object + additionalProperties: + description: A map(list of key-value pairs) where a valid JSON Pointer serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/AppSpecificExpectedUeBehaviourData' + minProperties: 1 + minProperties: 1 + suggestedPacketNumDlList: + description: > + A map(list of key-value pairs) where Dnn serves as key of SuggestedPacketNumDl + type: object + additionalProperties: + $ref: '#/components/schemas/SuggestedPacketNumDl' + minProperties: 1 + 3gppChargingCharacteristics: + $ref: '#/components/schemas/3GppChargingCharacteristics' + nsacMode: + $ref: '#/components/schemas/NsacAdmissionMode' + sessInactTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + additionalSharedDnnConfigurationsIds: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 + + OdbExemptedDnnInfo: + description: ODB Exempted DNN Information + type: object + required: + - odbExemptedInd + - dnnConfiguration + properties: + odbExemptedInd: + type: boolean + enum: + - true + dnnConfiguration: + $ref: '#/components/schemas/DnnConfiguration' + odbExemptedConditionsData: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string serves + as key of odbExemptedConditions + type: object + additionalProperties: + $ref: '#/components/schemas/OdbExemptedConditions' + minProperties: 1 + + OdbExemptedConditions: + type: object + properties: + spatialValidityCond: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + + DnnConfiguration: + description: Contains DNN Configuration + type: object + required: + - pduSessionTypes + - sscModes + properties: + pduSessionTypes: + $ref: '#/components/schemas/PduSessionTypes' + sscModes: + $ref: '#/components/schemas/SscModes' + iwkEpsInd: + $ref: '#/components/schemas/IwkEpsInd' + 5gQosProfile: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos' + sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + 3gppChargingCharacteristics: + $ref: '#/components/schemas/3GppChargingCharacteristics' + staticIpAddress: + type: array + items: + $ref: '#/components/schemas/IpAddress' + minItems: 1 + maxItems: 2 + upSecurity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity' + pduSessionContinuityInd: + $ref: '#/components/schemas/PduSessionContinuityInd' + niddNefId: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefId' + niddInfo: + $ref: '#/components/schemas/NiddInformation' + redundantSessionAllowed: + type: boolean + acsInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AcsInfo' + ipv4FrameRouteList: + type: array + items: + $ref: '#/components/schemas/FrameRouteInfo' + minItems: 1 + ipv6FrameRouteList: + type: array + items: + $ref: '#/components/schemas/FrameRouteInfo' + minItems: 1 + atsssAllowed: + type: boolean + default: false + secondaryAuth: + type: boolean + uavSecondaryAuth: + type: boolean + default: false + dnAaaIpAddressAllocation: + type: boolean + dnAaaAddress: + $ref: '#/components/schemas/IpAddress' + additionalDnAaaAddresses: + type: array + items: + $ref: '#/components/schemas/IpAddress' + minItems: 1 + dnAaaFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + iptvAccCtrlInfo: + type: string + ipv4Index: + $ref: '#/components/schemas/IpIndex' + ipv6Index: + $ref: '#/components/schemas/IpIndex' + ecsAddrConfigInfo: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/EcsAddrConfigInfo' + additionalEcsAddrConfigInfos: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/EcsAddrConfigInfo' + minItems: 1 + sharedEcsAddrConfigInfo: + $ref: '#/components/schemas/SharedDataId' + additionalSharedEcsAddrConfigInfoIds: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 + easDiscoveryAuthorized: + type: boolean + default: false + onboardingInd: + type: boolean + default: false + aerialUeInd: + $ref: '#/components/schemas/AerialUeIndication' + subscribedMaxIpv6PrefixSize: + type: integer + hrSboAuthorized: + type: boolean + default: false + + NiddInformation: + description: Contains NIDD Information + type: object + required: + - afId + properties: + afId: + type: string + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + extGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + + IpAddress: + description: IP Address + type: object + oneOf: + - required: + - ipv4Addr + - required: + - ipv6Addr + - required: + - ipv6Prefix + properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + + PduSessionTypes: + description: Contains a list of PDU session types + type: object + properties: + defaultSessionType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + allowedSessionTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + + SscModes: + description: Contains a list of SSC Modes + type: object + required: + - defaultSscMode + properties: + defaultSscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' + allowedSscModes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' + minItems: 1 + maxItems: 2 + + SmsSubscriptionData: + description: Contains SMS Subscription Data + type: object + properties: + smsSubscribed: + $ref: '#/components/schemas/SmsSubscribed' + sharedSmsSubsDataId: + $ref: '#/components/schemas/SharedDataId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + SmsManagementSubscriptionData: + description: Contains SMS Management Subscription Data + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + mtSmsSubscribed: + type: boolean + mtSmsBarringAll: + type: boolean + mtSmsBarringRoaming: + type: boolean + moSmsSubscribed: + type: boolean + moSmsBarringAll: + type: boolean + moSmsBarringRoaming: + type: boolean + sharedSmsMngDataIds: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + sharedTraceDataId: + $ref: '#/components/schemas/SharedDataId' + + SdmSubscription: + description: Contains SDM Subscriptions to Notifications + type: object + required: + - nfInstanceId + - callbackReference + - monitoredResourceUris + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + implicitUnsubscribe: + type: boolean + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + amfServiceName: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + subscriptionId: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + immediateReport: + type: boolean + default: false + report: + $ref: '#/components/schemas/ImmediateReport' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + contextInfo: + $ref: '#/components/schemas/ContextInfo' + nfChangeFilter: + type: boolean + default: false + uniqueSubscription: + type: boolean + resetIds: + type: array + items: + type: string + minItems: 1 + ueConSmfDataSubFilter: + $ref: '#/components/schemas/UeContextInSmfDataSubFilter' + adjacentPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + disasterRoamingInd: + type: boolean + default: false + dataRestorationCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + udrRestartInd: + type: boolean + default: false + expectedUeBehaviourThresholds: + description: > + A map(list of key-value pairs) where a valid JSON pointer serves as key of + expectedUeBehaviourThresholds + type: object + additionalProperties: + $ref: '#/components/schemas/ExpectedUeBehaviourThreshold' + minProperties: 1 + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + + SdmSubsModification: + description: Contains modification information + type: object + properties: + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + nfChangeFilter: + type: boolean + ueConSmfDataSubFilter: + $ref: '#/components/schemas/UeContextInSmfDataSubFilter' + expectedUeBehaviourThresholds: + description: > + A map(list of key-value pairs) where a valid JSON pointer serves as key of + expectedUeBehaviourThresholds + type: object + additionalProperties: + $ref: '#/components/schemas/ExpectedUeBehaviourThreshold' + minProperties: 1 + + ModificationNotification: + description: Contains notifications + type: object + required: + - notifyItems + properties: + notifyItems: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotifyItem' + minItems: 1 + subscriptionId: + type: string + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + + IdTranslationResult: + description: Contains Identifier translation result + type: object + required: + - supi + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + additionalSupis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + additionalGpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + + AcknowledgeInfo: + description: Contains acknowledgement information + type: object + required: + - provisioningTime + properties: + sorMacIue: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SorMac' + upuMacIue: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuMac' + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + sorTransparentContainer: + $ref: '#/components/schemas/SorTransparentContainer' + ueNotReachable: + type: boolean + default: false + upuTransparentContainer: + $ref: '#/components/schemas/UpuTransparentContainer' + + SorInfo: + description: Contains steering of roaming information + type: object + properties: + steeringContainer: + $ref: '#/components/schemas/SteeringContainer' + ackInd: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/AckInd' + sorMacIausf: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SorMac' + countersor: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/CounterSor' + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + sorTransparentContainer: + $ref: '#/components/schemas/SorTransparentContainer' + sorCmci: + $ref: '#/components/schemas/SorCmci' + sorSnpnSi: + $ref: '#/components/schemas/SorSnpnSi' + sorSnpnSiLs: + $ref: '#/components/schemas/SorSnpnSiLs' + storeSorCmciInMe: + type: boolean + usimSupportOfSorCmci: + type: boolean + required: + - ackInd + - provisioningTime + + SharedDataIds: + description: Contains IDs of Shared Data + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 + uniqueItems: true + + UpuInfo: + description: Contains UE Parameter Update Information + type: object + properties: + upuDataList: + type: array + items: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuData' + minItems: 1 + upuRegInd: + $ref: '#/components/schemas/UpuRegInd' + upuAckInd: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuAckInd' + upuMacIausf: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuMac' + counterUpu: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/CounterUpu' + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + upuTransparentContainer: + $ref: '#/components/schemas/UpuTransparentContainer' + required: + - provisioningTime + + SharedData: + description: Contains Shared Data + type: object + required: + - sharedDataId + properties: + sharedDataId: + $ref: '#/components/schemas/SharedDataId' + sharedAmData: + $ref: '#/components/schemas/AccessAndMobilitySubscriptionData' + sharedSmsSubsData: + $ref: '#/components/schemas/SmsSubscriptionData' + sharedSmsMngSubsData: + $ref: '#/components/schemas/SmsManagementSubscriptionData' + sharedDnnConfigurations: + description: > + A map(list of key-value pairs) where Dnn, or optionally the Wildcard DNN, + serves as key of DnnConfiguration + type: object + additionalProperties: + $ref: '#/components/schemas/DnnConfiguration' + minProperties: 1 + sharedTraceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + sharedSnssaiInfos: + description: A map(list of key-value pairs) where singleNssai serves as key of SnssaiInfo + type: object + additionalProperties: + $ref: '#/components/schemas/SnssaiInfo' + minProperties: 1 + sharedVnGroupDatas: + description: A map(list of key-value pairs) where GroupId serves as key of VnGroupData + type: object + additionalProperties: + $ref: '#/components/schemas/VnGroupData' + minProperties: 1 + treatmentInstructions: + description: > + A map(list of key-value pairs) where JSON pointer pointing to an attribute within + the SharedData serves as key of SharedDataTreatmentInstruction + type: object + additionalProperties: + $ref: '#/components/schemas/SharedDataTreatmentInstruction' + minProperties: 1 + sharedSmSubsData: + $ref: '#/components/schemas/SessionManagementSubscriptionData' + sharedEcsAddrConfigInfo: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/EcsAddrConfigInfo' + + TraceDataResponse: + description: Contains Trace Data Response + type: object + properties: + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + sharedTraceDataId: + $ref: '#/components/schemas/SharedDataId' + + SteeringContainer: + description: Contains Steering Info or a secured packet + oneOf: + - type: array + items: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo' + minItems: 1 + - $ref: '#/components/schemas/SecuredPacket' + + GroupIdentifiers: + description: Contains Information to identify a group of Ues + type: object + properties: + extGroupId: + $ref: '#/components/schemas/ExtGroupId' + intGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + ueIdList: + type: array + items: + $ref: '#/components/schemas/UeId' + minItems: 1 + + VnGroupData: + description: Contains VN Group Data + type: object + properties: + pduSessionTypes: + $ref: '#/components/schemas/PduSessionTypes' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appDescriptors: + type: array + items: + $ref: '#/components/schemas/AppDescriptor' + minItems: 1 + secondaryAuth: + type: boolean + dnAaaIpAddressAllocation: + type: boolean + dnAaaAddress: + $ref: '#/components/schemas/IpAddress' + additionalDnAaaAddresses: + type: array + items: + $ref: '#/components/schemas/IpAddress' + minItems: 1 + dnAaaFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + 5gVnGroupCommunicationInd: + type: boolean + 5gVnGroupCommunicationType: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/5GVnGroupCommunicationType' + maxGroupDataRate: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/MaxGroupDataRate' + + AppDescriptor: + description: Contains an Application Descriptor + type: object + properties: + osId: + $ref: 'TS29519_Policy_Data.yaml#/components/schemas/OsId' + appId: + type: string + + AdditionalSnssaiData: + description: Contains additional S-NSSAI Data + type: object + properties: + requiredAuthnAuthz: + type: boolean + subscribedUeSliceMbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbrRm' + subscribedNsSrgList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsSrg' + minItems: 1 + nsacMode: + $ref: '#/components/schemas/NsacAdmissionMode' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + deregInactTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + onDemand: + type: boolean + default: false + + AppPortId: + description: Contains the Application Port Id + type: object + properties: + destinationPort: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + originatorPort: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + + LcsPrivacyData: + description: Contains LCS Privacy Data + type: object + properties: + lpi: + $ref: '#/components/schemas/Lpi' + unrelatedClass: + $ref: '#/components/schemas/UnrelatedClass' + plmnOperatorClasses: + type: array + items: + $ref: '#/components/schemas/PlmnOperatorClass' + minItems: 1 + evtRptExpectedArea: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + areaUsageInd: + allOf: + - $ref: '#/components/schemas/AreaUsageInd' + default: INSIDE_REPORTING + upLocRepIndAf: + allOf: + - $ref: '#/components/schemas/UpLocRepIndAf' + default: USER_PLANE_REPORT_NOT_ALLOWED + + Lpi: + description: Contains Location Privacy Indication + type: object + required: + - locationPrivacyInd + properties: + locationPrivacyInd: + $ref: '#/components/schemas/LocationPrivacyInd' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + + UnrelatedClass: + description: Contains Unrelated Class + type: object + required: + - defaultUnrelatedClass + properties: + defaultUnrelatedClass: + $ref: '#/components/schemas/DefaultUnrelatedClass' + externalUnrelatedClass: + $ref: '#/components/schemas/ExternalUnrelatedClass' + serviceTypeUnrelatedClasses: + type: array + items: + $ref: '#/components/schemas/ServiceTypeUnrelatedClass' + minItems: 1 + + PlmnOperatorClass: + description: Contains PLMN Operator Class + type: object + required: + - lcsClientClass + - lcsClientIds + properties: + lcsClientClass: + $ref: '#/components/schemas/LcsClientClass' + lcsClientIds: + type: array + items: + $ref: '#/components/schemas/LcsClientId' + minItems: 1 + + ValidTimePeriod: + description: Contains the validity time period + type: object + properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + + ExternalUnrelatedClass: + description: Contains External Unrelated Class + properties: + lcsClientExternals: + type: array + items: + $ref: '#/components/schemas/LcsClientExternal' + minItems: 1 + afExternals: + type: array + items: + $ref: '#/components/schemas/AfExternal' + minItems: 1 + lcsClientGroupExternals: + type: array + items: + $ref: '#/components/schemas/LcsClientGroupExternal' + minItems: 1 + + AfExternal: + description: Unrelated Class identified by Application Function + type: object + properties: + afId: + $ref: '#/components/schemas/AfId' + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + privacyCheckRelatedAction: + $ref: '#/components/schemas/PrivacyCheckRelatedAction' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + + LcsClientExternal: + description: Unrelated Class identified by LCS client + type: object + properties: + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + privacyCheckRelatedAction: + $ref: '#/components/schemas/PrivacyCheckRelatedAction' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + + LcsClientGroupExternal: + description: Unrelated Class identified by LCS client group + type: object + properties: + lcsClientGroupId: + $ref: '#/components/schemas/ExtGroupId' + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + privacyCheckRelatedAction: + $ref: '#/components/schemas/PrivacyCheckRelatedAction' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + + ServiceTypeUnrelatedClass: + description: Contains Service Type Unrelated Class + type: object + required: + - serviceType + properties: + serviceType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsServiceType' + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + privacyCheckRelatedAction: + $ref: '#/components/schemas/PrivacyCheckRelatedAction' + codeWordInd: + $ref: '#/components/schemas/CodeWordInd' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + codeWordList: + type: array + items: + $ref: '#/components/schemas/CodeWord' + minItems: 1 + + LcsMoData: + description: LCS Mobile Originated Subscription Data + type: object + required: + - allowedServiceClasses + properties: + allowedServiceClasses: + type: array + items: + $ref: '#/components/schemas/LcsMoServiceClass' + minItems: 1 + moAssistanceDataTypes: + $ref: '#/components/schemas/LcsBroadcastAssistanceTypesData' + + LcsSubscriptionData: + description: LSC Subscription Data + type: object + properties: + configuredLmfId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + pruInd: + $ref: '#/components/schemas/PruInd' + lpHapType: + $ref: 'TS29518_Namf_Location.yaml#/components/schemas/LpHapType' + userPlanePosIndLmf: + type: boolean + default: false + + LcsBroadcastAssistanceTypesData: + description: LCS Broadcast Assistance Data Types + type: object + required: + - locationAssistanceType + properties: + locationAssistanceType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Binary' + + EcRestrictionDataWb: + description: Enhanced Coverage Restriction data + type: object + anyOf: + - required: [ ecModeARestricted ] + - required: [ ecModeBRestricted ] + properties: + ecModeARestricted: + type: boolean + ecModeBRestricted: + type: boolean + + ExpectedUeBehaviourData: + description: Contains expected UE behaviour data + type: object + properties: + stationaryIndication: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StationaryIndication' + communicationDurationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + periodicTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + scheduledCommunicationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime' + scheduledCommunicationType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationType' + expectedUmts: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/LocationArea' + minItems: 1 + description: > + Identifies the UE's expected geographical movement. The attribute is only + applicable in 5G. + trafficProfile: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficProfile' + batteryIndication: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BatteryIndication' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + confidenceLevel: + type: string + pattern: '^[0]\.[0-9]{2}$|^1\.00$' + accuracyLevel: + type: string + pattern: '^[0]\.[0-9]{2}$|^1\.00$' + + SuggestedPacketNumDl: + description: Contains suggested number of DL packets + type: object + required: + - suggestedPacketNumDl + properties: + suggestedPacketNumDl: + type: integer + minimum: 1 + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + + FrameRouteInfo: + description: Contains Frame Route Information + type: object + properties: + ipv4Mask: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrMask' + ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + + SorUpdateInfo: + description: Contains Steering Of Roaming Update Information + type: object + required: + - vplmnId + properties: + vplmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + EnhancedCoverageRestrictionData: + description: Contains Enhanced Coverage Restriction Data + type: object + properties: + plmnEcInfoList: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/PlmnEcInfo' + minItems: 1 + + EdrxParameters: + description: Contains eDRX parameters + type: object + required: + - ratType + - edrxValue + properties: + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + edrxValue: + type: string + pattern: '^([0-1]{4})$' + + PtwParameters: + description: Contains paging time window parameters + type: object + required: + - operationMode + - ptwValue + properties: + operationMode: + $ref: '#/components/schemas/OperationMode' + ptwValue: + type: string + pattern: '^([0-1]{4})$' + extendedPtwValue: + type: string + pattern: '^([0-1]{8})$' + + UeId: + description: Identifier of UE + type: object + required: + - supi + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + + V2xSubscriptionData: + description: V2X Subscription Data + type: object + properties: + nrV2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrV2xAuth' + lteV2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LteV2xAuth' + nrUePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ltePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + + DefaultUnrelatedClass: + description: Default Unrelated Class + type: object + properties: + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + privacyCheckRelatedAction: + $ref: '#/components/schemas/PrivacyCheckRelatedAction' + codeWordInd: + $ref: '#/components/schemas/CodeWordInd' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + codeWordList: + type: array + items: + $ref: '#/components/schemas/CodeWord' + minItems: 1 + + ContextInfo: + description: Context Information + type: object + properties: + origHeaders: + type: array + items: + type: string + minItems: 1 + requestHeaders: + type: array + items: + type: string + minItems: 1 + + AerialUeSubscriptionInfo: + description: > + Contains the Aerial UE Subscription Information, it at least contains + the Aerial UE Indication. + type: object + required: + - aerialUeInd + properties: + aerialUeInd: + $ref: '#/components/schemas/AerialUeIndication' + 3gppUavId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + + SmSubsData: + description: Session Management Subscription Data + oneOf: + - type: array + items: + $ref: '#/components/schemas/SessionManagementSubscriptionData' + minItems: 1 + - $ref: '#/components/schemas/ExtendedSmSubsData' + + ExtendedSmSubsData: + description: > + Contains identifiers of shared Session Management Subscription Data + and optionally individual Session Management Subscription Data. + type: object + required: + - sharedSmSubsDataIds + properties: + sharedSmSubsDataIds: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 + individualSmSubsData: + type: array + items: + $ref: '#/components/schemas/SessionManagementSubscriptionData' + + ImmediateReport: + description: Contains the immediate report + oneOf: + - $ref: '#/components/schemas/SubscriptionDataSets' + - type: array + items: + $ref: '#/components/schemas/SharedData' + minItems: 0 + + MbsSubscriptionData: + description: Contains the 5MBS Subscription Data. + type: object + properties: + mbsAllowed: + type: boolean + default: false + mbsSessionIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + minItems: 1 + ueMbsAssistanceInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + minItems: 1 + + UcSubscriptionData: + description: Contains the User Consent Subscription Data. + type: object + properties: + userConsentPerPurposeList: + description: > + A map(list of key-value pairs) where user consent purpose serves as key of user consent + type: object + additionalProperties: + $ref: '#/components/schemas/UserConsent' + minProperties: 1 + + UeContextInSmfDataSubFilter: + description: UE Context In Smf Data Subscription Filter. + type: object + properties: + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + emergencyInd: + type: boolean + default: false + + UeIdentifiers: + description: A map(list of key-value pairs) where Gpsi/Supi serves as key of arrays of Supi/Gpsi + type: object + properties: + ueIdList: + description: A map(list of key-value pairs) where Gpsi serves as key of arrays of Supi + type: object + additionalProperties: + $ref: '#/components/schemas/SupiInfo' + minItems: 1 + ueIdGpsiList: + description: A map(list of key-value pairs) where Supi serves as key of arrays of Gpsi + type: object + additionalProperties: + $ref: '#/components/schemas/GpsiInfo' + minItems: 1 + + SupiInfo: + description: List of Supis. + type: object + required: + - supiList + properties: + supiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + + GpsiInfo: + description: List of Gpsis. + type: object + required: + - gpsiList + properties: + gpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + + TimeSyncSubscriptionData: + description: UE Time Synchronization Subscription Data + type: object + required: + - afReqAuthorizations + - serviceIds + properties: + afReqAuthorizations: + $ref: '#/components/schemas/AfRequestAuthorization' + serviceIds: + type: array + items: + $ref: '#/components/schemas/TimeSyncServiceId' + minItems: 1 + + AfRequestAuthorization: + description: AF Request Authorization + type: object + properties: + gptpAllowedInfoList: + type: array + items: + $ref: '#/components/schemas/GptpAllowedInfo' + minItems: 1 + astiAllowedInfo: + $ref: '#/components/schemas/AstiAllowedInfo' + oneOf: + - required: [ gptpAllowedInfoList ] + - required: [ astiAllowedInfo ] + + GptpAllowedInfo: + description: AF authorization information for gPTP + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + gptpAllowed: + type: boolean + coverageArea: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + uuTimeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + tempVals: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + acceptableInd: + type: boolean + default: false + clockQualityAcceptanceCriteria: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' + required: + - gptpAllowed + + AstiAllowedInfo: + description: AF authorization information for ASTI + type: object + properties: + astiAllowed: + type: boolean + coverageArea: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + uuTimeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + tempVals: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + clockQualityMetricsInd: + type: boolean + default: false + acceptableInd: + type: boolean + default: false + clockQualityAcceptanceCriteria: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' + required: + - astiAllowed + + TimeSyncServiceId: + description: Time Synchronization Service ID + type: object + required: + - reference + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + reference: + type: string + tempVals: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + coverageArea: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + uuTimeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + + ConditionalCagInfo: + description: Conditional Closed Access Group Information + type: object + required: + - allowedCagList + properties: + allowedCagList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CagId' + minItems: 1 + cagOnlyIndicator: + type: boolean + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + + AppSpecificExpectedUeBehaviourData: + description: Application specific expected UE behaviour data + type: object + anyOf: + - required: [ appId ] + - required: [ trafficFilters ] + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + trafficFilters: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + expectedInactivityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + confidenceLevel: + type: string + pattern: '^[0]\.[0-9]{2}$|^1\.00$' + accuracyLevel: + type: string + pattern: '^[0]\.[0-9]{2}$|^1\.00$' + + ExpectedUeBehaviourThreshold: + description: Expected UE Behaviour Threshold + type: object + properties: + expectedUeBehaviourDatasets: + type: array + items: + $ref: '#/components/schemas/ExpectedUeBehaviourDataset' + minItems: 1 + singleNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + dnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + confidenceLevel: + type: string + accuracyLevel: + type: string + + A2xSubscriptionData: + description: Contains A2X Subscription Data + type: object + properties: + nrA2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrA2xAuth' + lteA2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LteA2xAuth' + nrUePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ltePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + + RangingSlPosQos: + description: Contains Ranging and Sidelink Positioning QoS + type: object + properties: + hAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' + vAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' + relativeHAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' + relativeVAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' + distanceAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' + directionAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' + verticalRequested: + type: boolean + responseTime: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ResponseTime' + lcsQosClass: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsQosClass' + rangingSlPosPriorityLevel: + type: integer + minimum: 1 + maximum: 8 + rangingSlPosDelayBudget: + type: integer + minimum: 0 + maximum: 1023 + + MbsrOperationAllowed: + description: Indicates whether the UE is allowed for MBSR operation + type: object + properties: + mbsrOperationAllowedInd: + type: boolean + default: false + mbsrLocationInfo: + $ref: '#/components/schemas/MbsrLocationInfo' + mbsrTimeInfo: + $ref: '#/components/schemas/MbsrTimeInfo' + + MbsrLocationInfo: + description: MBSR Location Information + type: object + properties: + mbsrLocation: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + mbsrLocationAreas: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaCode' + minItems: 1 + + MbsrTimeInfo: + description: MBSR Time Information + type: object + properties: + mbsrTimeWindow: + type: array + items: + $ref: '#/components/schemas/ValidTimePeriod' + minItems: 1 + mbsrRecurTime: + type: array + items: + $ref: '#/components/schemas/RecurTime' + minItems: 1 + + RecurTime: + description: Contains the recurring time period + type: object + properties: + recurTimeWindow: + $ref: '#/components/schemas/ValidTimePeriod' + recurType: + $ref: '#/components/schemas/RecurType' + recurMonth: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MonthOfYear' + minItems: 1 + recurWeek: + type: array + items: + type: integer + minimum: 1 + maximum: 64 + minItems: 1 + recurDay: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DayOfWeek' + minItems: 1 + recurDate: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minItems: 1 + + + RangingSlPrivacyData: + description: Contains Ranging and Sidelink Positioning Privacy Subscription Data. + type: object + properties: + rslppi: + $ref: '#/components/schemas/Rslppi' + rangingSlUnrelatedClass: + $ref: '#/components/schemas/RangingSlUnrelatedClass' + rangingSlPlmnOperatorClasses: + type: array + items: + $ref: '#/components/schemas/RangingSlPlmnOperatorClass' + minItems: 1 + rangingSlEvtRptExpectedArea: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + + Rslppi: + description: Describes Ranging and Sidelink Positioning Privacy Indication. + type: object + required: + - rangingSlPrivacyInd + properties: + rangingSlPrivacyInd: + $ref: '#/components/schemas/RangingSlPrivacyInd' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + + RangingSlUnrelatedClass: + description: Describes Call/Session unrelated Classes for ranging and sidelink positioning. + type: object + required: + - rangingSlDefaultUnrelatedClass + properties: + rangingSlDefaultUnrelatedClass: + $ref: '#/components/schemas/RangingSlDefaultUnrelatedClass' + rangingSlExternalUnrelatedClass: + $ref: '#/components/schemas/RangingSlExternalUnrelatedClass' + rangingSlAppIDUnrelatedClasses: + type: array + items: + $ref: '#/components/schemas/RangingSlAppIDUnrelatedClass' + minItems: 1 + + RangingSlDefaultUnrelatedClass: + description: > + Describes default Call/Session unrelated Class subscription for ranging and sidelink + positioning for unidentified value added LCS clients or AFs. + type: object + properties: + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + rangingSlPrivacyCheckRelatedAction: + $ref: '#/components/schemas/RangingSlPrivacyCheckRelatedAction' + codeWordInd: + $ref: '#/components/schemas/CodeWordInd' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + codeWordList: + type: array + items: + $ref: '#/components/schemas/CodeWord' + minItems: 1 + + RangingSlPlmnOperatorClass: + description: Describes PLMN Operator Class for ranging and sidelink positioning. + type: object + required: + - rangingSlLcsClientClass + - lcsClientIds + properties: + rangingSlLcsClientClass: + $ref: '#/components/schemas/LcsClientClass' + lcsClientIds: + type: array + items: + $ref: '#/components/schemas/LcsClientId' + minItems: 1 + + RangingSlExternalUnrelatedClass: + description: > + Describes Call/Session unrelated Class subscriptions for ranging and sidelink positioning + for identified value added LCS Clients or AFs. + properties: + rangingSlLcsClientExternals: + type: array + items: + $ref: '#/components/schemas/RangingSlLcsClientExternal' + minItems: 1 + rangingSlAfExternals: + type: array + items: + $ref: '#/components/schemas/RangingSlAfExternal' + minItems: 1 + + RangingSlAfExternal: + description: > + Describes list of Call/session Unrelated Class for ranging and sidelink positioning + identified by AF in the external LCS client list. + type: object + properties: + afId: + $ref: '#/components/schemas/AfId' + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + rangingSlPrivacyCheckRelatedAction: + $ref: '#/components/schemas/RangingSlPrivacyCheckRelatedAction' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + + RangingSlLcsClientExternal: + description: > + Describes list of Call/session Unrelated Class for ranging and sidelink + positioningidentified by LCS client in the external LCS client list. + type: object + properties: + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + rangingSlPrivacyCheckRelatedAction: + $ref: '#/components/schemas/RangingSlPrivacyCheckRelatedAction' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + + + RangingSlAppIDUnrelatedClass: + description: > + Describes Call/Session unrelated Class subscriptions for ranging and sidelink positioning + service for identified service type for UE. + type: object + required: + - rangingSlAppID + properties: + rangingSlAppID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + rangingSlPrivacyCheckRelatedAction: + $ref: '#/components/schemas/RangingSlPrivacyCheckRelatedAction' + codeWordInd: + $ref: '#/components/schemas/CodeWordInd' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + codeWordList: + type: array + items: + $ref: '#/components/schemas/CodeWord' + minItems: 1 + + +# SIMPLE TYPES: + + UeUsageType: + description: UE Usage Type + type: integer + + MpsPriorityIndicator: + description: MPS priority indicator + type: boolean + + McsPriorityIndicator: + description: MCS priority indicator + type: boolean + + DnnIndicator: + description: DNN indicator + type: boolean + + LboRoamingAllowed: + description: LBO Roaming allowed indicator + type: boolean + + SmsSubscribed: + description: SMS subscribed indicator + type: boolean + + 3GppChargingCharacteristics: + description: 3GPP Charging Characteristics + type: string + + MicoAllowed: + description: Mobile Initiated Connection Only indicator + type: boolean + + SharedDataId: + description: Identifier of shared data + type: string + pattern: '^[0-9]{5,6}-.+$' + + IwkEpsInd: + description: Interworking with EPS indication + type: boolean + + SecuredPacket: + description: Secured Packet + type: string + format: byte + + UpuRegInd: + description: Re-registration request indicator for UPU + type: boolean + + ExtGroupId: + description: External Identifier of a group of UEs + type: string + pattern: '^extgroupid-[^@]+@[^@]+$' + + NbIoTUePriority: + description: NB-IoT UE Priority + type: integer + minimum: 0 + maximum: 255 + + CodeWord: + description: Contains the codeword + type: string + + AfId: + description: Application Function Identifier + type: string + + LcsClientId: + description: LSC client Identifier + type: string + + SorTransparentContainer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + UpuTransparentContainer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + IpIndex: + description: > + Represents the IP Index to be sent from UDM to the SMF + (its value can be either an integer or a string) + anyOf: + - type: integer + - type: string + + SorCmci: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + SorSnpnSi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + SorSnpnSiLs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + RangingSlPosSubscriptionData: + description: Contains the Ranging/SL positioning Subscription Data. + type: object + properties: + rangingSlPosAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RangingSlPosAuth' + rangingSlPosPlmn: + type: array + items: + $ref: '#/components/schemas/RangingSlPosPlmn' + minItems: 1 + rangingSlPosQos: + $ref: '#/components/schemas/RangingSlPosQos' + + RangingSlPosPlmn: + description: > + Contains the PLMN identities where the Ranging/SL Positioning services are authorised to + use and the authorised Ranging/SL Positioning services on this given PLMNs. + type: object + required: + - rangingSlPosPlmn + properties: + rangingSlPosPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + rangingSlPosAllowed: + type: array + items: + $ref: '#/components/schemas/RangingSlPosAllowed' + minItems: 1 + +# ENUMS: + + DataSetName: + description: Indicates the requested data set name. + anyOf: + - type: string + enum: + - AM + - SMF_SEL + - UEC_SMF + - UEC_SMSF + - SMS_SUB + - SM + - TRACE + - SMS_MNG + - LCS_PRIVACY + - LCS_MO + - LCS_SUB + - UEC_AMF + - V2X + - LCS_BCA + - PROSE + - UC + - MBS + - A2X + - RANGINGSL_PRIVACY + - 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. + + + UcPurpose: + description: Indicates the purpose of the user consent. + anyOf: + - type: string + enum: + - ANALYTICS + - MODEL_TRAINING + - NW_CAP_EXPOSURE + - EDGEAPP_UE_LOCATION + - 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. + + UserConsent: + description: Indicates user’s consent. + anyOf: + - type: string + enum: + - CONSENT_NOT_GIVEN + - CONSENT_GIVEN + - 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. + + PduSessionContinuityInd: + description: > + It indicates the handling of PDU session when + the UE moves in and out of NB-IoT. + In its absence, the local policy should be used. + anyOf: + - type: string + enum: + - MAINTAIN_PDUSESSION + - RECONNECT_PDUSESSION + - RELEASE_PDUSESSION + - 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. + + LocationPrivacyInd: + description: > + Indicates one of the mutually exclusive global settings + (if the location is allowed or disallowed). + anyOf: + - type: string + enum: + - LOCATION_DISALLOWED + - LOCATION_ALLOWED + - 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. + + PrivacyCheckRelatedAction: + description: Indicates actions related to privacy check. + anyOf: + - type: string + enum: + - LOCATION_NOT_ALLOWED + - LOCATION_ALLOWED_WITH_NOTIFICATION + - LOCATION_ALLOWED_WITHOUT_NOTIFICATION + - LOCATION_ALLOWED_WITHOUT_RESPONSE + - LOCATION_RESTRICTED_WITHOUT_RESPONSE + - 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. + + LcsClientClass: + description: Indicates LCS Client class. + anyOf: + - type: string + enum: + - BROADCAST_SERVICE + - OM_IN_HPLMN + - OM_IN_VPLMN + - ANONYMOUS_LOCATION_SERVICE + - SPECIFIC_SERVICE + - NWDAF_IN_HPLMN + - NWDAF_IN_VPLMN + - 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. + + LcsMoServiceClass: + description: Indicates the MO-LR services allowed for a UE subscriber + anyOf: + - type: string + enum: + - BASIC_SELF_LOCATION + - AUTONOMOUS_SELF_LOCATION + - TRANSFER_TO_THIRD_PARTY + - 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. + + + OperationMode: + description: > + Indicates the Operation Mode. + anyOf: + - type: string + enum: + - WB_S1 + - NB_S1 + - WB_N1 + - NB_N1 + - NR_N1 + - NR_N1_REDCAP + - 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. + + SorUpdateIndicator: + description: Indicates serving node PLMN identity. + anyOf: + - type: string + enum: + - INITIAL_REGISTRATION + - EMERGENCY_REGISTRATION + - 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. + + CodeWordInd: + description: > + Indicates that the codeword shall be checked in UE + or one or more codeword values to be checked in GMLC. + anyOf: + - type: string + enum: + - CODEWORD_CHECK_IN_UE + - CODEWORD_CHECK_IN_GMLC + - 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. + + MdtUserConsent: + description: > + Indicates the user has given his consent for MDT activation. + anyOf: + - type: string + enum: + - CONSENT_NOT_GIVEN + - CONSENT_GIVEN + - 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. + + SharedDataTreatmentInstruction: + description: > + Indicates the presence of this attribute in the individual data. + Otherwise, the individual data takes precedence, by default. + anyOf: + - type: string + enum: + - USE_IF_NO_CLASH + - OVERWRITE + - MAX + - MIN + - 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. + + GpsiType: + description: Type of GPSI (MSISDN or External-ID) + anyOf: + - type: string + enum: + - MSISDN + - EXT_ID + - EXT_GROUP_ID + - 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. + + AerialUeIndication: + description: > + Indicates the Aerial service for the UE is allowed or not allowed, possible values are + - AERIAL_UE_ALLOWED: Aerial service for the UE is allowed. + - AERIAL_UE_NOT_ALLOWED: Aerial service for the UE is not allowed. + anyOf: + - type: string + enum: + - AERIAL_UE_ALLOWED + - AERIAL_UE_NOT_ALLOWED + - 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. + + ProseDirectAllowed: + description: > + Indicates the 5G ProSe Direct services that can be authorised to + use in the given PLMN for the UE. + anyOf: + - type: string + enum: + - ANNOUNCE + - MONITOR + - RESTRICTD_ANNOUNCE + - RESTRICTD_MONITOR + - DISCOVERER + - DISCOVEREE + - BROADCAST + - GROUPCAST + - UNICAST + - LAYER2_RELAY + - LAYER3_RELAY + - LAYER3_REMOTE + - LAYER2_UE_RELAY + - LAYER3_UE_RELAY + - LAYER2_END + - LAYER3_END + - 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. + + NsacAdmissionMode: + description: > + Indicates the NSAC admission mode applied in roaming case. + anyOf: + - type: string + enum: + - VPLMN_ADMISSION + - VPLMN_WITH_HPLMN_ASSISTANCE + - HPLMN_ADMISSION + - 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. + + PruInd: + description: > + Indicates whether the UE can act as a PRU or the type of PRU. + anyOf: + - type: string + enum: + - NON_PRU + - STATIONARY_PRU + - NON_STATIONARY_PRU + - 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. + + AreaUsageInd: + description: > + Indicates one of the mutually exclusive global settings + (whether the UE is allowed to generate and send the reports inside or outside the event + report expected area). + anyOf: + - type: string + enum: + - INSIDE_REPORTING + - OUTSIDE_REPORTING + - 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. + + + RangingSlPosAllowed: + description: > + Indicates the Ranging/SL positioning services that can be authorised to + use in the given PLMN for the UE. + anyOf: + - type: string + enum: + - PC5 + - ANNOUNCE + - MONITOR + - DISCOVERER + - DISCOVEREE + - LOCATED_UE + - SL_SERVER_UE + - SL_CLIENT_UE + - 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. + + ExpectedUeBehaviourDataset: + description: > + Indicates the name of the Expected UE Behaviour Dataset + anyOf: + - type: string + enum: + - STATIONARY_INDICATION + - COMMUNICATION_DURATION_TIME + - PERIODIC_TIME + - SCHEDULED_COMMUNICATION_TIME + - SCHEDULED_COMMUNICATION_TYPE + - EXPECTED_UMTS + - TRAFFIC_PROFILE + - BATTERY_INDICATION + - EXPECTED_INACTIVITY_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. + + UpLocRepIndAf: + description: > + Indicates one of the mutually exclusive global settings for location reporting over user + plane connectivity to an LCS client or AF. + anyOf: + - type: string + enum: + - USER_PLANE_REPORT_ALLOWED + - USER_PLANE_REPORT_NOT_ALLOWED + - 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. + RecurType: + description: Indicates the recurrence applicable to a time window. + anyOf: + - type: string + enum: + - DAILY + - WEEKLY + - MONTHLY_BY_DATE + - MONTHLY_BY_DAY + - YEARLY + - WEEKDAYS_ONLY + - WEEKENDS_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. + + RangingSlPrivacyInd: + description: > + Indicates one of the mutually exclusive global settings + (if the ranging and sidelink positioning is allowed or disallowed). + anyOf: + - type: string + enum: + - RANGINGSL_DISALLOWED + - RANGINGSL_ALLOWED + - 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. + + RangingSlPrivacyCheckRelatedAction: + description: Indicates actions related to privacy check for ranging and sidelink positioning. + anyOf: + - type: string + enum: + - RANGINGSL_NOT_ALLOWED + - RANGINGSL_ALLOWED_WITH_NOTIFICATION + - RANGINGSL_ALLOWED_WITHOUT_NOTIFICATION + - RANGINGSL_ALLOWED_WITHOUT_RESPONSE + - RANGINGSL_RESTRICTED_WITHOUT_RESPONSE + - 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. + -- GitLab From 73b29750fb01ff09eed9ff1f92a4547227557abc Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 06:37:32 +0000 Subject: [PATCH 25/33] Upload the YAML for cross reference compile --- OpenAPI/TS29572_Nlmf_Location.yaml | 2343 ++++++++++++++++++++++++++++ 1 file changed, 2343 insertions(+) create mode 100644 OpenAPI/TS29572_Nlmf_Location.yaml diff --git a/OpenAPI/TS29572_Nlmf_Location.yaml b/OpenAPI/TS29572_Nlmf_Location.yaml new file mode 100644 index 0000000..1a8ed70 --- /dev/null +++ b/OpenAPI/TS29572_Nlmf_Location.yaml @@ -0,0 +1,2343 @@ +openapi: 3.0.0 + +info: + version: '1.4.0-alpha.1' + title: 'LMF Location' + description: | + LMF Location Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.572 V19.0.0; 5G System; Location Management Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/' + +servers: + - url: '{apiRoot}/nlmf-loc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + +paths: + /determine-location: + post: + summary: Determine Location of an UE + operationId: DetermineLocation + tags: + - Determine Location + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:determine-location:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InputData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/InputData' + binaryDataLppMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataLppMessage: + contentType: application/vnd.3gpp.lpp + headers: + Content-Id: + schema: + type: string + binaryDataLppMessageExt1: + contentType: application/vnd.3gpp.lpp + headers: + Content-Id: + schema: + type: string + binaryDataLppMessageExt2: + contentType: application/vnd.3gpp.lpp + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LocationDataExt' + '204': + description: Expected response for MO-LR requesting location assistance data. + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + EventNotify: + '{$request.body#/hgmlcCallBackURI}': + post: + requestBody: + description: UE Event Notification + content: + application/json: + schema: + $ref: '#/components/schemas/EventNotifyDataExt' + responses: + '204': + description: Expected response to a valid notification + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + /up-subscriptions: + post: + summary: subscribe about status of a secure LCS-UP connection for a target UE + operationId: UpSubscriptions + tags: + - UP Subscribe + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:up-subscription:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpSubscription' + required: true + responses: + '201': + description: Expected response to successful UP Subscription + content: + application/json: + schema: + $ref: '#/components/schemas/UpSubscription' + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + UPNotify: + '{$request.body#/upNotifyCallBackUri}': + post: + requestBody: + description: UP Connection Status Notification + content: + application/json: + schema: + $ref: '#/components/schemas/UpNotifyData' + responses: + '204': + description: Expected response to a valid notification + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /up-subscriptions/{subscriptionId}: + delete: + summary: Deletes a subscription + operationId: DeleteSubscription + tags: + - UP Unsubscribe + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:up-subscriptions:invoke + parameters: + - name: subscriptionId + in: path + required: true + description: Unique subscription Id + schema: + type: string + responses: + '204': + description: Expected response to a successful subscription removal + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + + /cancel-location: + post: + summary: request cancellation of periodic or triggered location + operationId: CancelLocation + tags: + - Cancel Location + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:cancel-location:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelLocData' + required: true + responses: + '204': + description: Expected response to a successful cancellation + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + /location-context-transfer: + post: + summary: transfer context information for periodic or triggered location + operationId: LocationContextTransfer + tags: + - Location Context Transfer + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:location-context-transfer:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocContextData' + required: true + responses: + '204': + description: Expected response to successful location context transfer + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + /measure-location: + post: + summary: PRU location measurement + operationId: LocationMeasure + tags: + - Location Measure + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:measure-location:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocMeasurementReq' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LocMeasurementResp' + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /configure-up: + post: + summary: set up, modify or terminate a secure LCS-UP connection for a target UE + operationId: UpConfig + tags: + - UP Configure + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:configure-up:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpConfig' + required: true + responses: + '204': + description: > + Expected response to successful set up, modify or terminate LCS-UP connection. + '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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nlmf-loc: Access to the Nlmf_Location API + nlmf-loc:determine-location:invoke: Access to invoke Determine Location + nlmf-loc:cancel-location:invoke: Access to invoke Cancel Location + nlmf-loc:location-context-transfer:invoke: Access to invoke Location Context + nlmf-loc:measure-location:invoke: Access to invoke Location Measurement + nlmf-loc:up-subscriptions:invoke: Access to invoke UP Subscription + nlmf-loc:configure-up:invoke: Access to invoke UP Config + + schemas: +# +# STRUCTURED TYPES +# + InputData: + description: Information within Determine Location Request. + type: object + not: + required: [ ecgi, ncgi ] + properties: + externalClientType: + $ref: '#/components/schemas/ExternalClientType' + correlationID: + $ref: '#/components/schemas/CorrelationID' + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + locationQoS: + $ref: '#/components/schemas/LocationQoS' + supportedGADShapes: + type: array + items: + $ref: '#/components/schemas/SupportedGADShapes' + minItems: 1 + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + requestedRangingSlResult: + type: array + items: + $ref: '#/components/schemas/RangingSlResult' + minItems: 1 + relatedUes: + type: array + items: + $ref: '#/components/schemas/RelatedUe' + minItems: 1 + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ecgiOnSecondNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ncgiOnSecondNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + priority: + $ref: '#/components/schemas/LcsPriority' + velocityRequested: + $ref: '#/components/schemas/VelocityRequested' + ueLcsCap: + $ref: '#/components/schemas/UeLcsCapability' + lcsServiceType: + $ref: '#/components/schemas/LcsServiceType' + ldrType: + $ref: '#/components/schemas/LdrType' + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + lirGmlcCallBackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + vgmlcAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + lirReference: + $ref: '#/components/schemas/LirReference' + periodicEventInfo: + $ref: '#/components/schemas/PeriodicEventInfo' + areaEventInfo: + $ref: '#/components/schemas/AreaEventInfo' + motionEventInfo: + $ref: '#/components/schemas/MotionEventInfo' + reportingAccessTypes: + type: array + items: + $ref: '#/components/schemas/ReportingAccessType' + minItems: 1 + ueConnectivityStates: + $ref: '#/components/schemas/UeConnectivityState' + ueLocationServiceInd: + $ref: '#/components/schemas/UeLocationServiceInd' + moAssistanceDataTypes: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/LcsBroadcastAssistanceTypesData' + lppMessage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + lppMessageExt: + description: Indicates the lpp message extension. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + uePositioningCap: + $ref: '#/components/schemas/UePositioningCapabilities' + tnapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TnapId' + twapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TwapId' + ueCountryDetInd: + type: boolean + scheduledLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reliableLocReq: + type: boolean + default: false + evtRptAllowedAreas: + type: array + items: + $ref: '#/components/schemas/ReportingArea' + minItems: 1 + maxItems: 250 + ueUnawareInd: + type: boolean + enum: + - true + intermediateLocationInd: + type: boolean + default: false + maxRespTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + lpHapType: + $ref: 'TS29518_Namf_Location.yaml#/components/schemas/LpHapType' + ueUpPosCaps: + type: array + items: + $ref: '#/components/schemas/UeUpPositioningCapabilities' + minItems: 1 + reportingInd: + allOf: + - $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/ReportingInd' + default: INSIDE_REPORTING + mbsrInfo: + $ref: '#/components/schemas/MbsrInfo' + integrityRequirements: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/IntegrityRequirements' + upLocRepAddrAf: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/UpLocRepAddrAfRm' + upCumEvtRptCriteria: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpCumEvtRptCriteria' + mappedQoSEps: + $ref: '#/components/schemas/MappedLocationQoSEps' + additionalUeInfo: + $ref: '#/components/schemas/AdditionalUeInfo' + coordinateID: + type: integer + rangingSlCapability: + $ref: '#/components/schemas/RangingSlCapability' + slPositioningCapabilities: + type: array + items: + $ref: '#/components/schemas/SlPositioningCapability' + minItems: 1 + + LocationDataExt: + description: Extended Location Data for UEs + allOf: + - $ref: '#/components/schemas/LocationData' + - $ref: '#/components/schemas/AddLocationDatas' + + LocationData: + description: Information within Determine Location Response. + type: object + required: + - locationEstimate + properties: + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + accuracyFulfilmentIndicator: + $ref: '#/components/schemas/AccuracyFulfilmentIndicator' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + civicAddress: + $ref: '#/components/schemas/CivicAddress' + localLocationEstimate: + $ref: '#/components/schemas/LocalArea' + positioningDataList: + type: array + items: + $ref: '#/components/schemas/PositioningMethodAndUsage' + minItems: 1 + gnssPositioningDataList: + type: array + items: + $ref: '#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 1 + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + remoteUeInd: + type: boolean + enum: + - true + altitude: + $ref: '#/components/schemas/Altitude' + barometricPressure: + $ref: '#/components/schemas/BarometricPressure' + servingLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' + uePositioningCap: + $ref: '#/components/schemas/UePositioningCapabilities' + ueAreaInd: + $ref: '#/components/schemas/UeAreaIndication' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + achievedQos: + $ref: '#/components/schemas/MinorLocationQoS' + directReportInd: + type: boolean + default: false + indoorOutdoorInd: + $ref: '#/components/schemas/IndoorOutdoorInd' + acceptedPeriodicEventInfo: + $ref: '#/components/schemas/PeriodicEventInfo' + haGnssMetrics: + $ref: '#/components/schemas/HighAccuracyGnssMetrics' + losNlosMeasureInd: + $ref: '#/components/schemas/LosNlosMeasureInd' + relatedApplicationlayerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationlayerId' + distanceDirection: + $ref: '#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: '#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: '#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: '#/components/schemas/VelocityEstimate' + rangingSlCapability: + $ref: '#/components/schemas/RangingSlCapability' + integrityResult: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/IntegrityResult' + + + GeographicArea: + description: Geographic area specified by different shape. + anyOf: + - $ref: '#/components/schemas/Point' + - $ref: '#/components/schemas/PointUncertaintyCircle' + - $ref: '#/components/schemas/PointUncertaintyEllipse' + - $ref: '#/components/schemas/Polygon' + - $ref: '#/components/schemas/PointAltitude' + - $ref: '#/components/schemas/PointAltitudeUncertainty' + - $ref: '#/components/schemas/EllipsoidArc' + + GADShape: + description: Common base type for GAD shapes. + type: object + required: + - shape + properties: + shape: + $ref: '#/components/schemas/SupportedGADShapes' + discriminator: + propertyName: shape + mapping: + POINT: '#/components/schemas/Point' + POINT_UNCERTAINTY_CIRCLE: '#/components/schemas/PointUncertaintyCircle' + POINT_UNCERTAINTY_ELLIPSE: '#/components/schemas/PointUncertaintyEllipse' + POLYGON: '#/components/schemas/Polygon' + POINT_ALTITUDE: '#/components/schemas/PointAltitude' + POINT_ALTITUDE_UNCERTAINTY: '#/components/schemas/PointAltitudeUncertainty' + ELLIPSOID_ARC: '#/components/schemas/EllipsoidArc' + LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE: '#/components/schemas/Local2dPointUncertaintyEllipse' + LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID: '#/components/schemas/Local3dPointUncertaintyEllipsoid' + + Point: + description: Ellipsoid Point. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + + PointUncertaintyCircle: + description: Ellipsoid point with uncertainty circle. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - uncertainty + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + uncertainty: + $ref: '#/components/schemas/Uncertainty' + + PointUncertaintyEllipse: + description: Ellipsoid point with uncertainty ellipse. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - uncertaintyEllipse + - confidence + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + uncertaintyEllipse: + $ref: '#/components/schemas/UncertaintyEllipse' + confidence: + $ref: '#/components/schemas/Confidence' + + Polygon: + description: Polygon. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - pointList + properties: + pointList: + $ref: '#/components/schemas/PointList' + + PointAltitude: + description: Ellipsoid point with altitude. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - altitude + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + altitude: + $ref: '#/components/schemas/Altitude' + + PointAltitudeUncertainty: + description: Ellipsoid point with altitude and uncertainty ellipsoid. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - altitude + - uncertaintyEllipse + - uncertaintyAltitude + - confidence + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + altitude: + $ref: '#/components/schemas/Altitude' + uncertaintyEllipse: + $ref: '#/components/schemas/UncertaintyEllipse' + uncertaintyAltitude: + $ref: '#/components/schemas/Uncertainty' + confidence: + $ref: '#/components/schemas/Confidence' + vConfidence: + $ref: '#/components/schemas/Confidence' + + EllipsoidArc: + description: Ellipsoid Arc. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - innerRadius + - uncertaintyRadius + - offsetAngle + - includedAngle + - confidence + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + innerRadius: + $ref: '#/components/schemas/InnerRadius' + uncertaintyRadius: + $ref: '#/components/schemas/Uncertainty' + offsetAngle: + $ref: '#/components/schemas/Angle' + includedAngle: + $ref: '#/components/schemas/Angle' + confidence: + $ref: '#/components/schemas/Confidence' + + LocalOrigin: + description: Indicates a Local origin in a reference system + type: object + required: + - coordinateId + properties: + coordinateId: + type: string + point: + $ref: '#/components/schemas/GeographicalCoordinates' + area: + $ref: '#/components/schemas/GeographicArea' + horizAxesOrientation: + $ref: '#/components/schemas/HorizAxesOrientation' + + RelativeCartesianLocation: + description: Relative Cartesian Location + type: object + required: + - x + - y + properties: + x: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + y: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + z: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + + + LocalArea: + description: Local area specified by different shape + oneOf: + - $ref: '#/components/schemas/Local2dPointUncertaintyEllipse' + - $ref: '#/components/schemas/Local3dPointUncertaintyEllipsoid' + + UeAreaIndication: + description: > + Indicates area (country, area in a country or international area) where UE is located + type: object + oneOf: + - required: + - country + - required: + - internationalAreaInd + properties: + country: + description: Indicates country or area in a country where UE is located + type: string + internationalAreaInd: + description: > + Indicates international area indication if UE is located in international area + type: boolean + default: false + + Local2dPointUncertaintyEllipse: + description: Local 2D point with uncertainty ellipse + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - localOrigin + - point + - uncertaintyEllipse + - confidence + properties: + localOrigin: + $ref: '#/components/schemas/LocalOrigin' + point: + $ref: '#/components/schemas/RelativeCartesianLocation' + uncertaintyEllipse: + $ref: '#/components/schemas/UncertaintyEllipse' + confidence: + $ref: '#/components/schemas/Confidence' + + Local3dPointUncertaintyEllipsoid: + description: Local 3D point with uncertainty ellipsoid + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - localOrigin + - point + - uncertaintyEllipsoid + - confidence + properties: + localOrigin: + $ref: '#/components/schemas/LocalOrigin' + point: + $ref: '#/components/schemas/RelativeCartesianLocation' + uncertaintyEllipsoid: + $ref: '#/components/schemas/UncertaintyEllipsoid' + confidence: + $ref: '#/components/schemas/Confidence' + vConfidence: + $ref: '#/components/schemas/Confidence' + + GeographicalCoordinates: + description: Geographical coordinates. + type: object + required: + - lon + - lat + properties: + lon: + type: number + format: double + minimum: -180 + maximum: 180 + lat: + type: number + format: double + minimum: -90 + maximum: 90 + + UncertaintyEllipse: + description: Ellipse with uncertainty. + type: object + required: + - semiMajor + - semiMinor + - orientationMajor + properties: + semiMajor: + $ref: '#/components/schemas/Uncertainty' + semiMinor: + $ref: '#/components/schemas/Uncertainty' + orientationMajor: + $ref: '#/components/schemas/Orientation' + + UncertaintyEllipsoid: + description: Ellipsoid with uncertainty + type: object + required: + - semiMajor + - semiMinor + - vertical + - orientationMajor + properties: + semiMajor: + $ref: '#/components/schemas/Uncertainty' + semiMinor: + $ref: '#/components/schemas/Uncertainty' + vertical: + $ref: '#/components/schemas/Uncertainty' + orientationMajor: + $ref: '#/components/schemas/Orientation' + + PointList: + description: List of points. + type: array + items: + $ref: '#/components/schemas/GeographicalCoordinates' + minItems: 3 + maxItems: 15 + + LocationQoS: + description: QoS of Location request. + type: object + properties: + hAccuracy: + $ref: '#/components/schemas/Accuracy' + vAccuracy: + $ref: '#/components/schemas/Accuracy' + verticalRequested: + type: boolean + responseTime: + $ref: '#/components/schemas/ResponseTime' + minorLocQoses: + type: array + items: + $ref: '#/components/schemas/MinorLocationQoS' + minItems: 1 + maxItems: 2 + lcsQosClass: + $ref: '#/components/schemas/LcsQosClass' + + PositioningMethodAndUsage: + description: Indicates the usage of a positioning method. + type: object + required: + - method + - mode + - usage + properties: + method: + $ref: '#/components/schemas/PositioningMethod' + mode: + $ref: '#/components/schemas/PositioningMode' + usage: + $ref: '#/components/schemas/Usage' + methodCode: + type: integer + minimum: 16 + maximum: 31 + + GnssPositioningMethodAndUsage: + description: > + Indicates the usage of a Global Navigation Satellite System (GNSS) positioning method. + type: object + required: + - mode + - gnss + - usage + properties: + mode: + $ref: '#/components/schemas/PositioningMode' + gnss: + $ref: '#/components/schemas/GnssId' + usage: + $ref: '#/components/schemas/Usage' + + CivicAddress: + description: Indicates a Civic address. + type: object + properties: + country: + type: string + A1: + type: string + A2: + type: string + A3: + type: string + A4: + type: string + A5: + type: string + A6: + type: string + PRD: + type: string + POD: + type: string + STS: + type: string + HNO: + type: string + HNS: + type: string + LMK: + type: string + LOC: + type: string + NAM: + type: string + PC: + type: string + BLD: + type: string + UNIT: + type: string + FLR: + type: string + ROOM: + type: string + PLC: + type: string + PCN: + type: string + POBOX: + type: string + ADDCODE: + type: string + SEAT: + type: string + RD: + type: string + RDSEC: + type: string + RDBR: + type: string + RDSUBBR: + type: string + PRM: + type: string + POM: + type: string + usageRules: + type: string + method: + type: string + providedBy: + type: string + + VelocityEstimate: + description: Velocity estimate. + anyOf: + - $ref: '#/components/schemas/HorizontalVelocity' + - $ref: '#/components/schemas/HorizontalWithVerticalVelocity' + - $ref: '#/components/schemas/HorizontalVelocityWithUncertainty' + - $ref: '#/components/schemas/HorizontalWithVerticalVelocityAndUncertainty' + + HorizontalVelocity: + description: Horizontal velocity. + type: object + required: + - hSpeed + - bearing + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + + HorizontalWithVerticalVelocity: + description: Horizontal and vertical velocity. + type: object + required: + - hSpeed + - bearing + - vSpeed + - vDirection + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + vSpeed: + $ref: '#/components/schemas/VerticalSpeed' + vDirection: + $ref: '#/components/schemas/VerticalDirection' + + HorizontalVelocityWithUncertainty: + description: Horizontal velocity with speed uncertainty. + type: object + required: + - hSpeed + - bearing + - hUncertainty + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + hUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + + HorizontalWithVerticalVelocityAndUncertainty: + description: Horizontal and vertical velocity with speed uncertainty. + type: object + required: + - hSpeed + - bearing + - vSpeed + - vDirection + - hUncertainty + - vUncertainty + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + vSpeed: + $ref: '#/components/schemas/VerticalSpeed' + vDirection: + $ref: '#/components/schemas/VerticalDirection' + hUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + vUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + + UeLcsCapability: + description: Indicates the LCS capability supported by the UE.. + type: object + properties: + lppSupport: + type: boolean + default: true + ciotOptimisation: + type: boolean + default: false + + PeriodicEventInfo: + description: Indicates the information of periodic event reporting. + type: object + required: + - reportingAmount + - reportingInterval + properties: + reportingAmount: + $ref: '#/components/schemas/ReportingAmount' + reportingInterval: + $ref: '#/components/schemas/ReportingInterval' + reportingInfiniteInd: + type: boolean + enum: + - true + reportingIntervalMs: + $ref: '#/components/schemas/ReportingIntervalMs' + + AreaEventInfo: + description: Indicates the information of area based event reporting. + type: object + required: + - areaDefinition + properties: + areaDefinition: + type: array + items: + $ref: '#/components/schemas/ReportingArea' + minItems: 1 + maxItems: 250 + occurrenceInfo: + $ref: '#/components/schemas/OccurrenceInfo' + minimumInterval: + $ref: '#/components/schemas/MinimumInterval' + maximumInterval: + $ref: '#/components/schemas/MaximumInterval' + samplingInterval: + $ref: '#/components/schemas/SamplingInterval' + reportingDuration: + $ref: '#/components/schemas/ReportingDuration' + reportingLocationReq: + type: boolean + default: true + + ReportingArea: + description: Indicates an area for event reporting. + type: object + required: + - areaType + properties: + areaType: + $ref: '#/components/schemas/ReportingAreaType' + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + + MotionEventInfo: + description: Indicates the information of motion based event reporting. + type: object + required: + - linearDistance + properties: + linearDistance: + $ref: '#/components/schemas/LinearDistance' + occurrenceInfo: + $ref: '#/components/schemas/OccurrenceInfo' + minimumInterval: + $ref: '#/components/schemas/MinimumInterval' + maximumInterval: + $ref: '#/components/schemas/MaximumInterval' + samplingInterval: + $ref: '#/components/schemas/SamplingInterval' + reportingDuration: + $ref: '#/components/schemas/ReportingDuration' + reportingLocationReq: + type: boolean + default: true + + CancelLocData: + description: Information within Cancel Location Request. + type: object + required: + - hgmlcCallBackURI + - ldrReference + properties: + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + LocContextData: + description: Information within Transfer Location Context Request. + type: object + required: + - amfId + - ldrType + - hgmlcCallBackURI + - ldrReference + - eventReportMessage + properties: + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + locationQoS: + $ref: '#/components/schemas/LocationQoS' + supportedGADShapes: + type: array + items: + $ref: '#/components/schemas/SupportedGADShapes' + minItems: 1 + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ldrType: + $ref: '#/components/schemas/LdrType' + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + periodicEventInfo: + $ref: '#/components/schemas/PeriodicEventInfo' + areaEventInfo: + $ref: '#/components/schemas/AreaEventInfo' + motionEventInfo: + $ref: '#/components/schemas/MotionEventInfo' + eventReportMessage: + $ref: '#/components/schemas/EventReportMessage' + eventReportingStatus: + $ref: '#/components/schemas/EventReportingStatus' + ueLocationInfo: + $ref: '#/components/schemas/UELocationInfo' + cIoT5GSOptimisation: + type: boolean + default: false + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + uePositioningCap: + $ref: '#/components/schemas/UePositioningCapabilities' + scheduledLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + indoorOutdoorInd: + $ref: '#/components/schemas/IndoorOutdoorInd' + losNlosMeasureInd: + $ref: '#/components/schemas/LosNlosMeasureInd' + upCumEvtRptCriteria: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpCumEvtRptCriteria' + + EventReportMessage: + description: Indicates an event report message. + type: object + required: + - eventClass + - eventContent + properties: + eventClass: + $ref: '#/components/schemas/EventClass' + eventContent: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + + EventReportingStatus: + description: Indicates the status of event reporting. + type: object + properties: + eventReportCounter: + $ref: '#/components/schemas/EventReportCounter' + eventReportDuration: + $ref: '#/components/schemas/EventReportDuration' + + UELocationInfo: + description: Indicates location information of a UE. + type: object + properties: + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + ageOfVelocityEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfVelocityEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + + EventNotifyDataExt: + description: Extended Event Notify Data for UEs + allOf: + - $ref: '#/components/schemas/EventNotifyData' + - $ref: '#/components/schemas/AddEventNotifyDatas' + + EventNotifyData: + description: Information within Event Notify Request. + type: object + required: + - reportedEventType + - ldrReference + properties: + reportedEventType: + $ref: '#/components/schemas/ReportedEventType' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + lirReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LirReference' + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + civicAddress: + $ref: '#/components/schemas/CivicAddress' + localLocationEstimate: + $ref: '#/components/schemas/LocalArea' + positioningDataList: + type: array + items: + $ref: '#/components/schemas/PositioningMethodAndUsage' + minItems: 1 + gnssPositioningDataList: + type: array + items: + $ref: '#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 1 + servingLMFidentification: + $ref: '#/components/schemas/LMFIdentification' + terminationCause: + $ref: '#/components/schemas/TerminationCause' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + altitude: + $ref: '#/components/schemas/Altitude' + achievedQos: + $ref: '#/components/schemas/MinorLocationQoS' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + indoorOutdoorInd: + $ref: '#/components/schemas/IndoorOutdoorInd' + haGnssMetrics: + $ref: '#/components/schemas/HighAccuracyGnssMetrics' + losNlosMeasureInd: + $ref: '#/components/schemas/LosNlosMeasureInd' + upLocRepStatAf: + type: integer + relatedApplicationlayerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationlayerId' + distanceDirection: + $ref: '#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: '#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: '#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: '#/components/schemas/VelocityEstimate' + integrityResult: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/IntegrityResult' + + + UeConnectivityState: + description: Indicates the connectivity state of a UE. + type: object + required: + - accessType + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + connectivitystate: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmState' + + MinorLocationQoS: + description: Contain Minor Location QoS. + type: object + properties: + hAccuracy: + $ref: '#/components/schemas/Accuracy' + vAccuracy: + $ref: '#/components/schemas/Accuracy' + + MbsrInfo: + description: MBSR Information + type: object + properties: + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + + + LocMeasurementReq: + description: Location Measurement Request. + type: object + properties: + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + preCalcuLocEstimate: + $ref: '#/components/schemas/GeographicArea' + timestampOfPreCalcuLocEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeWindows: + type: array + items: + $ref: '#/components/schemas/TimeWindow' + minItems: 1 + + LocMeasurementResp: + description: Location Measurement Response. + type: object + required: + - locMeasurements + properties: + locMeasurements: + type: array + items: + $ref: '#/components/schemas/LocMeasurements' + minItems: 1 + + LocMeasurements: + description: PRU Location Measurements. + type: object + properties: + locInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + HighAccuracyGnssMetrics: + description: High Accuracy GNSS Positioning Metrics. + type: object + properties: + nrOfUsedSatellites: + type: integer + minimum: 0 + maximum: 64 + hdopi: + type: integer + minimum: 1 + maximum: 256 + pdopi: + type: integer + minimum: 1 + maximum: 256 + age: + type: integer + minimum: 0 + maximum: 99 + fixType: + $ref: '#/components/schemas/FixType' + + UpNotifyData: + description: UP Subscription + type: object + required: + - notifCorrelationId + - upConnectionStatus + properties: + notifCorrelationId: + $ref: '#/components/schemas/CorrelationID' + upConnectionStatus: + $ref: '#/components/schemas/UpConnectionStatus' + targetLMFId: + $ref: '#/components/schemas/LMFIdentification' + + UpSubscription: + description: UP Subscription + type: object + required: + - upNotifyCallBackUri + - notifCorrelationId + - supi + properties: + upNotifyCallBackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrelationId: + $ref: '#/components/schemas/CorrelationID' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + + RelatedUe: + description: Related UE Information + type: object + required: + - applicationlayerId + - relatedUeType + properties: + applicationlayerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationlayerId' + relatedUeType: + $ref: '#/components/schemas/RelatedUeType' + + UpConfig: + description: UP Config + type: object + required: + - upNotifyCallBackUri + - notifCorrelationId + anyOf: + - required: [supi] + - required: [gpsi] + properties: + upNotifyCallBackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrelationId: + $ref: '#/components/schemas/CorrelationID' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + amfReallocationInd: + type: boolean + default: false + lcsUpConnectionInd: + $ref: '#/components/schemas/LcsUpConnectionInd' + targetLMFId: + $ref: '#/components/schemas/LMFIdentification' + + RangeDirection: + description: Represents a distance and direction from a point A to a point B. + type: object + properties: + distance: + type: number + azimuthDirection: + $ref: '#/components/schemas/Angle' + elevationDirection: + $ref: '#/components/schemas/Angle' + + 2DRelativeLocation: + description: Represents a relative 2D location with uncertainty ellipse. + type: object + properties: + semiMinor: + $ref: '#/components/schemas/Uncertainty' + semiMajor: + $ref: '#/components/schemas/Uncertainty' + orientationAngle: + $ref: '#/components/schemas/Angle' + + 3DRelativeLocation: + description: Represents a relative 3D location with uncertainty ellipsoid. + type: object + properties: + semiMinor: + $ref: '#/components/schemas/Uncertainty' + semiMajor: + $ref: '#/components/schemas/Uncertainty' + verticalUncertainty: + $ref: '#/components/schemas/Uncertainty' + orientationAngle: + $ref: '#/components/schemas/Angle' + + AddLocationDatas: + description: Additional Location Data. + type: object + properties: + addLocationDatas: + type: array + items: + $ref: '#/components/schemas/LocationData' + minItems: 1 + + AddEventNotifyDatas: + description: Additional Event Notify Data. + type: object + properties: + addEventNotifyDatas: + type: array + items: + $ref: '#/components/schemas/EventNotifyData' + minItems: 1 + + MappedLocationQoSEps: + description: Mapped Location QoS for EPS. + type: object + required: + - hAccuracy + properties: + hAccuracy: + $ref: '#/components/schemas/Accuracy' + vAccuracy: + $ref: '#/components/schemas/Accuracy' + + AdditionalUeInfo: + description: MBSR UE Information + type: object + properties: + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + + +# +# +# SIMPLE TYPES +# + Altitude: + description: Indicates value of altitude. + type: number + format: double + minimum: -32767 + maximum: 32767 + + Angle: + description: Indicates value of angle. + type: integer + minimum: 0 + maximum: 360 + + Uncertainty: + description: Indicates value of uncertainty. + type: number + format: float + minimum: 0 + + Orientation: + description: Indicates value of orientation angle. + type: integer + minimum: 0 + maximum: 180 + + HorizAxesOrientation: + description: Horizontal axes orientation angle clockwise from northing in 0.1 degrees. + type: integer + minimum: 0 + maximum: 3600 + + Confidence: + description: Indicates value of confidence. + type: integer + minimum: 0 + maximum: 100 + + Accuracy: + description: Indicates value of accuracy. + type: number + format: float + minimum: 0 + + InnerRadius: + description: Indicates value of the inner radius. + type: integer + format: int32 + minimum: 0 + maximum: 327675 + + CorrelationID: + description: LCS Correlation ID. + type: string + minLength: 1 + maxLength: 255 + + AgeOfLocationEstimate: + description: Indicates value of the age of the location estimate. + type: integer + minimum: 0 + maximum: 32767 + + HorizontalSpeed: + description: Indicates value of horizontal speed. + type: number + format: float + minimum: 0 + maximum: 2047 + + VerticalSpeed: + description: Indicates value of vertical speed. + type: number + format: float + minimum: 0 + maximum: 255 + + SpeedUncertainty: + description: Indicates value of speed uncertainty. + type: number + format: float + minimum: 0 + maximum: 255 + + BarometricPressure: + description: Specifies the measured uncompensated atmospheric pressure. + type: integer + minimum: 30000 + maximum: 115000 + + LcsServiceType: + description: LCS service type. + type: integer + minimum: 0 + maximum: 127 + + LdrReference: + description: LDR Reference. + type: string + minLength: 2 + maxLength: 510 + + LirReference: + description: LIR Reference. + type: string + minLength: 2 + maxLength: 510 + + ReportingAmount: + description: Number of required periodic event reports. + type: integer + minimum: 1 + maximum: 8639999 + + ReportingInterval: + description: Event reporting periodic interval in seconds. + type: integer + minimum: 1 + maximum: 8639999 + + ReportingIntervalMs: + description: Event reporting periodic interval in milliseconds. + type: integer + minimum: 1 + maximum: 999 + + MinimumInterval: + description: Minimum interval between event reports. + type: integer + minimum: 1 + maximum: 32767 + + MaximumInterval: + description: Maximum interval between event reports. + type: integer + minimum: 1 + maximum: 86400 + + SamplingInterval: + description: Maximum time interval between consecutive evaluations by a UE of a trigger event. + type: integer + minimum: 1 + maximum: 3600 + + ReportingDuration: + description: Maximum duration of event reporting. + type: integer + minimum: 1 + maximum: 8640000 + + LinearDistance: + description: Minimum straight line distance moved by a UE to trigger a motion event report. + type: integer + minimum: 1 + maximum: 10000 + + LMFIdentification: + description: LMF identification. + type: string + + EventReportCounter: + description: Number of event reports received from the target UE. + type: integer + minimum: 1 + maximum: 8640000 + + EventReportDuration: + description: Duration of event reporting. + type: integer + minimum: 1 + maximum: 8640000 + + UePositioningCapabilities: + description: > + Positioning capabilities supported by the UE. A string encoding the + "ProvideCapabilities-r9-IEs" IE as specified in clause 6.3 of 3GPP + TS 37.355 (start from octet 1). + type: string + format: byte + + TimeWindow: + description: Time Window. + type: string + format: byte + + RangingSlCapability: + description: Ranging/Sidelink Positioning Positioning capabilities supported by the UE. + type: string + format: byte + +# +# ENUMS +# + ExternalClientType: + description: Indicates types of External Clients. + anyOf: + - type: string + enum: + - EMERGENCY_SERVICES + - VALUE_ADDED_SERVICES + - PLMN_OPERATOR_SERVICES + - LAWFUL_INTERCEPT_SERVICES + - PLMN_OPERATOR_BROADCAST_SERVICES + - PLMN_OPERATOR_OM + - PLMN_OPERATOR_ANONYMOUS_STATISTICS + - PLMN_OPERATOR_TARGET_MS_SERVICE_SUPPORT + - SL_POS + - type: string + + SupportedGADShapes: + description: Indicates supported GAD shapes. + anyOf: + - type: string + enum: + - POINT + - POINT_UNCERTAINTY_CIRCLE + - POINT_UNCERTAINTY_ELLIPSE + - POLYGON + - POINT_ALTITUDE + - POINT_ALTITUDE_UNCERTAINTY + - ELLIPSOID_ARC + - LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE + - LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID + - DISTANCE_DIRECTION + - RELATIVE_2D_LOCATION_UNCERTAINTY_ELLIPSE + - RELATIVE_3D_LOCATION_UNCERTAINTY_ELLIPSOID + - type: string + + ResponseTime: + description: Indicates acceptable delay of location request. + anyOf: + - type: string + enum: + - LOW_DELAY + - DELAY_TOLERANT + - NO_DELAY + - type: string + + PositioningMethod: + description: Indicates supported positioning methods. + anyOf: + - type: string + enum: + - CELLID + - ECID + - OTDOA + - BAROMETRIC_PRESSURE + - WLAN + - BLUETOOTH + - MBS + - MOTION_SENSOR + - DL_TDOA + - DL_AOD + - MULTI-RTT + - NR_ECID + - UL_TDOA + - UL_AOA + - NETWORK_SPECIFIC + - SL_TDOA + - SL_TOA + - SL_AoA + - SL_RT + - type: string + + PositioningMode: + description: Indicates supported modes used for positioning method. + anyOf: + - type: string + enum: + - UE_BASED + - UE_ASSISTED + - CONVENTIONAL + - type: string + + GnssId: + description: Global Navigation Satellite System (GNSS) ID. + anyOf: + - type: string + enum: + - GPS + - GALILEO + - SBAS + - MODERNIZED_GPS + - QZSS + - GLONASS + - BDS + - NAVIC + - type: string + + Usage: + description: Indicates usage made of the location measurement. + anyOf: + - type: string + enum: + - UNSUCCESS + - SUCCESS_RESULTS_NOT_USED + - SUCCESS_RESULTS_USED_TO_VERIFY_LOCATION + - SUCCESS_RESULTS_USED_TO_GENERATE_LOCATION + - SUCCESS_METHOD_NOT_DETERMINED + - type: string + + LcsPriority: + description: Indicates priority of the LCS client. + anyOf: + - type: string + enum: + - HIGHEST_PRIORITY + - NORMAL_PRIORITY + - type: string + + VelocityRequested: + description: Indicates velocity requirement. + anyOf: + - type: string + enum: + - VELOCITY_IS_NOT_REQUESTED + - VELOCITY_IS_REQUESTED + - type: string + + AccuracyFulfilmentIndicator: + description: Indicates fulfilment of requested accuracy. + anyOf: + - type: string + enum: + - REQUESTED_ACCURACY_FULFILLED + - REQUESTED_ACCURACY_NOT_FULFILLED + - type: string + + VerticalDirection: + description: Indicates direction of vertical speed. + type: string + enum: + - UPWARD + - DOWNWARD + + LdrType: + description: Indicates LDR types. + anyOf: + - type: string + enum: + - UE_AVAILABLE + - PERIODIC + - ENTERING_INTO_AREA + - LEAVING_FROM_AREA + - BEING_INSIDE_AREA + - MOTION + - type: string + + ReportingAreaType: + description: Indicates type of event reporting area. + anyOf: + - type: string + enum: + - EPS_TRACKING_AREA_IDENTITY + - E-UTRAN_CELL_GLOBAL_IDENTIFICATION + - 5GS_TRACKING_AREA_IDENTITY + - NR_CELL_GLOBAL_IDENTITY + - type: string + + OccurrenceInfo: + description: Specifies occurrence of event reporting. + anyOf: + - type: string + enum: + - ONE_TIME_EVENT + - MULTIPLE_TIME_EVENT + - type: string + + ReportingAccessType: + description: Specifies access types of event reporting. + anyOf: + - type: string + enum: + - NR + - EUTRA_CONNECTED_TO_5GC + - NON_3GPP_CONNECTED_TO_5GC + - NR_LEO + - NR_MEO + - NR_GEO + - NR_OTHER_SAT + - EUTRA_CONNECTED_TO_EPC + - type: string + + EventClass: + description: Specifies event classes. + anyOf: + - type: string + enum: + - SUPPLEMENTARY_SERVICES + - type: string + + ReportedEventType: + description: Specifies type of event reporting. + anyOf: + - type: string + enum: + - PERIODIC_EVENT + - ENTERING_AREA_EVENT + - LEAVING_AREA_EVENT + - BEING_INSIDE_AREA_EVENT + - MOTION_EVENT + - MAXIMUM_INTERVAL_EXPIRATION_EVENT + - LOCATION_CANCELLATION_EVENT + - INTERMEDIATE_EVENT + - DIRECT_REPORT_EVENT + - CUMULATIVE_EVENT_REPORT + - type: string + + TerminationCause: + description: Specifies causes of event reporting termination. + anyOf: + - type: string + enum: + - TERMINATION_BY_UE + - TERMINATION_BY_NETWORK + - NORMAL_TERMINATION + - type: string + + LcsQosClass: + description: Specifies LCS QoS class. + anyOf: + - type: string + enum: + - BEST_EFFORT + - ASSURED + - MULTIPLE_QOS + - type: string + + UeLocationServiceInd: + description: Specifies location service types requested by UE. + anyOf: + - type: string + enum: + - LOCATION_ESTIMATE + - LOCATION_ASSISTANCE_DATA + - type: string + + IndoorOutdoorInd: + description: Specifies UE location indoor or outdoor. + anyOf: + - type: string + enum: + - INDOOR + - OUTDOOR + - type: string + + FixType: + description: Specifies the positioning fix type. + anyOf: + - type: string + enum: + - CARRIER_PHASE_FLOAT + - CARRIER_PHASE_FIX + - type: string + + LosNlosMeasureInd: + description: Specifies LOS measurement or NLOS measurement. + anyOf: + - type: string + enum: + - LOS + - NLOS + - type: string + + UpConnectionStatus: + description: UP Connection Status. + anyOf: + - type: string + enum: + - ESTABLISHED + - RELEASED + - MOVE + - type: string + + RangingSlResult: + description: Specifies the type of result requested for ranging and sidelink positioning. + anyOf: + - type: string + enum: + - ABSOLUTE_LOCATION + - RELATIVE_LOCATION + - RANGING_DIRECTION + - RANGING + - DIRECTION + - VELOCITY + - RELATIVE_VELOCITY + - type: string + + RelatedUeType: + description: Specifies the different roles of UE for ranging and sidelink positioning service. + anyOf: + - type: string + enum: + - LOCATED_UE + - REFERENCE_UE + - type: string + + LcsUpConnectionInd: + description: LCS UP Connection Indication. + anyOf: + - type: string + enum: + - TERMINATION + - SETUP + - type: string + + UeUpPositioningCapabilities: + description: User plane positioning capabilities supported by the UE. + anyOf: + - type: string + enum: + - LCS_UPP + - SUPL + - type: string + + SlPositioningCapability: + description: The Ranging and sidelink positioning capabilities supported by the UE. + anyOf: + - type: string + enum: + - V2X + - 5G_PROSE + - type: string -- GitLab From 8f69a8e59d7e1a518c4005a5d5e81184440a8df5 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 06:37:47 +0000 Subject: [PATCH 26/33] Upload New File --- OpenAPI/TS29554_Npcf_BDTPolicyControl.yaml | 441 +++++++++++++++++++++ 1 file changed, 441 insertions(+) create mode 100644 OpenAPI/TS29554_Npcf_BDTPolicyControl.yaml diff --git a/OpenAPI/TS29554_Npcf_BDTPolicyControl.yaml b/OpenAPI/TS29554_Npcf_BDTPolicyControl.yaml new file mode 100644 index 0000000..107bc83 --- /dev/null +++ b/OpenAPI/TS29554_Npcf_BDTPolicyControl.yaml @@ -0,0 +1,441 @@ +openapi: 3.0.0 + +info: + title: Npcf_BDTPolicyControl Service API + version: 1.3.0 + description: | + PCF BDT Policy Control Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.554 V18.3.0; 5G System; Background Data Transfer Policy Control Service. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.554/' + +servers: + - url: '{apiRoot}/npcf-bdtpolicycontrol/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - npcf-bdtpolicycontrol + +paths: + /bdtpolicies: + post: + summary: Create a new Individual BDT policy + operationId: CreateBDTPolicy + tags: + - BDT policies (Collection) + requestBody: + description: > + Contains information for the creation of a new Individual BDT policy resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BdtReqData' + responses: + '201': + description: Background data transfer policies offered to an ASP. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicy' + headers: + Location: + description: > + Contains the URI of the created individual BDT policy resource, + according to the structure + {apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtPolicyId} + required: true + schema: + type: string + '303': + description: > + See Other. The result of the POST request would be equivalent to the + existing Individual BDT policy resource. + headers: + Location: + description: Contains the URI of the existing individual BDT policy resource. + 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: + BdtNotification: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + responses: + '204': + description: No Content, a reception of the BDT 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' + + /bdtpolicies/{bdtPolicyId}: + get: + summary: Read an Individual BDT policy + operationId: GetBDTPolicy + tags: + - Individual BDT policy (Document) + parameters: + - name: bdtPolicyId + description: String identifying the individual BDT policy resource in the PCF. + in: path + required: true + schema: + type: string + responses: + '200': + description: Background data transfer policies offered to and selected by an ASP. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicy' + '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' + patch: + summary: Update an Individual BDT policy + operationId: UpdateBDTPolicy + tags: + - Individual BDT policy (Document) + parameters: + - name: bdtPolicyId + description: String identifying the individual BDT policy resource in the PCF. + in: path + required: true + schema: + type: string + requestBody: + description: > + Contains modification instruction to be performed on the BdtPolicy data + structure to select a transfer policy and in addition, may indicate whether + the BDT warning notification is enabled or disabled. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PatchBdtPolicy' + responses: + '200': + description: > + The Individual BDT Policy resource is modified and a representation of that + resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicy' + '204': + description: The Individual BDT Policy resource is modified. + '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' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcf-bdtpolicycontrol: Access to the Npcf_BDTPolicyControl API + + schemas: + +# Structured data types + + BdtPolicy: + description: Represents an Individual BDT policy resource. + type: object + properties: + bdtPolData: + $ref: '#/components/schemas/BdtPolicyData' + bdtReqData: + $ref: '#/components/schemas/BdtReqData' + + BdtReqData: + description: > + Contains service requirements for creation a new Individual BDT policy resource. + type: object + required: + - aspId + - desTimeInt + - numOfUes + - volPerUe + properties: + aspId: + $ref: '#/components/schemas/AspId' + desTimeInt: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nwAreaInfo: + $ref: '#/components/schemas/NetworkAreaInfo' + numOfUes: + description: Indicates a number of UEs. + type: integer + volPerUe: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + trafficDes: + $ref: 'TS29122_ResourceManagementOfBdt.yaml#/components/schemas/TrafficDescriptor' + warnNotifReq: + description: Indicates whether the BDT warning notification is enabled or disabled. + type: boolean + default: false + + BdtPolicyData: + description: Describes the authorization data of an Individual BDT policy resource. + type: object + required: + - bdtRefId + - transfPolicies + properties: + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + transfPolicies: + description: Contains transfer policies. + type: array + items: + $ref: '#/components/schemas/TransferPolicy' + minItems: 1 + selTransPolicyId: + description: Contains an identity of the selected transfer policy. + type: integer + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + PatchBdtPolicy: + description: > + Describes the updates in authorization data of an Individual BDT Policy created + by the PCF. + type: object + properties: + bdtPolData: + $ref: '#/components/schemas/BdtPolicyDataPatch' + bdtReqData: + $ref: '#/components/schemas/BdtReqDataPatch' + + BdtPolicyDataPatch: + description: > + A JSON Merge Patch body schema containing modification instruction to be performed + on the bdtPolData attribute of the BdtPolicy data structure to select a transfer + policy. Adds selTransPolicyId to BdtPolicyData data structure. + type: object + required: + - selTransPolicyId + properties: + selTransPolicyId: + description: > + Contains an identity (i.e. transPolicyId value) of the selected transfer + policy. If the BdtNotification_5G feature is supported value 0 indicates that + no transfer policy is selected. + type: integer + + BdtReqDataPatch: + description: > + A JSON Merge Patch body schema containing modification instruction to be performed + on the bdtReqData attribute of the BdtPolicy data structure to indicate whether + the BDT warning notification is enabled or disabled. Modifies warnNotifReq from + BdtReqData data structure. + type: object + properties: + warnNotifReq: + description: Indicates whether the BDT warning notification is enabled or disabled. + type: boolean + + TransferPolicy: + description: Describes a transfer policy. + type: object + required: + - ratingGroup + - recTimeInt + - transPolicyId + properties: + maxBitRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxBitRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ratingGroup: + description: Indicates a rating group for the recommended time window. + type: integer + recTimeInt: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + transPolicyId: + description: Contains an identity of a transfer policy. + type: integer + + NetworkAreaInfo: + description: > + Describes a network area information in which the NF service consumer requests + the number of UEs. + type: object + properties: + ecgis: + description: Contains a list of E-UTRA cell identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + minItems: 1 + ncgis: + description: Contains a list of NR cell identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + minItems: 1 + gRanNodeIds: + description: Contains a list of NG RAN nodes. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + tais: + description: Contains a list of tracking area identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + + Notification: + description: Describes a BDT notification. + type: object + required: + - bdtRefId + properties: + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + candPolicies: + description: > + Contains a list of the candidate transfer policies from which the AF may + select a new transfer policy due to a network performance is below the criteria + set by the operator. + type: array + items: + $ref: '#/components/schemas/TransferPolicy' + minItems: 1 + nwAreaInfo: + $ref: '#/components/schemas/NetworkAreaInfo' + timeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + +# Simple data types + + AspId: + description: Contains an identity of an application service provider. + type: string -- GitLab From e46e01a6dec969f40f7576c52337070d171f372b Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 06:38:06 +0000 Subject: [PATCH 27/33] Upload the YAML for cross reference compile --- OpenAPI/TS29518_Namf_Communication.yaml | 4605 +++++++++++++++++++++++ 1 file changed, 4605 insertions(+) create mode 100644 OpenAPI/TS29518_Namf_Communication.yaml diff --git a/OpenAPI/TS29518_Namf_Communication.yaml b/OpenAPI/TS29518_Namf_Communication.yaml new file mode 100644 index 0000000..32b9bf5 --- /dev/null +++ b/OpenAPI/TS29518_Namf_Communication.yaml @@ -0,0 +1,4605 @@ +openapi: 3.0.0 + +info: + version: 1.4.0-alpha.1 + title: Namf_Communication + description: | + AMF Communication Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +security: + - {} + - oAuth2ClientCredentials: + - namf-comm + +externalDocs: + description: 3GPP TS 29.518 V19.0.0; 5G System; Access and Mobility Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' + +servers: + - url: '{apiRoot}/namf-comm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + /ue-contexts/{ueContextId}: + put: + summary: Namf_Communication CreateUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: CreateUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextCreateData' + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + binaryDataN2InformationExt8: + type: string + format: binary + binaryDataN2InformationExt9: + type: string + format: binary + binaryDataN2InformationExt10: + type: string + format: binary + binaryDataN2InformationExt11: + type: string + format: binary + binaryDataN2InformationExt12: + type: string + format: binary + binaryDataN2InformationExt13: + type: string + format: binary + binaryDataN2InformationExt14: + type: string + format: binary + binaryDataN2InformationExt15: + type: string + format: binary + binaryDataN2InformationExt16: + type: string + format: binary + binaryDataN2InformationExt17: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt16: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt17: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + callbacks: + onN2MessageNotify: + '{$request.body#/n2NotifyUri}': + post: + summary: Namf_Communication N2 Info Notify (UE Specific) service Operation + tags: + - N2 Info Notify + operationId: N2InfoNotifyHandoverComplete + requestBody: + description: UE Specific N2 Information Notification + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationNotification' + responses: + '200': + description: N2 Information Notification Response. + content: + application/json: + schema: + $ref: '#/components/schemas/N2InfoNotificationRspData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/N2InfoNotificationRspData' + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + binaryDataN2InformationExt8: + type: string + format: binary + binaryDataN2InformationExt9: + type: string + format: binary + binaryDataN2InformationExt10: + type: string + format: binary + binaryDataN2InformationExt11: + type: string + format: binary + binaryDataN2InformationExt12: + type: string + format: binary + binaryDataN2InformationExt13: + type: string + format: binary + binaryDataN2InformationExt14: + type: string + format: binary + binaryDataN2InformationExt15: + type: string + format: binary + binaryDataN2InformationExt16: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt16: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '204': + description: Expected response to a successful callback processing + '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' + responses: + '201': + description: UE context successfully created. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/namf-comm//ue-contexts/{ueContextId} + required: true + schema: + type: string + 3gpp-Sbi-Producer-Id: + description: > + Indicating the AMF serving the UE Context. This header shall be included when the + UE Context is created in a target AMF other than the initial AMF sending the + response. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextCreatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextCreatedData' + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + binaryDataN2InformationExt8: + type: string + format: binary + binaryDataN2InformationExt9: + type: string + format: binary + binaryDataN2InformationExt10: + type: string + format: binary + binaryDataN2InformationExt11: + type: string + format: binary + binaryDataN2InformationExt12: + type: string + format: binary + binaryDataN2InformationExt13: + type: string + format: binary + binaryDataN2InformationExt14: + type: string + format: binary + binaryDataN2InformationExt15: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '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/UeContextCreateError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextCreateError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Response parts + jsonData: + $ref: '#/components/schemas/UeContextCreateError' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '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': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextCreateError' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + /ue-contexts/{ueContextId}/release: + post: + summary: Namf_Communication ReleaseUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: ReleaseUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UEContextRelease' + required: true + responses: + '204': + description: UE Context successfully released + '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: + description: Unexpected error + /ue-contexts/{ueContextId}/assign-ebi: + post: + summary: Namf_Communication EBI Assignment service Operation + tags: + - Individual ueContext (Document) + operationId: EBIAssignment + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:assign-ebi + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiData' + required: true + responses: + '200': + description: EBI Assignment successfully performed. + content: + application/json: + schema: + $ref: '#/components/schemas/AssignedEbiData' + '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/AssignEbiError' + application/problem+json: # error originated by an SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiError' + application/problem+json: # error originated by an SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiError' + '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': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/AssignEbiError' + application/problem+json: # error originated by an SCP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + /ue-contexts/{ueContextId}/transfer: + post: + summary: Namf_Communication UEContextTransfer service Operation + tags: + - Individual ueContext (Document) + operationId: UEContextTransfer + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextTransferReqData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextTransferReqData' + binaryDataN1Message: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: UE context transfer successfully initiated. + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextTransferRspData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextTransferRspData' + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '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: + description: Unexpected error + /ue-contexts/{ueContextId}/transfer-update: + post: + summary: Namf_Communication RegistrationStatusUpdate service Operation + tags: + - Individual ueContext (Document) + operationId: RegistrationStatusUpdate + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UeRegStatusUpdateReqData' + required: true + responses: + '200': + description: UE context transfer status successfully updated. + content: + application/json: + schema: + $ref: '#/components/schemas/UeRegStatusUpdateRspData' + '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' + /ue-contexts/{ueContextId}/relocate: + post: + summary: Namf_Communication RelocateUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: RelocateUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextRelocateData' + binaryDataForwardRelocationRequest: + type: string + format: binary + binaryDataN2Information: + type: string + format: binary + binaryDataN2InformationExt1: + type: string + format: binary + binaryDataN2InformationExt2: + type: string + format: binary + binaryDataN2InformationExt3: + type: string + format: binary + binaryDataN2InformationExt4: + type: string + format: binary + binaryDataN2InformationExt5: + type: string + format: binary + binaryDataN2InformationExt6: + type: string + format: binary + binaryDataN2InformationExt7: + type: string + format: binary + binaryDataN2InformationExt8: + type: string + format: binary + binaryDataN2InformationExt9: + type: string + format: binary + binaryDataN2InformationExt10: + type: string + format: binary + binaryDataN2InformationExt11: + type: string + format: binary + binaryDataN2InformationExt12: + type: string + format: binary + binaryDataN2InformationExt13: + type: string + format: binary + binaryDataN2InformationExt14: + type: string + format: binary + binaryDataN2InformationExt15: + type: string + format: binary + binaryDataN2InformationExt16: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataForwardRelocationRequest: + contentType: application/vnd.3gpp.gtpc + headers: + Content-Id: + schema: + type: string + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt11: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt12: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt13: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt14: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt15: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2InformationExt16: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + responses: + '201': + description: UE context successfully relocated. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-comm//ue-contexts/{ueContextId}/relocate' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextRelocatedData' + '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: + description: Unexpected error + /ue-contexts/{ueContextId}/cancel-relocate: + post: + summary: Namf_Communication CancelRelocateUEContext service Operation + tags: + - Individual ueContext (Document) + operationId: CancelRelocateUEContext + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:ue-contexts:mobility + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(5g-guti-[0-9]{5,6}[0-9a-fA-F]{14}|imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/UeContextCancelRelocateData' + binaryDataGtpcMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataGtpcMessage: + contentType: application/vnd.3gpp.gtpc + headers: + Content-Id: + schema: + type: string + required: true + responses: + '204': + description: UE Context successfully released + '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: + description: Unexpected error + /ue-contexts/{ueContextId}/n1-n2-messages: + post: + summary: Namf_Communication N1N2 Message Transfer (UE Specific) service Operation + tags: + - n1N2Message collection (Collection) + operationId: N1N2MessageTransfer + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:n1-n2-messages + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|cid-.{1,255}|.+)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferReqData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N1N2MessageTransferReqData' + binaryDataN1Message: + type: string + format: binary + binaryDataN2Information: + type: string + format: binary + binaryMtData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryMtData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + required: true + responses: + '202': + description: N1N2 Message Transfer accepted. + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferRspData' + headers: + Location: + description: > + The URI of the resource located on the AMF In this release, the URI shall only be + used by NF Service Consumer to correlate the possible N1/N2 Message Transfer Failure + Notification With the related N1/N2 Message Transfer Operation. The NF service + consumer shall not send any service requests towards the URI received in the + Location header. + required: true + schema: + type: string + '200': + description: N1N2 Message Transfer successfully initiated. + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferRspData' + '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' + '409': + description: Conflicts + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferError' + '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' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MessageTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + default: + description: Unexpected error + callbacks: + onN1N2TransferFailure: + '{$request.body#/n1n2FailureTxfNotifURI}': + post: + summary: Namf_Communication N1N2Transfer Failure Notification service Operation + tags: + - N1N2 Transfer Failure Notification + operationId: N1N2TransferFailureNotification + requestBody: + description: N1N2Transfer Failure Notification + content: + application/json: + schema: + $ref: '#/components/schemas/N1N2MsgTxfrFailureNotification' + responses: + '204': + description: Expected response to a successful callback processing + '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' + /ue-contexts/{ueContextId}/n1-n2-messages/subscriptions: + post: + summary: Namf_Communication N1N2 Message Subscribe (UE Specific) service Operation + tags: + - N1N2 Subscriptions Collection for Individual UE Contexts (Collection) + operationId: N1N2MessageSubscribe + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:n1-n2-messages + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UeN1N2InfoSubscriptionCreateData' + required: true + responses: + '201': + description: N1N2 Message Subscription successfully created. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-comm//ue-contexts/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UeN1N2InfoSubscriptionCreatedData' + '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: + description: Unexpected error + callbacks: + onN1N2MessageNotify: + '{$request.body#/n1NotifyCallbackUri}': + post: + summary: Namf_Communication N1 Message Notify service Operation + tags: + - N1 Message Notify + operationId: N1MessageNotify + requestBody: + description: N1 Message Notification + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N1MessageNotification' + binaryDataN1Message: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: Expected response to a successful callback processing + '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' + '{$request.body#/n2NotifyCallbackUri}': + post: + summary: Namf_Communication N2 Info Notify (UE Specific) service Operation + tags: + - N2 Info Notify + operationId: N2InfoNotify + requestBody: + description: UE Specific N2 Information Notification + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N2InformationNotification' + binaryDataN1Message: + type: string + format: binary + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1Message: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: Expected response to a successful callback processing + '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' + /ue-contexts/{ueContextId}/n1-n2-messages/subscriptions/{subscriptionId}: + delete: + summary: Namf_Communication N1N2 Message UnSubscribe (UE Specific) service Operation + tags: + - N1N2 Individual Subscription (Document) + operationId: N1N2MessageUnSubscribe + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:n1-n2-messages + parameters: + - name: ueContextId + in: path + description: UE Context Identifier + required: true + schema: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$' + - name: subscriptionId + in: path + description: Subscription Identifier + required: true + schema: + type: string + responses: + '204': + description: N1N2 Message Subscription successfully removed. + '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' + /non-ue-n2-messages/transfer: + post: + summary: Namf_Communication Non UE N2 Message Transfer service Operation + tags: + - Non UE N2Messages collection (Collection) + operationId: NonUeN2MessageTransfer + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:non-ue-n2-messages + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferReqData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N2InformationTransferReqData' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: Non UE N2 Message Transfer successfully initiated. + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferRspData' + multipart/related: # response with binary body part(s) + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/N2InformationTransferRspData' + binaryDataN2Information1: + type: string + format: binary + binaryDataN2Information2: + type: string + format: binary + binaryDataN2Information3: + type: string + format: binary + binaryDataN2Information4: + type: string + format: binary + binaryDataN2Information5: + type: string + format: binary + binaryDataN2Information6: + type: string + format: binary + binaryDataN2Information7: + type: string + format: binary + binaryDataN2Information8: + type: string + format: binary + binaryDataN2Information9: + type: string + format: binary + binaryDataN2Information10: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + '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/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + '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': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + description: Service Unavailable + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationTransferError' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + default: + description: Unexpected error + /non-ue-n2-messages/subscriptions: + post: + summary: Namf_Communication Non UE N2 Info Subscribe service Operation + tags: + - Non UE N2Messages Subscriptions collection (Collection) + operationId: NonUeN2InfoSubscribe + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:non-ue-n2-messages + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NonUeN2InfoSubscriptionCreateData' + required: true + responses: + '201': + description: Non UE N2 Info Subscription successfully created. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-comm//non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NonUeN2InfoSubscriptionCreatedData' + '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: + description: Unexpected error + callbacks: + onN2InfoNotify: + '{$request.body#/n2NotifyCallbackUri}': + post: + summary: Namf_Communication Non UE N2 Info Notify service Operation + tags: + - Non UE N2 Info Notify + operationId: NonUeN2InfoNotify + requestBody: + description: Non UE N2 Information Notification + content: + application/json: + schema: + $ref: '#/components/schemas/N2InformationNotification' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/N2InformationNotification' + binaryDataN2Information1: + type: string + format: binary + binaryDataN2Information2: + type: string + format: binary + binaryDataN2Information3: + type: string + format: binary + binaryDataN2Information4: + type: string + format: binary + binaryDataN2Information5: + type: string + format: binary + binaryDataN2Information6: + type: string + format: binary + binaryDataN2Information7: + type: string + format: binary + binaryDataN2Information8: + type: string + format: binary + binaryDataN2Information9: + type: string + format: binary + binaryDataN2Information10: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information2: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information3: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information4: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information5: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information6: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information7: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information8: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information9: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2Information10: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: Expected response to a successful callback processing + '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' + /non-ue-n2-messages/subscriptions/{n2NotifySubscriptionId}: + delete: + summary: Namf_Communication Non UE N2 Info UnSubscribe service Operation + tags: + - Non UE N2 Message Notification Individual Subscription (Document) + operationId: NonUeN2InfoUnSubscribe + security: + - {} + - oAuth2ClientCredentials: + - namf-comm + - oAuth2ClientCredentials: + - namf-comm + - namf-comm:non-ue-n2-messages + parameters: + - name: n2NotifySubscriptionId + in: path + description: N2 info Subscription Identifier + required: true + schema: + type: string + responses: + '204': + description: Non UE N2 INfo Subscription successfully removed. + '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' + /subscriptions: + post: + summary: Namf_Communication AMF Status Change Subscribe service Operation + tags: + - subscriptions collection (Collection) + operationId: AMFStatusChangeSubscribe + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true + responses: + '201': + description: N1N2 Message Subscription successfully created. + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-comm//subscriptions/{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + '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: + description: Unexpected error + callbacks: + onAmfStatusChange: + '{$request.body#/amfStatusUri}': + post: + summary: Amf Status Change Notify service Operation + tags: + - Amf Status Change Notify + operationId: AmfStatusChangeNotify + requestBody: + description: Amf Status Change Notification + content: + application/json: + schema: + $ref: '#/components/schemas/AmfStatusChangeNotification' + responses: + '204': + description: Expected response to a successful callback processing + '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' + /subscriptions/{subscriptionId}: + delete: + summary: Namf_Communication AMF Status Change UnSubscribe service Operation + tags: + - individual subscription (Document) + operationId: AMFStatusChangeUnSubscribe + parameters: + - name: subscriptionId + in: path + description: AMF Status Change Subscription Identifier + required: true + schema: + type: string + responses: + '204': + description: N1N2 Message Subscription successfully removed. + '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: + description: Unexpected error + put: + summary: Namf_Communication AMF Status Change Subscribe Modify service Operation + tags: + - individual subscription (Document) + operationId: AMFStatusChangeSubscribeModfy + parameters: + - name: subscriptionId + in: path + description: AMF Status Change Subscription Identifier + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true + responses: + '200': + description: Subscription modified successfully + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + '204': + description: Events subscription modification is accepted entirely + '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: + description: Unexpected error + callbacks: + OnAmfStatusChange: + '{$request.body#/amfStatusUri}': + post: + summary: Amf Status Change Notify service Operation + tags: + - Amf Status Change Notify + operationId: AmfStatusChangeNOtify + requestBody: + description: Amf Status Change Notification + content: + application/json: + schema: + $ref: '#/components/schemas/AmfStatusChangeNotification' + responses: + '204': + description: Expected response to a successful callback processing + '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' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + namf-comm: Access to the Namf_Communication API + namf-comm:ue-contexts:mobility: > + Access to service operations applying to UE context resources, i.e., + UEContextTransfer, RegistrationStatusUpdate, CreateUEContext, ReleaseUEContext, + RelocateUEContext, and CancelRelocateUEContext. + namf-comm:ue-contexts:assign-ebi: > + Access to service operations applying to UE context resources for EBI assignment, + i.e., EBIAssignment. + namf-comm:n1-n2-messages: > + Access to service operations applying to n1-n2-messages resources, i.e., + N1N2MessageSubscribe, N1N2MessageUnSubscribe, N1N2MessageTransfer, N1MessageNotify and + N2InfoNotify + namf-comm:non-ue-n2-messages: > + Access to service operations applying to the non-ue-n2-messages resources, i.e., + NonUeN2MessageTransfer, NonUeN2InfoSubscribe, NonUeN2InfoUnSubscribe, and + NonUeN2InfoNotify + schemas: +# +# STRUCTURED DATA TYPES +# + SubscriptionData: + description: Data within an AMF Status Change Subscription request and response + type: object + properties: + amfStatusUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + required: + - amfStatusUri + AmfStatusChangeNotification: + description: Data within an AMF Status Change Notification request + type: object + properties: + amfStatusInfoList: + type: array + items: + $ref: '#/components/schemas/AmfStatusInfo' + minItems: 1 + required: + - amfStatusInfoList + AmfStatusInfo: + description: AMF Status Information + type: object + properties: + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + statusChange: + $ref: '#/components/schemas/StatusChange' + targetAmfRemoval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + targetAmfFailure: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + required: + - guamiList + - statusChange + AssignEbiData: + description: Data within an EBI assignment request + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + arpList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + releasedEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + modifiedEbiList: + type: array + items: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/EbiArpMapping' + minItems: 1 + required: + - pduSessionId + AssignedEbiData: + description: Data within a successful response to an EBI assignment request + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + assignedEbiList: + type: array + items: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/EbiArpMapping' + minItems: 0 + failedArpList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + releasedEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + modifiedEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + required: + - pduSessionId + - assignedEbiList + AssignEbiFailed: + description: Represents failed assignment of EBI(s) + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + failedArpList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + required: + - pduSessionId + UEContextRelease: + description: Data within a Release UE Context request + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + unauthenticatedSupi: + type: boolean + default: false + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + required: + - ngapCause + N2InformationTransferReqData: + description: Data within a N2 Information Transfer request containing the N2 information requested to be transferred to 5G AN + type: object + properties: + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + ratSelector: + $ref: '#/components/schemas/RatSelector' + globalRanNodeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + n2Information: + $ref: '#/components/schemas/N2InfoContainer' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - n2Information + NonUeN2InfoSubscriptionCreateData: + description: Data within a create subscription request for non-UE specific N2 information notification + type: object + properties: + globalRanNodeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + anTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' + n2NotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + notifCorrelationId: + type: string + required: + - n2InformationClass + - n2NotifyCallbackUri + NonUeN2InfoSubscriptionCreatedData: + description: Data for the created subscription for non-UE specific N2 information notification + type: object + properties: + n2NotifySubscriptionId: + type: string + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' + required: + - n2NotifySubscriptionId + UeN1N2InfoSubscriptionCreateData: + description: Data within a create subscription request for UE specific N1 and/or N2 information notification + type: object + properties: + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' + n2NotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + n1MessageClass: + $ref: '#/components/schemas/N1MessageClass' + n1NotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + UeN1N2InfoSubscriptionCreatedData: + description: Data for the created subscription for UE specific N1 and/or N2 information notification + type: object + properties: + n1n2NotifySubscriptionId: + type: string + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - n1n2NotifySubscriptionId + N2InformationNotification: + description: Data within a N2 information notification request + type: object + properties: + n2NotifySubscriptionId: + type: string + n2InfoContainer: + $ref: '#/components/schemas/N2InfoContainer' + toReleaseSessionList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + lcsCorrelationId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CorrelationID' + notifyReason: + $ref: '#/components/schemas/N2InfoNotifyReason' + smfChangeInfoList: + type: array + items: + $ref: '#/components/schemas/SmfChangeInfo' + minItems: 1 + ranNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + initialAmfName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + anN2IPv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + anN2IPv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + notifySourceNgRan: + type: boolean + default: false + notifCorrelationId: + type: string + toReleaseSessionInfo: + type: array + items: + $ref: '#/components/schemas/ReleaseSessionInfo' + minItems: 1 + required: + - n2NotifySubscriptionId + + N2InfoContainer: + description: N2 information container + type: object + properties: + n2InformationClass: + $ref: '#/components/schemas/N2InformationClass' + smInfo: + $ref: '#/components/schemas/N2SmInformation' + ranInfo: + $ref: '#/components/schemas/N2RanInformation' + nrppaInfo: + $ref: '#/components/schemas/NrppaInformation' + pwsInfo: + $ref: '#/components/schemas/PwsInformation' + v2xInfo: + $ref: '#/components/schemas/V2xInformation' + proseInfo: + $ref: '#/components/schemas/ProSeInformation' + tssInfo: + $ref: '#/components/schemas/TssInformation' + rslpInfo: + $ref: '#/components/schemas/RslpInformation' + a2xInfo: + $ref: '#/components/schemas/A2xInformation' + required: + - n2InformationClass + N1MessageNotification: + description: Data within a N1 message notification request + type: object + properties: + n1NotifySubscriptionId: + type: string + n1MessageContainer: + $ref: '#/components/schemas/N1MessageContainer' + lcsCorrelationId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CorrelationID' + registrationCtxtContainer: + $ref: '#/components/schemas/RegistrationContextContainer' + newLmfIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + cIoT5GSOptimisation: + type: boolean + default: false + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + pruInd: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/PruInd' + required: + - n1MessageContainer + N1MessageContainer: + description: N1 Message container + type: object + properties: + n1MessageClass: + $ref: '#/components/schemas/N1MessageClass' + n1MessageContent: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + serviceInstanceId: + type: string + required: + - n1MessageClass + - n1MessageContent + N1N2MessageTransferReqData: + description: Data within a N1/N2 message transfer request + type: object + properties: + n1MessageContainer: + $ref: '#/components/schemas/N1MessageContainer' + n2InfoContainer: + $ref: '#/components/schemas/N2InfoContainer' + mtData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + skipInd: + type: boolean + default: false + lastMsgIndication: + type: boolean + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + lcsCorrelationId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CorrelationID' + ppi: + $ref: '#/components/schemas/Ppi' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + n1n2FailureTxfNotifURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smfReallocationInd: + type: boolean + default: false + areaOfValidity: + $ref: '#/components/schemas/AreaOfValidity' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oldGuami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + maAcceptedInd: + type: boolean + default: false + extBufSupport: + type: boolean + default: false + targetAccess: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pruInd: + type: boolean + enum: + - true + + + + N1N2MessageTransferRspData: + description: Data within a N1/N2 message transfer response + type: object + properties: + cause: + $ref: '#/components/schemas/N1N2MessageTransferCause' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - cause + RegistrationContextContainer: + description: Registration Context Container used to send the UE context information, N1 message from UE, AN address etc during Registration with AMF re-allocation procedure + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + localTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + anN2ApId: + type: integer + ranNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + initialAmfName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + userLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + rrcEstCause: + type: string + pattern: '^[0-9a-fA-F]+$' + ueContextRequest: + type: boolean + default: false + initialAmfN2ApId: + type: integer + anN2IPv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + anN2IPv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + allowedNssai: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/AllowedNssai' + configuredNssai: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/ConfiguredSnssai' + minItems: 1 + rejectedNssaiInPlmn: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + rejectedNssaiInTa: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + selectedPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + iabNodeInd: + type: boolean + default: false + mbsrNodeInd: + type: boolean + default: false + ceModeBInd: + $ref: '#/components/schemas/CeModeBInd' + lteMInd: + $ref: '#/components/schemas/LteMInd' + authenticatedInd: + type: boolean + default: false + npnAccessInfo: + $ref: '#/components/schemas/NpnAccessInfo' + required: + - ueContext + - anType + - anN2ApId + - ranNodeId + - initialAmfName + - userLocation + + AreaOfValidity: + description: Area of validity information for N2 information transfer + type: object + properties: + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 0 + taiRangeList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TaiRange' + minItems: 1 + required: + - taiList + UeContextTransferReqData: + description: Data within a UE Context Transfer Request to start transferring of an individual ueContext resource from old AMF to new AMF + type: object + properties: + reason: + $ref: '#/components/schemas/TransferReason' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + regRequest: + $ref: '#/components/schemas/N1MessageContainer' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - reason + - accessType + UeContextTransferRspData: + description: Data within a successful response to the UE Context Transfer request + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + ueRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + ueRadioCapabilityForPaging: + $ref: '#/components/schemas/N2InfoContent' + ueNbiotRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + xrDeviceWith2Rx: + $ref: '#/components/schemas/XrDeviceWith2Rx' + required: + - ueContext + + UeContext: + description: Represents an individual ueContext resource + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + supiUnauthInd: + type: boolean + gpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + ausfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + routingIndicator: + type: string + hNwPubKeyId: + type: integer + groupList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + drxParameter: + $ref: '#/components/schemas/DrxParameter' + subRfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + pcfRfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + usedRfsp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndex' + subUeAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + pcfUeAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + subUeSliceMbrList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbr' + minProperties: 1 + description: A map(list of key-value pairs) where Snssai serves as key. + smsfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + seafData: + $ref: '#/components/schemas/SeafData' + 5gMmCapability: + $ref: '#/components/schemas/5GMmCapability' + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + pcfAmpServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + pcfUepServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + pcfBinding: + $ref: '#/components/schemas/SbiBindingLevel' + pcfAmPolicyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + amPolicyReqTriggerList: + type: array + items: + $ref: '#/components/schemas/PolicyReqTrigger' + minItems: 1 + pcfUePolicyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + uePolicyReqTriggerList: + type: array + items: + $ref: '#/components/schemas/PolicyReqTrigger' + minItems: 1 + hpcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + hpcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + restrictedRatList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + forbiddenAreaList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Area' + minItems: 1 + serviceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' + restrictedCoreNwTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CoreNetworkType' + minItems: 1 + eventSubscriptionList: + type: array + items: + $ref: '#/components/schemas/ExtAmfEventSubscription' + minItems: 1 + mmContextList: + type: array + items: + $ref: '#/components/schemas/MmContext' + minItems: 1 + maxItems: 2 + sessionContextList: + type: array + items: + $ref: '#/components/schemas/PduSessionContext' + minItems: 1 + epsInterworkingInfo: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/EpsInterworkingInfo' + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + serviceGapExpiryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + stnSr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StnSr' + cMsisdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CMsisdn' + msClassmark2: + $ref: '#/components/schemas/MSClassmark2' + supportedCodecList: + type: array + items: + $ref: '#/components/schemas/SupportedCodec' + minItems: 1 + smallDataRateStatusInfos: + type: array + items: + $ref: '#/components/schemas/SmallDataRateStatusInfo' + minItems: 1 + restrictedPrimaryRatList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + restrictedSecondaryRatList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + v2xContext: + $ref: '#/components/schemas/V2xContext' + lteCatMInd: + type: boolean + default: false + redCapInd: + type: boolean + default: false + eRedCapInd: + type: boolean + default: false + moExpDataCounter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter' + cagData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/CagData' + managementMdtInd: + type: boolean + default: false + adjacenPlmnMngtMdtInds: + description: A map (list of key-value pairs where PlmnId serves as key) of Booleans + type: object + additionalProperties: + type: boolean + minProperties: 1 + immediateMdtConf: + $ref: '#/components/schemas/ImmediateMdtConf' + ecRestrictionDataWb: + $ref: '#/components/schemas/EcRestrictionDataWb' + ecRestrictionDataNb: + type: boolean + default: false + iabOperationAllowed: + type: boolean + proseContext: + $ref: '#/components/schemas/ProseContext' + analyticsSubscriptionList: + type: array + items: + $ref: '#/components/schemas/AnalyticsSubscription' + minItems: 1 + pcfAmpBindingInfo: + type: string + pcfUepBindingInfo: + type: string + usedServiceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' + praInAmPolicy: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: A map(list of key-value pairs) where praId serves as key. + praInUePolicy: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: A map(list of key-value pairs) where praId serves as key. + updpSubscriptionData: + $ref: '#/components/schemas/UpdpSubscriptionData' + smPolicyNotifyPduList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + minItems: 1 + pcfUeCallbackInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + uePositioningCap: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/UePositioningCapabilities' + astiDistributionIndication: + type: boolean + default: false + tsErrorBudget: + type: integer + snpnOnboardInd: + type: boolean + default: false + smfSelInfo: + $ref: 'TS29507_Npcf_AMPolicyControl.yaml#/components/schemas/SmfSelectionData' + pcfUeSliceMbrList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbr' + minProperties: 1 + description: A map(list of key-value pairs) where Snssai serves as key. + smsfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + smsfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + smsfBindingInfo: + type: string + disasterRoamingInd: + type: boolean + default: false + disasterPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + wlServAreaRes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WirelineServiceAreaRestriction' + asTimeDisParam: + $ref: 'TS29507_Npcf_AMPolicyControl.yaml#/components/schemas/AsTimeDistributionParam' + amPolicyInfoContainer: + $ref: '#/components/schemas/AmPolicyInfoContainer' + a2xContext: + $ref: '#/components/schemas/A2xContext' + mbsrOperationAllowed: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/MbsrOperationAllowed' + lcsUpContext: + $ref: '#/components/schemas/LcsUpContext' + reconnectInd: + type: boolean + default: false + uePolicyContainer: + $ref: '#/components/schemas/UePolicyContainer' + amPolicyInd: + type: boolean + uePolicyInd: + type: boolean + + + + + N2SmInformation: + description: Represents the session management SMF related N2 information data part + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + n2InfoContent: + $ref: '#/components/schemas/N2InfoContent' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + homePlmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + iwkSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + subjectToHo: + type: boolean + required: + - pduSessionId + N2InfoContent: + description: Represents a transparent N2 information content to be relayed by AMF + type: object + properties: + ngapMessageType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + ngapIeType: + $ref: '#/components/schemas/NgapIeType' + ngapData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + required: + - ngapData + NrppaInformation: + description: Represents a NRPPa related N2 information data part + type: object + properties: + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nrppaPdu: + $ref: '#/components/schemas/N2InfoContent' + serviceInstanceId: + type: string + required: + - nfId + - nrppaPdu + PwsInformation: + description: Represents a PWS related information data part + type: object + properties: + messageIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + serialNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + pwsContainer: + $ref: '#/components/schemas/N2InfoContent' + bcEmptyAreaList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + sendRanResponse: + type: boolean + default: false + omcId: + $ref: '#/components/schemas/OmcIdentifier' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + required: + - messageIdentifier + - serialNumber + - pwsContainer + N1N2MsgTxfrFailureNotification: + description: Data within a N1/N2 Message Transfer Failure Notification request + type: object + properties: + cause: + $ref: '#/components/schemas/N1N2MessageTransferCause' + n1n2MsgDataUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + + required: + - cause + - n1n2MsgDataUri + N1N2MessageTransferError: + description: Data within a N1/N2 Message Transfer Error response + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + errInfo: + $ref: '#/components/schemas/N1N2MsgTxfrErrDetail' + required: + - error + N1N2MsgTxfrErrDetail: + description: N1/N2 Message Transfer Error Details + type: object + properties: + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + highestPrioArp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + maxWaitingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + N2InformationTransferRspData: + description: Data within a successful response to the N2 Information Transfer request to transfer N2 Information to the AN + type: object + properties: + result: + $ref: '#/components/schemas/N2InformationTransferResult' + pwsRspData: + $ref: '#/components/schemas/PWSResponseData' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + tssRspPerNgranList: + type: array + items: + $ref: '#/components/schemas/TssRspPerNgran' + minItems: 1 + maxItems: 10 + required: + - result + MmContext: + description: Represents a Mobility Management Context in UE Context + type: object + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + nasSecurityMode: + $ref: '#/components/schemas/NasSecurityMode' + epsNasSecurityMode: + $ref: '#/components/schemas/EpsNasSecurityMode' + nasDownlinkCount: + $ref: '#/components/schemas/NasCount' + nasUplinkCount: + $ref: '#/components/schemas/NasCount' + ueSecurityCapability: + $ref: '#/components/schemas/UeSecurityCapability' + s1UeNetworkCapability: + $ref: '#/components/schemas/S1UeNetworkCapability' + allowedNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + nssaiMappingList: + type: array + items: + $ref: '#/components/schemas/NssaiMapping' + minItems: 1 + allowedHomeNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + partiallyAllowedNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartiallyAllowedSnssai' + minItems: 1 + replacedSnssaiMappingList: + type: array + items: + $ref: '#/components/schemas/SliceReplacementMapping' + minItems: 1 + nsInstanceList: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' + minItems: 1 + expectedUEbehavior: + $ref: '#/components/schemas/ExpectedUeBehavior' + ueDifferentiationInfo: + $ref: '#/components/schemas/UeDifferentiationInfo' + plmnAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId' + manAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ManAssiUeRadioCapId' + ucmfDicEntryId: + type: string + n3IwfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + wagfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + tngfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + anN2ApId: + type: integer + nssaaStatusList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NssaaStatus' + minItems: 1 + pendingNssaiMappingList: + type: array + items: + $ref: '#/components/schemas/NssaiMapping' + minItems: 1 + uuaaMmStatus: + $ref: '#/components/schemas/UuaaMmStatus' + deregInactTimerList: + description: The S-NSSAI shall be used as the key of the map. + type: object + additionalProperties: + $ref: '#/components/schemas/DeregInactTimerInfo' + voSupportMatchInd: + type: boolean + required: + - accessType + SeafData: + description: Represents SEAF data derived from data received from AUSF + type: object + properties: + ngKsi: + $ref: '#/components/schemas/NgKsi' + keyAmf: + $ref: '#/components/schemas/KeyAmf' + nh: + type: string + pattern: '^[A-Fa-f0-9]+$' + ncc: + type: integer + minimum: 0 + maximum: 7 + keyAmfChangeInd: + type: boolean + keyAmfHDerivationInd: + type: boolean + required: + - ngKsi + - keyAmf + NasSecurityMode: + description: Indicates the NAS Security Mode + type: object + properties: + integrityAlgorithm: + $ref: '#/components/schemas/IntegrityAlgorithm' + cipheringAlgorithm: + $ref: '#/components/schemas/CipheringAlgorithm' + required: + - integrityAlgorithm + - cipheringAlgorithm + PduSessionContext: + description: Represents a PDU Session Context in UE Context + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + smContextRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + selectedDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + additionalAccessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + allocatedEbiList: + type: array + items: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/EbiArpMapping' + minItems: 1 + hsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + hsmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + hsmfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + smfBinding: + $ref: '#/components/schemas/SbiBindingLevel' + vsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + vsmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + vsmfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + vsmfBinding: + $ref: '#/components/schemas/SbiBindingLevel' + ismfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ismfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + ismfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + ismfBinding: + $ref: '#/components/schemas/SbiBindingLevel' + nsInstance: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' + smfServiceInstanceId: + type: string + maPduSession: + type: boolean + default: false + cnAssistedRanPara: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/CnAssistedRanPara' + nrfManagementUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nrfDiscoveryUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nrfAccessTokenUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smfBindingInfo: + type: string + vsmfBindingInfo: + type: string + ismfBindingInfo: + type: string + additionalSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altAdditionalSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pgwIpAddr: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + anchorSmfSupportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + anchorSmfOauth2Required: + type: boolean + hrsboAllowedInd: + type: boolean + required: + - pduSessionId + - smContextRef + - sNssai + - dnn + - accessType + NssaiMapping: + description: Represents the mapping between a S-NSSAI in serving PLMN to a S-NSSAI in home PLMN + type: object + properties: + mappedSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + hSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - mappedSnssai + - hSnssai + UeRegStatusUpdateReqData: + description: Data within a UE registration status update request to indicate a completion of transferring at a target AMF + type: object + properties: + transferStatus: + $ref: '#/components/schemas/UeContextTransferStatus' + toReleaseSessionList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + pcfReselectedInd: + type: boolean + smfChangeInfoList: + type: array + items: + $ref: '#/components/schemas/SmfChangeInfo' + minItems: 1 + analyticsNotUsedList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + toReleaseSessionInfo: + type: array + items: + $ref: '#/components/schemas/ReleaseSessionInfo' + minItems: 1 + required: + - transferStatus + UeRegStatusUpdateRspData: + description: Data within a UE registration status update response to provide the status of UE context transfer status update at a source AMF + type: object + properties: + regStatusTransferComplete: + type: boolean + required: + - regStatusTransferComplete + AssignEbiError: + description: Data within a failure response to the EBI assignment request + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + failureDetails: + $ref: '#/components/schemas/AssignEbiFailed' + required: + - error + - failureDetails + + UeContextCreateData: + description: Data within a request to create an individual ueContext resource + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + targetId: + $ref: '#/components/schemas/NgRanTargetId' + sourceToTargetData: + $ref: '#/components/schemas/N2InfoContent' + pduSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + n2NotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ueRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + ueRadioCapabilityForPaging: + $ref: '#/components/schemas/N2InfoContent' + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + xrDeviceWith2Rx: + $ref: '#/components/schemas/XrDeviceWith2Rx' + required: + - ueContext + - targetId + - sourceToTargetData + - pduSessionList + + UeContextCreatedData: + description: Data within a successful response for creating an individual ueContext resource + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + targetToSourceData: + $ref: '#/components/schemas/N2InfoContent' + pduSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + failedSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + pcfReselectedInd: + type: boolean + analyticsNotUsedList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + required: + - ueContext + - targetToSourceData + - pduSessionList + UeContextCreateError: + description: Data within a failure response for creating a UE context + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + targetToSourceFailureData: + $ref: '#/components/schemas/N2InfoContent' + required: + - error + UeContextRelocateData: + description: Data within a Relocate UE Context request + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + targetId: + $ref: '#/components/schemas/NgRanTargetId' + sourceToTargetData: + $ref: '#/components/schemas/N2InfoContent' + forwardRelocationRequest: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + pduSessionList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + ueRadioCapability: + $ref: '#/components/schemas/N2InfoContent' + ngapCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + xrDeviceWith2Rx: + $ref: '#/components/schemas/XrDeviceWith2Rx' + required: + - ueContext + - targetId + - sourceToTargetData + - forwardRelocationRequest + UeContextRelocatedData: + description: Data within a Relocate UE Context response + type: object + properties: + ueContext: + $ref: '#/components/schemas/UeContext' + required: + - ueContext + + UeContextCancelRelocateData: + description: Data structure used for cancellation of UE Context Relocation + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + relocationCancelRequest: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + required: + - relocationCancelRequest + NgRanTargetId: + description: Indicates a NG RAN as target of the handover + type: object + properties: + ranNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + required: + - ranNodeId + - tai + PWSResponseData: + description: Data related PWS included in a N2 Information Transfer response + type: object + properties: + ngapMessageType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + serialNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + messageIdentifier: + type: integer + unknownTaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + n2PwsSubMissInd: + type: boolean + enum: + - true + required: + - ngapMessageType + - serialNumber + - messageIdentifier + PWSErrorData: + description: Data related to PWS error included in a N2 Information Transfer failure response + type: object + properties: + namfCause: + type: integer + required: + - namfCause + N2InformationTransferError: + description: Data within a failure response for a non-UE related N2 Information Transfer + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + pwsErrorInfo: + $ref: '#/components/schemas/PWSErrorData' + required: + - error + NgKsi: + description: Represents the ngKSI + type: object + properties: + tsc: + $ref: '#/components/schemas/ScType' + ksi: + type: integer + minimum: 0 + maximum: 6 + required: + - tsc + - ksi + KeyAmf: + description: Represents the Kamf or K'amf + type: object + properties: + keyType: + $ref: '#/components/schemas/KeyAmfType' + keyVal: + type: string + required: + - keyType + - keyVal + ExpectedUeBehavior: + description: Represents the expected UE behavior (e.g. UE moving trajectory) and its validity period + type: object + properties: + expMoveTrajectory: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + minItems: 1 + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - expMoveTrajectory + - validityTime + N2RanInformation: + description: Represents the RAN related N2 information data part + type: object + properties: + n2InfoContent: + $ref: '#/components/schemas/N2InfoContent' + required: + - n2InfoContent + N2InfoNotificationRspData: + description: Data within a N2 information notification response + type: object + properties: + secRatDataUsageList: + type: array + items: + $ref: '#/components/schemas/N2SmInformation' + minItems: 1 + SmallDataRateStatusInfo: + description: Represents the small data rate status + type: object + properties: + Snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + Dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + SmallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + required: + - Snssai + - Dnn + - SmallDataRateStatus + SmfChangeInfo: + description: SMF change information for PDU session(s) + type: object + properties: + pduSessionIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + smfChangeInd: + $ref: '#/components/schemas/SmfChangeIndication' + required: + - pduSessionIdList + - smfChangeInd + + V2xContext: + description: Represents the V2X services related parameters + type: object + properties: + nrV2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrV2xAuth' + lteV2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LteV2xAuth' + nrUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + lteUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + pc5QoSPara: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pc5QoSPara' + + V2xInformation: + description: V2X related N2 information + type: object + properties: + n2Pc5Pol: + $ref: '#/components/schemas/N2InfoContent' + + ProSeInformation: + description: Represents 5G ProSe related N2 information. + type: object + properties: + n2Pc5ProSePol: + $ref: '#/components/schemas/N2InfoContent' + + ImmediateMdtConf: + description: Immediate MDT Configuration + type: object + properties: + jobType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/JobType' + measurementLteList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MeasurementLteForMdt' + minItems: 1 + measurementNrList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MeasurementNrForMdt' + minItems: 1 + reportingTriggerList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportingTrigger' + minItems: 1 + reportInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportIntervalMdt' + reportIntervalNr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportIntervalNrMdt' + reportAmount: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReportAmountMdt' + eventThresholdRsrp: + type: integer + minimum: 0 + maximum: 97 + eventThresholdRsrq: + type: integer + minimum: 0 + maximum: 34 + eventThresholdRsrpNr: + type: integer + minimum: 0 + maximum: 127 + eventThresholdRsrqNr: + type: integer + minimum: 0 + maximum: 127 + collectionPeriodRmmLte: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CollectionPeriodRmmLteMdt' + collectionPeriodRmmNr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CollectionPeriodRmmNrMdt' + measurementPeriodLte: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MeasurementPeriodLteMdt' + areaScope: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaScope' + positioningMethod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PositioningMethodMdt' + addPositioningMethodList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PositioningMethodMdt' + minItems: 1 + mdtAllowedPlmnIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + maxItems: 16 + sensorMeasurementList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SensorMeasurement' + minItems: 1 + sensorMeasurementLteList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SensorMeasurement' + minItems: 1 + eventThresholdSinrNr: + type: integer + minimum: 0 + maximum: 127 + bluetoothMeasurementNr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BluetoothMeasurement' + bluetoothMeasurementLte: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BluetoothMeasurement' + wlanMeasurementNr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WlanMeasurement' + wlanMeasurementLte: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WlanMeasurement' + required: + - jobType + + EpsNasSecurityMode: + description: Indicates the EPS NAS Security Mode + type: object + properties: + integrityAlgorithm: + $ref: '#/components/schemas/EpsNasIntegrityAlgorithm' + cipheringAlgorithm: + $ref: '#/components/schemas/EpsNasCipheringAlgorithm' + required: + - integrityAlgorithm + - cipheringAlgorithm + + EcRestrictionDataWb: + description: Enhanced Coverage Restriction Data for WB-N1 mode + type: object + properties: + ecModeARestricted: + type: boolean + default: false + ecModeBRestricted: + type: boolean + required: + - ecModeBRestricted + + ExtAmfEventSubscription: + description: AMF event subscription extended with additional information received for the subscription + allOf: + - $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/AmfEventSubscription' + - $ref: '#/components/schemas/AmfEventSubscriptionAddInfo' + + AmfEventSubscriptionAddInfo: + description: Additional information received for an AMF event subscription, e.g. binding indications + type: object + properties: + bindingInfo: + type: array + items: + type: string + minItems: 1 + maxItems: 2 + subscribingNfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + eventSyncInd: + type: boolean + nfConsumerInfo: + type: array + items: + type: string + minItems: 1 + aoiStateList: + type: object + description: > + Map of subscribed Area of Interest (AoI) Event State in the old AMF. The JSON pointer to + an AmfEventArea element in the areaList IE (or a PresenceInfo element in + presenceInfoList IE) of the AmfEvent data type shall be the key of the map. + additionalProperties: + $ref: '#/components/schemas/AreaOfInterestEventState' + accessToken: + type: string + description: > + JWS Compact Serialized representation of JWS signed JSON object (AccessTokenClaims + defined in 3GPP TS 29.510) + + UeDifferentiationInfo: + description: Represents the UE Differentiation Information and its validity time + type: object + properties: + periodicComInd: + $ref: '#/components/schemas/PeriodicCommunicationIndicator' + periodicTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + scheduledComTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime' + stationaryInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StationaryIndication' + trafficProfile: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficProfile' + batteryInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BatteryIndication' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + + CeModeBInd: + description: CE-mode-B Support Indicator. + type: object + properties: + ceModeBSupportInd: + type: boolean + required: + - ceModeBSupportInd + + LteMInd: + description: LTE-M Indication. + type: object + properties: + lteCatMInd: + type: boolean + required: + - lteCatMInd + + NpnAccessInfo: + description: NPN Access Information. + type: object + properties: + cellCagInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CagId' + minItems: 1 + + ProseContext: + description: Represents the ProSe services related parameters. + type: object + properties: + directDiscovery: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + directComm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + l2Relay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + l3Relay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + l2Remote: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + l3Remote: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + l2UeRelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + l3UeRelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + l2End: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + l3End: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + multiPathComm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UeAuth' + nrUePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + pc5QoSPara: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pc5QoSPara' + + AnalyticsSubscription: + description: Analytics subscriptions created in the NWDAF. + type: object + properties: + nwdafId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nwdafSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + nwdafSubscriptionList: + type: array + items: + $ref: '#/components/schemas/NwdafSubscription' + minItems: 1 + required: + - nwdafSubscriptionList + + NwdafSubscription: + description: Individual NWDAF subscription identified by the subscription Id. + type: object + properties: + nwdafEvtSubsServiceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nwdafEventsSubscription: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' + required: + - nwdafEvtSubsServiceUri + - nwdafEventsSubscription + + UpdpSubscriptionData: + description: UE policy delivery related N1 message notification subscription data. + type: object + properties: + updpNotifySubscriptionId: + type: string + updpNotifyCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + updpCallbackBinding: + type: string + required: + - updpNotifySubscriptionId + - updpNotifyCallbackUri + + ReleaseSessionInfo: + description: PDU session Id(s) and the cause for triggering the release. + type: object + properties: + releaseSessionList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + releaseCause: + $ref: '#/components/schemas/ReleaseCause' + required: + - releaseSessionList + - releaseCause + + AreaOfInterestEventState: + description: Event State of AoI event in old AMF + type: object + required: + - presence + properties: + presence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + individualPraIdList: + type: array + items: + type: string + minItems: 1 + + TssInformation: + description: Represents a Tss related N2 information data part + type: object + properties: + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + tssContainer: + type: array + items: + $ref: '#/components/schemas/N2InfoContent' + minItems: 1 + maxItems: 10 + tssRspPerNgranList: + type: array + items: + $ref: '#/components/schemas/TssRspPerNgran' + minItems: 1 + maxItems: 10 + required: + - tssContainer + + RslpInformation: + description: Represents Ranging/SL positioning related N2 information. + type: object + properties: + n2Pc5RslpPol: + $ref: '#/components/schemas/N2InfoContent' + + A2xContext: + description: Represents the A2X services related parameters + type: object + properties: + nrA2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrA2xAuth' + lteA2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LteA2xAuth' + nrUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + lteUeSidelinkAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + pc5QoSPara: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pc5QoSPara' + + A2xInformation: + description: A2X related N2 information + type: object + properties: + n2Pc5Pol: + $ref: '#/components/schemas/N2InfoContent' + + AmPolicyInfoContainer: + description: AM Policy Information Container + type: object + properties: + sliceUsgCtrlInfoSets: + type: object + description: A map(list of key-value pairs) where Snssai serves as key. + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceUsageControlInfo' + minProperties: 1 + + LcsUpContext: + description: Represents the LCS UP related parameters + type: object + properties: + upConnectionStatus: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/UpConnectionStatus' + servingLMFIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + + DeregInactTimerInfo: + description: Network Slice Deregistration Inactivity Timer Information + type: object + required: + - deregInactExpiryTime + properties: + deregInactExpiryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NssaaStatus' + + TssRspPerNgran: + description: Represents a TSS related N2 information data part + type: object + properties: + ngranId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + ngranFailureInfo: + $ref: '#/components/schemas/NgranFailureInfo' + tssContainer: + $ref: '#/components/schemas/N2InfoContent' + required: + - ngranId + + SliceReplacementMapping: + description: > + Represents the mapping between a replaced S-NSSAI in serving PLMN to its alternative S-NSSAI + type: object + properties: + replacedSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - replacedSnssai + - altSnssai + + +# +# SIMPLE DATA TYPES +# + EpsBearerId: + description: EPS Bearer Identifier + type: integer + minimum: 0 + maximum: 15 + Ppi: + description: Paging Policy Indicator + type: integer + minimum: 0 + maximum: 7 + NasCount: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + 5GMmCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + UeSecurityCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + S1UeNetworkCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + DrxParameter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + OmcIdentifier: + description: Represents the OMC Identifier + type: string + MSClassmark2: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + SupportedCodec: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + UePolicyContainer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + + +# +# ENUMERATIONS +# + StatusChange: + description: Enumeration for AMF status + anyOf: + - type: string + enum: + - AMF_UNAVAILABLE + - AMF_AVAILABLE + - type: string + N2InformationClass: + description: Enumeration for N2 Information Class + anyOf: + - type: string + enum: + - SM + - NRPPa + - PWS + - PWS-BCAL + - PWS-RF + - RAN + - V2X + - PROSE + - TSS + - RSPP + - A2X + - type: string + N1MessageClass: + description: Enumeration for N1 Message Class + anyOf: + - type: string + enum: + - 5GMM + - SM + - LPP + - SMS + - UPDP + - LCS + - UPP-CM + - type: string + N1N2MessageTransferCause: + description: Enumeration for N1N2Message Transfer Cause + anyOf: + - type: string + enum: + - ATTEMPTING_TO_REACH_UE + - N1_N2_TRANSFER_INITIATED + - WAITING_FOR_ASYNCHRONOUS_TRANSFER + - UE_NOT_RESPONDING + - N1_MSG_NOT_TRANSFERRED + - N2_MSG_NOT_TRANSFERRED + - UE_NOT_REACHABLE_FOR_SESSION + - TEMPORARY_REJECT_REGISTRATION_ONGOING + - TEMPORARY_REJECT_HANDOVER_ONGOING + - REJECTION_DUE_TO_PAGING_RESTRICTION + - AN_NOT_RESPONDING + - FAILURE_CAUSE_UNSPECIFIED + - type: string + UeContextTransferStatus: + description: Describes the status of an individual ueContext resource in UE Context Transfer procedures + anyOf: + - type: string + enum: + - TRANSFERRED + - NOT_TRANSFERRED + - type: string + N2InformationTransferResult: + description: Describes the result of N2 information transfer by AMF to the AN + anyOf: + - type: string + enum: + - N2_INFO_TRANSFER_INITIATED + - type: string + CipheringAlgorithm: + description: Indicates the supported Ciphering Algorithm + anyOf: + - type: string + enum: + - NEA0 + - NEA1 + - NEA2 + - NEA3 + - type: string + IntegrityAlgorithm: + description: Indicates the supported Integrity Algorithm + anyOf: + - type: string + enum: + - NIA0 + - NIA1 + - NIA2 + - NIA3 + - type: string + + ScType: + description: Indicates the security context type + anyOf: + - type: string + enum: + - NATIVE + - MAPPED + - type: string + KeyAmfType: + description: Indicates the Kamf type + anyOf: + - type: string + enum: + - KAMF + - KPRIMEAMF + - type: string + TransferReason: + description: Indicates UE Context Transfer Reason + anyOf: + - type: string + enum: + - INIT_REG + - MOBI_REG + - MOBI_REG_UE_VALIDATED + - type: string + PolicyReqTrigger: + description: Policy Request Triggers + anyOf: + - type: string + enum: + - LOCATION_CHANGE + - PRA_CHANGE + - ALLOWED_NSSAI_CHANGE + - NWDAF_DATA_CHANGE + - PLMN_CHANGE + - CON_STATE_CHANGE + - SMF_SELECT_CHANGE + - ACCESS_TYPE_CHANGE + - SAT_BACKHAUL_CHANGE + - type: string + RatSelector: + description: Indicates the RAT type for the transfer of N2 information + anyOf: + - type: string + enum: + - E-UTRA + - NR + - type: string + NgapIeType: + description: Indicates the supported NGAP IE types + anyOf: + - type: string + enum: + - PDU_RES_SETUP_REQ + - PDU_RES_REL_CMD + - PDU_RES_MOD_REQ + - HANDOVER_CMD + - HANDOVER_REQUIRED + - HANDOVER_PREP_FAIL + - SRC_TO_TAR_CONTAINER + - TAR_TO_SRC_CONTAINER + - TAR_TO_SRC_FAIL_CONTAINER + - RAN_STATUS_TRANS_CONTAINER + - SON_CONFIG_TRANSFER + - NRPPA_PDU + - UE_RADIO_CAPABILITY + - RIM_INFO_TRANSFER + - SECONDARY_RAT_USAGE + - PC5_QOS_PARA + - EARLY_STATUS_TRANS_CONTAINER + - UE_RADIO_CAPABILITY_FOR_PAGING + - type: string + N2InfoNotifyReason: + description: N2 Information Notify Reason + anyOf: + - type: string + enum: + - HANDOVER_COMPLETED + - type: string + SmfChangeIndication: + description: Indicates the I-SMF or V-SMF change or removal + anyOf: + - type: string + enum: + - CHANGED + - REMOVED + - type: string + SbiBindingLevel: + description: SBI Binding Level + anyOf: + - type: string + enum: + - NF_INSTANCE_BINDING + - NF_SET_BINDING + - NF_SERVICE_SET_BINDING + - NF_SERVICE_INSTANCE_BINDING + - type: string + + EpsNasCipheringAlgorithm: + description: Indicates the supported EPS NAS Ciphering Algorithm + anyOf: + - type: string + enum: + - EEA0 + - EEA1 + - EEA2 + - EEA3 + - type: string + + EpsNasIntegrityAlgorithm: + description: Indicates the supported EPS NAS Integrity Algorithm + anyOf: + - type: string + enum: + - EIA0 + - EIA1 + - EIA2 + - EIA3 + - type: string + + PeriodicCommunicationIndicator: + description: Indicates the Periodic Communication Indicator + anyOf: + - type: string + enum: + - PIORIODICALLY + - ON_DEMAND + - type: string + + UuaaMmStatus: + description: Indicates the UUAA-MM status + anyOf: + - type: string + enum: + - SUCCESS + - PENDING + - FAILED + - type: string + + ReleaseCause: + description: The cause for triggering the release. + anyOf: + - type: string + enum: + - SNPN_SNPN_MOBILITY + - NO_HR_AGREEMENT + - UNSPECIFIED + - type: string + + + NgranFailureInfo: + description: Indicates a NG-RAN failure event. + anyOf: + - type: string + enum: + - NG_RAN_NOT_REACHABLE + - NG_RAN_FAILURE_WITH_RESTART + - NG_RAN_FAILURE_WITHOUT_RESTART + - type: string + + + XrDeviceWith2Rx: + description: Information of the XR Device with 2Rx + anyOf: + - type: string + enum: + - TRUE + - type: string -- GitLab From 889c05f12174c45b21c0927bb4fb336ba689f4df Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 06:38:24 +0000 Subject: [PATCH 28/33] Upload the YAML for cross reference compile --- OpenAPI/TS28623_PmControlNrm.yaml | 77 +++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 OpenAPI/TS28623_PmControlNrm.yaml diff --git a/OpenAPI/TS28623_PmControlNrm.yaml b/OpenAPI/TS28623_PmControlNrm.yaml new file mode 100644 index 0000000..720842e --- /dev/null +++ b/OpenAPI/TS28623_PmControlNrm.yaml @@ -0,0 +1,77 @@ +openapi: 3.0.1 +info: + title: PM control NRM + version: 19.0.0 + description: >- + OAS 3.0.1 definition of the PM control NRM fragment + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623; Generic NRM,PM control NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: + #-------- Definition of types for name-containments ------ + SubNetwork-ncO-PmControlNrm: + type: object + properties: + PerfMetricJob: + $ref: '#/components/schemas/PerfMetricJob-Multiple' + ManagedElement-PmControlNrm: + type: object + properties: + PerfMetricJob: + $ref: '#/components/schemas/PerfMetricJob-Multiple' + #-------Definition of generic IOCs ----------# + +#-------- Definition of types----------------------------------------------------- + + +#-------- Definition of concrete IOCs -------------------------------------------- + PerfMetricJob-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + not: + required: [ conditionMonitorRef, schedulerRef ] + properties: + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + jobId: + type: string + performanceMetrics: + type: array + items: + type: string + granularityPeriod: + type: integer + minimum: 1 + objectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + rootObjectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + conditionMonitorRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + schedulerRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + reportingCtrl: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ReportingCtrl' + Files: + $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/Files-Multiple' + +#-------- Definition of YAML arrays for name-contained IOCs ---------------------- + PerfMetricJob-Multiple: + type: array + items: + $ref: '#/components/schemas/PerfMetricJob-Single' + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + resources-pmControlNrm: + oneOf: + - $ref: '#/components/schemas/PerfMetricJob-Single' -- GitLab From 0f9097ba58cf088c74d40ac2d13722db2e3700dc Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Fri, 27 Sep 2024 06:38:43 +0000 Subject: [PATCH 29/33] Upload the YAML for cross reference compile --- OpenAPI/TS29514_Npcf_PolicyAuthorization.yaml | 2818 +++++++++++++++++ 1 file changed, 2818 insertions(+) create mode 100644 OpenAPI/TS29514_Npcf_PolicyAuthorization.yaml diff --git a/OpenAPI/TS29514_Npcf_PolicyAuthorization.yaml b/OpenAPI/TS29514_Npcf_PolicyAuthorization.yaml new file mode 100644 index 0000000..219ef27 --- /dev/null +++ b/OpenAPI/TS29514_Npcf_PolicyAuthorization.yaml @@ -0,0 +1,2818 @@ +openapi: 3.0.0 + +info: + title: Npcf_PolicyAuthorization Service API + version: 1.4.0-alpha.1 + description: | + PCF Policy Authorization Service. + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.514 V19.0.0; 5G System; Policy Authorization Service; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.514/' + +servers: + - url: '{apiRoot}/npcf-policyauthorization/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npcf-policyauthorization + +paths: + /app-sessions: + post: + summary: Creates a new Individual Application Session Context resource + operationId: PostAppSessions + tags: + - Application Sessions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - npcf-policyauthorization + - oAuth2ClientCredentials: + - npcf-policyauthorization + - npcf-policyauthorization:policy-auth-mgmt + requestBody: + description: Contains the information for the creation the resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + responses: + '201': + description: Successful creation of the resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + headers: + Location: + description: > + Contains the URI of the created individual application session context resource, + according to the structure + {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId} + or the URI of the created events subscription sub-resource, + according to the structure + {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId} + /events-subscription + required: true + schema: + type: string + '303': + description: > + See Other. The result of the HTTP POST request would be equivalent to the existing + Application Session Context. + headers: + Location: + description: > + Contains the URI of the existing individual Application Session Context resource. + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtendedProblemDetails' + headers: + Retry-After: + description: > + Indicates the time the AF has to wait before making a new request. It can be a + non-negative integer (decimal number) indicating the number of seconds the AF + has to wait before making a new request or an HTTP-date after which the AF can + retry a new request. + schema: + anyOf: + - type: integer + - type: string + '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: + terminationRequest: + '{$request.body#/ascReqData/notifUri}/terminate': + post: + requestBody: + description: > + Request of the termination of the Individual Application Session Context. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TerminationInfo' + 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' + eventNotification: + '{$request.body#/ascReqData/evSubsc/notifUri}/notify': + post: + requestBody: + description: Notification of an event occurrence in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + 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' + detected5GsBridgeForPduSession: + '{$request.body#/ascReqData/evSubsc/notifUri}/new-bridge': + post: + requestBody: + description: Notification of a new TSC user plane node detected in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionTsnBridge' + 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' + eventNotificationPduSession: + '{$request.body#/ascReqData/evSubsc/notifUri}/pdu-session': + post: + requestBody: + description: Notification of PDU session established or terminated. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionEventNotification' + 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' + + /app-sessions/pcscf-restoration: + post: + summary: "Indicates P-CSCF restoration and does not create an Individual Application Session Context" + operationId: PcscfRestoration + tags: + - PCSCF Restoration Indication + requestBody: + description: PCSCF Restoration Indication. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcscfRestorationRequestData' + responses: + '204': + description: The deletion is confirmed without returning additional data. + '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' + + /app-sessions/{appSessionId}: + get: + summary: "Reads an existing Individual Application Session Context" + operationId: GetAppSession + tags: + - Individual Application Session Context (Document) + security: + - {} + - oAuth2ClientCredentials: + - npcf-policyauthorization + - oAuth2ClientCredentials: + - npcf-policyauthorization + - npcf-policyauthorization:policy-auth-mgmt + parameters: + - name: appSessionId + description: String identifying the resource. + in: path + required: true + schema: + type: string + responses: + '200': + description: A representation of the resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + '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' + patch: + summary: "Modifies an existing Individual Application Session Context" + operationId: ModAppSession + tags: + - Individual Application Session Context (Document) + security: + - {} + - oAuth2ClientCredentials: + - npcf-policyauthorization + - oAuth2ClientCredentials: + - npcf-policyauthorization + - npcf-policyauthorization:policy-auth-mgmt + parameters: + - name: appSessionId + description: String identifying the resource. + in: path + required: true + schema: + type: string + requestBody: + description: Modification of the resource. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AppSessionContextUpdateDataPatch' + responses: + '200': + description: > + Successful modification of the resource and a representation of that resource is + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + '204': + description: The successful modification. + '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': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtendedProblemDetails' + headers: + Retry-After: + description: > + Indicates the time the AF has to wait before making a new request. It can be a + non-negative integer (decimal number) indicating the number of seconds the AF has + to wait before making a new request or an HTTP-date after which the AF can retry + a new request. + schema: + anyOf: + - type: integer + - type: string + '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: + eventNotification: + '{$request.body#/ascReqData/evSubsc/notifUri}/notify': + post: + requestBody: + description: Notification of an event occurrence in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + 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' + + /app-sessions/{appSessionId}/delete: + post: + summary: "Deletes an existing Individual Application Session Context" + operationId: DeleteAppSession + tags: + - Individual Application Session Context (Document) + security: + - {} + - oAuth2ClientCredentials: + - npcf-policyauthorization + - oAuth2ClientCredentials: + - npcf-policyauthorization + - npcf-policyauthorization:policy-auth-mgmt + parameters: + - name: appSessionId + description: String identifying the Individual Application Session Context resource. + in: path + required: true + schema: + type: string + requestBody: + description: > + Deletion of the Individual Application Session Context resource, req notification. + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + responses: + '200': + description: The deletion of the resource is confirmed and a resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + '204': + description: The deletion is confirmed without returning additional data. + '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' + + /app-sessions/{appSessionId}/events-subscription: + put: + summary: "creates or modifies an Events Subscription subresource" + operationId: updateEventsSubsc + tags: + - Events Subscription (Document) + parameters: + - name: appSessionId + description: String identifying the Events Subscription resource. + in: path + required: true + schema: + type: string + requestBody: + description: Creation or modification of an Events Subscription resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + responses: + '201': + description: > + The creation of the Events Subscription resource is confirmed and its representation is + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscPutData' + headers: + Location: + description: > + Contains the URI of the created Events Subscription resource, + according to the structure + {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId}/ + events-subscription + required: true + schema: + type: string + '200': + description: > + The modification of the Events Subscription resource is confirmed its representation is + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscPutData' + '204': + description: > + The modification of the Events Subscription subresource is confirmed without returning + additional data. + '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' + callbacks: + eventNotification: + '{$request.body#/notifUri}/notify': + post: + requestBody: + description: > + Contains the information for the notification of an event occurrence in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + 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' + delete: + summary: deletes the Events Subscription subresource + operationId: DeleteEventsSubsc + tags: + - Events Subscription (Document) + parameters: + - name: appSessionId + description: String identifying the Individual Application Session Context resource. + in: path + required: true + schema: + type: string + responses: + '204': + description: > + The deletion of the of the Events Subscription sub-resource is confirmed without + returning additional data. + '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: + npcf-policyauthorization: Access to the Npcf_PolicyAuthorization API + npcf-policyauthorization:policy-auth-mgmt: > + Access to service operations applying to PCF Policy Authorization for creation, + updation, deletion, retrieval. + + schemas: + + AppSessionContext: + description: Represents an Individual Application Session Context resource. + type: object + properties: + ascReqData: + $ref: '#/components/schemas/AppSessionContextReqData' + ascRespData: + $ref: '#/components/schemas/AppSessionContextRespData' + evsNotif: + $ref: '#/components/schemas/EventsNotification' + + AppSessionContextReqData: + description: Identifies the service requirements of an Individual Application Session Context. + type: object + required: + - notifUri + - suppFeat + oneOf: + - required: [ueIpv4] + - required: [ueIpv6] + - required: [ueMac] + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afChargId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationChargingId' + afReqData: + $ref: '#/components/schemas/AfRequestedData' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirement' + afSfcReq: + $ref: '#/components/schemas/AfSfcRequirement' + aspId: + $ref: '#/components/schemas/AspId' + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqData' + mcpttId: + description: Indication of MCPTT service request. + type: string + mcVideoId: + description: Indication of MCVideo service request. + type: string + medComponents: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaComponent' + minProperties: 1 + description: > + Contains media component information. The key of the map is the medCompN attribute. + multiModalId: + $ref: '#/components/schemas/MultiModalId' + ipDomain: + type: string + mpsAction: + $ref: '#/components/schemas/MpsAction' + mpsId: + description: Indication of MPS service request. + type: string + mcsId: + description: Indication of MCS service request. + type: string + preemptControlInfo: + $ref: '#/components/schemas/PreemptionControlInformation' + qosDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + qosInactInt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + resPrio: + $ref: '#/components/schemas/ReservPriority' + servInfStatus: + $ref: '#/components/schemas/ServiceInfoStatus' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + servUrn: + $ref: '#/components/schemas/ServiceUrn' + sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + sponId: + $ref: '#/components/schemas/SponId' + sponStatus: + $ref: '#/components/schemas/SponsoringStatus' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + ueIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + tsnPortManContNwtts: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + tscNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + tscNotifCorreId: + type: string + description: > + Correlation identifier for TSC management information notifications. + + AppSessionContextRespData: + description: > + Describes the authorization data of an Individual Application Session Context created by + the PCF. + type: object + properties: + servAuthInfo: + $ref: '#/components/schemas/ServAuthInfo' + directNotifReports: + type: array + items: + $ref: '#/components/schemas/DirectNotificationReport' + minItems: 1 + description: > + QoS monitoring parameter(s) that cannot be directly notified for the indicated flows. + ueIds: + type: array + items: + $ref: '#/components/schemas/UeIdentityInfo' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + AppSessionContextUpdateDataPatch: + description: > + Identifies the modifications to an Individual Application Session Context and/or the + modifications to the sub-resource Events Subscription. + type: object + properties: + ascReqData: + $ref: '#/components/schemas/AppSessionContextUpdateData' + + AppSessionContextUpdateData: + description: > + Identifies the modifications to the "ascReqData" property of an Individual Application + Session Context which may include the modifications to the sub-resource Events Subscription. + type: object + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirementRm' + afSfcReq: + $ref: '#/components/schemas/AfSfcRequirement' + aspId: + $ref: '#/components/schemas/AspId' + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqDataRm' + mcpttId: + description: Indication of MCPTT service request. + type: string + mcVideoId: + description: Indication of modification of MCVideo service. + type: string + medComponents: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaComponentRm' + minProperties: 1 + description: > + Contains media component information. The key of the map is the medCompN attribute. + mpsAction: + $ref: '#/components/schemas/MpsAction' + mpsId: + description: Indication of MPS service request. + type: string + mcsId: + description: Indication of MCS service request. + type: string + preemptControlInfo: + $ref: '#/components/schemas/PreemptionControlInformationRm' + qosDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + qosInactInt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + resPrio: + $ref: '#/components/schemas/ReservPriority' + servInfStatus: + $ref: '#/components/schemas/ServiceInfoStatus' + sipForkInd: + $ref: '#/components/schemas/SipForkingIndication' + sponId: + $ref: '#/components/schemas/SponId' + sponStatus: + $ref: '#/components/schemas/SponsoringStatus' + tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + tsnPortManContNwtts: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + tscNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + tscNotifCorreId: + type: string + description: > + Correlation identifier for TSC management information notifications. + + EventsSubscReqData: + description: Identifies the events the application subscribes to. + type: object + required: + - events + properties: + events: + type: array + items: + $ref: '#/components/schemas/AfEventSubscription' + minItems: 1 + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reqQosMonParams: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + qosMon: + $ref: '#/components/schemas/QosMonitoringInformation' + qosMonDatRate: + $ref: '#/components/schemas/QosMonitoringInformation' + pdvReqMonParams: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + pdvMon: + $ref: '#/components/schemas/QosMonitoringInformation' + congestMon: + $ref: '#/components/schemas/QosMonitoringInformation' + rttMon: + $ref: '#/components/schemas/QosMonitoringInformation' + rttFlowRef: + $ref: '#/components/schemas/RttFlowReference' + reqAnis: + type: array + items: + $ref: '#/components/schemas/RequiredAccessInfo' + minItems: 1 + usgThres: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + notifCorreId: + type: string + afAppIds: + type: array + items: + $ref: '#/components/schemas/AfAppId' + minItems: 1 + directNotifInd: + type: boolean + description: > + Indicates whether the direct event notification is requested (true) or not (false) for + the provided QoS monitoring parameters. + Default value is false. + avrgWndw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' + + EventsSubscReqDataRm: + description: > + This data type is defined in the same way as the EventsSubscReqData data type, but with + the OpenAPI nullable property set to true. + type: object + required: + - events + properties: + events: + type: array + items: + $ref: '#/components/schemas/AfEventSubscription' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reqQosMonParams: + type: array + nullable: true + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + qosMon: + $ref: '#/components/schemas/QosMonitoringInformationRm' + qosMonDatRate: + $ref: '#/components/schemas/QosMonitoringInformationRm' + pdvReqMonParams: + type: array + nullable: true + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + pdvMon: + $ref: '#/components/schemas/QosMonitoringInformationRm' + congestMon: + $ref: '#/components/schemas/QosMonitoringInformationRm' + rttMon: + $ref: '#/components/schemas/QosMonitoringInformationRm' + rttFlowRef: + $ref: '#/components/schemas/RttFlowReferenceRm' + reqAnis: + type: array + items: + $ref: '#/components/schemas/RequiredAccessInfo' + minItems: 1 + usgThres: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm' + notifCorreId: + type: string + directNotifInd: + type: boolean + nullable: true + description: > + Indicates whether the direct event notification is requested (true) or not (false) for + the provided and/or previously provided QoS monitoring parameters. + avrgWndw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' + nullable: true + + MediaComponent: + description: Identifies a media component. + type: object + required: + - medCompN + allOf: + - not: + required: [altSerReqs,altSerReqsData] + - not: + required: [qosReference,altSerReqsData] + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirement' + afSfcReq: + $ref: '#/components/schemas/AfSfcRequirement' + qosReference: + type: string + disUeNotif: + type: boolean + altSerReqs: + type: array + items: + type: string + minItems: 1 + altSerReqsData: + type: array + items: + $ref: '#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Contains alternative service requirements that include individual QoS parameter sets. + contVer: + $ref: '#/components/schemas/ContentVersion' + codecs: + type: array + items: + $ref: '#/components/schemas/CodecData' + minItems: 1 + maxItems: 2 + desMaxLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + desMaxLoss: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + flusId: + type: string + fStatus: + $ref: '#/components/schemas/FlowStatus' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPacketLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxSuppBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxSuppBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + medCompN: + type: integer + medSubComps: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaSubComponent' + minProperties: 1 + description: > + Contains the requested bitrate and filters for the set of service data flows identified + by their common flow identifier. The key of the map is the fNum attribute. + medType: + $ref: '#/components/schemas/MediaType' + minDesBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minDesBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + preemptCap: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionCapability' + preemptVuln: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionVulnerability' + prioSharingInd: + $ref: '#/components/schemas/PrioritySharingIndicator' + resPrio: + $ref: '#/components/schemas/ReservPriority' + rrBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + rsBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + sharingKeyDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + sharingKeyUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + tsnQos: + $ref: '#/components/schemas/TsnQosContainer' + tscaiInputDl: + $ref: '#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: '#/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 supported + and set to "true". + rTLatencyInd: + type: boolean + description: > + Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of + the service, when it is included and set to "true". + pdb: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + rTLatencyIndCorreId: + $ref: '#/components/schemas/RttFlowReference' + pduSetQosDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' + pduSetQosUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' + protoDescDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescription' + protoDescUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescription' + periodUl: + $ref: '#/components/schemas/DurationMilliSec' + periodDl: + $ref: '#/components/schemas/DurationMilliSec' + l4sInd: + $ref: '#/components/schemas/UplinkDownlinkSupport' + + MediaComponentRm: + description: > + This data type is defined in the same way as the MediaComponent data type, but with the + OpenAPI nullable property set to true. + type: object + required: + - medCompN + not: + required: [altSerReqs,altSerReqsData] + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirementRm' + afSfcReq: + $ref: '#/components/schemas/AfSfcRequirement' + qosReference: + type: string + nullable: true + altSerReqs: + type: array + items: + type: string + minItems: 1 + nullable: true + altSerReqsData: + type: array + items: + $ref: '#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Contains removable alternative service requirements that include individual QoS + parameter sets. + nullable: true + disUeNotif: + type: boolean + contVer: + $ref: '#/components/schemas/ContentVersion' + codecs: + type: array + items: + $ref: '#/components/schemas/CodecData' + minItems: 1 + maxItems: 2 + desMaxLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FloatRm' + desMaxLoss: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FloatRm' + flusId: + type: string + nullable: true + fStatus: + $ref: '#/components/schemas/FlowStatus' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPacketLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxSuppBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxSuppBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + medCompN: + type: integer + medSubComps: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaSubComponentRm' + minProperties: 1 + description: > + Contains the requested bitrate and filters for the set of service data flows identified + by their common flow identifier. The key of the map is the fNum attribute. + medType: + $ref: '#/components/schemas/MediaType' + minDesBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + minDesBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + preemptCap: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionCapabilityRm' + preemptVuln: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionVulnerabilityRm' + prioSharingInd: + $ref: '#/components/schemas/PrioritySharingIndicator' + resPrio: + $ref: '#/components/schemas/ReservPriority' + rrBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + rsBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + sharingKeyDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32Rm' + sharingKeyUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32Rm' + tsnQos: + $ref: '#/components/schemas/TsnQosContainerRm' + tscaiInputDl: + $ref: '#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: '#/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 supported + and set to "true". The default value is "false" if omitted. + rTLatencyInd: + type: boolean + nullable: true + description: > + Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of + the service, when it is included and set to "true". The default value is "false" if + omitted. + pdb: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudgetRm' + rTLatencyIndCorreId: + $ref: '#/components/schemas/RttFlowReferenceRm' + pduSetQosDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm' + pduSetQosUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm' + protoDescDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescriptionRm' + protoDescUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescriptionRm' + periodUl: + $ref: '#/components/schemas/DurationMilliSecRm' + periodDl: + $ref: '#/components/schemas/DurationMilliSecRm' + l4sInd: + $ref: '#/components/schemas/UplinkDownlinkSupport' + nullable: true + + MediaSubComponent: + description: Identifies a media subcomponent. + type: object + required: + - fNum + properties: + afSigProtocol: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' + ethfDescs: + type: array + items: + $ref: '#/components/schemas/EthFlowDescription' + minItems: 1 + maxItems: 2 + fNum: + type: integer + fDescs: + type: array + items: + $ref: '#/components/schemas/FlowDescription' + minItems: 1 + maxItems: 2 + addInfoFlowDescs: + type: array + items: + $ref: '#/components/schemas/AddFlowDescriptionInfo' + minItems: 1 + maxItems: 2 + description: > + Represents additional flow description information (flow label and IPsec SPI) + per Uplink and/or Downlink IP flows. + fStatus: + $ref: '#/components/schemas/FlowStatus' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + tosTrCl: + $ref: '#/components/schemas/TosTrafficClass' + flowUsage: + $ref: '#/components/schemas/FlowUsage' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqData' + + MediaSubComponentRm: + description: > + This data type is defined in the same way as the MediaSubComponent data type, but with the + OpenAPI nullable property set to true. Removable attributes marBwDl and marBwUl are defined + with the corresponding removable data type. + type: object + required: + - fNum + properties: + afSigProtocol: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' + ethfDescs: + type: array + items: + $ref: '#/components/schemas/EthFlowDescription' + minItems: 1 + maxItems: 2 + nullable: true + fNum: + type: integer + fDescs: + type: array + items: + $ref: '#/components/schemas/FlowDescription' + minItems: 1 + maxItems: 2 + nullable: true + addInfoFlowDescs: + type: array + items: + $ref: '#/components/schemas/AddFlowDescriptionInfo' + minItems: 1 + maxItems: 2 + nullable: true + description: > + Represents additional flow description information (flow label and IPsec SPI) + per Uplink and/or Downlink IP flows. + fStatus: + $ref: '#/components/schemas/FlowStatus' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + tosTrCl: + $ref: '#/components/schemas/TosTrafficClassRm' + flowUsage: + $ref: '#/components/schemas/FlowUsage' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqDataRm' + nullable: true + + EventsNotification: + description: Describes the notification of a matched event. + type: object + required: + - evSubsUri + - evNotifs + properties: + adReports: + type: array + items: + $ref: '#/components/schemas/AppDetectionReport' + minItems: 1 + description: Includes the detected application report. + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + addAccessInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo' + relAccessInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo' + anChargAddr: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AccNetChargingAddress' + anChargIds: + type: array + items: + $ref: '#/components/schemas/AccessNetChargingIdentifier' + minItems: 1 + anGwAddr: + $ref: '#/components/schemas/AnGwAddress' + l4sReports: + type: array + items: + $ref: '#/components/schemas/L4sSupport' + minItems: 1 + evSubsUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + evNotifs: + type: array + items: + $ref: '#/components/schemas/AfEventNotification' + minItems: 1 + failedResourcAllocReports: + type: array + items: + $ref: '#/components/schemas/ResourcesAllocationInfo' + minItems: 1 + succResourcAllocReports: + type: array + items: + $ref: '#/components/schemas/ResourcesAllocationInfo' + minItems: 1 + noNetLocSupp: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/NetLocAccessSupport' + outOfCredReports: + type: array + items: + $ref: '#/components/schemas/OutOfCreditInformation' + minItems: 1 + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + qncReports: + type: array + items: + $ref: '#/components/schemas/QosNotificationControlInfo' + minItems: 1 + qosMonReports: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 + qosMonDatRateReps: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 + pdvMonReports: + type: array + items: + $ref: '#/components/schemas/PdvMonitoringReport' + minItems: 1 + congestReports: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 + rttMonReports: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 + qosMonCapRepos: + type: array + items: + $ref: '#/components/schemas/CapabilityReportFlow' + minItems: 1 + ranNasRelCauses: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RanNasRelCause' + minItems: 1 + description: Contains the RAN and/or NAS release cause. + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + ueLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + usgRep: + $ref: 'TS29122_CommonData.yaml#/components/schemas/AccumulatedUsage' + urspEnfRep: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/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' + tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + tsnPortManContNwtts: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + ipv4AddrList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrMask' + minItems: 1 + ipv6PrefixList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + batOffsetInfo: + $ref: '#/components/schemas/BatOffsetInfo' + ueReachStatus: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UeReachabilityStatus' + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + + AfEventSubscription: + description: Describes the event information delivered in the subscription. + type: object + required: + - event + properties: + event: + $ref: '#/components/schemas/AfEvent' + notifMethod: + $ref: '#/components/schemas/AfNotifMethod' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + waitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + qosMonParamType: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosMonitoringParamType' + + AfEventNotification: + description: Describes the event information delivered in the notification. + type: object + required: + - event + properties: + event: + $ref: '#/components/schemas/AfEvent' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + + TerminationInfo: + description: > + Indicates the cause for requesting the deletion of the Individual Application Session + Context resource. + type: object + required: + - termCause + - resUri + properties: + termCause: + $ref: '#/components/schemas/TerminationCause' + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + + AfRoutingRequirement: + description: Describes AF requirements on routing traffic. + type: object + properties: + appReloc: + type: boolean + routeToLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + spVal: + $ref: '#/components/schemas/SpatialValidity' + tempVals: + type: array + items: + $ref: '#/components/schemas/TemporalValidity' + minItems: 1 + upPathChgSub: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' + addrPreserInd: + type: boolean + 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' + easIpReplaceInfos: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EasIpReplacementInfo' + minItems: 1 + description: Contains EAS IP replacement information. + easRedisInd: + type: boolean + description: Indicates the EAS rediscovery is required. + maxAllowedUpLat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + tfcCorreInfo: + $ref: 'TS29519_Application_Data.yaml#/components/schemas/TrafficCorrelationInfo' + + AfSfcRequirement: + description: Describes AF requirements on steering traffic to N6-LAN. + type: object + properties: + sfcIdDl: + type: string + description: Reference to a pre-configured SFC for downlink traffic. + nullable: true + sfcIdUl: + type: string + description: Reference to a pre-configured SFC for uplink traffic. + nullable: true + spVal: + $ref: '#/components/schemas/SpatialValidityRm' + metadata: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Metadata' + nullable: true + + SpatialValidity: + description: Describes explicitly the route to an Application location. + type: object + required: + - presenceInfoList + properties: + presenceInfoList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Defines the presence information provisioned by the AF. The praId attribute within the + PresenceInfo data type is the key of the map. + + SpatialValidityRm: + description: > + This data type is defined in the same way as the SpatialValidity data type, but with the + OpenAPI nullable property set to true. + type: object + required: + - presenceInfoList + properties: + presenceInfoList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Defines the presence information provisioned by the AF. The praId attribute within the + PresenceInfo data type is the key of the map. + nullable: true + + AfRoutingRequirementRm: + description: > + This data type is defined in the same way as the AfRoutingRequirement data type, but with + the OpenAPI nullable property set to true and the spVal and tempVals attributes defined as + removable. + type: object + properties: + appReloc: + type: boolean + routeToLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + nullable: true + spVal: + $ref: '#/components/schemas/SpatialValidityRm' + tempVals: + type: array + items: + $ref: '#/components/schemas/TemporalValidity' + minItems: 1 + nullable: true + upPathChgSub: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' + addrPreserInd: + type: boolean + nullable: true + simConnInd: + type: boolean + nullable: true + description: > + Indicates whether simultaneous connectivity should be temporarily maintained for the + source and target PSA. + simConnTerm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + easIpReplaceInfos: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EasIpReplacementInfo' + minItems: 1 + description: Contains EAS IP replacement information. + nullable: true + easRedisInd: + type: boolean + description: Indicates the EAS rediscovery is required. + maxAllowedUpLat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' + tfcCorreInfo: + $ref: 'TS29519_Application_Data.yaml#/components/schemas/TrafficCorrelationInfo' + nullable: true + + AnGwAddress: + description: Describes the address of the access network gateway control node. + type: object + anyOf: + - required: [anGwIpv4Addr] + - required: [anGwIpv6Addr] + properties: + anGwIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + anGwIpv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + + Flows: + description: Identifies the flows. + type: object + required: + - medCompN + properties: + contVers: + type: array + items: + $ref: '#/components/schemas/ContentVersion' + minItems: 1 + fNums: + type: array + items: + type: integer + minItems: 1 + medCompN: + type: integer + + EthFlowDescription: + description: Identifies an Ethernet flow. + type: object + required: + - ethType + properties: + destMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + ethType: + type: string + fDesc: + $ref: '#/components/schemas/FlowDescription' + fDir: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowDirection' + sourceMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + vlanTags: + type: array + items: + type: string + minItems: 1 + maxItems: 2 + srcMacAddrEnd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + destMacAddrEnd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + + ResourcesAllocationInfo: + description: Describes the status of the PCC rule(s) related to certain media components. + type: object + properties: + mcResourcStatus: + $ref: '#/components/schemas/MediaComponentResourcesStatus' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + altSerReq: + type: string + description: > + Indicates whether NG-RAN supports alternative QoS parameters. The default value false + shall apply if the attribute is not present. It shall be set to false to indicate that + the lowest priority alternative QoS profile could not be fulfilled. + + TemporalValidity: + description: Indicates the time interval(s) during which the AF request is to be applied. + type: object + properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + stopTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + + QosNotificationControlInfo: + description: > + Indicates whether the QoS targets for a GRB flow are not guaranteed or guaranteed again. + type: object + required: + - notifType + properties: + notifType: + $ref: '#/components/schemas/QosNotifType' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + altSerReq: + type: string + description: > + Indicates the alternative service requirement NG-RAN can guarantee. When it is omitted + and the notifType attribute is set to NOT_GUAARANTEED it indicates that the lowest + priority alternative alternative service requirement could not be fulfilled by NG-RAN. + altSerReqNotSuppInd: + type: boolean + description: > + When present and set to true it indicates that Alternative Service Requirements are not + supported by NG-RAN. + + AcceptableServiceInfo: + description: Indicates the maximum bandwidth that shall be authorized by the PCF. + type: object + properties: + accBwMedComps: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaComponent' + description: > + Indicates the maximum bandwidth that shall be authorized by the PCF for each media + component of the map. The key of the map is the media component number. + minProperties: 1 + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + + UeIdentityInfo: + description: Represents 5GS-Level UE identities. + type: object + anyOf: + - required: [gpsi] + - required: [pei] + - required: [supi] + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + + AccessNetChargingIdentifier: + description: Describes the access network charging identifier. + type: object + oneOf: + - required: [accNetChaIdValue] + - required: [accNetChargIdString] + properties: + accNetChaIdValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + accNetChargIdString: + type: string + description: A character string containing the access network charging identifier. + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + + OutOfCreditInformation: + description: > + Indicates the SDFs without available credit and the corresponding termination action. + type: object + required: + - finUnitAct + properties: + finUnitAct: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/FinalUnitAction' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + + QosMonitoringInformation: + description: > + Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or + round trip delay. + type: object + properties: + repThreshDl: + type: integer + repThreshUl: + type: integer + repThreshRp: + type: integer + repThreshDatRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + repThreshDatRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + conThreshDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + conThreshUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + + PduSessionTsnBridge: + description: > + Contains the new TSC user plane node information and may contain the DS-TT port and/or + NW-TT port management information. + type: object + required: + - tsnBridgeInfo + properties: + tsnBridgeInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/TsnBridgeInfo' + tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + tsnPortManContNwtts: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + ueIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + ipDomain: + type: string + description: IPv4 address domain identifier. + ueIpv6AddrPrefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + + QosMonitoringInformationRm: + description: > + This data type is defined in the same way as the QosMonitoringInformation data type, but + with the OpenAPI nullable property set to true. + type: object + properties: + repThreshDl: + type: integer + nullable: true + repThreshUl: + type: integer + nullable: true + repThreshRp: + type: integer + nullable: true + repThreshDatRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + repThreshDatRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + conThreshDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' + conThreshUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' + nullable: true + + PcscfRestorationRequestData: + description: Indicates P-CSCF restoration. + type: object + oneOf: + - required: [ueIpv4] + - required: [ueIpv6] + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + ipDomain: + type: string + sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + ueIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + + QosMonitoringReport: + description: QoS Monitoring reporting information. + type: object + properties: + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + 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. + ulConInfo: + type: array + items: + type: integer + minItems: 1 + dlConInfo: + type: array + items: + type: integer + minItems: 1 + ulDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + + TsnQosContainer: + description: Indicates TSC Traffic QoS. + type: object + properties: + maxTscBurstSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol' + tscPackDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + maxPer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + tscPrioLevel: + $ref: '#/components/schemas/TscPriorityLevel' + + TsnQosContainerRm: + description: Indicates removable TSC Traffic QoS. + type: object + properties: + maxTscBurstSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + tscPackDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudgetRm' + maxPer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRateRm' + tscPrioLevel: + $ref: '#/components/schemas/TscPriorityLevelRm' + nullable: true + + TscaiInputContainer: + description: Indicates TSC Traffic pattern. + type: object + properties: + periodicity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + burstArrivalTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + surTimeInNumMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + surTimeInTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + burstArrivalTimeWnd: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + periodicityRange: + $ref: '#/components/schemas/PeriodicityRange' + nullable: true + + AppDetectionReport: + description: > + Indicates the start or stop of the detected application traffic and the application + identifier of the detected application traffic. + type: object + required: + - adNotifType + - afAppId + properties: + adNotifType: + $ref: '#/components/schemas/AppDetectionNotifType' + afAppId: + $ref: '#/components/schemas/AfAppId' + + PduSessionEventNotification: + description: > + Indicates PDU session related events information. + type: object + required: + - evNotif + properties: + evNotif: + $ref: '#/components/schemas/AfEventNotification' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + ueIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + status: + $ref: '#/components/schemas/PduSessionStatus' + pcfInfo: + $ref: '#/components/schemas/PcfAddressingInfo' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + + PcfAddressingInfo: + description: Contains PCF address information. + type: object + properties: + pcfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_PolicyAuthorization service. + bindingInfo: + type: string + description: contains the binding indications of the PCF. + + AlternativeServiceRequirementsData: + description: Contains an alternative QoS related parameter set. + type: object + required: + - altQosParamSetRef + properties: + altQosParamSetRef: + type: string + description: Reference to this alternative QoS related parameter set. + gbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + pdb: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + per: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + + EventsSubscPutData: + description: > + Identifies the events the application subscribes to within an Events Subscription + sub-resource data. It may contain the notification of the already met events. + anyOf: + - $ref: '#/components/schemas/EventsSubscReqData' + - $ref: '#/components/schemas/EventsNotification' + + PeriodicityRange: + description: > + Contains the acceptable range (which is formulated as lower bound and upper bound of + the periodicity of the start twobursts in reference to the external GM) or + acceptable periodicity value(s) (which is formulated as a list of values for + the periodicity). + type: object + oneOf: + - required: [lowerBound, upperBound] + - required: [periodicVals] + properties: + lowerBound: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + upperBound: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + periodicVals: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minItems: 1 + + BatOffsetInfo: + description: > + Indicates the offset of the BAT and the optionally adjusted periodicity. + type: object + required: + - ranBatOffsetNotif + 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' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + description: > + Identification of the flows. If no flows are provided, the BAT offset applies + for all flows of the AF session. + + PdvMonitoringReport: + description: Packet Delay Variation reporting information. + type: object + properties: + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + description: Identification of the flows. + ulPdv: + type: integer + description: Uplink packet delay variation in units of milliseconds. + dlPdv: + type: integer + description: Downlink packet delay variation in units of milliseconds. + rtPdv: + type: integer + description: Round trip packet delay variation in units of milliseconds. + + AddFlowDescriptionInfo: + description: Contains additional flow description information. + type: object + properties: + spi: + type: string + description: > + 4-octet string representing the security parameter index of the IPSec packet + in hexadecimal representation. + flowLabel: + type: string + description: > + 3-octet string representing the IPv6 flow label header field in hexadecimal + representation. + flowDir: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowDirection' + + L4sSupport: + description: > + Indicates whether the ECN marking for L4S support is not available or available + again in 5GS. + type: object + required: + - notifType + properties: + notifType: + $ref: '#/components/schemas/L4sNotifType' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + + DirectNotificationReport: + description: > + Represents the QoS monitoring parameters that cannot be directly notified for + the indicated flows. + type: object + required: + - qosMonParamType + properties: + qosMonParamType: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosMonitoringParamType' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + + RttFlowReference: + description: > + Contains the shared key with the media subcomponent that shares the subscription to + round trip time measurements in the complementary direction. + type: object + required: + - sharedKey + properties: + flowDir: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowDirection' + sharedKey: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + + RttFlowReferenceRm: + description: > + It is defined as the RttFlowRerence data type but with the OpenAPI nullable true property. + type: object + required: + - sharedKey + properties: + flowDir: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowDirection' + sharedKey: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + nullable: true + + CapabilityReportFlow: + description: Contains control support information. + type: object + properties: + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + description: > + An array of flows associated with the notified support. + capReport: + $ref: '#/components/schemas/NotifCap' + required: + - capReport + +# +# EXTENDED PROBLEMDETAILS +# + ExtendedProblemDetails: + description: Extends ProblemDetails to also include the acceptable service info. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - type: object + properties: + acceptableServInfo: + $ref: '#/components/schemas/AcceptableServiceInfo' + +# +# SIMPLE DATA TYPES +# + AfAppId: + description: Contains an AF application identifier. + type: string + AspId: + description: Contains an identity of an application service provider. + type: string + CodecData: + description: Contains codec related information. + type: string + ContentVersion: + description: Represents the content version of some content. + type: integer + FlowDescription: + description: Defines a packet filter of an IP flow. + type: string + SponId: + description: Contains an identity of a sponsor. + type: string + ServiceUrn: + description: Contains values of the service URN and may include subservices. + type: string + TosTrafficClass: + description: > + 2-octet string, where each octet is encoded in hexadecimal representation. The first octet + contains the IPv4 Type-of-Service or the IPv6 Traffic-Class field and the second octet + contains the ToS/Traffic Class mask field. + type: string + TosTrafficClassRm: + description: > + This data type is defined in the same way as the TosTrafficClass data type, but with the + OpenAPI nullable property set to true. + type: string + nullable: true + MultiModalId: + description: > + This data type contains a multi-modal service identifier. + type: string + TscPriorityLevel: + description: Represents the priority level of TSC Flows. + type: integer + minimum: 1 + maximum: 8 + TscPriorityLevelRm: + description: > + This data type is defined in the same way as the TscPriorityLevel data type, but with the + OpenAPI nullable property set to true. + type: integer + minimum: 1 + maximum: 8 + nullable: true + + DurationMilliSec: + description: Indicates the time interval in units of milliseconds. + type: integer + + DurationMilliSecRm: + description: > + This data type is defined in the same way as the "DurationMillisec" data type, but with the + OpenAPI nullable property set to true. + type: integer + +# +# ENUMERATIONS DATA TYPES +# + MediaType: + description: Indicates the media type of a media component. + anyOf: + - type: string + enum: + - AUDIO + - VIDEO + - DATA + - APPLICATION + - CONTROL + - TEXT + - MESSAGE + - OTHER + - 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. + + MpsAction: + description: > + Indicates whether it is an invocation, a revocation or an invocation with authorization of + the MPS for DTS service. + anyOf: + - type: string + enum: + - DISABLE_MPS_FOR_DTS + - ENABLE_MPS_FOR_DTS + - AUTHORIZE_AND_ENABLE_MPS_FOR_DTS + - AUTHORIZE_AND_ENABLE_MPS_FOR_AF_SIGNALLING + - 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. + + ReservPriority: + description: Indicates the reservation priority. + anyOf: + - type: string + enum: + - PRIO_1 + - PRIO_2 + - PRIO_3 + - PRIO_4 + - PRIO_5 + - PRIO_6 + - PRIO_7 + - PRIO_8 + - PRIO_9 + - PRIO_10 + - PRIO_11 + - PRIO_12 + - PRIO_13 + - PRIO_14 + - PRIO_15 + - PRIO_16 + - 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. + + ServAuthInfo: + description: Indicates the result of the Policy Authorization service request from the AF. + anyOf: + - type: string + enum: + - TP_NOT_KNOWN + - TP_EXPIRED + - TP_NOT_YET_OCURRED + - ROUT_REQ_NOT_AUTHORIZED + - DIRECT_NOTIF_NOT_POSSIBLE + - 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. + + SponsoringStatus: + description: Indicates whether sponsored data connectivity is enabled or disabled/not enabled. + anyOf: + - type: string + enum: + - SPONSOR_DISABLED + - SPONSOR_ENABLED + - 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. + + AfEvent: + description: Represents an event to notify to the AF. + anyOf: + - type: string + enum: + - ACCESS_TYPE_CHANGE + - ANI_REPORT + - APP_DETECTION + - CHARGING_CORRELATION + - EPS_FALLBACK + - EXTRA_UE_ADDR + - FAILED_QOS_UPDATE + - FAILED_RESOURCES_ALLOCATION + - OUT_OF_CREDIT + - PDU_SESSION_STATUS + - PLMN_CHG + - QOS_MONITORING + - QOS_MON_CAP_REPO + - QOS_NOTIF + - RAN_NAS_CAUSE + - REALLOCATION_OF_CREDIT + - SAT_CATEGORY_CHG + - SUCCESSFUL_QOS_UPDATE + - SUCCESSFUL_RESOURCES_ALLOCATION + - TSN_BRIDGE_INFO + - UP_PATH_CHG_FAILURE + - USAGE_REPORT + - UE_REACH_STATUS_CH + - BAT_OFFSET_INFO + - URSP_ENF_INFO + - PACK_DEL_VAR + - L4S_SUPP + - RT_DELAY_TWO_QOS_FLOWS + - 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. + + AfNotifMethod: + description: Represents the notification methods that can be subscribed for an event. + anyOf: + - type: string + enum: + - EVENT_DETECTION + - ONE_TIME + - 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. + + QosNotifType: + description: Indicates the notification type for QoS Notification Control. + anyOf: + - type: string + enum: + - GUARANTEED + - NOT_GUARANTEED + - 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. + + TerminationCause: + description: > + Indicates the cause behind requesting the deletion of the Individual Application Session + Context resource. + anyOf: + - type: string + enum: + - ALL_SDF_DEACTIVATION + - PDU_SESSION_TERMINATION + - PS_TO_CS_HO + - INSUFFICIENT_SERVER_RESOURCES + - INSUFFICIENT_QOS_FLOW_RESOURCES + - SPONSORED_DATA_CONNECTIVITY_DISALLOWED + - 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. + + MediaComponentResourcesStatus: + description: Indicates whether the media component is active or inactive. + 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. + + FlowUsage: + description: Describes the flow usage of the flows described by a media subcomponent. + anyOf: + - type: string + enum: + - NO_INFO + - RTCP + - AF_SIGNALLING + - 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. + + FlowStatus: + description: Describes whether the IP flow(s) are enabled or disabled. + anyOf: + - type: string + enum: + - ENABLED-UPLINK + - ENABLED-DOWNLINK + - ENABLED + - DISABLED + - REMOVED + - 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. + + RequiredAccessInfo: + description: Indicates the access network information required for an AF session. + anyOf: + - type: string + enum: + - USER_LOCATION + - UE_TIME_ZONE + - 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. + + SipForkingIndication: + description: > + Indicates whether several SIP dialogues are related to an "Individual Application Session + Context" resource. + anyOf: + - type: string + enum: + - SINGLE_DIALOGUE + - SEVERAL_DIALOGUES + - 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. + + AfRequestedData: + description: Represents the information that the AF requested to be exposed. + anyOf: + - type: string + enum: + - UE_IDENTITY + - 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. + + ServiceInfoStatus: + description: Represents the preliminary or final service information status. + anyOf: + - type: string + enum: + - FINAL + - PRELIMINARY + - 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. + + PreemptionControlInformation: + description: Represents Pre-emption control information. + anyOf: + - type: string + enum: + - MOST_RECENT + - LEAST_RECENT + - HIGHEST_BW + - 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. + + PrioritySharingIndicator: + description: Represents the Priority sharing indicator. + anyOf: + - type: string + enum: + - ENABLED + - DISABLED + - 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. + + PreemptionControlInformationRm: + description: > + This data type is defined in the same way as the PreemptionControlInformation data type, but + with the OpenAPI nullable property set to true. + anyOf: + - $ref: '#/components/schemas/PreemptionControlInformation' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' + + AppDetectionNotifType: + description: Indicates the notification type for Application Detection Control. + anyOf: + - type: string + enum: + - APP_START + - APP_STOP + - 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. + + PduSessionStatus: + description: Indicates whether the PDU session is established or terminated. + anyOf: + - type: string + enum: + - ESTABLISHED + - TERMINATED + - 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. + + UplinkDownlinkSupport: + description: > + Represents whether an indication or capability is supported for the UL, the DL or both, + UL and DL. + anyOf: + - type: string + enum: + - UL + - DL + - UL_DL + - 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. + + L4sNotifType: + description: Indicates the notification type for ECN marking for L4S support in 5GS. + anyOf: + - type: string + enum: + - AVAILABLE + - NOT_AVAILABLE + - 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. + + NotifCap: + description: Indicates whether the notified capability is supported or not supported. + anyOf: + - type: string + enum: + - SUPPORTED + - 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. + -- GitLab From abf8c5089e0af8a9c7c9cffb507f4df34a3b3115 Mon Sep 17 00:00:00 2001 From: Miguel Angel Reina Ortega Date: Mon, 30 Sep 2024 10:29:04 +0200 Subject: [PATCH 30/33] Adding CT OpenAPI files as submodule --- .gitmodules | 4 ++++ OpenAPI/externals | 1 + 2 files changed, 5 insertions(+) create mode 100644 .gitmodules create mode 160000 OpenAPI/externals diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..1e7356a --- /dev/null +++ b/.gitmodules @@ -0,0 +1,4 @@ +[submodule "OpenAPI/externals"] + path = OpenAPI/externals + url = https://forge.3gpp.org/rep/all/5G_APIs.git + branch = REL-19 diff --git a/OpenAPI/externals b/OpenAPI/externals new file mode 160000 index 0000000..8f1d585 --- /dev/null +++ b/OpenAPI/externals @@ -0,0 +1 @@ +Subproject commit 8f1d5851d3378c3a2d91ff0f26c805384cc68b23 -- GitLab From 8af22a48eb834ba7467b41c5dc88c8de582daf9f Mon Sep 17 00:00:00 2001 From: mozhi Date: Tue, 5 Nov 2024 10:18:19 +0000 Subject: [PATCH 31/33] TS32.291_Rel19_CR0589 for Ranging and Sidelink Positioning charging --- OpenAPI/TS32291_Nchf_ConvergedCharging.yaml | 37 +++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml b/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml index 02482aa..dbbcb11 100644 --- a/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml +++ b/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml @@ -378,6 +378,8 @@ components: $ref: '#/components/schemas/NSACFChargingInformation' nSSAAChargingInformation: $ref: '#/components/schemas/NSSAAChargingInformation' + rangingSLChargingInformation: + $ref: '#/components/schemas/RangingSLChargingInformation' required: - nfConsumerIdentification - invocationTimeStamp @@ -2109,6 +2111,30 @@ components: required: - nSSAAMessageType - userIdentification + RangingSLChargingInformation: + type: object + properties: + targetUEID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + sLReferenceUEID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + sLPositioningServerUEID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + locatedUEID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + locationType: + $ref: '#/components/schemas/LocationType' + locationEstimate: + $ref: '#/components/schemas/LocationEstimate' + LocationEstimate: + type: object + properties: + userLocationInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + horizontalAccuracy: + $ref: '#/components/schemas/OctetString' + verticalAccuracy: + $ref: '#/components/schemas/OctetString' PFIContainerInformation: type: object properties: @@ -2509,6 +2535,7 @@ components: - TSCTSF - MB_SMF - CHF + - GMLC - type: string ChargingCharacteristicsSelectionMode: anyOf: @@ -3135,5 +3162,15 @@ components: - Re-Authentication-Notification - Revocation Notification - type: string + LocationType: + anyOf: + - type: string + enum: + - CURRENT_LOCATION + - LAST_KNOWN_LOCATION + - INITIAL_LOCATION + - DEFERRED_LOCATION + - NOTIFICATION_VERIFICATION + - type: string -- GitLab From 572d88976449a885b9583773fdbc70a66b96a307 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Sat, 30 Nov 2024 03:41:36 +0000 Subject: [PATCH 32/33] Update file TS32291_Nchf_ConvergedCharging.yaml --- OpenAPI/TS32291_Nchf_ConvergedCharging.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml b/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml index dbbcb11..7cab92c 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.3.0-alpha.1 description: | ConvergedCharging Service © 2023, 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 V19.1.0: Telecommunication management; Charging management; 5G system, charging service; Stage 3. url: 'http://www.3gpp.org/ftp/Specs/archive/32_series/32.291/' servers: -- GitLab From c217285b65f2c115ef4298c535d7e9e3c0017047 Mon Sep 17 00:00:00 2001 From: SHAN CHEN Date: Sat, 30 Nov 2024 03:42:36 +0000 Subject: [PATCH 33/33] Code moderator update the TS Version to TS 32.291 19.1.0 and Version 3.3.0-alpha.1 --- OpenAPI/TS32291_Nchf_ConvergedCharging.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml b/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml index 7cab92c..6f502c1 100644 --- a/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml +++ b/OpenAPI/TS32291_Nchf_ConvergedCharging.yaml @@ -1,4 +1,7 @@ openapi: 3.0.0 +info: + title: Nchf_ConvergedCharging +api: 3.0.0 info: title: Nchf_ConvergedCharging version: 3.3.0-alpha.1 -- GitLab