From a73bceee521194108ce49a57c077d37741104f95 Mon Sep 17 00:00:00 2001 From: Jesus de Gregorio Date: Sat, 9 Mar 2024 19:39:45 +0100 Subject: [PATCH] Rel-18 Dec'23 --- TS24558_Eecs_ServiceProvisioning.yaml | 39 +- TS24558_Eees_ACREvents.yaml | 8 +- TS24558_Eees_AppContextRelocation.yaml | 20 +- TS24558_Eees_EASDiscovery.yaml | 18 +- TS24558_Eees_EECRegistration.yaml | 20 +- TS26512_CommonData.yaml | 141 +- TS26512_EventExposure.yaml | 300 +++ ...2_M1_ConsumptionReportingProvisioning.yaml | 11 +- TS26512_M1_ContentHostingProvisioning.yaml | 14 +- ...ntentPreparationTemplatesProvisioning.yaml | 24 +- TS26512_M1_PolicyTemplatesProvisioning.yaml | 28 +- TS26512_M1_ProvisioningSessions.yaml | 8 +- TS26512_M5_ConsumptionReporting.yaml | 8 +- TS26512_M5_ServiceAccessInformation.yaml | 29 +- TS26512_R2_DataReporting.yaml | 26 + TS26512_R4_DataReporting.yaml | 96 +- TS28104_MdaReport.yaml | 6 +- TS28105_AiMlNrm.yaml | 6 +- TS28312_IntentExpectations.yaml | 274 ++- TS28312_IntentNrm.yaml | 245 ++- TS28317_RanScNrm.yaml | 176 ++ TS28532_FaultMnS.yaml | 2 +- TS28532_FileDataReportingMnS.yaml | 2 +- TS28532_HeartbeatNtf.yaml | 2 +- TS28532_PerfMnS.yaml | 2 +- TS28532_ProvMnS.yaml | 3 +- TS28532_StreamingDataMnS.yaml | 4 +- TS28538_EdgeNrm.yaml | 134 +- TS28541_5GcNrm.yaml | 1100 ++++++++++- TS28541_NrNrm.yaml | 116 +- TS28541_SliceNrm.yaml | 189 +- TS28623_ComDefs.yaml | 48 +- TS28623_GenericNrm.yaml | 1705 +++-------------- TS28623_TraceControlNrm.yaml | 1470 ++++++++++++++ TS29122_AsSessionWithQoS.yaml | 72 +- TS29122_CommonData.yaml | 6 +- TS29122_CpProvisioning.yaml | 27 +- TS29122_GMDviaMBMSbyMB2.yaml | 50 +- TS29122_MonitoringEvent.yaml | 59 +- TS29122_PfdManagement.yaml | 16 +- TS29122_RacsParameterProvisioning.yaml | 6 +- TS29175_Nimsas_MediaControl.yaml | 216 +++ TS29175_Nimsas_SessionEventControl.yaml | 268 +++ TS29176_Nmf_MRM.yaml | 349 ++++ TS29222_CAPIF_Discover_Service_API.yaml | 35 +- TS29222_CAPIF_Events_API.yaml | 30 +- TS29222_CAPIF_Publish_Service_API.yaml | 88 +- TS29222_CAPIF_Security_API.yaml | 45 +- TS29257_UAE_DAASupport.yaml | 7 +- TS29309_Nbsp_GBA.yaml | 14 +- TS29435_NSCE_PolicyManagement.yaml | 678 +++++++ TS29486_VAE_ApplicationRequirement.yaml | 8 +- TS29486_VAE_DynamicGroup.yaml | 8 +- TS29486_VAE_HDMapDynamicInfo.yaml | 8 +- TS29486_VAE_MessageDelivery.yaml | 10 +- TS29486_VAE_PC5ProvisioningRequirement.yaml | 8 +- TS29486_VAE_ServiceAndQoSControlInfo.yaml | 423 ++++ TS29486_VAE_SessionOrientedService.yaml | 8 +- TS29486_VAE_V2PApplicationRequirement.yaml | 306 +++ TS29486_VAE_VRUZoneManagement.yaml | 511 +++++ TS29500_CustomHeaders.abnf | 39 +- TS29502_CustomHeaders.abnf | 9 +- TS29502_Nsmf_PDUSession.yaml | 263 ++- TS29503_Nudm_EE.yaml | 41 +- TS29503_Nudm_PP.yaml | 82 +- TS29503_Nudm_SDM.yaml | 377 ++-- TS29503_Nudm_UEAU.yaml | 8 +- TS29503_Nudm_UECM.yaml | 35 +- TS29504_CustomHeaders.abnf | 4 +- TS29504_Nudr_DR.yaml | 13 +- TS29504_Nudr_GroupIDmap.yaml | 74 +- TS29505_Subscription_Data.yaml | 260 +-- TS29508_Nsmf_EventExposure.yaml | 73 +- TS29509_Nausf_UEAuthentication.yaml | 6 +- TS29510_Nnrf_AccessToken.yaml | 14 +- TS29510_Nnrf_Bootstrapping.yaml | 13 +- TS29510_Nnrf_NFDiscovery.yaml | 99 +- TS29510_Nnrf_NFManagement.yaml | 194 +- TS29512_Npcf_SMPolicyControl.yaml | 48 +- TS29514_Npcf_PolicyAuthorization.yaml | 8 +- TS29515_Ngmlc_Location.yaml | 91 +- TS29517_Naf_EventExposure.yaml | 42 +- TS29518_Namf_Communication.yaml | 38 +- TS29518_Namf_EventExposure.yaml | 28 +- TS29518_Namf_Location.yaml | 72 +- TS29518_Namf_MBSBroadcast.yaml | 132 +- TS29518_Namf_MT.yaml | 4 +- TS29519_Application_Data.yaml | 969 +++++++++- TS29519_Policy_Data.yaml | 85 +- TS29520_Nnwdaf_AnalyticsInfo.yaml | 18 +- TS29520_Nnwdaf_DataManagement.yaml | 32 +- TS29520_Nnwdaf_EventsSubscription.yaml | 270 ++- TS29520_Nnwdaf_MLModelMonitor.yaml | 461 +++++ TS29520_Nnwdaf_MLModelProvision.yaml | 121 +- TS29520_Nnwdaf_MLModelTraining.yaml | 14 +- TS29520_Nnwdaf_RoamingAnalytics.yaml | 294 +++ TS29520_Nnwdaf_RoamingData.yaml | 278 +++ TS29522_ASTI.yaml | 50 +- TS29522_AnalyticsExposure.yaml | 97 +- TS29522_DNAIMapping.yaml | 45 +- TS29522_EASDeployment.yaml | 6 +- TS29522_ECSAddress.yaml | 369 ++++ TS29522_EcsAddressProvision.yaml | 6 +- TS29522_MBSGroupMsgDelivery.yaml | 91 +- TS29522_MBSSession.yaml | 50 +- TS29522_MBSTMGI.yaml | 33 +- TS29522_MemberUESelectionAssistance.yaml | 303 ++- TS29522_PDTQPolicyNegotiation.yaml | 9 +- TS29522_ServiceParameter.yaml | 38 +- TS29522_SliceParamProvision.yaml | 6 +- TS29522_TimeSyncExposure.yaml | 132 +- TS29522_TrafficInfluence.yaml | 8 +- TS29522_UEAddress.yaml | 103 + TS29522_UEId.yaml | 9 +- TS29525_Npcf_UEPolicyControl.yaml | 155 +- TS29531_Nnssf_NSSAIAvailability.yaml | 38 +- TS29532_Nmbsmf_MBSSession.yaml | 34 +- TS29536_Nnsacf_NSAC.yaml | 24 +- TS29536_Nnsacf_SliceEventExposure.yaml | 14 +- TS29537_Npcf_MBSPolicyAuthorization.yaml | 9 +- TS29537_Npcf_MBSPolicyControl.yaml | 6 +- TS29538_MSGG_BGDelivery.yaml | 19 +- TS29538_MSGG_L3GDelivery.yaml | 14 +- TS29538_MSGG_N3GDelivery.yaml | 15 +- TS29538_MSGS_ASRegistration.yaml | 14 +- TS29538_MSGS_MSGDelivery.yaml | 13 +- TS29540_Nsmsf_SMService.yaml | 6 +- TS29543_Npcf_PDTQPolicyControl.yaml | 7 +- TS29548_SDD_DDContext.yaml | 106 +- TS29548_SDD_DataStorage.yaml | 983 ++++++++++ TS29548_SDD_PolicyConfiguration.yaml | 397 ++++ TS29548_SDD_Transmission.yaml | 255 ++- ...48_SDD_TransmissionQualityMeasurement.yaml | 245 ++- TS29549_SS_IdmParameterProvisioning.yaml | 378 ++++ TS29549_SS_LocationReporting.yaml | 164 +- TS29549_SS_NetworkResourceAdaptation.yaml | 291 ++- TS29549_SS_VALServiceAreaConfiguration.yaml | 381 +++- TS29550_Nsoraf_SOR.yaml | 6 +- TS29551_Nnef_PFDmanagement.yaml | 23 +- TS29553_Npanf_ResolveRemoteUserId.yaml | 8 +- TS29555_N5g-ddnmf_Discovery.yaml | 12 +- TS29556_Neasdf_DNSContext.yaml | 17 +- TS29558_Eecs_EESRegistration.yaml | 52 +- TS29558_Eecs_TargetEESDiscovery.yaml | 13 +- TS29558_Eees_ACRManagementEvent.yaml | 83 +- TS29558_Eees_CommonEASAnnouncement.yaml | 23 +- TS29558_Eees_EASRegistration.yaml | 28 +- TS29558_Eees_UEIdentifier.yaml | 116 +- TS29559_Npkmf_Discovery.yaml | 372 ++++ TS29563_Nhss_EE.yaml | 97 +- TS29563_Nhss_SDM.yaml | 25 +- TS29563_Nhss_UEAU.yaml | 16 +- TS29563_Nhss_UECM.yaml | 12 +- TS29564_Nupf_EventExposure.yaml | 39 +- TS29564_Nupf_GetPrivateUEIPaddr.yaml | 8 +- TS29565_Ntsctsf_ASTI.yaml | 54 +- TS29565_Ntsctsf_TimeSynchronization.yaml | 41 +- TS29571_CommonData.yaml | 219 ++- TS29572_Nlmf_Location.yaml | 276 ++- TS29573_JOSEProtectedMessageForwarding.yaml | 35 +- TS29573_N32_Handshake.yaml | 11 +- TS29574_Ndccf_DataManagement.yaml | 14 +- TS29575_Nadrf_DataManagement.yaml | 4 +- TS29575_Nadrf_MLModelManagement.yaml | 137 +- TS29580_Nmbsf_MBSUserDataIngestSession.yaml | 19 +- TS29581_Nmbstf_DistSession.yaml | 14 +- TS29583_PIN_ASRegistration.yaml | 329 ++++ TS29583_PIN_ASServiceContinuity.yaml | 400 ++++ TS29583_PIN_ASServiceSwitch.yaml | 394 ++++ TS29586_Nslpkmf_Discovery.yaml | 397 ++++ TS29586_Nslpkmf_SLPKMFKeyRequest.yaml | 141 ++ TS29591_Nnef_EventExposure.yaml | 51 +- TS29591_Nnef_TrafficInfluenceData.yaml | 26 +- TS29591_Nnef_UEId.yaml | 98 + TS29594_Nchf_SpendingLimitControl.yaml | 31 +- TS29598_Nudsf_DataRepository.yaml | 58 +- TS29598_Nudsf_Timer.yaml | 8 +- TS29675_Nucmf_Provisioning.yaml | 6 +- TS32291_Nchf_ConvergedCharging.yaml | 88 +- 179 files changed, 19422 insertions(+), 3441 deletions(-) create mode 100644 TS26512_EventExposure.yaml create mode 100644 TS26512_R2_DataReporting.yaml create mode 100644 TS28317_RanScNrm.yaml create mode 100644 TS28623_TraceControlNrm.yaml create mode 100644 TS29175_Nimsas_MediaControl.yaml create mode 100644 TS29175_Nimsas_SessionEventControl.yaml create mode 100644 TS29176_Nmf_MRM.yaml create mode 100644 TS29435_NSCE_PolicyManagement.yaml create mode 100644 TS29486_VAE_ServiceAndQoSControlInfo.yaml create mode 100644 TS29486_VAE_V2PApplicationRequirement.yaml create mode 100644 TS29486_VAE_VRUZoneManagement.yaml create mode 100644 TS29520_Nnwdaf_MLModelMonitor.yaml create mode 100644 TS29520_Nnwdaf_RoamingAnalytics.yaml create mode 100644 TS29520_Nnwdaf_RoamingData.yaml create mode 100644 TS29522_ECSAddress.yaml create mode 100644 TS29522_UEAddress.yaml create mode 100644 TS29548_SDD_DataStorage.yaml create mode 100644 TS29548_SDD_PolicyConfiguration.yaml create mode 100644 TS29549_SS_IdmParameterProvisioning.yaml create mode 100644 TS29559_Npkmf_Discovery.yaml create mode 100644 TS29583_PIN_ASRegistration.yaml create mode 100644 TS29583_PIN_ASServiceContinuity.yaml create mode 100644 TS29583_PIN_ASServiceSwitch.yaml create mode 100644 TS29586_Nslpkmf_Discovery.yaml create mode 100644 TS29586_Nslpkmf_SLPKMFKeyRequest.yaml create mode 100644 TS29591_Nnef_UEId.yaml diff --git a/TS24558_Eecs_ServiceProvisioning.yaml b/TS24558_Eecs_ServiceProvisioning.yaml index fb5f0062..ff6361fb 100644 --- a/TS24558_Eecs_ServiceProvisioning.yaml +++ b/TS24558_Eecs_ServiceProvisioning.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: Eecs_ServiceProvisioning - version: "1.1.0-alpha.3" + version: "1.1.0-alpha.4" description: | API for ECS Service Provisioning. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 24.558 V18.2.0 Enabling Edge Applications; Protocol specification. + description: 3GPP TS 24.558 V18.3.0 Enabling Edge Applications; Protocol specification. url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/ security: @@ -529,10 +529,41 @@ components: description: > The EAS instantiation status per EASID (e.g. instantiated, instantiable but not be instantiated yet). + eesAuthMethods: + type: array + items: + $ref: '#/components/schemas/EesAuthMethod' + minItems: 1 + description: > + Indicates the authentication methods supported by the EES. + easBundleInfo: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EASBundleInfo' required: - eesId - eecRegConf + EesAuthMethod: + anyOf: + - type: string + enum: + - TLS_CLIENT_SERVER_CERTIFICATE + - TLS_WITH_AKMA + - TLS_WITH_GBA + - SERVER_SIDE_CERTIFICATE_BASED + - 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 Authentication methods supported by EES. + Possible values are: + - TLS_CLIENT_SERVER_CERTIFICATE: Represents TLS with client server certificate + authentication. + - TLS_WITH_AKMA: Represents TLS with AKMA authentication. + - TLS_WITH_GBA: Represents TLS with GBA authentication. + - SERVER_SIDE_CERTIFICATE_BASED: Represents server side certification only. + ECSServProvSubscriptionPatch: description: > Represents modifications to an individual service provisioning subscription resource. @@ -550,10 +581,10 @@ components: items: $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario' description: > - Indicates if the EEC supports service continuity or not, also indicates which ACR - scenarios are supported by the EEC. + Indicates which ACR scenarios are supported by the EEC. connInfo: type: array items: $ref: '#/components/schemas/ConnectivityInfo' description: List of connectivity information for the UE. + diff --git a/TS24558_Eees_ACREvents.yaml b/TS24558_Eees_ACREvents.yaml index 256a94cc..1f817f8e 100644 --- a/TS24558_Eees_ACREvents.yaml +++ b/TS24558_Eees_ACREvents.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: Eees_ACREvents - version: "1.1.0-alpha.1" + version: "1.1.0-alpha.2" description: | API for ACR events subscription and notification. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 24.558 V18.1.0 Enabling Edge Applications; Protocol specification. + 3GPP TS 24.558 V18.3.0 Enabling Edge Applications; Protocol specification. url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/' security: @@ -22,7 +22,7 @@ servers: variables: apiRoot: default: https://example.com - description: apiRoot as defined in clause 6.1 of 3GPP TS 24.558 + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558 paths: @@ -412,3 +412,5 @@ components: required: - acrRes - tEasEndpoint + + diff --git a/TS24558_Eees_AppContextRelocation.yaml b/TS24558_Eees_AppContextRelocation.yaml index 6049eb06..cf34a214 100644 --- a/TS24558_Eees_AppContextRelocation.yaml +++ b/TS24558_Eees_AppContextRelocation.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: Eees Application Context Relocation Service - version: "1.1.0-alpha.2" + version: "1.1.0-alpha.3" description: | Eees Application Context Relocation Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -9,7 +9,7 @@ info: externalDocs: description: > - 3GPP TS 24.558 V18.1.0; Enabling Edge Applications; Protocol specification; Stage 3. + 3GPP TS 24.558 V18.3.0; Enabling Edge Applications; Protocol specification; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/24.558/' servers: @@ -177,6 +177,8 @@ components: type: string sEasEndpoint: $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' + expectedLocArea: + $ref: '#/components/schemas/ExpectedLocationArea' required: - requestorId - sEasEndpoint @@ -213,6 +215,8 @@ components: $ref: '#/components/schemas/EecCtxtReloc' predictExpTime: $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + expectedLocArea: + $ref: '#/components/schemas/ExpectedLocationArea' required: - requestorId - tEasEndpoint @@ -232,6 +236,8 @@ components: type: string tEasEndpoint: $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' + expectedLocArea: + $ref: '#/components/schemas/ExpectedLocationArea' required: - ueId - tEasId @@ -253,3 +259,13 @@ components: $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' required: - eecCtxtId + + ExpectedLocationArea: + description: > + Represents the expected location or service are of UE. + type: object + properties: + locInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + svcArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' diff --git a/TS24558_Eees_EASDiscovery.yaml b/TS24558_Eees_EASDiscovery.yaml index 439fbde5..71539bd4 100644 --- a/TS24558_Eees_EASDiscovery.yaml +++ b/TS24558_Eees_EASDiscovery.yaml @@ -6,11 +6,11 @@ info: API for EAS Discovery. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: "1.1.0-alpha.3" + version: "1.1.0-alpha.4" externalDocs: description: > - 3GPP TS 24.558 V18.2.0 Enabling Edge Applications; Protocol specification. + 3GPP TS 24.558 V18.3.0 Enabling Edge Applications; Protocol specification. url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/ security: @@ -22,7 +22,7 @@ servers: variables: apiRoot: default: https://example.com - description: apiRoot as defined in clause 6.1 of 3GPP TS 24.558 + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558. paths: @@ -369,6 +369,15 @@ components: be performed. predictExpTime: $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + servingPLMNInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + svcContinuityPlanInd: + type: boolean + description: > + Indicates to the EES whether the EAS discovery request is triggered as part of service + continuity planning. The default value false indicates this request is not part of + service continuity planning. The true value indicate this request is part of + service continuity planning. required: - requestorId @@ -553,6 +562,8 @@ components: type: string minItems: 1 description: Service features. + easBundleInfo: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EASBundleInfo' not: required: [stdEasType, easType] @@ -721,3 +732,4 @@ components: properties: numRecPerf: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + diff --git a/TS24558_Eees_EECRegistration.yaml b/TS24558_Eees_EECRegistration.yaml index d6b4be52..9ead54fa 100644 --- a/TS24558_Eees_EECRegistration.yaml +++ b/TS24558_Eees_EECRegistration.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: Eees_EECRegistration - version: "1.1.0-alpha.3" + version: "1.1.0-alpha.4" description: | API for EEC registration. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 24.558 V18.2.0 Enabling Edge Applications; Protocol specification. + 3GPP TS 24.558 V18.3.0 Enabling Edge Applications; Protocol specification. url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/' security: @@ -22,7 +22,7 @@ servers: variables: apiRoot: default: https://example.com - description: apiRoot as defined in clause 6.1 of 3GPP TS 24.558 + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558. paths: @@ -269,8 +269,18 @@ components: Set to true to indicate that UE Mobility support is required. Set to false to indicate that UE mobility support is not required. The default value when omitted is false. + easSelReqInd: + type: boolean + description: > + Set to true to indicate the EES support for EAS selection. + Set to false to indicate the EES shall not select the EAS. + The default value when omitted is false. ueType: $ref: '#/components/schemas/DeviceType' + discoveredEas: + type: array + items: + $ref: 'TS24558_Eees_EASDiscovery.yaml#/components/schemas/DiscoveredEas' unfulfillAcProfs: type: array items: @@ -376,6 +386,9 @@ components: ueMobilityReq: type: boolean description: Indicates whether UE requires mobility support or not. + easSelReqInd: + type: boolean + description: Indicates whether EES support for EAS selection is required or not. ueType: $ref: '#/components/schemas/DeviceType' @@ -422,3 +435,4 @@ components: Possible values are: - CONSTRAINED_UE: Indicates UE is constrained with resources like power, processor etc. - NORMAL_UE: Indicates UE is not constrained with resources. + diff --git a/TS26512_CommonData.yaml b/TS26512_CommonData.yaml index aba41310..b603af60 100644 --- a/TS26512_CommonData.yaml +++ b/TS26512_CommonData.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: 5GMS Common Data Types - version: 2.0.2 + version: 3.0.0 description: | 5GMS Common Data Types © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ tags: - name: 5GMS Common Data Types description: '5G Media Streaming: Common Data Types' externalDocs: - description: 'TS 26.512 V17.6.0; 5G Media Streaming (5GMS); Protocols' + description: 'TS 26.512 V18.0.0; 5G Media Streaming (5GMS); Protocols' url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/' paths: {} components: @@ -26,6 +26,10 @@ components: minimum: 0.0 maximum: 100.0 #DurationSec is defined in TS29571_CommonData + Duration: + type: string + format: duration + description: 'String with format "duration" as defined by JSON Schema (referencing IETF RFC 3339, appendix A and, ultimately, ISO 8601).' #DateTime is defined in TS29571_CommonData #Uri is defined in TS29571_CommonData Url: @@ -40,6 +44,9 @@ components: type: string format: uri description: 'Absolute Uniform Resource Locator, conforming with the "absolute-URI" production specified in IETF RFC 3986, section 4.3 in which the scheme part is "http" or "https". Note that the "query" suffix is permitted by this production but the "fragment" suffix is not.' + MediaDeliverySessionId: + type: string + description: 'A unique identifier for a media delivery session.' ##################################### # Clause 6.4.3: Structured data types @@ -193,6 +200,136 @@ components: appRequest: type: boolean + MediaStreamingSessionIdentification: + type: object + required: + - sessionId + properties: + sessionId: + $ref: '#/components/schemas/MediaDeliverySessionId' + + MediaStreamingAccess: + type: object + description: Common properties of a single media access by the Media Stream Handler. + required: + - mediaStreamHandlerEndpointAddress + - applicationServerEndpointAddress + - requestMessage + - responseMessage + - processingLatency + properties: + mediaStreamHandlerEndpointAddress: + $ref: '#/components/schemas/EndpointAddress' + applicationServerEndpointAddress: + $ref: '#/components/schemas/EndpointAddress' + requestMessage: + type: object + required: + - method + - url + - protocolVersion + - size + - bodySize + properties: + method: + type: string + url: + $ref: '#/components/schemas/AbsoluteUrl' + protocolVersion: + type: string + range: + type: string + size: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + bodySize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + contentType: + type: string + userAgent: + type: string + userIdentity: + type: string + referer: + $ref: '#/components/schemas/AbsoluteUrl' + cacheStatus: + $ref: '#/components/schemas/CacheStatus' + responseMessage: + type: object + required: + - responseCode + - size + - bodySize + properties: + responseCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + size: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + bodySize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + contentType: + type: string + processingLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + connectionMetrics: + type: object + required: + - meanNetworkRoundTripTime + - networkRoundTripTimeVariation + - congestionWindowSize + properties: + meanNetworkRoundTripTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + networkRoundTripTimeVariation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + congestionWindowSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + + NetworkAssistanceInvocation: + description: Common properties of a single Network Assistance invocation. + type: object + properties: + policyTemplateId: + $ref: '#/components/schemas/ResourceId' + serviceDataFlowDescriptions: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/ServiceDataFlowDescription' + requestedQoS: + $ref: '#/components/schemas/UnidirectionalQoSSpecification' + # The network QoS parameters (if any) requested by the Media Session Handler. + recommendedQoS: + type: object + description: The network QoS parameters (if any) recommended to the Media Session Handler. + required: + - maximumBitRate + - minimumBitRate + properties: + maximumBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minimumBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + + UnidirectionalQoSSpecification: + type: object + description: A specification for network Quality of Service in either the downlink or uplink direction. + required: + - maximumRequestedBitRate + - minimumRequestedBitRate + properties: + maximumRequestedBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minimumDesiredBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minimumRequestedBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + desiredPacketLatency: + type: integer + minimum: 0 + desiredPacketLossRate: + type: integer + minimum: 0 + ##################################### # Clause 6.4.4: Enumerated data types ##################################### diff --git a/TS26512_EventExposure.yaml b/TS26512_EventExposure.yaml new file mode 100644 index 00000000..d64ca290 --- /dev/null +++ b/TS26512_EventExposure.yaml @@ -0,0 +1,300 @@ +openapi: 3.0.0 +info: + title: 5GMS Event Exposure + version: 1.0.0 + description: | + 5GMS Event Exposure syntax + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +tags: + - name: 5GMS Event Exposure + description: '5G Media Streaming: Event Exposure' +externalDocs: + description: 'TS 26.512 V18.0.0; 5G Media Streaming (5GMS); Protocols' + url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/' +paths: {} +components: + schemas: + BaseEventCollection: + type: object + description: Abstract base data type describing a collection of event records + required: + - collectionTimestamp + - startTimestamp + - endTimestamp + - sampleCount + - streamingDirection + - summarisations + - records + properties: + collectionTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + # The date–time at which this collection was exposed by the Data Collection AF as an event to its subscribed event consumers. + startTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + # Date–time of earliest data sample included in or summarised by this collection. + endTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + # Date–time of latest data sample included in or summarised by this collection. + sampleCount: + type: integer + minimum: 1 + description: The number of data samples included in or summarised by this collection. + streamingDirection: + $ref: 'TS26512_CommonData.yaml#/components/schemas/ProvisioningSessionType' + summarisations: + type: array + minItems: 1 + items: + $ref: 'TS26532_Ndcaf_DataReportingProvisioning.yaml#/components/schemas/DataAggregationFunctionType' + description: One or more data aggregation functions that have been applied to the UE data to produce summary records present in this collection. + records: + type: array + minItems: 0 + items: {} + description: Type of record is defined by concrete data type. + + BaseEventRecord: + type: object + description: Abstract base data type describing a single UE data record or summarising a set of UE data records. + required: + - recordType + - recordTimestamp + properties: + recordType: + $ref: '#/components/schemas/EventRecordType' + recordTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + # The date–time at which the UE data carried in this record was sampled or summarised. + provisioningSessionId: + $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId' + # The identifier of the Provisioning Session to which this record pertains. Present only for individual data sample record type. + sessionId: + $ref: 'TS26512_CommonData.yaml#/components/schemas/MediaDeliverySessionId' + # A value synthesised by the 5GMS System that uniquely identifies the media streaming session to which this record pertains. Present only for individual data sample record type. + ueIdentification: + type: string + description: GPSI of the requesting UE or a stable globally unique string identifying the requesting Media Session Handler. Present only for individual data sample record type and only when exposure is permitted by the data exposure restrictions in force for the event type in question. + dataNetworkName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + # Identifying the Data Network of the M4 media streaming session. Present only for individual data sample record type. + sliceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + # The S-NSSAI identifying the Network Slice of the M4 media streaming session. Present only for individual data sample record type. + ueLocations: + type: array + minItems: 0 + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + description: The location of the UE when the data described by this record was sampled. Present only for individual data sample record type and only when exposure is permitted by the data exposure restrictions in force for the event in question. + + EventRecordType: + description: Enumeration of event record types. + anyOf: + - type: string + enum: [INDIVIDUAL_SAMPLE, SUMMARY_MEAN, SUMMARY_MINIMUM, SUMMARY_MAXIMUM, SUMMARY_SUM] + - 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. + + QoEMetricsCollection: + description: A collection of QoE Metrics Event records. + allOf: + - $ref: '#/components/schemas/BaseEventCollection' + - type: object + required: + - records + properties: + records: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/QoEMetricsEvent' + description: A set of QoE Metrics Event records, each one describing a QoE metrics report or summarising a set of QoE metrics reports. + + QoEMetricsEvent: + description: A QoE Metrics Event record. + allOf: + - $ref: '#/components/schemas/BaseEventRecord' + - type: object + required: + - metricType + properties: + metricType: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + # A fully-qualified term identifier that uniquely identifies the QoE metrics reporting scheme and the type of QoE metric included in this record, as specified in clause E.2, up to but excluding the first hierarchical separator. + samples: + type: array + minItems: 1 + items: + type: object + required: + - metrics + properties: + sampleTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + # The moment in time at which this QoE metric was sampled. + sampleDuration: + $ref: 'TS26512_CommonData.yaml#/components/schemas/Duration' + # The time duration over which this QoE metric was sampled. + mediaTimestamp: + $ref: 'TS26512_CommonData.yaml#/components/schemas/Duration' + # The time point in the media at which this QoE metric was sampled. + metrics: + type: array + minItems: 1 + description: A set of key–value pairs for the samples metrics associated with this QoE metric sample. + items: + type: object + description: A name and optional value for a QoE metric within a QoE metric sample. + required: + - key + properties: + key: + type: string + description: A token that uniquely identifies the type of metric within the scope of the event type. + value: {} + + ConsumptionReportingUnitsCollection: + description: A collection of Consumption Reporting Event records. + allOf: + - $ref: '#/components/schemas/BaseEventCollection' + - type: object + required: + - records + properties: + records: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/ConsumptionReportingEvent' + description: A set of records, each one describing a Consumption Reporting Unit. + + ConsumptionReportingEvent: + description: A Consumption Reporting Event record, corresponding to a Consumption Reporting Unit. + allOf: + - $ref: '#/components/schemas/BaseEventRecord' + - type: object + required: + - unitDuration + - mediaPlayerEntryUrl + - mediaComponentIdentifier + properties: + unitDuration: + $ref: 'TS26512_CommonData.yaml#/components/schemas/Duration' + # The duration of this consumption reporting unit. + clientEndpointAddress: + $ref: 'TS26512_CommonData.yaml#/components/schemas/EndpointAddress' + # The endpoint address of the UE that consumed media. + serverEndpointAddress: + $ref: 'TS26512_CommonData.yaml#/components/schemas/EndpointAddress' + # The endpoint address of the 5GMS AS from which media was consumed. + mediaPlayerEntryUrl: + $ref: 'TS26512_CommonData.yaml#/components/schemas/AbsoluteUrl' + # The Media Player Entry URL to which this consumption reporting unit pertains. + mediaComponentIdentifier: + type: string + description: A token (e.g., an MPEG DASH representation identifier) identifying the media component of the Media Player Entry that was consumed during this consumption reporting unit. + + NetworkAssistanceInvocationsCollection: + description: A collection of Network Assistance Invocation Event records. + allOf: + - $ref: '#/components/schemas/BaseEventCollection' + - type: object + required: + - records + properties: + records: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/NetworkAssistanceInvocationEvent' + description: A set of records, each one describing a Network Assistance invocation or summarising a set of Network Assistance invocations. + + NetworkAssistanceInvocationEvent: + description: A Network Assistance Invocation Event record. + allOf: + - $ref: '#/components/schemas/BaseEventRecord' + - type: object + required: + - networkAssistanceType + properties: + networkAssistanceType: + $ref: '#/components/schemas/NetworkAssistanceType' + # The type of Network Assistance solicited by the Media Session Handler. + - $ref: 'TS26512_CommonData.yaml#/components/schemas/NetworkAssistanceInvocation' + + NetworkAssistanceType: + description: The type of network assistance sought by the Media Session Handler. + anyOf: + - type: string + enum: [AF_THROUGHPUT_ESTIMATION, AF_DELIVERY_BOOST, ANBR_THROUGHPUT_ESTIMATION, ANBR_DELIVERY_BOOST] + - 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. + + DynamicPolicyInvocationsCollection: + description: A collection of Dynamic Policy Invocation Event records. + allOf: + - $ref: '#/components/schemas/BaseEventCollection' + - type: object + required: + - records + properties: + records: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/DynamicPolicyInvocationEvent' + description: A set of records, each one describing a dynamic policy invocation. + + DynamicPolicyInvocationEvent: + description: A Dynamic Policy Invocation Event record. + allOf: + - $ref: '#/components/schemas/BaseEventRecord' + - type: object + required: + - policyTemplateId + properties: + policyTemplateId: + $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId' + serviceDataFlowDescriptions: + type: array + minItems: 1 + items: + $ref: 'TS26512_CommonData.yaml#/components/schemas/ServiceDataFlowDescription' + description: The set of Service Data Flows to which the Media Session Handler requested that the Policy Template be applied. At least a domain name or one packet filter shall be present. + requestedQoS: + $ref: 'TS26512_CommonData.yaml#/components/schemas/UnidirectionalQoSSpecification' + # The network QoS parameters (if any) requested by the Media Session Handler. + enforcementMethod: + type: string + description: The policy enforcement method chosen by the 5GMS AF. + enforcementBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + # The enforcement bit rate (if any) selected by the 5GMS AF. + + MediaStreamingAccessesCollection: + description: A collection of Media Streaming Access Event records. + allOf: + - $ref: '#/components/schemas/BaseEventCollection' + - type: object + required: + - records + properties: + records: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/MediaStreamingAccessEvent' + description: A set of records, each one describing one media streaming access. + + MediaStreamingAccessEvent: + description: A Media Streaming Access Event record. + allOf: + - $ref: '#/components/schemas/BaseEventRecord' + - $ref: 'TS26512_CommonData.yaml#/components/schemas/MediaStreamingAccess' diff --git a/TS26512_M1_ConsumptionReportingProvisioning.yaml b/TS26512_M1_ConsumptionReportingProvisioning.yaml index 8ff1e200..e9679462 100644 --- a/TS26512_M1_ConsumptionReportingProvisioning.yaml +++ b/TS26512_M1_ConsumptionReportingProvisioning.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: M1_ConsumptionReportingProvisioning - version: 2.0.1 + version: 2.1.0 description: | 5GMS AF M1 Consumption Reporting Provisioning API © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ tags: - name: M1_ConsumptionReportingProvisioning description: '5G Media Streaming: Provisioning (M1) APIs: Consumption Reporting Provisioning' externalDocs: - description: 'TS 26.512 V17.4.0; 5G Media Streaming (5GMS); Protocols' + description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols' url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/' servers: - url: '{apiRoot}/3gpp-m1/v2' @@ -100,7 +100,7 @@ paths: '204': description: 'Destroyed Consumption Reporting Configuration' '404': - description: 'Not Found' + description: 'Not Found' components: schemas: ConsumptionReportingConfiguration: @@ -108,7 +108,10 @@ components: description: "A representation of a Consumption Reporting Configuration resource." properties: reportingInterval: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + minimum: 0 + exclusiveMinimum: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' samplePercentage: $ref: 'TS26512_CommonData.yaml#/components/schemas/Percentage' locationReporting: diff --git a/TS26512_M1_ContentHostingProvisioning.yaml b/TS26512_M1_ContentHostingProvisioning.yaml index 84ef9676..587589b6 100644 --- a/TS26512_M1_ContentHostingProvisioning.yaml +++ b/TS26512_M1_ContentHostingProvisioning.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: M1_ContentHostingProvisioning - version: 2.2.2 + version: 2.2.3 description: | 5GMS AF M1 Content Hosting Provisioning API © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ tags: - name: M1_ContentHostingProvisioning description: '5G Media Streaming: Provisioning (M1) APIs: Content Hosting Provisioning' externalDocs: - description: 'TS 26.512 V17.6.0; 5G Media Streaming (5GMS); Protocols' + description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols' url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/' servers: - url: '{apiRoot}/3gpp-m1/v2' @@ -138,6 +138,9 @@ paths: '204': # No Content description: 'No Content Purged' + '400': + # Bad Request (e.g. syntactically invalid regular expression in request body) + $ref: 'TS29571_CommonData.yaml#/components/responses/400' '404': # Not Found $ref: 'TS29571_CommonData.yaml#/components/responses/404' @@ -150,13 +153,6 @@ paths: '415': # Unsupported Media Type $ref: 'TS29571_CommonData.yaml#/components/responses/415' - '422': - # Unprocessable Entity (e.g. syntactically invalid regular expression in request body) - description: 'Unprocessable Entity' - content: - application/problem+json: - schema: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' '500': # Internal Server Error $ref: 'TS29571_CommonData.yaml#/components/responses/500' diff --git a/TS26512_M1_ContentPreparationTemplatesProvisioning.yaml b/TS26512_M1_ContentPreparationTemplatesProvisioning.yaml index 8eed6e47..87e000aa 100644 --- a/TS26512_M1_ContentPreparationTemplatesProvisioning.yaml +++ b/TS26512_M1_ContentPreparationTemplatesProvisioning.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: M1_ContentPreparationTemplatesProvisioning - version: 2.1.0 + version: 2.1.1 description: | 5GMS AF M1 Content Preparation Templates Provisioning API © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ tags: - name: M1_ContentPreparationTemplatesProvisioning description: '5G Media Streaming: Provisioning (M1) APIs: Content Preparation Templates Provisioning' externalDocs: - description: 'TS 26.512 V17.4.0; 5G Media Streaming (5GMS); Protocols' + description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols' url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/' servers: - url: '{apiRoot}/3gpp-m1/v2' @@ -31,7 +31,7 @@ paths: operationId: createContentPreparationTemplate summary: 'Create (and optionally upload) a new Content Preparation Template for the specified Provisioning Session' requestBody: - description: 'A Content Preparation Template of any type' + description: 'A Content Preparation Template of any supported type' required: true content: '*/*': @@ -46,6 +46,12 @@ paths: required: true schema: $ref: 'TS26512_CommonData.yaml#/components/schemas/AbsoluteUrl' + '415': + # Unsupported Media Type + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '503': + # Service Unavailable + $ref: 'TS29571_CommonData.yaml#/components/responses/503' /provisioning-sessions/{provisioningSessionId}/content-preparation-templates/{contentPreparationTemplateId}: parameters: - name: provisioningSessionId @@ -85,6 +91,12 @@ paths: description: 'Updated Content Preparation Template' '404': description: 'Not Found' + '415': + # Unsupported Media Type + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '503': + # Service Unavailable + $ref: 'TS29571_CommonData.yaml#/components/responses/503' patch: operationId: patchContentPreparationTemplate summary: 'Patch the specified Content Preparation Template for the specified Provisioning Session' @@ -107,6 +119,12 @@ paths: type: string '404': description: 'Not Found' + '415': + # Unsupported Media Type + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '503': + # Service Unavailable + $ref: 'TS29571_CommonData.yaml#/components/responses/503' delete: operationId: destroyContentPreparationTemplate summary: 'Destroy the specified Content Preparation Template of the specified Provisioning Session' diff --git a/TS26512_M1_PolicyTemplatesProvisioning.yaml b/TS26512_M1_PolicyTemplatesProvisioning.yaml index ee4053d1..f78b7bf3 100644 --- a/TS26512_M1_PolicyTemplatesProvisioning.yaml +++ b/TS26512_M1_PolicyTemplatesProvisioning.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: M1_PolicyTemplatesProvisioning - version: 2.2.0 + version: 2.2.1 description: | 5GMS AF M1 Policy Templates Provisioning API © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ tags: - name: M1_PolicyTemplatesProvisioning description: '5G Media Streaming: Provisioning (M1) APIs: Policy Templates Provisioning' externalDocs: - description: 'TS 26.512 V17.6.0; 5G Media Streaming (5GMS); Protocols' + description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols' url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/' servers: - url: '{apiRoot}/3gpp-m1/v2' @@ -127,21 +127,25 @@ components: - state - stateReason - externalReference - - applicationSessionContext properties: policyTemplateId: - $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId' + readOnly: true + allOf: + - $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId' state: + readOnly: true anyOf: - - type: string - enum: [PENDING, INVALID, READY, 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. + - type: string + enum: [PENDING, INVALID, READY, 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. stateReason: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' externalReference: type: string qoSSpecification: diff --git a/TS26512_M1_ProvisioningSessions.yaml b/TS26512_M1_ProvisioningSessions.yaml index 2e6cf6df..3fa386f3 100644 --- a/TS26512_M1_ProvisioningSessions.yaml +++ b/TS26512_M1_ProvisioningSessions.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: M1_ProvisioningSessions - version: 2.0.1 + version: 2.1.0 description: | 5GMS AF M1 Provisioning Sessions API © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ tags: - name: M1_ProvisioningSessions description: '5G Media Streaming: Provisioning (M1) APIs: Provisioning Sessions' externalDocs: - description: 'TS 26.512 V17.4.0; 5G Media Streaming (5GMS); Protocols' + description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols' url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/' servers: - url: '{apiRoot}/3gpp-m1/v2' @@ -69,7 +69,7 @@ components: required: - provisioningSessionId - provisioningSessionType - - externalApplicationId + - appId properties: provisioningSessionId: $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId' @@ -77,7 +77,7 @@ components: $ref: 'TS26512_CommonData.yaml#/components/schemas/ProvisioningSessionType' aspId: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AspId' - externalApplicationId: + appId: $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' serverCertificateIds: type: array diff --git a/TS26512_M5_ConsumptionReporting.yaml b/TS26512_M5_ConsumptionReporting.yaml index 59204cc5..35b295e4 100644 --- a/TS26512_M5_ConsumptionReporting.yaml +++ b/TS26512_M5_ConsumptionReporting.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: M5_ConsumptionReporting - version: 2.1.0 + version: 2.2.0 description: | 5GMS AF M5 Consumption Reporting API © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ tags: - name: M5_ConsumptionReporting description: '5G Media Streaming: Media Session Handling (M5) APIs: Consumption Reporting' externalDocs: - description: 'TS 26.512 V17.6.0; 5G Media Streaming (5GMS); Protocols' + description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols' url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/' servers: - url: '{apiRoot}/3gpp-m5/v2' @@ -72,7 +72,9 @@ components: properties: mediaConsumed: type: string - mediaEndpointAddress: + clientEndpointAddress: + $ref: 'TS26512_CommonData.yaml#/components/schemas/EndpointAddress' + serverEndpointAddress: $ref: 'TS26512_CommonData.yaml#/components/schemas/EndpointAddress' startTime: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' diff --git a/TS26512_M5_ServiceAccessInformation.yaml b/TS26512_M5_ServiceAccessInformation.yaml index 817e06de..84b46d9e 100644 --- a/TS26512_M5_ServiceAccessInformation.yaml +++ b/TS26512_M5_ServiceAccessInformation.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: M5_ServiceAccessInformation - version: 2.3.0 + version: 2.4.0 description: | 5GMS AF M5 Service Access Information API © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ tags: - name: M5_ServiceAccessInformation description: '5G Media Streaming: Media Session Handling (M5) APIs: Service Access Information' externalDocs: - description: 'TS 26.512 V17.6.0; 5G Media Streaming (5GMS); Protocols' + description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols' url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/' servers: - url: '{apiRoot}/3gpp-m5/v2' @@ -90,6 +90,7 @@ components: required: - serverAddresses - locationReporting + - accessReporting - samplePercentage properties: reportingInterval: @@ -106,28 +107,32 @@ components: type: object required: - serverAddresses - - validPolicyTemplateIds + - policyTemplateBindings - sdfMethods properties: serverAddresses: $ref: '#/components/schemas/ServerAddresses' - validPolicyTemplateIds: + policyTemplateBindings: type: array + minItems: 1 items: - $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId' - minItems: 0 + type: object + required: + - externalReference + - policyTemplateId + properties: + externalReference: + type: string + policyTemplateId: + $ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId' sdfMethods: type: array items: $ref: 'TS26512_CommonData.yaml#/components/schemas/SdfMethod' minItems: 0 - externalReferences: - type: array - items: - type: string - minItems: 1 - clientMetricsReportingConfiguration: + clientMetricsReportingConfigurations: type: array + minItems: 1 items: type: object required: diff --git a/TS26512_R2_DataReporting.yaml b/TS26512_R2_DataReporting.yaml new file mode 100644 index 00000000..9507c031 --- /dev/null +++ b/TS26512_R2_DataReporting.yaml @@ -0,0 +1,26 @@ +openapi: 3.0.0 +info: + title: 5GMS Data Reporting data types + version: 1.0.0 + description: | + 5GMS Data Reporting data types + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +tags: + - name: 5GMS Data Reporting data types + description: '5G Media Streaming: Data Reporting data types' + +externalDocs: + description: 'TS 26.512 V18.0.0; 5G Media Streaming (5GMS); Protocols' + url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/' + +paths: {} + +components: + schemas: + ANBRNetworkAssistanceInvocationRecord: + description: "An R2 data reporting record describing a single ANBR-based Network Assistance invocation by the Media Stream Handler." + allOf: + - $ref: 'TS26532_Ndcaf_DataReporting.yaml#/components/schemas/BaseRecord' + - $ref: 'TS26512_CommonData.yaml#/components/schemas/MediaStreamingSessionIdentification' + - $ref: 'TS26512_CommonData.yaml#/components/schemas/NetworkAssistanceInvocation' diff --git a/TS26512_R4_DataReporting.yaml b/TS26512_R4_DataReporting.yaml index 591fdade..c9304776 100644 --- a/TS26512_R4_DataReporting.yaml +++ b/TS26512_R4_DataReporting.yaml @@ -1,98 +1,26 @@ openapi: 3.0.0 info: - title: 5GMS Data Reporting data types - version: 1.0.1 + title: 5GMS R4 Data Reporting data types + version: 2.0.0 description: | - 5GMS Data Reporting data types + 5GMS R4 Data Reporting data types © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. tags: - - name: 5GMS Data Reporting data types - description: '5G Media Streaming: Data Reporting data types' + - name: 5GMS R4 Data Reporting data types + description: '5G Media Streaming: R4 Data Reporting data types' externalDocs: - description: 'TS 26.512 V17.4.0; 5G Media Streaming (5GMS); Protocols' + description: 'TS 26.512 V18.0.0; 5G Media Streaming (5GMS); Protocols' url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/' paths: {} components: schemas: - MediaStreamingAccessRecord: - allOf: - - $ref: 'TS26532_Ndcaf_DataReporting.yaml#/components/schemas/BaseRecord' - - type: object - required: - - mediaStreamHandlerEndpointAddress - - applicationServerEndpointAddress - - requestMessage - - responseMessage - - processingLatency - properties: - mediaStreamHandlerEndpointAddress: - $ref: 'TS26512_CommonData.yaml#/components/schemas/EndpointAddress' - applicationServerEndpointAddress: - $ref: 'TS26512_CommonData.yaml#/components/schemas/EndpointAddress' - sessionIdentifier: - type: string - requestMessage: - type: object - required: - - method - - url - - protocolVersion - - size - - bodySize - properties: - method: - type: string - url: - $ref: 'TS26512_CommonData.yaml#/components/schemas/AbsoluteUrl' - protocolVersion: - type: string - range: - type: string - size: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - bodySize: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - contentType: - type: string - userAgent: - type: string - userIdentity: - type: string - referer: - $ref: 'TS26512_CommonData.yaml#/components/schemas/AbsoluteUrl' - cacheStatus: - $ref: 'TS26512_CommonData.yaml#/components/schemas/CacheStatus' - responseMessage: - type: object - required: - - responseCode - - size - - bodySize - properties: - responseCode: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - size: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - bodySize: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - contentType: - type: string - processingLatency: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - connectionMetrics: - type: object - required: - - meanNetworkRoundTripTime - - networkRoundTripTimeVariation - - congestionWindowSize - properties: - meanNetworkRoundTripTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - networkRoundTripTimeVariation: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' - congestionWindowSize: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + MediaStreamingAccessRecord: + description: "An R4 data reporting record describing a single media access by the Media Stream Handler." + allOf: + - $ref: 'TS26532_Ndcaf_DataReporting.yaml#/components/schemas/BaseRecord' + - $ref: 'TS26512_CommonData.yaml#/components/schemas/MediaStreamingSessionIdentification' + - $ref: 'TS26512_CommonData.yaml#/components/schemas/MediaStreamingAccess' diff --git a/TS28104_MdaReport.yaml b/TS28104_MdaReport.yaml index 670f57a0..a81b09f6 100644 --- a/TS28104_MdaReport.yaml +++ b/TS28104_MdaReport.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: MDA Report - version: 18.0.0 + version: 18.2.0 description: >- OAS 3.0.1 specification of the MDA Report © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -20,7 +20,7 @@ components: properties: mDAType: type: string - mdaOutputList: + mDAOutputList: type: array items: $ref: '#/components/schemas/MDAOutputEntry' @@ -37,7 +37,7 @@ components: properties: mDAOutputIEName: type: string - mdaOutputIEValue: {} + mDAOutputIEValue: {} TimeWindow: diff --git a/TS28105_AiMlNrm.yaml b/TS28105_AiMlNrm.yaml index 943f6aeb..71e2d385 100644 --- a/TS28105_AiMlNrm.yaml +++ b/TS28105_AiMlNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: AI/ML NRM - version: 18.1.0 + version: 18.2.0 description: >- OAS 3.0.1 specification of the AI/ML NRM © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -201,6 +201,8 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' trainingReportRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + mLEnityGeneratedRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' MLTrainingReport-Single: @@ -220,7 +222,7 @@ components: type: array items: type: string - confidenceIndication: + modelConfidenceIndication: type: integer modelPerformanceTraining: type: array diff --git a/TS28312_IntentExpectations.yaml b/TS28312_IntentExpectations.yaml index 5423a87a..b0c35072 100644 --- a/TS28312_IntentExpectations.yaml +++ b/TS28312_IntentExpectations.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Scenario specific Intent Expectations - version: 18.1.0 + version: 18.2.0 description: >- OAS 3.0.1 definition of scenario specific Intent Expectations © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -46,9 +46,39 @@ components: expectationContexts: type: array items: - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationContext' + type: object + oneOf: + - $ref: '#/components/schemas/TargetAssuranceTimeContext' + - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context' required: - expectationId + RadioServiceExpectation: + description: >- + This data type is the "IntentExpectation" data type with specialisations to represent MnS consumer's expectations for radio service delivering + type: object + properties: + expectationId: + type: string + expectationVerb: + $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationVerb" + expectationObject: + $ref: "#/components/schemas/RadioServiceExpectationObject" + expectationTargets: + type: array + items: + type: object + oneOf: + - $ref: '#/components/schemas/DLLatencyTarget' + - $ref: '#/components/schemas/ULLatencyTarget' + - $ref: '#/components/schemas/DLThptPerUETarget' + - $ref: '#/components/schemas/ULThptPerUETarget' + - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationTarget' + expectationContexts: + type: array + items: + $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context' + required: + - expectationId EdgeServiceSupportExpectation: description: >- This data type is the "IntentExpectation" data type with specialisations to represent MnS consumer's expectations for service deployment @@ -82,7 +112,7 @@ components: - $ref: '#/components/schemas/ServiceEndTimeContext' - $ref: '#/components/schemas/UEMobilityLevelContext' - $ref: '#/components/schemas/ResourceSharingLevelContext' - - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationContext' + - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context' required: - expectationId 5GCNetworkExpectation: @@ -105,11 +135,17 @@ components: oneOf: - $ref: "#/components/schemas/MaxNumberofPDUsessionsTarget" - $ref: "#/components/schemas/MaxNumberofRegisteredsubscribersTarget" + - $ref: "#/components/schemas/IncomingDataTarget" + - $ref: "#/components/schemas/OutgoingDataTarget" - $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationTarget" expectationContexts: type: array items: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/ExpectationContext" + type: object + oneOf: + - $ref: '#/components/schemas/StartTimeContext' + - $ref: '#/components/schemas/ResourceSharingLevelContext' + - $ref: "TS28312_IntentNrm.yaml#/components/schemas/Context" expectationfulfilmentInfo: $ref: "TS28312_IntentNrm.yaml#/components/schemas/FulfilmentInfo" required: @@ -136,10 +172,30 @@ components: - $ref: '#/components/schemas/CoverageAreaPolygonContext' - $ref: '#/components/schemas/CoverageTACContext' - $ref: '#/components/schemas/PLMNContext' - - $ref: '#/components/schemas/NRFqBandContext' + - $ref: '#/components/schemas/DlFrequencyContext' + - $ref: '#/components/schemas/UlFrequencyContext' - $ref: '#/components/schemas/RATContext' - $ref: "#/components/schemas/UEGroupContext" - - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ObjectContext' + - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context' + RadioServiceExpectationObject: + description: >- + This data type is the "ExpectationObject" data type with specialisations for RadioServicekExpectation + type: object + properties: + objectType: + type: string + enum: + - Radio_Service + objectInstance: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + objectContexts: + type: array + items: + type: object + oneOf: + - $ref: '#/components/schemas/CoverageAreaPolygonContext' + - $ref: '#/components/schemas/ServiceTypeContext' + - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context' ServiceSupportExpectationObject: description: >- This data type is the "ExpectationObject" data type with specialisations for EdgeServiceSupportExpectation @@ -159,7 +215,7 @@ components: - $ref: '#/components/schemas/EdgeIdenfiticationIdContext' - $ref: '#/components/schemas/EdgeIdentificationLocContext' - $ref: '#/components/schemas/CoverageAreaTAContext' - - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ObjectContext' + - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context' 5GCNetworkExpectationObject: description: >- This data type is the "ExpectationObject" data type with specialisations for 5GCNetworkExpectation @@ -180,7 +236,9 @@ components: - $ref: "#/components/schemas/NfInstanceLocationContext" - $ref: "#/components/schemas/PLMNContext" - $ref: "#/components/schemas/TaiContext" - - $ref: "#/components/schemas/ObjectContext" + - $ref: "#/components/schemas/ServingScopeContext" + - $ref: "#/components/schemas/DnnContext" + - $ref: "TS28312_IntentNrm.yaml#/components/schemas/Context" #-------Definition of the ExpectationObject dataType ----------# @@ -607,6 +665,23 @@ components: - IS_LESS_THAN targetValueRange: type: integer + targetContexts: + $ref: '#/components/schemas/5GSessionContext' + 5GSessionContext: + description: >- + This data type is the "TargetContext" data type with specialisations for 5GSessionContext + type: object + properties: + contextAttribute: + type: string + enum: + - 5GSession + contextCondition: + type: string + enum: + - IS_less_THAN + contextValueRange: + type: integer MaxNumberofRegisteredsubscribersTarget: description: >- This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofRegisteredsubscribersTarget @@ -622,23 +697,40 @@ components: - IS_LESS_THAN targetValueRange: type: integer - - #-------Definition of the concrete ExpectationTarget dataType----------# - - #-------Definition of the concrete ObjectTarget dataType----------------# - ObjectContext: + IncomingDataTarget: description: >- - This data type is the "ObjectContext" data type without specialisations + This data type is the "ExpectationTarget" data type with specialisations for IncomingDataTarget type: object properties: - contextAttribute: + targetName: type: string - contextCondition: - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Condition' - contextValueRange: - type: array - items: - type: number + enum: + - IncomingData + targetCondition: + type: string + enum: + - IS_LESS_THAN + targetValueRange: + type: integer + OutgoingDataTarget: + description: >- + This data type is the "ExpectationTarget" data type with specialisations for OutgoingDataTarget + type: object + properties: + targetName: + type: string + enum: + - OutgoingData + targetCondition: + type: string + enum: + - IS_LESS_THAN + targetValueRange: + type: integer + + #-------Definition of the concrete ExpectationTarget dataType----------# + + #-------Definition of the concrete ObjectTarget dataType----------------# CoverageAreaPolygonContext: description: >- This data type is the "ObjectContext" data type with specialisations for CoverageAreaPolygonContext @@ -653,11 +745,7 @@ components: enum: - IS_ALL_OF contextValueRange: - type: array - items: - $ref: '#/components/schemas/CoverageArea' - CoverageArea: - type: string + $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea' CoverageTACContext: description: >- This data type is the "ObjectContext" data type with specialisations for CoverageTACContext @@ -674,7 +762,7 @@ components: contextValueRange: type: array items: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/NrTac' + $ref: "TS28623_ComDefs.yaml#/components/schemas/Tac" PLMNContext: description: >- This data type is the "ObjectContext" data type with specialisations for PLMNContext @@ -692,15 +780,17 @@ components: type: array items: $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - NRFqBandContext: + DlFrequencyContext: description: >- - This data type is the "ObjectContext" data type with specialisations for NRFqBandContext + This data type is the "Context" data type with specialisations for Object context "DLFrequencyContext". + It describes the downlink frequency information (RF reference frequencies and/ or the + frequency operating band) supported by the RAN SubNetwork that the intent expectation is applied. type: object properties: contextAttribute: type: string enum: - - NRFqBand + - DlFrequency contextCondition: type: string enum: @@ -708,7 +798,26 @@ components: contextValueRange: type: array items: - type: string + $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Frequency' + UlFrequencyContext: + description: >- + This data type is the "Context" data type with specialisations for Object context "DLFrequencyContext". + It describes the uplink frequency information (RF reference frequencies and/ or the frequency + operating band) supported by the RAN SubNetwork that the intent expectation is applied. + type: object + properties: + contextAttribute: + type: string + enum: + - UlFrequency + contextCondition: + type: string + enum: + - IS_ALL_OF + contextValueRange: + type: array + items: + $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Frequency' RATContext: description: >- This data type is the "ObjectContext" data type with specialisations for RATContext @@ -746,14 +855,7 @@ components: contextValueRange: type: array items: - $ref: "#/components/schemas/UEGroup" - UEGroup: - type: object - properties: - fiveQI: - type: integer - sNssai: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + $ref: "TS28312_IntentNrm.yaml#/components/schemas/UEGroup" EdgeIdenfiticationIdContext: description: >- This data type is the "ObjectContext" data type with specialisations for EdgeIdentificationIdContext @@ -768,9 +870,7 @@ components: enum: - IS_EQUAL_TO contextValueRange: - type: array - items: - type: string + type: string EdgeIdentificationLocContext: description: >- This data type is the "ObjectContext" data type with specialisations for EdgeIdentificationLocContext @@ -785,9 +885,7 @@ components: enum: - IS_EQUAL_TO contextValueRange: - type: array - items: - type: string + $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoCoordinate' CoverageAreaTAContext: description: >- This data type is the "ObjectContext" data type with specialisations for CoverageAreaTAContext @@ -804,9 +902,7 @@ components: contextValueRange: type: array items: - $ref: '#/components/schemas/CoverageAreaTAList' - CoverageAreaTAList: - type: integer + $ref: "TS28623_ComDefs.yaml#/components/schemas/Tac" NfTypeContext: description: >- This data type is the "ObjectContext" data type with specialisations for NfTypeContext @@ -858,10 +954,60 @@ components: type: array items: $ref: "TS28623_GenericNrm.yaml#/components/schemas/Tai" - + ServingScopeContext: + description: >- + This data type is the "ObjectContext" data type with specialisations for ServingScopeContext + type: object + properties: + contextAttribute: + type: string + enum: + - ServingScope + contextCondition: + type: string + enum: + - IS_ALL_OF + contextValueRange: + type: array + items: + type: string + DnnContext: + description: >- + This data type is the "ObjectContext" data type with specialisations for DnnContext + type: object + properties: + contextAttribute: + type: string + enum: + - Dnn + contextCondition: + type: string + enum: + - IS_ALL_OF + contextValueRange: + type: array + items: + type: string #-------Definition of the scenario specific ObjectTarget dataType----------------# #-------Definition of the concrete ExpectationContext dataType----------------# + + TargetAssuranceTimeContext: + description: >- + This data type is the "Expectation Context" data type with specialisations for TargetAssuranceTimeContext + type: object + properties: + contextAttribute: + type: string + enum: + - TargetAssuranceTime + contextCondition: + type: string + enum: + - IS_EQUAL_TO + contextValueRange: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' + ServiceStartTimeContext: description: >- This data type is the "ExpectationContext" data type with specialisations for ServiceStartTimeContext @@ -922,4 +1068,34 @@ components: - IS_EQUAL_TO contextValueRange: $ref: "TS28541_SliceNrm.yaml#/components/schemas/SharingLevel" + ServiceTypeContext: + description: >- + This data type is the "ExpectationContext" data type with specialisations for ServiceTypeContext + type: object + properties: + contextAttribute: + type: string + enum: + - ServiceType + contextCondition: + type: string + enum: + - IS_EQUAL_TO + contextValueRange: + $ref: "TS28541_NrNrm.yaml#/components/schemas/Sst" + StartTimeContext: + description: >- + This data type is the "ExpectationContext" data type with specialisations for StartTimeContext + type: object + properties: + contextAttribute: + type: string + enum: + - StartTime + contextCondition: + type: string + enum: + - IS_EQUAL_TO + contextValueRange: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' #-------Definition of the concrete ExpectionContext dataType----------------# diff --git a/TS28312_IntentNrm.yaml b/TS28312_IntentNrm.yaml index 90016741..915541a5 100644 --- a/TS28312_IntentNrm.yaml +++ b/TS28312_IntentNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Intent NRM - version: 18.1.0 + version: 18.2.0 description: >- OAS 3.0.1 definition of the Intent NRM © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -15,7 +15,7 @@ components: #-------Definition of generic IOCs ----------# - SubNetwork-Single: + SubNetwork-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -31,6 +31,8 @@ components: $ref: '#/components/schemas/IntentHandlingFunction-Multiple' Intent-Single: + description: >- + This IOC represents the properties of an Intent driven management information between MnS consumer and MnS producer. allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -44,43 +46,65 @@ components: oneOf: - $ref: "#/components/schemas/IntentExpectation" - $ref: "TS28312_IntentExpectations.yaml#/components/schemas/RadioNetworkExpectation" - - $ref: "TS28312_IntentExpectations.yaml#/components/schemas/EdgeServiceSupportExpectation" + - $ref: "TS28312_IntentExpectations.yaml#/components/schemas/EdgeServiceSupportExpectation" + - $ref: "TS28312_IntentExpectations.yaml#/components/schemas/5GCNetworkExpectation" + - $ref: "TS28312_IntentExpectations.yaml#/components/schemas/RadioServiceExpectation" + contextSelectivity: + $ref: "#/components/schemas/Selectivity" intentContexts: type: array items: - $ref: '#/components/schemas/IntentContext' + $ref: '#/components/schemas/Context' + description: >- + It describes the list of Context(s) which represents the constraints and conditions that should apply + for the entire intent even if there may be specific contexts defined for specific parts of the intent intentAdminState: type: string enum: - ACTIVATED - DEACTIVATED + description: >- + It describes the intent administrative state. + This attribute is used when MnS consumer-suspension mechanism is supported intentPriority: - type: integer + type: integer + minimum: 1 + maximum: 100 + description: It expresses the priority of the stated intent within a MnS consumer. + intentPreemptionCapability: + type: string + enum: + - TRUE + - FALSE observationPeriod: type: integer + description: >- + It represents the observation period of the fulfilmentInfo for corresponding + ExpectationTargets, IntentExpectations and Intent. intentReportReference: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' IntentReport-Single: + description: It represents intent report information from MnS producer to MnS consumer. allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: intentFulfilmentReport: - type: array - items: - $ref: '#/components/schemas/IntentFulfilmentReport' + $ref: '#/components/schemas/IntentFulfilmentReport' intentConflictReports: type: array items: $ref: '#/components/schemas/IntentConflictReport' intentFeasibilityCheckReport: - type: array - items: - $ref: '#/components/schemas/IntentFeasibilityCheckReport' + $ref: '#/components/schemas/IntentFeasibilityCheckReport' + lastUpdatedTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' intentReference: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - IntentHandlingFunction-Single: + description: >- + It represents the intent handling capabilities can be supported by a specific intent + handling function of MnS producer. allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -100,10 +124,12 @@ components: IntentExpectation: description: >- This data type is the "IntentExpectation" data type without specialisations + It represents MnS consumer's requirements, goals and contexts given to a 3GPP system type: object properties: expectationId: type: string + description: A unique identifier of the intentExpectation within the intent. expectationVerb: $ref: "#/components/schemas/ExpectationVerb" expectationObject: @@ -112,10 +138,12 @@ components: type: array items: $ref: '#/components/schemas/ExpectationTarget' + contextSelectivity: + $ref: "#/components/schemas/Selectivity" expectationContexts: type: array items: - $ref: '#/components/schemas/ExpectationContext' + $ref: '#/components/schemas/Context' required: - expectationId #-------Definition of the generic IntentExpectation dataType ----------# @@ -123,6 +151,7 @@ components: #-------Definition of the generic ExpectationObject dataType ----------# ExpectationObject: description: >- + It represents the Object to which the IntentExpectation should apply. This data type is the "ExpectationObject" data type without specialisations type: object properties: @@ -131,13 +160,18 @@ components: enum: - RAN_SubNetwork #value for Radio Network Expectation--# - Edge_Service_Support #value for Edge Service Support Expectation--# + - 5GC_SubNetwork #value for 5GC Network Expectation--# objectInstance: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + contextSelectivity: + $ref: "#/components/schemas/Selectivity" objectContexts: type: array items: - $ref: '#/components/schemas/ObjectContext' - + $ref: '#/components/schemas/Context' + description: >- + It describes the list of Context(s) which represents the constraints and conditions to be + used as filter information to identify the object(s) to which a given intentExpectation should apply. #-------Definition of the generic ExpectationObject dataType ----------# #-------Definition of the generic dataType --------------# @@ -154,12 +188,19 @@ components: - IS_EQUAL_TO_OR_LESS_THAN - IS_EQUAL_TO_OR_GREATER_THAN - IS_ALL_OF - FulfilStatus: + Selectivity: + type: string + enum: + - ALL_OF + - ONE_OF + - ANY_OF + FulfilmentStatus: type: string readOnly: true enum: - FULFILLED - NOT_FULFILLED + description: It describes the current status of the intent fulfilment result. NotFulfilledState: type: string readOnly: true @@ -170,26 +211,49 @@ components: - SUSPENDED - TERMINATED - FULFILMENTFAILED + description: It describes the current progress of or the reason for not achieving fulfilment + for the intent, intentExpectation or expectationTarget. + An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo FulfilmentInfo: + description: >- + This dataType represents the properties of a specific fulfilment information for an aspect of + the intent (i.e. either an expectation, a target or the whole intent). type: object properties: - fulfilStatus: - $ref: '#/components/schemas/FulfilStatus' + fulfilmentStatus: + $ref: '#/components/schemas/FulfilmentStatus' notFullfilledState: - description: -> - An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo $ref: "#/components/schemas/NotFulfilledState" notFulfilledReasons: - description: -> - An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo - type: string - readOnly: true + type: array + items: + type: string + readOnly: true + description: An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo ExpectationVerb: type: string enum: - DELIVER - ENSURE - ValueRangeType: + description: It describes the characteristic of the intentExpectation and is the property that describes the types of intentExpectations. + Frequency: + description: >- + It desribes the RF reference frequency (i.e. Absolute Radio Frequency Channel Number) + and/or the frequency operating band used for a given direction (UL or DL) in FDD or + for both UL and DL directions in TDD. + type: object + properties: + arfcn: + type: integer + description: >- + This attribute shall be supported, when the frequency information represent RF reference frequency. + The allowed values for NR see TS 38.104 subclause 5.4.2.1; The allowed values for EUTRAN see TS 36.104 [X] subclause 5.7.3; + freqband: + type: string + description: >- + This attribute shall be supported, when the frequency information represent frequency operating band. + The allowed values for NR see TS 38.104 subclause 5.4.2.3; The allowed value for EUTRAN see TS 36.104 subclause 5.7.3 + ValueRangeType: oneOf: - type: number - type: string @@ -200,29 +264,27 @@ components: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea' - $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoCoordinate' - #-------Definition of the generic dataType --------------# - - #-------Definition of the generic IntentContext dataType --------------# - IntentContext: + - $ref: '#/components/schemas/UEGroup' + - $ref: '#/components/schemas/Frequency' + UEGroup: description: >- - This data type is the "IntentContext" data type without specialisations + It describes the UE Group, which is + represented by specific 5QI, specific S-NSSAI, or a specific combination + of S-NSSAI and 5QI type: object properties: - contextAttribute: - type: string - contextCondition: - $ref: '#/components/schemas/Condition' - contextValueRange: - oneOf: - - type: array - items: - $ref: "#/components/schemas/ValueRangeType" - - $ref: "#/components/schemas/ValueRangeType" - #-------Definition of the generic IntentContext dataType --------------# + fiveQI: + type: integer + minimum: 0 + maximum: 255 + sNssai: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + #-------Definition of the generic dataType --------------# #-------Definition of the generic ExpectationTarget dataType----------# ExpectationTarget: description: >- + This data type represents the target of the IntentExpectation that are required to be achieved. This data type is the "ExpectationTarget" data type without specialisations type: object properties: @@ -231,36 +293,24 @@ components: targetCondition: $ref: '#/components/schemas/Condition' targetValueRange: - oneOf: - - type: array - items: - $ref: "#/components/schemas/ValueRangeType" - - $ref: "#/components/schemas/ValueRangeType" + oneOf: + - type: array + items: + $ref: "#/components/schemas/ValueRangeType" + - $ref: "#/components/schemas/ValueRangeType" + contextSelectivity: + $ref: "#/components/schemas/Selectivity" targetContexts: type: array items: - $ref: '#/components/schemas/TargetContext' - TargetContext: - description: >- - This data type is the "TargetContext" data type without specialisations - type: object - properties: - contextAttribute: - type: string - contextCondition: - $ref: '#/components/schemas/Condition' - contextValueRange: - oneOf: - - type: array - items: - $ref: "#/components/schemas/ValueRangeType" - - $ref: "#/components/schemas/ValueRangeType" + $ref: '#/components/schemas/Context' + description: It describes the list of constraints and conditions that should apply for a specific expectationTarget. #-------Definition of the generic ExpectationTarget dataType----------# - #-------Definition of the generic ObjectContext dataType----------------# - ObjectContext: + #-------Definition of the generic Context dataType----------------# + Context: description: >- - This data type is the "ObjectContext" data type without specialisations + This data type is the "Context" data type without specialisations type: object properties: contextAttribute: @@ -273,29 +323,13 @@ components: items: $ref: "#/components/schemas/ValueRangeType" - $ref: "#/components/schemas/ValueRangeType" - #-------Definition of the generic ObjectContext dataType----------------# + #-------Definition of the generic Context dataType----------------# - #-------Definition of the generic ExpectionContext dataType----------------# - ExpectationContext: - description: >- - This data type is the "ExpectationContext" data type without specialisations - type: object - properties: - contextAttribute: - type: string - contextCondition: - $ref: '#/components/schemas/Condition' - contextValueRange: - oneOf: - - type: array - items: - $ref: "#/components/schemas/ValueRangeType" - - $ref: "#/components/schemas/ValueRangeType" - #-------Definition of the concrete ExpectionContext dataType----------------# #-------Definition of the generic IntentFulfilmentReport dataType----------------# IntentFulfilmentReport: description: >- - This data type is the "IntentFulfilmentReport" data type without specialisations + It includes the intentFulfilmentInfo and expectationFulfilmetResult. + This attribute shall be supported when intent fulfilment information is supported by IntentReport type: object properties: intentFulfilmentInfo: @@ -309,7 +343,7 @@ components: #-------Definition of the generic ExpectationFulfilmentResult dataType----------------# ExpectationFulfilmentResult: description: >- - This data type is the "ExpectationFulfilmentResult" data type without specialisations + It includes the expectationFulfilmentInfo and targetFulfilmetResults for each IntentExpectation. type: object properties: expectaitonId: @@ -325,7 +359,7 @@ components: #-------Definition of the generic TargetFulfilmentResult dataType----------------# TargetFulfilmentResult: description: >- - This data type is the "TargetFulfilmentResult" data type without specialisations + This data type includes targetFulfilmentInfo and targetAchievedValue for each ExpectationTarget. type: object properties: targetName: @@ -339,23 +373,37 @@ components: #-------Definition of the generic IntentConflictReport dataType----------------# IntentConflictReport: description: >- - This data type is the "IntentConflictReport" data type without specialisations + It represents the conflict information for the detected conflict + This attribute shall be supported when intent conflict information is supported by IntentReport type: object properties: + conflictId: + type: string conflictType: type: string enum: - INTENT_CONFLICT - EXPECTATION_CONFLICT - TARGET_CONFLICT - conflictField: - type: string + conflictingIntent: + description: >- + This will be present if the value of conflictType is INTENT_CONFLICT. It describes the DN of the conflicting intent + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + conflictingExpectation: + description: >- + This will be present if the value of conflictType is EXPECTATION_CONFLICT. It describes the expectationId of the conflicting IntentExpectation with an Intent + type: string + conflictingTarget: + description: >- + This will be present if the value of conflictType is TARGET_CONFLICT. It describes the targetName of the conflicting ExpectationTarget with an IntentExpectation + type: string #-------Definition of the concrete IntentConflictReport dataType----------------# #-------Definition of the generic IntentFeasibilityCheckReport dataType----------------# IntentFeasibilityCheckReport: description: >- - This data type is the "IntentFeasibilityCheckReport" data type without specialisations + It represents the intent feasibility check information + This attribute shall be supported when intent feasibility check information information is supported by IntentReport type: object properties: feasibilityCheckResult: @@ -364,13 +412,15 @@ components: - FEASIBLE - INFEASIBLE infeasibilityReason: - description: -> - An attribute which is used when feasibilityCheckResult is INFEASIBLE type: string + description: An attribute which is used when feasibilityCheckResult is INFEASIBLE #-------Definition of the concrete IntentFeasibilityCheckReport dataType----------------# #-------Definition of the generic IntentHandlingCapability dataType----------------# IntentHandlingCapability: + description: >- + It represents expectation object information and expectation target information + which can be supported by a specific intent handling function of MnS producer. type: object properties: intentHandlingCapabilityId: @@ -380,10 +430,13 @@ components: enum: - RAN_SUBNETWORK - EDGE_SERVICE_SUPPORT - supportedExpectationTargetType: + - 5GC_SUBNETWORK + description: It describes the expectation object type which can be supported by a specific intent handling function of MnS producer. + supportedExpectationTargetNames: type: array items: - $ref: "#/components/schemas/ExpectationTarget" + type: string + description: It describes the supported expectation targets for the supported expectation object type. #-------Definition of the concrete IntentHandlingCapability dataType----------------# #------Definition of JSON arrays for name-contained IOCs ---------------# @@ -415,6 +468,8 @@ components: resources-intentNrm: oneOf: - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/IntentHandlingFunction-Single' - $ref: '#/components/schemas/Intent-Single' + - $ref: '#/components/schemas/IntentReport-Single' #----- Definitions in TS 28.312 for TS 28.532 --------------------------# diff --git a/TS28317_RanScNrm.yaml b/TS28317_RanScNrm.yaml new file mode 100644 index 00000000..ed6566f2 --- /dev/null +++ b/TS28317_RanScNrm.yaml @@ -0,0 +1,176 @@ +openapi: 3.0.1 +info: + title: RANSC NRM + version: 18.0.0 + description: >- + OAS 3.0.1 definition of the RANSC NRM + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.317; Self-configuration of Radio Access Network Entities (RAN NEs) + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.317/ +paths: {} +components: + schemas: + +#-------Definition of IOCs ----------# + SubNetwork-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ScMgmtProfile: + $ref: '#/components/schemas/ScMgmtProfile-Multiple' + Sc_Process: + $ref: '#/components/schemas/Sc_Process-Multiple' + + ScMgmtProfile-Single: + description: >- + The ScMgmtProfile represents MnS Consumer's requirements for self-configuration management + for a set of RAN NEs or RAN NE types. + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + nEInformation: + type: array + items: + $ref: '#/components/schemas/NEInfomration' + description: >- + This attribute defines the NE Type(s) or the NE instance(s) for which this + ScMgmtProfile instance is valid. + configDataFileLocation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + + Sc_Process-Single: + description: >- + This IOC represents the self-configuration process for a RAN NE, which allows the MnS + Consumer to be informed about the current situation of the Self Configuration process. + When the automated management process for an RAN NE starts, an instance of the Sc_Process + is created automatically by the MnS Producer and informed to MnS consumer. + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + nEIdentification: + $ref: '#/components/schemas/NEIdentification' + scProcessMonitor: + $ref: '#/components/schemas/ScProcessMonitor' + cancelScProcess: + type: string + enum: + - TRUE + - FALSE + description: >- + Setting this attribute to "TRUE" cancels the self configuration process. + scMgmtProfileRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' +#-------Definition of IOCs ----------# + + +#-------Definition of Data types ----------# + NEType: + type: integer + description: It defines the type of RAN NE + GnbId: + type: integer + minimum: 0 + maximum: 4294967295 + description: It is the identity of gNB + EnbId: + type: string + minimum: 0 + maximum: 268435455 + description: It is the identity of ng-eNB + NEIdentification: + oneOf: + - $ref: '#/components/schemas/EnbId' + - $ref: '#/components/schemas/GnbId' + NEInfomration: + description: >- + It defines the NE Type or the NE instance for which this + ScMgmtProfile instance is valid. + oneOf: + - $ref: '#/components/schemas/NEType' + - $ref: '#/components/schemas/NEIdentification' + ScProcessMonitor: + description: >- + This data type is the "ProcessMonitor" data type with specialisations + for usage in the RANSC management for monitoring for the self configuration process. + type: object + properties: + jobId: + type: string + status: + type: string + enum: + - NOT_STARTED + - RUNNING + - FINSHED + - FAILED + - CANCELLING + - CANCELLED + progressPercentage: + type: integer + minimum: 0 + maximum: 100 + progressStateInfo: + type: string + enum: + - NE_HEALTH_CHECK + - SW_DOWNLOAD + - SW_INSTALLATION + - SW_ACTIVATION + - PREPARE_BASIC_CONFIGURATION_AND_OAMLINK + - RETRIEVE_CONFIGURATION_DATA + - SETUP_PRECONFIGURED_SIGNALLING_LINKS + - TSET_FINAL_STATE_OF_NE + resultStateInfo: + oneOf: + - type: string + enum: + - UNKNOWN + - INCORRECT_CONFIGURATION + - NE_HARDWARE_ERROR_DELECTED + - DISCONNECTION_BETWEEN_NE_AND_OAM + - OTHER + - type: string + startTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + +#-------Definition of Data types ----------# + +#------Definition of JSON arrays for name-contained IOCs ---------------# + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + ScMgmtProfile-Multiple: + type: array + items: + $ref: '#/components/schemas/ScMgmtProfile-Single' + Sc_Process-Multiple: + type: array + items: + $ref: '#/components/schemas/Sc_Process-Single' +#------Definition of JSON arrays for name-contained IOCs ---------------# + + +#----- Definitions in TS 28.317 for TS 28.532 --------------------------# + resources-RanScNrm: + oneOf: + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ScMgmtProfile-Single' + - $ref: '#/components/schemas/Sc_Process-Single' + +#----- Definitions in TS 28.317 for TS 28.532 --------------------------# + diff --git a/TS28532_FaultMnS.yaml b/TS28532_FaultMnS.yaml index 2891cb22..3c5631aa 100644 --- a/TS28532_FaultMnS.yaml +++ b/TS28532_FaultMnS.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Fault Supervision MnS - version: 17.3.0 + version: 18.1.0 description: >- OAS 3.0.1 definition of the Fault Supervision MnS © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). diff --git a/TS28532_FileDataReportingMnS.yaml b/TS28532_FileDataReportingMnS.yaml index 27c5a23b..176070ca 100644 --- a/TS28532_FileDataReportingMnS.yaml +++ b/TS28532_FileDataReportingMnS.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: File Data Reporting MnS - version: 17.3.0 + version: 18.1.0 description: >- OAS 3.0.1 definition of the File Data Reporting MnS © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). diff --git a/TS28532_HeartbeatNtf.yaml b/TS28532_HeartbeatNtf.yaml index 4d10cac8..d9d777df 100644 --- a/TS28532_HeartbeatNtf.yaml +++ b/TS28532_HeartbeatNtf.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Heartbeat notification - version: 17.1.0 + version: 18.1.0 description: >- OAS 3.0.1 definition of the heartbeat notification © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). diff --git a/TS28532_PerfMnS.yaml b/TS28532_PerfMnS.yaml index c2eabb54..af1014ab 100644 --- a/TS28532_PerfMnS.yaml +++ b/TS28532_PerfMnS.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: TS 28.532 Performance Threshold Monitoring MnS - version: 17.1.0 + version: 18.1.0 description: >- OAS 3.0.1 definition of the Performance Threshold Monitoring MnS © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). diff --git a/TS28532_ProvMnS.yaml b/TS28532_ProvMnS.yaml index 7b734bc7..a8076203 100644 --- a/TS28532_ProvMnS.yaml +++ b/TS28532_ProvMnS.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Provisioning MnS - version: 17.6.0 + version: 18.1.0 description: >- OAS 3.0.1 definition of the Provisioning MnS © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -397,6 +397,7 @@ components: - $ref: 'TS28104_MdaNrm.yaml#/components/schemas/resources-mdaNrm' - $ref: 'TS28105_AiMlNrm.yaml#/components/schemas/resources-AiMlNrm' - $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/resources-edgeNrm' + - $ref: 'TS28317_RanScNrm.yaml#/components/schemas/resources-RanScNrm' Scope: type: object properties: diff --git a/TS28532_StreamingDataMnS.yaml b/TS28532_StreamingDataMnS.yaml index ef587dac..6f7f94fc 100644 --- a/TS28532_StreamingDataMnS.yaml +++ b/TS28532_StreamingDataMnS.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: TS 28.532 Streaming data reporting service - version: 17.1.0 + version: 18.1.0 description: >- OAS 3.0.1 specification for the Streaming data reporting service (Streaming MnS) © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -402,7 +402,7 @@ components: traceInfo-Type: description: Information specific to trace data reporting allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/TraceJob-Attr' + - $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/TraceJob-Attr' traceReference-Type: description: Trace Reference (see clause 5.6 of 3GPP TS 32.422) as stream identifier for streaming trace data reporting type: string diff --git a/TS28538_EdgeNrm.yaml b/TS28538_EdgeNrm.yaml index 8500267e..cb10b910 100644 --- a/TS28538_EdgeNrm.yaml +++ b/TS28538_EdgeNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: 3GPP Edge NRM - version: 18.3.0 + version: 18.5.0 description: >- OAS 3.0.1 specification of the Edge NRM © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -73,6 +73,8 @@ components: type: integer virutalCPU: type: string + vnfdId: + type: string SoftwareImageInfo: type: object properties: @@ -112,7 +114,50 @@ components: 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' + relocationPolicy: + type: string + description: any of enumrated value + enum: + - YES + - NO + - YESwNOTIFY + AvailableEDNList: + type: object + properties: + resourceQuota: + $ref: '#/components/schemas/VirtualResource' #-------- Definition of concrete IOCs -------------------------------------------- MnS: @@ -155,6 +200,8 @@ components: $ref: '#/components/schemas/EASFunction-Multiple' EESFunction: $ref: '#/components/schemas/EESFunction-Multiple' + availableEdgeVirtualResources: + type: string EASFunction-Single: allOf: @@ -178,6 +225,10 @@ components: type: array items: type: string + relocationTriggerInfo: + $ref: '#/components/schemas/RelocationTriggerInfo' + relocationRejectByASP: + type: boolean - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' EASProfile-Single: allOf: @@ -256,12 +307,6 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' softwareImageInfo: $ref: '#/components/schemas/SoftwareImageInfo' - trackingAreaIdList: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/TaiList' - geographicalLocation: - $ref: '#/components/schemas/GeoLoc' - mcc: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' EASRequirements-Single: @@ -283,6 +328,65 @@ components: $ref: '#/components/schemas/Duration' eASFeature: $ref: '#/components/schemas/EASFeature' + relocationPolicy: + $ref: '#/components/schemas/EASFeature' + federationID: + type: string + reservationID: + type: string + + ResourceReservationJob: + 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: + type: string + resourceReservationStatus: + type: array + items: + $ref: '#/components/schemas/ResourceReservationStatus' + EdgeFederation-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + participatingOPiD: + type: string + originatingOPiD: + type: string + OperatorEdgeFederation-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + federationID: + type: string + FederationExpiry: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + originatedOPiD: + 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: + availableVirtualResource: + $ref: '#/components/schemas/VirtualResource' + availableEASResource: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + edgeDataNetworkRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' #-------- Definition of JSON arrays for name-contained IOCs ---------------------- @@ -311,6 +415,19 @@ components: type: array items: $ref: '#/components/schemas/EASProfile-Single' + EdgeFederation-Multiple: + type: array + items: + $ref: '#/components/schemas/EASProfile-Single' + OperatorEdgeFederation-Multiple: + type: array + items: + $ref: '#/components/schemas/OperatorEdgeFederation-Single' + OperatorEdgeDataNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/OperatorEdgeDataNetwork-Single' + #--------------------------------- Definition ------------------------------------ @@ -324,3 +441,6 @@ components: - $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' diff --git a/TS28541_5GcNrm.yaml b/TS28541_5GcNrm.yaml index 4cf5ec97..5a7ba351 100644 --- a/TS28541_5GcNrm.yaml +++ b/TS28541_5GcNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: 3GPP 5GC NRM - version: 18.5.0 + version: 18.6.0 description: >- OAS 3.0.1 specification of the 5GC NRM © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -123,12 +123,28 @@ components: 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 + 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: @@ -270,7 +286,7 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' minItems: 1 vendorId: - type: string + $ref: '#/components/schemas/VendorId' SEPPType: type: string description: any of enumerated value @@ -749,13 +765,24 @@ components: interfaceType: type: string enum: - - IPV4ENDPOINTADDRESSES - - IPV6ENDPOINTADDRESSES - - FQDN + - N3 + - N6 + - N9 + - DATA_FORWARDING + - N3MB + - N6MB + - N19MB + - NMB9 ipv4EndpointAddresses: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + minItems: 1 ipv6EndpointAddresses: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + minItems: 1 fqdn: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' networkInstance: @@ -957,7 +984,22 @@ components: $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 @@ -1494,18 +1536,38 @@ components: 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 + required: + - amfSetId + - amfRegionId + - guamiList properties: - # amfSetId: - # $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' - # amfRegionId: - # $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' + amfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' + amfRegionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' guamiList: type: array items: @@ -1531,13 +1593,13 @@ components: items: $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' minItems: 1 - # n2InterfaceAmfInfo: - # $ref: '#/components/schemas/N2InterfaceAmfInfo' - # amfOnboardingCapability: - # type: boolean - # default: false - # highLatencyCom: - # type: boolean + n2InterfaceAmfInfo: + $ref: '#/components/schemas/N2InterfaceAmfInfo' + amfOnboardingCapability: + type: boolean + default: false + highLatencyCom: + type: boolean SmfInfo: description: Information of an SMF NF Instance @@ -1583,27 +1645,27 @@ components: 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 + 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 + required: + - sNssaiUpfInfoList properties: - # sNssaiUpfInfoList: - # type: array - # items: - # $ref: '#/components/schemas/SnssaiUpfInfoItem' - # minItems: 1 + sNssaiUpfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiUpfInfoItem' + minItems: 1 smfServingArea: type: array items: @@ -1617,8 +1679,8 @@ components: iwkEpsInd: type: boolean default: false - # sxaInd: - # type: boolean + sxaInd: + type: boolean pduSessionTypes: type: array items: @@ -1704,6 +1766,25 @@ components: $ref: '#/components/schemas/ProseCapability' v2xCapability: $ref: '#/components/schemas/V2xCapability' + a2xSupportInd: + type: boolean + default: false + a2xCapability: + $ref: '#/components/schemas/A2xCapability' + rangingSlPosSupportInd: + type: boolean + default: false + + 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 @@ -1751,6 +1832,12 @@ components: 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 @@ -1896,26 +1983,26 @@ components: - $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 + 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 @@ -1974,14 +2061,14 @@ components: # - $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 + 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 @@ -1996,18 +2083,18 @@ components: # 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 + 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 @@ -2044,6 +2131,75 @@ components: - $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 @@ -2086,6 +2242,82 @@ components: 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 @@ -2190,16 +2422,345 @@ components: 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: + 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: - type: string - pattern: '^[0-9]{1,4}$' + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + required: + - msisdnRanges #-------- Definition of concrete IOCs -------------------------------------------- ProvMnS: @@ -2317,7 +2878,13 @@ components: AANFFunction: $ref: '#/components/schemas/AanfFunction-Multiple' BSFFunction: - $ref: '#/components/schemas/BsfFunction-Multiple' + $ref: '#/components/schemas/BsfFunction-Multiple' + MBSMFFunction: + $ref: '#/components/schemas/MbSmfFunction-Multiple' + MBUPFFunction: + $ref: '#/components/schemas/MbUpfFunction-Multiple' + MNPFFunction: + $ref: '#/components/schemas/MnpfFunction-Multiple' AmfFunction-Single: allOf: @@ -2385,7 +2952,9 @@ components: EP_N42: $ref: '#/components/schemas/EP_N42-Multiple' EP_N89: - $ref: '#/components/schemas/EP_N89-Multiple' + $ref: '#/components/schemas/EP_N89-Multiple' + EP_N11mb: + $ref: '#/components/schemas/EP_N11mb-Multiple' AmfSet-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -2475,6 +3044,8 @@ components: $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: @@ -2500,6 +3071,10 @@ components: $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: @@ -2717,6 +3292,8 @@ components: $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' @@ -2733,8 +3310,8 @@ components: type: string cNSIIdList: $ref: '#/components/schemas/CNSIIdList' - nFProfileList: - $ref: '#/components/schemas/NFProfileList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' commModelList: $ref: '#/components/schemas/CommModelList' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' @@ -2744,6 +3321,8 @@ components: $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' @@ -2882,6 +3461,11 @@ components: 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' ScpFunction-Single: allOf: @@ -2900,6 +3484,10 @@ components: scpInfo: $ref: '#/components/schemas/ScpInfo' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_SM13: + $ref: '#/components/schemas/EP_SM13-Multiple' NefFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -3458,6 +4046,20 @@ components: $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' @@ -3710,7 +4312,8 @@ components: type: string enum: - GBR - - NonGBR + - NON_GBR + - DELAY_CRITICAL_GBR priorityLevel: type: integer packetDelayBudget: @@ -4304,6 +4907,251 @@ components: $ref: '#/components/schemas/BsfInfo' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + 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' + - 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' + - 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' + - 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 + + 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 JSON arrays for name-contained IOCs ---------------------- SubNetwork-Multiple: @@ -4526,6 +5374,10 @@ components: 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: @@ -4639,6 +5491,46 @@ components: 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: @@ -4695,6 +5587,18 @@ components: 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' #------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- @@ -4762,6 +5666,7 @@ components: - $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' @@ -4785,6 +5690,11 @@ components: - $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' @@ -4795,6 +5705,13 @@ components: - $ref: '#/components/schemas/EP_NL5-Single' - $ref: '#/components/schemas/EP_NL6-Single' - $ref: '#/components/schemas/EP_NL9-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' @@ -4811,3 +5728,6 @@ components: - $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' diff --git a/TS28541_NrNrm.yaml b/TS28541_NrNrm.yaml index 0a509974..dd2a8ec6 100644 --- a/TS28541_NrNrm.yaml +++ b/TS28541_NrNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: NR NRM - version: 18.5.0 + version: 18.6.0 description: >- OAS 3.0.1 specification of the NR NRM © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -16,7 +16,9 @@ components: #-------- Definition of types----------------------------------------------------- GnbId: - type: string + type: integer + minimum: 0 + maximum: 4294967295 GnbIdLength: type: integer minimum: 22 @@ -25,16 +27,17 @@ components: type: string maxLength: 150 GnbDuId: - type: number + type: integer minimum: 0 maximum: 68719476735 GnbCuUpId: - type: number + type: integer minimum: 0 maximum: 68719476735 Sst: type: integer + minimum: 0 maximum: 255 Snssai: type: object @@ -43,6 +46,7 @@ components: $ref: '#/components/schemas/Sst' sd: type: string + pattern: '^[A-Fa-f0-9]{6}$' PlmnIdList: type: array @@ -65,13 +69,24 @@ components: type: string NpnIdentity: type: object + oneOf: + - required: [ plmnId, cagidList ] + - required: [ plmnId, nidList ] properties: plmnId: $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' cagidList: - $ref: '#/components/schemas/cagId' + type: array + items: + $ref: '#/components/schemas/cagId' + minItems: 1 + maxItems: 12 nidList: - $ref: '#/components/schemas/nid' + type: array + items: + $ref: '#/components/schemas/nid' + minItems: 1 + maxItems: 12 NpnIdentityList: type: array items: @@ -247,7 +262,7 @@ components: enum: - DL - UL - - DL and UL + - DL_AND_UL BwpContext: type: string enum: @@ -540,8 +555,8 @@ components: enum: - RS1 - RS2 - - RS1forEnoughMitigation - - RS1forNotEnoughMitigation + - RS1_FOR_ENOUGH_MITIGATION + - RS1_FOR_NOT_ENOUGH_MITIGATION RimRSReportConf: type: object @@ -582,7 +597,7 @@ components: - PRB - PRB_UL - PRB_DL - - RRC + - RRC_CONNECTED_USERS - DRB ParameterRange: type: object @@ -591,19 +606,36 @@ components: type: integer minValue: type: integer + NTNTAClist: type: array items: $ref: '#/components/schemas/NrTac' + Ephemeris: type: object oneOf: - - $ref: '#/components/schemas/PositionVelocity' - - $ref: '#/components/schemas/Orbital' + - required: [ positionVelocity ] + - required: [ orbital ] + required: + - satelliteId + - epochTime properties: satelliteId: - type: integer - + 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: @@ -828,7 +860,14 @@ components: $ref: '#/components/schemas/EP_F1C-Single' EP_F1U: $ref: '#/components/schemas/EP_F1U-Multiple' - + configurable5QISetRef: + description: This attribute is condition optional. The condition is NG-RAN Multi-Operator Core Network (NG-RAN MOCN) network sharing with operator specific 5QI is supported. + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + dynamic5QISetRef: + description: This attribute is condition optional. The condition is NG-RAN Multi-Operator Core Network (NG-RAN MOCN) network sharing with operator specific 5QI is supported. + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + NrOperatorCellDu: + $ref: '#/components/schemas/NrOperatorCellDu-Multiple' GnbCuUpFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -911,6 +950,8 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' dynamic5QISetRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + ephemerisInfoSetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' dCHOControl: type: boolean dDAPSHOControl: @@ -1078,8 +1119,7 @@ components: $ref: '#/components/schemas/CPCIConfigurationFunction-Single' DRACHOptimizationFunction: $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - NrOperatorCellDu: - $ref: '#/components/schemas/NrOperatorCellDu-Multiple' + BWPSet-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -1226,7 +1266,7 @@ components: beamType: type: string enum: - - SSB-BEAM + - SSB_BEAM beamAzimuth: type: integer minimum: -1800 @@ -1474,13 +1514,13 @@ components: isProbingCapable: type: string enum: - - yes - - no + - YES + - NO energySavingState: type: string enum: - - isNotEnergySaving - - isEnergySaving + - IS_NOT_ENERGY_SAVING + - IS_ENERGY_SAVING DRACHOptimizationFunction-Single: allOf: @@ -1496,7 +1536,6 @@ components: $ref: "#/components/schemas/UeAccProbabilityDist" ueAccDelayProbabilityDist: $ref: "#/components/schemas/UeAccDelayProbabilityDist" - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' DMROFunction-Single: allOf: @@ -1584,13 +1623,13 @@ components: energySavingControl: type: string enum: - - toBeEnergySaving - - toBeNotEnergySaving + - TO_BE_ENERGY_SAVING + - TO_BE_NOT_ENERGY_SAVING energySavingState: type: string enum: - - isNotEnergySaving - - isEnergySaving + - IS_NOT_ENERGY_SAVING + - IS_ENERGY_SAVING RimRSGlobal-Single: allOf: @@ -1956,7 +1995,7 @@ components: $ref: '#/components/schemas/PlmnInfoList' nTNTAClist: $ref: '#/components/schemas/NrTacList' - EphemerisInfoSet: + ephemerisInfoSet: $ref: '#/components/schemas/EphemerisInfoSet-Multiple' EphemerisInfoSet-Single: @@ -1968,20 +2007,8 @@ components: allOf: - type: object properties: - EphemerisInfos: - $ref: '#/components/schemas/Ephemeris-Multiple' - - Ephemeris-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - oneOf: - - $ref: '#/components/schemas/PositionVelocity' - - $ref: '#/components/schemas/Orbital' - properties: - satelliteId: - type: integer - + ephemerisInfos: + $ref: '#/components/schemas/EphemerisInfos' #-------- Definition of JSON arrays for name-contained IOCs ---------------------- @@ -2150,10 +2177,6 @@ components: items: $ref: '#/components/schemas/EphemerisInfoSet-Single' - Ephemeris-Multiple: - type: array - items: - $ref: '#/components/schemas/Ephemeris-Single' #-------- Definitions in TS 28.541 for TS 28.532 --------------------------------- resources-nrNrm: @@ -2222,5 +2245,4 @@ components: - $ref: '#/components/schemas/CCOOvershootCoverageParameters-Single' - $ref: '#/components/schemas/NTNFunction-Single' - $ref: '#/components/schemas/EphemerisInfoSet-Single' - - $ref: '#/components/schemas/Ephemeris-Single' diff --git a/TS28541_SliceNrm.yaml b/TS28541_SliceNrm.yaml index 88eeb770..52620a6b 100644 --- a/TS28541_SliceNrm.yaml +++ b/TS28541_SliceNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Slice NRM - version: 18.5.0 + version: 18.6.0 description: >- OAS 3.0.1 specification of the Slice NRM @ 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -178,13 +178,6 @@ components: $ref: '#/components/schemas/SynAvailability' accuracy: $ref: '#/components/schemas/Float' - SynchronicityRANSubnet: - type: object - properties: - availability: - $ref: '#/components/schemas/SynAvailability' - accuracy: - $ref: '#/components/schemas/Float' Positioning: type: object properties: @@ -196,15 +189,6 @@ components: $ref: '#/components/schemas/PredictionFrequency' accuracy: $ref: '#/components/schemas/Float' - PositioningRANSubnet: - type: object - properties: - availability: - $ref: '#/components/schemas/PositioningAvailability' - predictionFrequency: - $ref: '#/components/schemas/PredictionFrequency' - accuracy: - $ref: '#/components/schemas/Float' UserMgmtOpen: type: object properties: @@ -304,6 +288,68 @@ components: 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 @@ -334,11 +380,11 @@ components: type: integer delayTolerance: $ref: '#/components/schemas/DelayTolerance' - synchronicity: - $ref: '#/components/schemas/SynchronicityRANSubnet' sliceSimultaneousUse: $ref: '#/components/schemas/SliceSimultaneousUse' - reliability: + dLReliability: + type: number + uLReliability: type: number energyEfficiency: type: number @@ -354,6 +400,16 @@ components: $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' RANSliceSubnetProfile: type: object @@ -382,7 +438,9 @@ components: $ref: '#/components/schemas/XLThpt' uESpeed: type: integer - reliability: + dLReliability: + type: number + uLReliability: type: number dLMaxPktSize: type: integer @@ -395,7 +453,7 @@ components: delayTolerance: $ref: '#/components/schemas/DelayTolerance' positioning: - $ref: '#/components/schemas/PositioningRANSubnet' + $ref: '#/components/schemas/Positioning' sliceSimultaneousUse: $ref: '#/components/schemas/SliceSimultaneousUse' energyEfficiency: @@ -405,13 +463,22 @@ components: survivalTime: type: number synchronicity: - $ref: '#/components/schemas/SynchronicityRANSubnet' + $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' + TopSliceSubnetProfile: type: object properties: @@ -461,7 +528,9 @@ components: $ref: '#/components/schemas/MobilityLevel' uESpeed: type: integer - reliability: + dLReliability: + type: number + uLReliability: type: number dLDeterministicComm: $ref: '#/components/schemas/DeterministicComm' @@ -475,6 +544,18 @@ components: $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' ServiceProfile: type: object @@ -545,7 +626,9 @@ components: type: integer survivalTime: type: number - reliability: + dLReliability: + type: number + uLReliability: type: number maxDLDataVolume: type: number @@ -561,6 +644,11 @@ components: $ref: '#/components/schemas/N6Protection' nonIPSupport: $ref: '#/components/schemas/NonIPSupport' + supportedDataNetworks: + $ref: '#/components/schemas/DataNetwork' + dataNetworkAccess: + $ref: '#/components/schemas/DataNetworkAccess' + SliceProfile: type: object properties: @@ -675,7 +763,25 @@ components: An attribute that specifies the additional reason information if the reservation is failed. type: string + ResourceIsolationRule: + type: object + properties: + resourceType: + type: string + enum: + - MANAGED_FUNCTION + - NETWORK_SERVICE + isolationRule: + type: string + enum: + - DEDICATED + - SHARED + NetworkSlicingApplicability: + type: string + enum: + - NETWORKSLICE + - NETWORKSLICESUBNET #------------ Definition of concrete IOCs ---------------------------------------- @@ -717,7 +823,8 @@ components: $ref: '#/components/schemas/NetworkSliceController-Multiple' NetworkSliceSubnetController: $ref: '#/components/schemas/NetworkSliceSubnetController-Multiple' - + IsolationProfile: + $ref: '#/components/schemas/IsolationProfile-Multiple' NetworkSlice-Single: allOf: @@ -738,6 +845,8 @@ components: $ref: '#/components/schemas/ServiceProfileList' networkSliceControllerRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + isolationProfileRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' NetworkSliceSubnet-Single: allOf: @@ -772,6 +881,8 @@ components: - CN_SLICESUBNET networkSliceSubnetControllerRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + isolationProfileRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' EP_Transport-Single: allOf: @@ -894,6 +1005,26 @@ components: networkSliceSubnetRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + IsolationProfile-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + networkSlicingApplicability: + $ref: '#/components/schemas/NetworkSlicingApplicability' + resourceIsolationRuleList: + type: array + items: + $ref: '#/components/schemas/ResourceIsolationRule' + networkSliceRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + networkSliceSubnetRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + #-------- Definition of JSON arrays for name-contained IOCs ---------------------- SubNetwork-Multiple: type: array @@ -934,6 +1065,11 @@ components: 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: @@ -948,4 +1084,5 @@ components: - $ref: '#/components/schemas/FeasibilityCheckAndReservationJob-Single' - $ref: '#/components/schemas/NetworkSliceController-Single' - $ref: '#/components/schemas/NetworkSliceSubnetController-Single' + - $ref: '#/components/schemas/IsolationProfile-Single' diff --git a/TS28623_ComDefs.yaml b/TS28623_ComDefs.yaml index eb972351..88dbbd98 100644 --- a/TS28623_ComDefs.yaml +++ b/TS28623_ComDefs.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Common Type Definitions - version: 18.3.0 + version: 18.5.0 description: >- OAS 3.0.1 specification of common type definitions in the Generic NRM © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -19,6 +19,23 @@ components: DateTime: type: string format: date-time + FullTime: + type: string + description: format (e.g., full-time) is from RFC 3339 + format: full-time + DateMonth: + type: string + format: date-month + DateMonthDay: + type: string + format: date-mday + DayInYear: + type: object + properties: + month: + $ref: '#/components/schemas/DateMonth' + monthDay: + $ref: '#/components/schemas/DateMonthDay' Latitude: type: number format: float @@ -65,12 +82,21 @@ components: type: string pattern: '^[A-Fa-f0-9]{9}$' TimeWindow: - type: object - properties: - startTime: - $ref: '#/components/schemas/DateTime' - endTime: - $ref: '#/components/schemas/DateTime' + oneOf: + - type: object + properties: + startTime: + $ref: '#/components/schemas/DateTime' + endTime: + $ref: '#/components/schemas/DateTime' + - type: object + properties: + startTime: + $ref: '#/components/schemas/DateTime' + - type: object + properties: + endTime: + $ref: '#/components/schemas/DateTime' GeoCoordinate: type: object properties: @@ -150,6 +176,14 @@ components: Uri: type: string + TimeInterval: + type: object + properties: + intervalStart: + $ref: '#/components/schemas/FullTime' + intervalEnd: + $ref: '#/components/schemas/FullTime' + AdministrativeState: type: string enum: diff --git a/TS28623_GenericNrm.yaml b/TS28623_GenericNrm.yaml index e0434044..64b9c018 100644 --- a/TS28623_GenericNrm.yaml +++ b/TS28623_GenericNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Generic NRM - version: 18.4.0 + version: 18.5.0 description: >- OAS 3.0.1 definition of the Generic NRM © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -54,6 +54,10 @@ components: ThresholdInfo: type: object properties: + performanceMetrics: + type: array + items: + type: string thresholdDirection: type: string enum: @@ -272,1400 +276,160 @@ components: - NOT_STARTED - RUNNING - FINSHED - - FAILED - - CANCELLING - - CANCELLED - progressPercentage: - type: integer - minimum: 0 - maximum: 100 - progressStateInfo: - type: string - resultStateInfo: - oneOf: - - type: string - enum: - - NULL - - UNKNOWN - - NO_STORAGE - - LOW_MEMROY - - NO_CONNECTION_TO_REMOTE_SERVER - - FILE_NOT_AVAILABLE - - DNS_CANNOT_BE_RESOLVED - - TIMER_EXPIRED - - OTHER - - type: string - startTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - endTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - timer: - type: integer - AreaScope: - 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' - AreaConfig: - type: object - properties: - freqInfo: - $ref: '#/components/schemas/FreqInfo' - pciList: - type: array - items: - type: integer - FreqInfo: - description: specifies the carrier frequency and bands used in a cell. - type: object - properties: - arfcn: - type: integer - freqBands: - type: array - items: - type: integer - MbsfnArea: - type: object - properties: - mbsfnAreaId: - type: integer - minimum: 1 - earfcn: - type: integer - minimum: 1 - 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' - - ManagementData: - oneOf: - - type: array - items: - type: string - enum: - - COVERAGE - - CAPACITY - - ENERGY_EFFICIENCY - - MOBILITY - - ACCESSIBILITY - - type: array - items: - type: string - NodeFilter: - type: object - properties: - areaOfInterest: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AreaOfInterest' - networkDomain: - type: string - enum: - - CN - - RAN - cpUpType: - type: string - enum: - - CP - - UP - sst: - type: integer - -#-------- Definition of types used in Trace control NRM fragment------------------ - - jobType-Type: - type: string - description: Specifies whether the TraceJob represents only MDT, Logged MBSFN MDT, Trace or a combined Trace and MDT job. Applicable for Trace, MDT, RCEF and RLF reporting. See 3GPP TS 32.422 clause 5.9a for additional details. - enum: - - IMMEDIATE_MDT_ONLY - - LOGGED_MDT_ONLY - - TRACE_ONLY - - IMMEDIATE_MDT AND TRACE - - RLF_REPORT_ONLY - - RCEF_REPORT_ONLY - - LOGGED_MBSFN_MDT - - listOfInterfaces-Type: - description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details. - type: object - properties: - MSCServerInterfaces: - type: array - items: - type: string - enum: - - A - - Iu-CS - - Mc - - MAP-G - - MAP-B - - MAP-E - - MAP-F - - MAP-D - - MAP-C - - CAP - MGWInterfaces: - type: array - items: - type: string - enum: - - Mc - - Nb-UP - - Iu-UP - RNCInterfaces: - type: array - items: - type: string - enum: - - Iu-CS - - Iu-PS - - Iur - - Iub - - Uu - SGSNInterfaces: - type: array - items: - type: string - enum: - - Gb - - Iu-PS - - Gn - - MAP-Gr - - MAP-Gd - - MAP-Gf - - Ge - - Gs - - S6d - - S4 - - S3 - - S13 - GGSNInterfaces: - type: array - items: - type: string - enum: - - Gn - - Gi - - Gmb - S-CSCFInterfaces: - type: array - items: - type: string - enum: - - Mw - - Mg - - Mr - - Mi - P-CSCFInterfaces: - type: array - items: - type: string - enum: - - Gm - - Mw - I-CSCFInterfaces: - type: array - items: - type: string - enum: - - Cx - - Dx - - Mg - - Mw - MRFCInterfaces: - type: array - items: - type: string - enum: - - Mp - - Mr - MGCFInterfaces: - type: array - items: - type: string - enum: - - Mg - - Mj - - Mn - IBCFInterfaces: - type: array - items: - type: string - enum: - - Ix - - Mx - E-CSCFInterfaces: - type: array - items: - type: string - enum: - - Mw - - Ml - - Mm - - Mi/Mg - BGCFInterfaces: - type: array - items: - type: string - enum: - - Mi - - Mj - - Mk - ASInterfaces: - type: array - items: - type: string - enum: - - Dh - - Sh - - ISC - - Ut - HSSInterfaces: - type: array - items: - type: string - enum: - - MAP-C - - MAP-D - - Gc - - Gr - - Cx - - S6d - - S6a - - Sh - - N70 - - N71 - - NU1 - EIRInterfaces: - type: array - items: - type: string - enum: - - MAP-F - - S13 - - MAP-Gf - BM-SCInterfaces: - type: array - items: - type: string - enum: - - Gmb - MMEInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - S3 - - S6a - - S10 - - S11 - - S13 - SGWInterfaces: - type: array - items: - type: string - enum: - - S4 - - S5 - - S8 - - S11 - - Gxc - PDN_GWInterfaces: - type: array - items: - type: string - enum: - - S2a - - S2b - - S2c - - S5 - - S6b - - Gx - - S8 - - SGi - eNBInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - X2 - en-gNBInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - X2 - - Uu - - F1-C - - E1 - AMFInterfaces: - type: array - items: - type: string - enum: - - N1 - - N2 - - N8 - - N11 - - N12 - - N14 - - N15 - - N20 - - N22 - - N26 - AUSFInterfaces: - type: array - items: - type: string - enum: - - N12 - - N13 - NEFInterfaces: - type: array - items: - type: string - enum: - - N29 - - N30 - - N33 - NRFInterfaces: - type: array - items: - type: string - enum: - - N27 - NSSFInterfaces: - type: array - items: - type: string - enum: - - N22 - - N31 - PCFInterfaces: - type: array - items: - type: string - enum: - - N5 - - N7 - - N15 - SMFInterfaces: - type: array - items: - type: string - enum: - - N4 - - N7 - - N10 - - N11 - - S5-C - SMSFInterfaces: - type: array - items: - type: string - enum: - - N20 - - N21 - UDMInterfaces: - type: array - items: - type: string - enum: - - N8 - - N10 - - N13 - - N21 - - NU1 - UPFInterfaces: - type: array - items: - type: string - enum: - - N4 - ng-eNBInterfaces: - type: array - items: - type: string - enum: - - NG-C - - Xn-C - - Uu - gNB-CU-CPInterfaces: - type: array - items: - type: string - enum: - - NG-C - - Xn-C - - Uu - - F1-C - - E1 - - X2-C - gNB-CU-UPInterfaces: - type: array - items: - type: string - enum: - - E1 - gNB-DUInterfaces: - type: array - items: - type: string - enum: - - F1-C - - listOfNeTypes-Type: - description: The Network Element types where Trace Session activation is needed. See 3GPP TS 32.422 clause 5.4 for additional details. - type: array - items: - type: string - enum: - - MSC_SERVER - - SGSN - - MGW - - GGSN - - RNC - - BM_SC - - MME - - SGW - - PGW - - ENB - - EN_GNB - - GNB_CU_CP - - GNB_CU_UP - - GNB_DU - - AMF - - PCF - - SMF - - UPF - - AUSF - - SMSF - - HSS - - UDM - - plmnTarget-Type: - type: object - description: The PLMN for which sessions shall be selected in the Trace Session in case of management based activation when several PLMNs are supported in the RAN (this means that shared cells and not shared cells are allowed for the specified PLMN. Note that the PLMN Target might differ from the PLMN specified in the Trace Reference, as that specifies the PLMN that is containing the management system requesting the Trace Session from the NE. See 3GPP TS 32.422 clause 5.9b for additional details. - properties: - mcc: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' - mnc: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' - required: - - mcc - - mnc - - traceDepth-Type: - description: Specifies how detailed information should be recorded in the Network Element. The Trace Depth is a paremeter for Trace Session level, i.e., the Trace Depth is the same for all of the NEs to be traced in the same Trace Session. See 3GPP TS 32.422 clause 5.3 for additional details. - type: string - enum: - - MINIMUM - - MEDIUM - - MAXIMUM - - VENDORMINIMUM - - VENDORMEDIUM - - VENDORMAXIMUM - - traceReference-Type: - type: object - description: The Trace Reference parameter shall be globally unique, therefore the Trace Reference shall compose as follows - MCC+MNC+Trace ID, where the MCC and MNC are coming with the Trace activation request from the management system to identify one PLMN containing the management system, and Trace ID is a 3 byte Octet String. See 3GPP TS 32.422 clause 5.6 for additional details. - properties: - mcc: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' - mnc: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' - traceId: - type: string - required: - - mcc - - mnc - - traceId - - traceReportingFormat-Type: - type: string - description: Specifies whether file-based or streaming reporting shall be used for this Trace Session. See 3GPP TS 32.422 clause 5.11 for additional details. - enum: - - FILE-BASED - - STREAMING - - traceTarget-Type: - type: object - description: Trace target conveying both the type and value of the target ID. For additional details see 3GPP TS 32.422 - properties: - TargetIdType: - type: string - enum: - - IMSI - - IMEI - - IMEISV - - PUBLIC_ID - - UTRAN_CELL - - E-UTRAN_CELL - - NG-RAN_CELL - - eNB - - RNC - - gNB - - SUPI - TargetIdValue: - type: string - required: - - TargetIdType - - TargetIdValue - - triggeringEvents-Type: - type: object - description: Specifies when to start a Trace Recording Session and which message shall be recorded first, when to stop a Trace Recording Session and which message shall be recorded last respectively. See 3GPP TS 32.422 clause 5.1 for additional detials. - properties: - MSC_SERVER: - type: array - items: - type: string - enum: - - MO_MT_CALLS - - MO_MT_SMS - - LU_IMSIattach_IMSIdetach - - HANDOVER - - SS - SGSN: - type: array - items: - type: string - enum: - - PDPcontext - - MO_MT_SMS - - RAU_GPRSattach_GPRSdetach - - MBMScontext - MGW: - type: array - items: - type: string - enum: - - CONTEXT - GGSN: - type: array - items: - type: string - enum: - - PDPcontext - - MBMScontext - IMS: - type: array - items: - type: string - enum: - - SIPsession_StandaloneTransaction - BM_SC: - type: array - items: - type: string - enum: - - MBMSactivation - MME: - type: array - items: - type: string - enum: - - UEinitiatedPDNconnectivityRequest - - ServiceRequest - - InitialAttach_TAU_Detach - - UEinitiatedPDNdisconnection - - BearerActivationModificationDeletion - - Handover - SGW: - type: array - items: - type: string - enum: - - PDNconnectionCreation - - PDNconnectionTermination - - BearerActivationModificationDeletion - PGW: - type: array - items: - type: string - enum: - - PDNconnectionCreation - - PDNconnectionTermination - - BearerActivationModificationDeletion - AMF: - type: array - items: - type: string - enum: - - Registration - - ServiceRequest - - Handover - - UEderegistration - - NetworkDeregistration - - UEMobilityFromEPC - - UEMobilityToEPC - SMF: - type: array - items: - type: string - enum: - - PDUsessionEstablishment - - PDUsessionModification - - PDUsessionRelease - - PDUsessionUPactivationDeactivation - - MobilityBtw3gppAndN3gppTo5GC - - MobilityFromEpc - PCF: - type: array - items: - type: string - enum: - - AMpolicy - - SMpolicy - - Authorization - - BDTpolicy - UPF: - type: array - items: - type: string - enum: - - N4Session - AUSF: - type: array - items: - type: string - enum: - - UEauthentication - NEF: - type: array - items: - type: string - enum: - - EventExposure - - PFDmanagement - - ParameterProvision - - Trigger - NRF: - type: array - items: - type: string - enum: - - NFmanagement - - NFdiscovery - NSSF: - type: array - items: - type: string - enum: - - NSSelection - - NSSAI - SMSF: - type: array - items: - type: string - enum: - - SMservice - UDM: - type: array - items: - type: string - enum: - - UEcontext - - SubscriberData - - UEauthentication - - EventExposure - - anonymizationOfMdtData-Type: - description: Specifies level of MDT anonymization. For additional details see 3GPP TS 32.422 clause 5.10.12. - type: string - enum: - - NO_IDENTITY - - TAC_OF_IMEI - - beamLevelMeasurement-Type: - description: Determines whether beam level measurements shall be included in case of immediate MDT M1 measurement in NR. For additional details see 3GPP TS 32.422 clause 5.10.40. - type: boolean - - collectionPeriodRrmLte-Type: - description: See details in 3GPP TS 32.422 clause 5.10.20. - type: string - enum: - - 100ms - - 1000ms - - 1024ms - - 1280ms - - 2048ms - - 2560ms - - 5120ms - - 10000ms - - 10240ms - - 60000ms - - collectionPeriodM6Lte-Type: - description: See details in 3GPP TS 32.422 clause 5.10.32. - type: string - enum: - - 1024ms - - 2048ms - - 5120ms - - 10240ms - - collectionPeriodM7Lte-Type: - description: See details in 3GPP TS 32.422 clause 5.10.33. - type: integer - minimum: 1 - maximum: 60 - - collectionPeriodRrmUmts-Type: - description: See details in 3GPP TS 32.422 clause 5.10.21. - type: string - enum: - - 100ms - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - collectionPeriodRrmNr-Type: - description: See details in 3GPP TS 32.422 clause 5.10.30. - type: string - enum: - - 1024ms - - 2048ms - - 5120ms - - 10240ms - - 60000ms - - collectionPeriodM6Nr-Type: - description: See details in 3GPP TS 32.422 clause 5.10.34. - type: string - enum: - - 120ms - - 240ms - - 480ms - - 640ms - - 1024ms - - 2048ms - - 5120ms - - 10240ms - - 20480ms - - 40960ms - - 1min - - 6min - - 12min - - 30min - - collectionPeriodM7Nr-Type: - description: See details in 3GPP TS 32.422 clause 5.10.35. - type: integer - minimum: 1 - maximum: 60 - - eventListForEventTriggeredMeasurement-Type: - description: See details in 3GPP TS 32.422 clause 5.10.28. - type: string - enum: - - OUT_OF_COVERAGE - - A2_EVENT - - eventThreshold-Type: - description: See details in 3GPP TS 32.422 clause 5.10.7, 5.10.7a, 5.10.13 and 5.10.14. - type: object - properties: - EventThresholdRSRP: - oneOf: - - type: integer - minimum: 0 - maximum: 97 - - type: integer - minimum: 0 - maximum: 127 - EventThresholdRSRQ: - oneOf: - - type: integer - minimum: 0 - maximum: 34 - - type: integer - minimum: 0 - maximum: 127 - EventThreshold1F: - type: object - properties: - CPICH_RSCP: - type: integer - minimum: -120 - maximum: 25 - CPICH_EcNo: - type: integer - minimum: -24 - maximum: 0 - PathLoss: - type: integer - minimum: 30 - maximum: 165 - EventThreshold1I: - type: integer - minimum: -120 - maximum: 25 - - listOfMeasurements-Type: - description: See details in 3GPP TS 32.422 clause 5.10.3 for details. - type: object - properties: - UMTS: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M6_DL - - M6_UL - - M7_DL - - M7_UL - LTE: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M1_EVENT_TRIGGERED - - M6 - - M7 - - M8 - - M9 - NR: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M6 - - M7 - - M1_EVENT_TRIGGERED - - M8 - - M9 - - loggingDuration-Type: - description: See details in 3GPP TS 32.422 clause 5.10.9. - type: string - enum: - - 600s - - 1200s - - 2400s - - 3600s - - 5400s - - 7200s - - loggingInterval-Type: - description: See details in 3GPP TS 32.422 clause 5.10.8. - type: object - properties: - UMTS: - type: array - items: - type: string - enum: - - 1.28s - - 2.56s - - 5.12s - - 10.24s - - 20.48s - - 30.72s - - 40.96s - - 61.44s - LTE: - type: array - items: - type: string - enum: - - 1.28s - - 2.56s - - 5.12s - - 10.24s - - 20.48s - - 30.72s - - 40.96s - - 61.44s - NR: - type: array - items: - type: string - enum: - - 0.32s - - 0.64s - - 1.28s - - 2.56s - - 5.12s - - 10.24s - - 20.48s - - 30.72s - - 40.96s - - 61.44s - - INFINITY + - FAILED + - CANCELLING + - CANCELLED + progressPercentage: + type: integer + minimum: 0 + maximum: 100 + progressStateInfo: + type: string + resultStateInfo: + oneOf: + - type: string + enum: + - NULL + - UNKNOWN + - NO_STORAGE + - LOW_MEMROY + - NO_CONNECTION_TO_REMOTE_SERVER + - FILE_NOT_AVAILABLE + - DNS_CANNOT_BE_RESOLVED + - TIMER_EXPIRED + - OTHER + - type: string + startTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + timer: + type: integer + AreaScope: + 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' + - type: array + items: + $ref: '#/components/schemas/NpnId-Type' - eventThresholdL1-Type: - description: See details in 3GPP TS 32.422 clause 5.10.X. + Tai: type: object properties: - RSRP: - type: integer - minimum: 0 - maximum: 127 - RSRQ: - type: integer - minimum: 0 - maximum: 127 - - hysteresisL1-Type: - description: See details in 3GPP TS 32.422 clause 5.10.Y. - type: integer - minimum: 0 - maximum: 30 - - timeToTriggerL1-Type: - description: See details in 3GPP TS 32.422 clause 5.10.Z. - type: string - enum: - - 0ms - - 40ms - - 64ms - - 80ms - - 100ms - - 128ms - - 160ms - - 256ms - - 320ms - - 480ms - - 512ms - - 640ms - - 1024ms - - 1280ms - - 2560ms - - 5120ms - - measurementPeriodLte-Type: - description: See details in 3GPP TS 32.422 clause 5.10.23. - type: string - enum: - - 1024ms - - 2048ms - - 5120ms - - 10240ms - - 1min - - measurementPeriodUmts-Type: - description: See details in 3GPP TS 32.422 clause 5.10.22. - type: string - enum: - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - - measurementQuantity-Type: - description: See details in 3GPP TS 32.422 clause 5.10.15. - type: string - enum: - - CPICH_EcNo - - CPICH_RSCP - - PathLoss - - eventThresholdUphUmts-Type: - description: See details in 3GPP TS 32.422 clause 5.10.A. - type: integer - minimum: 0 - maximum: 31 - - plmnList-Type: - description: See details in 3GPP TS 32.422 clause 5.10.24. - type: array - items: - type: object - properties: - mcc: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' - mnc: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' - required: - - mcc - - mnc - maxItems: 16 - - positioningMethod-Type: - description: See details in 3GPP TS 32.422 clause 5.10.19. - type: string - enum: - - GNSS - - E-CELL_ID - - reportAmount-Type: - description: See details in 3GPP TS 32.422 clause 5.10.6. - type: string - enum: - - 1 - - 2 - - 4 - - 8 - - 16 - - 32 - - 64 - - INFINITY - reportAmountM1LTE-Type: - description: See details in 3GPP TS 32.422 clause 5.10.x. - type: string - enum: - - 1 - - 2 - - 4 - - 8 - - 16 - - 32 - - 64 - - INFINITY - - reportAmountM4LTE-Type: - description: See details in 3GPP TS 32.422 clause 5.10.y. - type: string - enum: - - 1 - - 2 - - 4 - - 8 - - 16 - - 32 - - 64 - - INFINITY - - reportAmountM5LTE-Type: - description: See details in 3GPP TS 32.422 clause 5.10.z. - type: string - enum: - - 1 - - 2 - - 4 - - 8 - - 16 - - 32 - - 64 - - INFINITY - - reportAmountM6LTE-Type: - description: See details in 3GPP TS 32.422 clause 5.10.a. + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + tac: + $ref: '#/components/schemas/Tac' + Tac: type: string - enum: - - 1 - - 2 - - 4 - - 8 - - 16 - - 32 - - 64 - - INFINITY - - reportAmountM7LTE-Type: - description: See details in 3GPP TS 32.422 clause 5.10.b. + pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' + EutraCellId: type: string - enum: - - 1 - - 2 - - 4 - - 8 - - 16 - - 32 - - 64 - - INFINITY - - reportingTrigger-Type: - description: See details in 3GPP TS 32.422 clause 5.10.4. - type: array - items: - type: string - enum: - - PERIODICAL - - A2_FOR_LTE_NR - - 1F_FOR_UMTS - - 1I_FOR_UMTS_MCPS_TDD - - A2_TRIGGERED_PERIODIC_FOR_LTE_NR - - ALL_CONFIGURED_RRM_FOR_LTE_NR - - ALL_CONFIGURED_RRM_FOR_UMTS - - reportInterval-Type: - description: See details in 3GPP TS 32.422 clause 5.10.5. - type: object - properties: - UMTS: - type: array - items: - type: string - enum: - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - LTE: - type: array - items: - type: string - enum: - - 120ms - - 240ms - - 480ms - - 640ms - - 1024ms - - 2048ms - - 5120ms - - 10240ms - - 60000ms - - 360000ms - - 720000ms - - 1800000ms - - 3600000ms - NR: - type: array - items: - type: string - enum: - - 120ms - - 240ms - - 480ms - - 640ms - - 1024ms - - 2048ms - - 5120ms - - 10240ms - - 20480ms - - 40960ms - - 60000ms - - 360000ms - - 720000ms - - 1800000ms - - reportType-Type: - description: Report type for logged NR MDT. See details in 3GPP TS 32.422 clause 5.10.27. + pattern: '^[A-Fa-f0-9]{7}$' + NrCellId: type: string - enum: - - PERIODICAL - - EVENT_TRIGGERED - - sensorInformation-Type: - description: See details in 3GPP TS 32.422 clause 5.10.29. - type: array - items: - type: string - enum: - - BAROMETRIC_PRESSURE - - UE_SPEED - - UE_ORIENTATION - - traceCollectionEntityId-Type: - description: See details in 3GPP TS 32.422 clause 5.10.11. Only TCE Id value may be sent over the air to the UE being configured for Logged MDT. - type: integer + pattern: '^[A-Fa-f0-9]{9}$' + IpAddr: + oneOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' - excessPacketDelayThresholds-Type: - description: Excess Packet Delay Threshold for NR MDT. See details in 3GPP TS 32.422 clause 4.1.1 and 4.1.2. - type: array - properties: - fiveQIValue: - type: integer - excessPacketDelayThresholdValue: + ManagementData: + oneOf: + - type: array + items: type: string enum: - - 0.25ms - - 0.5ms - - 1ms - - 2ms - - 4ms - - 5ms - - 10ms - - 20ms - - 30ms - - 40ms - - 50ms - - 60ms - - 70ms - - 80ms - - 90ms - - 100ms - - 150ms - - 300ms - - 500ms - minItems: 0 - maxItems: 255 - - traceConfig-Type: - description: Trace configuration parameters for NR. See details in 3GPP TS 28.622 clause 4.3.30. + - COVERAGE + - CAPACITY + - ENERGY_EFFICIENCY + - MOBILITY + - ACCESSIBILITY + - type: array + items: + type: string + NodeFilter: type: object properties: - listOfInterfaces: - $ref: '#/components/schemas/listOfInterfaces-Type' - listOfNeTypes: - $ref: '#/components/schemas/listOfNeTypes-Type' - traceDepth: - $ref: '#/components/schemas/traceDepth-Type' - triggeringEvents: - $ref: '#/components/schemas/triggeringEvents-Type' - - immediateMDTConfig-Type: - description: Immediate MDT configuration parameters. See details in 3GPP TS 28.622 clause 4.3.30. - type: object - properties: - listOfMeasurements: - $ref: '#/components/schemas/listOfMeasurements-Type' - reportingTrigger: - $ref: '#/components/schemas/reportingTrigger-Type' - reportAmount: - $ref: '#/components/schemas/reportAmount-Type' - reportAmountM1LTE: - $ref: '#/components/schemas/reportAmountM1LTE-Type' - reportAmountM4LTE: - $ref: '#/components/schemas/reportAmountM4LTE-Type' - reportAmountM5LTE: - $ref: '#/components/schemas/reportAmountM5LTE-Type' - reportAmountM6LTE: - $ref: '#/components/schemas/reportAmountM6LTE-Type' - reportAmountM7LTE: - $ref: '#/components/schemas/reportAmountM7LTE-Type' - reportInterval: - $ref: '#/components/schemas/reportInterval-Type' - eventThreshold: - $ref: '#/components/schemas/eventThreshold-Type' - collectionPeriodRrmLte: - $ref: '#/components/schemas/collectionPeriodRrmLte-Type' - collectionPeriodM6Lte: - $ref: '#/components/schemas/collectionPeriodM6Lte-Type' - collectionPeriodM7Lte: - $ref: '#/components/schemas/collectionPeriodM7Lte-Type' - collectionPeriodRrmUmts: - $ref: '#/components/schemas/collectionPeriodRrmUmts-Type' - collectionPeriodRrmNr: - $ref: '#/components/schemas/collectionPeriodRrmNr-Type' - collectionPeriodM6Nr: - $ref: '#/components/schemas/collectionPeriodM6Nr-Type' - collectionPeriodM7Nr: - $ref: '#/components/schemas/collectionPeriodM7Nr-Type' - eventThresholdUphUmts: - $ref: '#/components/schemas/eventThresholdUphUmts-Type' - measurementPeriodUmts: - $ref: '#/components/schemas/measurementPeriodUmts-Type' - measurementPeriodLte: - $ref: '#/components/schemas/measurementPeriodLte-Type' - measurementQuantity: - $ref: '#/components/schemas/measurementQuantity-Type' - beamLevelMeasurement: - $ref: '#/components/schemas/beamLevelMeasurement-Type' - positioningMethod: - $ref: '#/components/schemas/positioningMethod-Type' - excessPacketDelayThresholds: - $ref: '#/components/schemas/excessPacketDelayThresholds-Type' - - loggedMDTConfig-Type: - description: Logged MDT configuration parameters. See details in 3GPP TS 28.622 clause 4.3.30. + areaOfInterest: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AreaOfInterest' + networkDomain: + type: string + enum: + - CN + - RAN + cpUpType: + type: string + enum: + - CP + - UP + sst: + type: integer + 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 + description: This describes the PLMN id, CAG ID list or the NID of the SNPN within the PLMN. properties: - traceCollectionEntityId: - $ref: '#/components/schemas/traceCollectionEntityId-Type' - loggingDuration: - $ref: '#/components/schemas/loggingDuration-Type' - loggingInterval: - $ref: '#/components/schemas/loggingInterval-Type' - eventThresholdL1: - $ref: '#/components/schemas/eventThresholdL1-Type' - hysteresisL1: - $ref: '#/components/schemas/hysteresisL1-Type' - timeToTriggerL1: - $ref: '#/components/schemas/timeToTriggerL1-Type' - mbsfnAreaList: + plmnId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + cAGIdList: type: array items: - $ref: '#/components/schemas/MbsfnArea' - reportType: - $ref: '#/components/schemas/reportType-Type' - plmnList: - $ref: '#/components/schemas/plmnList-Type' - eventListForEventTriggeredMeasurement: - $ref: '#/components/schemas/eventListForEventTriggeredMeasurement-Type' - areaConfigurationForNeighCell: - $ref: '#/components/schemas/AreaConfig' - - mdtConfig-Type: - description: MDT config parameters. See details in 3GPP TS 28.622 clause 4.3.30. - type: object - properties: - anonymizationOfMdtData: - $ref: '#/components/schemas/anonymizationOfMdtData-Type' - areaScope: + type: string + nIDList: type: array items: - $ref: '#/components/schemas/AreaScope' - sensorInformation: - $ref: '#/components/schemas/sensorInformation-Type' - immediateMDTConfig: - $ref: '#/components/schemas/immediateMDTConfig-Type' - loggedMDTConfig: - $ref: '#/components/schemas/loggedMDTConfig-Type' - -#-------- end of Definition of types used in Trace control NRM fragment ---------- - + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Nid' #-------- Definition of abstract IOC Top ----------------------------------------- @@ -1771,7 +535,7 @@ components: ThresholdMonitor: $ref: '#/components/schemas/ThresholdMonitor-Multiple' TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' + $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/TraceJob-Multiple' ManagementDataCollection: $ref: '#/components/schemas/ManagementDataCollection-Multiple' NtfSubscriptionControl: @@ -1784,6 +548,15 @@ components: $ref: '#/components/schemas/Files-Multiple' MnsRegistry: $ref: '#/components/schemas/MnsRegistry-Single' + Scheduler: + $ref: '#/components/schemas/Scheduler-Multiple' + ConditionMonitor: + $ref: '#/components/schemas/ConditionMonitor-Multiple' + SupportedNotifications: + $ref: '#/components/schemas/SupportedNotifications-Single' + QMCJobs: + $ref: '#/components/schemas/QMCJob-Multiple' + ManagedElement-ncO: type: object properties: @@ -1794,7 +567,7 @@ components: ThresholdMonitor: $ref: '#/components/schemas/ThresholdMonitor-Multiple' TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' + $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/TraceJob-Multiple' NtfSubscriptionControl: $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' AlarmList: @@ -1803,6 +576,14 @@ components: $ref: '#/components/schemas/FileDownloadJob-Multiple' Files: $ref: '#/components/schemas/Files-Multiple' + Scheduler: + $ref: '#/components/schemas/Scheduler-Multiple' + ConditionMonitor: + $ref: '#/components/schemas/ConditionMonitor-Multiple' + SupportedNotifications: + $ref: '#/components/schemas/SupportedNotifications-Single' + QMCJobs: + $ref: '#/components/schemas/QMCJob-Multiple' #-------- Definition of abstract IOCs -------------------------------------------- @@ -1841,31 +622,6 @@ components: items: $ref: '#/components/schemas/SupportedPerfMetricGroup' - TraceJob-Attr: - type: object - description: abstract class used as a container of all TraceJob attributes - properties: - jobType: - $ref: '#/components/schemas/jobType-Type' - plmnTarget: - $ref: '#/components/schemas/plmnTarget-Type' - traceReportingConsumerUri: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' - traceCollectionEntityIpAddress: - $ref: '#/components/schemas/IpAddr' - traceReference: - $ref: '#/components/schemas/traceReference-Type' - jobId: - type: string - traceReportingFormat: - $ref: '#/components/schemas/traceReportingFormat-Type' - traceTarget: - $ref: '#/components/schemas/traceTarget-Type' - traceConfig: - $ref: '#/components/schemas/traceConfig-Type' - mdtConfig: - $ref: '#/components/schemas/mdtConfig-Type' - ManagedFunction-ncO: type: object properties: @@ -1876,7 +632,7 @@ components: ManagedNFService: $ref: '#/components/schemas/ManagedNFService-Multiple' TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' + $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/TraceJob-Multiple' #-------- Definition of concrete IOCs -------------------------------------------- @@ -1971,6 +727,8 @@ components: properties: attributes: type: object + not: + required: [ conditionMonitorRef, schedulerRef ] properties: administrativeState: $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' @@ -1989,10 +747,15 @@ components: $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: '#/components/schemas/ReportingCtrl' Files: $ref: '#/components/schemas/Files-Multiple' + ThresholdMonitor-Single: allOf: - $ref: '#/components/schemas/Top' @@ -2005,10 +768,6 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' operationalState: $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' - performanceMetrics: - type: array - items: - type: string thresholdInfoList: type: array items: @@ -2053,15 +812,7 @@ components: minimum: 0 triggerHeartbeatNtf: type: boolean - TraceJob-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: '#/components/schemas/TraceJob-Attr' - Files: - $ref: '#/components/schemas/Files-Multiple' + ManagementDataCollection-Single: allOf: - $ref: '#/components/schemas/Top' @@ -2083,6 +834,7 @@ components: enum: - SNSSAI - 5QI + - PLMN AlarmList-Single: allOf: - $ref: '#/components/schemas/Top' @@ -2210,6 +962,100 @@ components: type: array items: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + 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 + ConditionMonitor-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + condition: + type: string + conditionStatus: + type: boolean + + 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 + + QMCJob-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + serviceType: + type: string + enum: + - DASH + - MTSI + - VR + areaScope: + type: array + items: + $ref: '#/components/schemas/AreaScope' + qoECollectionEntityAddress: + $ref: '#/components/schemas/IpAddr' + pLMNTarget: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + qoETarget: + type: string + qoEReference: + type: string + jobId: + type: string + sliceScope: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + qMCConfigFile: + type: string + mDTAlignmentInformation: + $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/traceReference-Type' + availableRANqoEMetrics: + type: array + items: + type: string + enum: + - APPLAYERBUFFERLEVELLIST + - PLAYOUTDELAYFORMEDIA_STARTUP + minItems: 0 + maxItems: 2 #-------- Definition of YAML arrays for name-contained IOCs ---------------------- @@ -2241,10 +1087,6 @@ components: type: array items: $ref: '#/components/schemas/ThresholdMonitor-Single' - TraceJob-Multiple: - type: array - items: - $ref: '#/components/schemas/TraceJob-Single' ManagementDataCollection-Multiple: type: array items: @@ -2269,6 +1111,18 @@ components: type: array items: $ref: '#/components/schemas/MnsInfo-Single' + Scheduler-Multiple: + type: array + items: + $ref: '#/components/schemas/Scheduler-Single' + ConditionMonitor-Multiple: + type: array + items: + $ref: '#/components/schemas/ConditionMonitor-Single' + QMCJob-Multiple: + type: array + items: + $ref: '#/components/schemas/QMCJob-Single' #-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- @@ -2285,7 +1139,6 @@ components: - $ref: '#/components/schemas/PerfMetricJob-Single' - $ref: '#/components/schemas/ThresholdMonitor-Single' - - $ref: '#/components/schemas/TraceJob-Single' - $ref: '#/components/schemas/ManagementDataCollection-Single' - $ref: '#/components/schemas/NtfSubscriptionControl-Single' @@ -2299,3 +1152,7 @@ components: - $ref: '#/components/schemas/MnsRegistry-Single' - $ref: '#/components/schemas/MnsInfo-Single' + - $ref: '#/components/schemas/Scheduler-Single' + - $ref: '#/components/schemas/ConditionMonitor-Single' + - $ref: '#/components/schemas/SupportedNotifications-Single' + - $ref: '#/components/schemas/QMCJob-Single' diff --git a/TS28623_TraceControlNrm.yaml b/TS28623_TraceControlNrm.yaml new file mode 100644 index 00000000..34007256 --- /dev/null +++ b/TS28623_TraceControlNrm.yaml @@ -0,0 +1,1470 @@ +openapi: 3.0.1 +info: + title: Trace Control NRM + version: 18.5.0 + description: >- + OAS 3.0.1 definition of the Trace Control NRM fragment + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623; Generic NRM:Trace Control NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: +#-------- Definition of types used in Trace control NRM fragment------------------ + + jobType-Type: + type: string + description: Specifies whether the TraceJob represents only MDT, Logged MBSFN MDT, Trace or a combined Trace and MDT job. Applicable for Trace, MDT, RCEF and RLF reporting. See 3GPP TS 32.422 clause 5.9a for additional details. + enum: + - IMMEDIATE_MDT_ONLY + - LOGGED_MDT_ONLY + - TRACE_ONLY + - IMMEDIATE_MDT AND TRACE + - RLF_REPORT_ONLY + - RCEF_REPORT_ONLY + - LOGGED_MBSFN_MDT + + listOfInterfaces-Type: + description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details. + type: object + properties: + MSCServerInterfaces: + type: array + items: + type: string + enum: + - A + - Iu-CS + - Mc + - MAP-G + - MAP-B + - MAP-E + - MAP-F + - MAP-D + - MAP-C + - CAP + MGWInterfaces: + type: array + items: + type: string + enum: + - Mc + - Nb-UP + - Iu-UP + RNCInterfaces: + type: array + items: + type: string + enum: + - Iu-CS + - Iu-PS + - Iur + - Iub + - Uu + SGSNInterfaces: + type: array + items: + type: string + enum: + - Gb + - Iu-PS + - Gn + - MAP-Gr + - MAP-Gd + - MAP-Gf + - Ge + - Gs + - S6d + - S4 + - S3 + - S13 + GGSNInterfaces: + type: array + items: + type: string + enum: + - Gn + - Gi + - Gmb + S-CSCFInterfaces: + type: array + items: + type: string + enum: + - Mw + - Mg + - Mr + - Mi + P-CSCFInterfaces: + type: array + items: + type: string + enum: + - Gm + - Mw + I-CSCFInterfaces: + type: array + items: + type: string + enum: + - Cx + - Dx + - Mg + - Mw + MRFCInterfaces: + type: array + items: + type: string + enum: + - Mp + - Mr + MGCFInterfaces: + type: array + items: + type: string + enum: + - Mg + - Mj + - Mn + IBCFInterfaces: + type: array + items: + type: string + enum: + - Ix + - Mx + E-CSCFInterfaces: + type: array + items: + type: string + enum: + - Mw + - Ml + - Mm + - Mi/Mg + BGCFInterfaces: + type: array + items: + type: string + enum: + - Mi + - Mj + - Mk + ASInterfaces: + type: array + items: + type: string + enum: + - Dh + - Sh + - ISC + - Ut + HSSInterfaces: + type: array + items: + type: string + enum: + - MAP-C + - MAP-D + - Gc + - Gr + - Cx + - S6d + - S6a + - Sh + - N70 + - N71 + - NU1 + EIRInterfaces: + type: array + items: + type: string + enum: + - MAP-F + - S13 + - MAP-Gf + BM-SCInterfaces: + type: array + items: + type: string + enum: + - Gmb + MMEInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - S3 + - S6a + - S10 + - S11 + - S13 + SGWInterfaces: + type: array + items: + type: string + enum: + - S4 + - S5 + - S8 + - S11 + - Gxc + PDN_GWInterfaces: + type: array + items: + type: string + enum: + - S2a + - S2b + - S2c + - S5 + - S6b + - Gx + - S8 + - SGi + eNBInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - X2 + en-gNBInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - X2 + - Uu + - F1-C + - E1 + AMFInterfaces: + type: array + items: + type: string + enum: + - N1 + - N2 + - N8 + - N11 + - N12 + - N14 + - N15 + - N20 + - N22 + - N26 + AUSFInterfaces: + type: array + items: + type: string + enum: + - N12 + - N13 + NEFInterfaces: + type: array + items: + type: string + enum: + - N29 + - N30 + - N33 + NRFInterfaces: + type: array + items: + type: string + enum: + - N27 + NSSFInterfaces: + type: array + items: + type: string + enum: + - N22 + - N31 + PCFInterfaces: + type: array + items: + type: string + enum: + - N5 + - N7 + - N15 + SMFInterfaces: + type: array + items: + type: string + enum: + - N4 + - N7 + - N10 + - N11 + - S5-C + SMSFInterfaces: + type: array + items: + type: string + enum: + - N20 + - N21 + UDMInterfaces: + type: array + items: + type: string + enum: + - N8 + - N10 + - N13 + - N21 + - NU1 + UPFInterfaces: + type: array + items: + type: string + enum: + - N4 + ng-eNBInterfaces: + type: array + items: + type: string + enum: + - NG-C + - Xn-C + - Uu + gNB-CU-CPInterfaces: + type: array + items: + type: string + enum: + - NG-C + - Xn-C + - Uu + - F1-C + - E1 + - X2-C + gNB-CU-UPInterfaces: + type: array + items: + type: string + enum: + - E1 + gNB-DUInterfaces: + type: array + items: + type: string + enum: + - F1-C + + listOfNeTypes-Type: + description: The Network Element types where Trace Session activation is needed. See 3GPP TS 32.422 clause 5.4 for additional details. + type: array + items: + type: string + enum: + - MSC_SERVER + - SGSN + - MGW + - GGSN + - RNC + - BM_SC + - MME + - SGW + - PGW + - ENB + - EN_GNB + - GNB_CU_CP + - GNB_CU_UP + - GNB_DU + - AMF + - PCF + - SMF + - UPF + - AUSF + - SMSF + - HSS + - UDM + + plmnTarget-Type: + type: object + description: The PLMN for which sessions shall be selected in the Trace Session in case of management based activation when several PLMNs are supported in the RAN (this means that shared cells and not shared cells are allowed for the specified PLMN. Note that the PLMN Target might differ from the PLMN specified in the Trace Reference, as that specifies the PLMN that is containing the management system requesting the Trace Session from the NE. See 3GPP TS 32.422 clause 5.9b for additional details. + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + required: + - mcc + - mnc + + traceDepth-Type: + description: Specifies how detailed information should be recorded in the Network Element. The Trace Depth is a paremeter for Trace Session level, i.e., the Trace Depth is the same for all of the NEs to be traced in the same Trace Session. See 3GPP TS 32.422 clause 5.3 for additional details. + type: string + enum: + - MINIMUM + - MEDIUM + - MAXIMUM + - VENDORMINIMUM + - VENDORMEDIUM + - VENDORMAXIMUM + + traceReference-Type: + type: object + description: The Trace Reference parameter shall be globally unique, therefore the Trace Reference shall compose as follows - MCC+MNC+Trace ID, where the MCC and MNC are coming with the Trace activation request from the management system to identify one PLMN containing the management system, and Trace ID is a 3 byte Octet String. See 3GPP TS 32.422 clause 5.6 for additional details. + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + traceId: + type: string + required: + - mcc + - mnc + - traceId + + traceReportingFormat-Type: + type: string + description: Specifies whether file-based or streaming reporting shall be used for this Trace Session. See 3GPP TS 32.422 clause 5.11 for additional details. + enum: + - FILE-BASED + - STREAMING + + traceTarget-Type: + type: object + description: Trace target conveying both the type and value of the target ID. For additional details see 3GPP TS 32.422 + properties: + TargetIdType: + type: string + enum: + - IMSI + - IMEI + - IMEISV + - PUBLIC_ID + - UTRAN_CELL + - E-UTRAN_CELL + - NG-RAN_CELL + - eNB + - RNC + - gNB + - SUPI + TargetIdValue: + type: string + required: + - TargetIdType + - TargetIdValue + + triggeringEvents-Type: + type: object + description: Specifies when to start a Trace Recording Session and which message shall be recorded first, when to stop a Trace Recording Session and which message shall be recorded last respectively. See 3GPP TS 32.422 clause 5.1 for additional detials. + properties: + MSC_SERVER: + type: array + items: + type: string + enum: + - MO_MT_CALLS + - MO_MT_SMS + - LU_IMSIattach_IMSIdetach + - HANDOVER + - SS + SGSN: + type: array + items: + type: string + enum: + - PDPcontext + - MO_MT_SMS + - RAU_GPRSattach_GPRSdetach + - MBMScontext + MGW: + type: array + items: + type: string + enum: + - CONTEXT + GGSN: + type: array + items: + type: string + enum: + - PDPcontext + - MBMScontext + IMS: + type: array + items: + type: string + enum: + - SIPsession_StandaloneTransaction + BM_SC: + type: array + items: + type: string + enum: + - MBMSactivation + MME: + type: array + items: + type: string + enum: + - UEinitiatedPDNconnectivityRequest + - ServiceRequest + - InitialAttach_TAU_Detach + - UEinitiatedPDNdisconnection + - BearerActivationModificationDeletion + - Handover + SGW: + type: array + items: + type: string + enum: + - PDNconnectionCreation + - PDNconnectionTermination + - BearerActivationModificationDeletion + PGW: + type: array + items: + type: string + enum: + - PDNconnectionCreation + - PDNconnectionTermination + - BearerActivationModificationDeletion + AMF: + type: array + items: + type: string + enum: + - Registration + - ServiceRequest + - Handover + - UEderegistration + - NetworkDeregistration + - UEMobilityFromEPC + - UEMobilityToEPC + SMF: + type: array + items: + type: string + enum: + - PDUsessionEstablishment + - PDUsessionModification + - PDUsessionRelease + - PDUsessionUPactivationDeactivation + - MobilityBtw3gppAndN3gppTo5GC + - MobilityFromEpc + PCF: + type: array + items: + type: string + enum: + - AMpolicy + - SMpolicy + - Authorization + - BDTpolicy + UPF: + type: array + items: + type: string + enum: + - N4Session + AUSF: + type: array + items: + type: string + enum: + - UEauthentication + NEF: + type: array + items: + type: string + enum: + - EventExposure + - PFDmanagement + - ParameterProvision + - Trigger + NRF: + type: array + items: + type: string + enum: + - NFmanagement + - NFdiscovery + NSSF: + type: array + items: + type: string + enum: + - NSSelection + - NSSAI + SMSF: + type: array + items: + type: string + enum: + - SMservice + UDM: + type: array + items: + type: string + enum: + - UEcontext + - SubscriberData + - UEauthentication + - EventExposure + + anonymizationOfMdtData-Type: + description: Specifies level of MDT anonymization. For additional details see 3GPP TS 32.422 clause 5.10.12. + type: string + enum: + - NO_IDENTITY + - TAC_OF_IMEI + + beamLevelMeasurement-Type: + description: Determines whether beam level measurements shall be included in case of immediate MDT M1 measurement in NR. For additional details see 3GPP TS 32.422 clause 5.10.40. + type: boolean + + collectionPeriodRrmLte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.20. + type: string + enum: + - 100ms + - 1000ms + - 1024ms + - 1280ms + - 2048ms + - 2560ms + - 5120ms + - 10000ms + - 10240ms + - 60000ms + + collectionPeriodM6Lte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.32. + type: string + enum: + - 1024ms + - 2048ms + - 5120ms + - 10240ms + + collectionPeriodM7Lte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.33. + type: integer + minimum: 1 + maximum: 60 + + collectionPeriodRrmUmts-Type: + description: See details in 3GPP TS 32.422 clause 5.10.21. + type: string + enum: + - 100ms + - 250ms + - 500ms + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + + collectionPeriodRrmNr-Type: + description: See details in 3GPP TS 32.422 clause 5.10.30. + type: string + enum: + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 60000ms + + collectionPeriodM6Nr-Type: + description: See details in 3GPP TS 32.422 clause 5.10.34. + type: string + enum: + - 120ms + - 240ms + - 480ms + - 640ms + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 20480ms + - 40960ms + - 1min + - 6min + - 12min + - 30min + + collectionPeriodM7Nr-Type: + description: See details in 3GPP TS 32.422 clause 5.10.35. + type: integer + minimum: 1 + maximum: 60 + + eventListForEventTriggeredMeasurement-Type: + description: See details in 3GPP TS 32.422 clause 5.10.28. + type: string + enum: + - OUT_OF_COVERAGE + - A2_EVENT + + eventThreshold-Type: + description: See details in 3GPP TS 32.422 clause 5.10.7, 5.10.7a, 5.10.13 and 5.10.14. + type: object + properties: + EventThresholdRSRP: + oneOf: + - type: integer + minimum: 0 + maximum: 97 + - type: integer + minimum: 0 + maximum: 127 + EventThresholdRSRQ: + oneOf: + - type: integer + minimum: 0 + maximum: 34 + - type: integer + minimum: 0 + maximum: 127 + EventThreshold1F: + type: object + properties: + CPICH_RSCP: + type: integer + minimum: -120 + maximum: 25 + CPICH_EcNo: + type: integer + minimum: -24 + maximum: 0 + PathLoss: + type: integer + minimum: 30 + maximum: 165 + EventThreshold1I: + type: integer + minimum: -120 + maximum: 25 + + listOfMeasurements-Type: + description: See details in 3GPP TS 32.422 clause 5.10.3 for details. + type: object + properties: + UMTS: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M6_DL + - M6_UL + - M7_DL + - M7_UL + LTE: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M1_EVENT_TRIGGERED + - M6 + - M7 + - M8 + - M9 + NR: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M6 + - M7 + - M1_EVENT_TRIGGERED + - M8 + - M9 + + loggingDuration-Type: + description: See details in 3GPP TS 32.422 clause 5.10.9. + type: string + enum: + - 600s + - 1200s + - 2400s + - 3600s + - 5400s + - 7200s + + loggingInterval-Type: + description: See details in 3GPP TS 32.422 clause 5.10.8. + type: object + properties: + UMTS: + type: array + items: + type: string + enum: + - 1.28s + - 2.56s + - 5.12s + - 10.24s + - 20.48s + - 30.72s + - 40.96s + - 61.44s + LTE: + type: array + items: + type: string + enum: + - 1.28s + - 2.56s + - 5.12s + - 10.24s + - 20.48s + - 30.72s + - 40.96s + - 61.44s + NR: + type: array + items: + type: string + enum: + - 0.32s + - 0.64s + - 1.28s + - 2.56s + - 5.12s + - 10.24s + - 20.48s + - 30.72s + - 40.96s + - 61.44s + - INFINITY + + eventThresholdL1-Type: + description: See details in 3GPP TS 32.422 clause 5.10.X. + type: object + properties: + RSRP: + type: integer + minimum: 0 + maximum: 127 + RSRQ: + type: integer + minimum: 0 + maximum: 127 + + hysteresisL1-Type: + description: See details in 3GPP TS 32.422 clause 5.10.Y. + type: integer + minimum: 0 + maximum: 30 + + timeToTriggerL1-Type: + description: See details in 3GPP TS 32.422 clause 5.10.Z. + type: string + enum: + - 0ms + - 40ms + - 64ms + - 80ms + - 100ms + - 128ms + - 160ms + - 256ms + - 320ms + - 480ms + - 512ms + - 640ms + - 1024ms + - 1280ms + - 2560ms + - 5120ms + + measurementPeriodLte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.23. + type: string + enum: + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 1min + + measurementPeriodUmts-Type: + description: See details in 3GPP TS 32.422 clause 5.10.22. + type: string + enum: + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + - 8000ms + - 12000ms + - 16000ms + - 20000ms + - 24000ms + - 28000ms + - 32000ms + - 64000ms + + measurementQuantity-Type: + description: See details in 3GPP TS 32.422 clause 5.10.15. + type: string + enum: + - CPICH_EcNo + - CPICH_RSCP + - PathLoss + + eventThresholdUphUmts-Type: + description: See details in 3GPP TS 32.422 clause 5.10.A. + type: integer + minimum: 0 + maximum: 31 + + plmnList-Type: + description: See details in 3GPP TS 32.422 clause 5.10.24. + type: array + items: + type: object + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + required: + - mcc + - mnc + maxItems: 16 + + positioningMethod-Type: + description: See details in 3GPP TS 32.422 clause 5.10.19. + type: string + enum: + - GNSS + - E-CELL_ID + + reportAmount-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportAmountM1LTE-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportAmountM4LTE-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportAmountM5LTE-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportAmountM6LTE-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportAmountM7LTE-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportAmountM1NR-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportAmountM4NR-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportAmountM5NR-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportAmountM6NR-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportAmountM7NR-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportingTrigger-Type: + description: See details in 3GPP TS 32.422 clause 5.10.4. + type: array + items: + type: string + enum: + - PERIODICAL + - A2_FOR_LTE_NR + - 1F_FOR_UMTS + - 1I_FOR_UMTS_MCPS_TDD + - A2_TRIGGERED_PERIODIC_FOR_LTE_NR + - ALL_CONFIGURED_RRM_FOR_LTE_NR + - ALL_CONFIGURED_RRM_FOR_UMTS + + reportInterval-Type: + description: See details in 3GPP TS 32.422 clause 5.10.5. + type: object + properties: + UMTS: + type: array + items: + type: string + enum: + - 250ms + - 500ms + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + - 8000ms + - 12000ms + - 16000ms + - 20000ms + - 24000ms + - 28000ms + - 32000ms + - 64000ms + LTE: + type: array + items: + type: string + enum: + - 120ms + - 240ms + - 480ms + - 640ms + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 60000ms + - 360000ms + - 720000ms + - 1800000ms + - 3600000ms + NR: + type: array + items: + type: string + enum: + - 120ms + - 240ms + - 480ms + - 640ms + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 20480ms + - 40960ms + - 60000ms + - 360000ms + - 720000ms + - 1800000ms + + reportType-Type: + description: Report type for logged NR MDT. See details in 3GPP TS 32.422 clause 5.10.27. + type: string + enum: + - PERIODICAL + - EVENT_TRIGGERED + + sensorInformation-Type: + description: See details in 3GPP TS 32.422 clause 5.10.29. + type: array + items: + type: string + enum: + - BAROMETRIC_PRESSURE + - UE_SPEED + - UE_ORIENTATION + + traceCollectionEntityId-Type: + description: See details in 3GPP TS 32.422 clause 5.10.11. Only TCE Id value may be sent over the air to the UE being configured for Logged MDT. + type: integer + + excessPacketDelayThreshold-Type: + description: Excess Packet Delay Threshold for NR MDT. See details in 3GPP TS 32.422 clause 4.1.1 and 4.1.2. + type: object + properties: + fiveQIValue: + type: integer + excessPacketDelayThresholdValue: + type: string + enum: + - 0.25MS + - 0.5MS + - 1MS + - 2MS + - 4MS + - 5MS + - 10MS + - 20MS + - 30MS + - 40MS + - 50MS + - 60MS + - 70MS + - 80MS + - 90MS + - 100MS + - 150MS + - 300MS + - 500MS + + excessPacketDelayThresholds-Type: + description: Array of type excessPacketDelayThreshold-Type. + type: array + items: + $ref: '#/components/schemas/excessPacketDelayThreshold-Type' + minItems: 0 + maxItems: 255 + + traceConfig-Type: + description: Trace configuration parameters for NR. See details in 3GPP TS 28.622 clause 4.3.30. + type: object + properties: + listOfInterfaces: + $ref: '#/components/schemas/listOfInterfaces-Type' + listOfNeTypes: + $ref: '#/components/schemas/listOfNeTypes-Type' + traceDepth: + $ref: '#/components/schemas/traceDepth-Type' + triggeringEvents: + $ref: '#/components/schemas/triggeringEvents-Type' + + immediateMDTConfig-Type: + description: Immediate MDT configuration parameters. See details in 3GPP TS 28.622 clause 4.3.30. + type: object + properties: + listOfMeasurements: + $ref: '#/components/schemas/listOfMeasurements-Type' + reportingTrigger: + $ref: '#/components/schemas/reportingTrigger-Type' + reportAmount: + $ref: '#/components/schemas/reportAmount-Type' + reportAmountM1LTE: + $ref: '#/components/schemas/reportAmountM1LTE-Type' + reportAmountM4LTE: + $ref: '#/components/schemas/reportAmountM4LTE-Type' + reportAmountM5LTE: + $ref: '#/components/schemas/reportAmountM5LTE-Type' + reportAmountM6LTE: + $ref: '#/components/schemas/reportAmountM6LTE-Type' + reportAmountM7LTE: + $ref: '#/components/schemas/reportAmountM7LTE-Type' + reportAmountM1NR: + $ref: '#/components/schemas/reportAmountM1NR-Type' + reportAmountM4NR: + $ref: '#/components/schemas/reportAmountM4NR-Type' + reportAmountM5NR: + $ref: '#/components/schemas/reportAmountM5NR-Type' + reportAmountM6NR: + $ref: '#/components/schemas/reportAmountM6NR-Type' + reportAmountM7NR: + $ref: '#/components/schemas/reportAmountM7NR-Type' + reportInterval: + $ref: '#/components/schemas/reportInterval-Type' + eventThreshold: + $ref: '#/components/schemas/eventThreshold-Type' + collectionPeriodRrmLte: + $ref: '#/components/schemas/collectionPeriodRrmLte-Type' + collectionPeriodM6Lte: + $ref: '#/components/schemas/collectionPeriodM6Lte-Type' + collectionPeriodM7Lte: + $ref: '#/components/schemas/collectionPeriodM7Lte-Type' + collectionPeriodRrmUmts: + $ref: '#/components/schemas/collectionPeriodRrmUmts-Type' + collectionPeriodRrmNr: + $ref: '#/components/schemas/collectionPeriodRrmNr-Type' + collectionPeriodM6Nr: + $ref: '#/components/schemas/collectionPeriodM6Nr-Type' + collectionPeriodM7Nr: + $ref: '#/components/schemas/collectionPeriodM7Nr-Type' + eventThresholdUphUmts: + $ref: '#/components/schemas/eventThresholdUphUmts-Type' + measurementPeriodUmts: + $ref: '#/components/schemas/measurementPeriodUmts-Type' + measurementPeriodLte: + $ref: '#/components/schemas/measurementPeriodLte-Type' + measurementQuantity: + $ref: '#/components/schemas/measurementQuantity-Type' + beamLevelMeasurement: + $ref: '#/components/schemas/beamLevelMeasurement-Type' + positioningMethod: + $ref: '#/components/schemas/positioningMethod-Type' + excessPacketDelayThresholds: + $ref: '#/components/schemas/excessPacketDelayThresholds-Type' + + loggedMDTConfig-Type: + description: Logged MDT configuration parameters. See details in 3GPP TS 28.622 clause 4.3.30. + type: object + properties: + traceCollectionEntityId: + $ref: '#/components/schemas/traceCollectionEntityId-Type' + loggingDuration: + $ref: '#/components/schemas/loggingDuration-Type' + loggingInterval: + $ref: '#/components/schemas/loggingInterval-Type' + eventThresholdL1: + $ref: '#/components/schemas/eventThresholdL1-Type' + hysteresisL1: + $ref: '#/components/schemas/hysteresisL1-Type' + timeToTriggerL1: + $ref: '#/components/schemas/timeToTriggerL1-Type' + mbsfnAreaList: + type: array + items: + $ref: '#/components/schemas/MbsfnArea' + reportType: + $ref: '#/components/schemas/reportType-Type' + plmnList: + $ref: '#/components/schemas/plmnList-Type' + eventListForEventTriggeredMeasurement: + $ref: '#/components/schemas/eventListForEventTriggeredMeasurement-Type' + areaConfigurationForNeighCell: + $ref: '#/components/schemas/AreaConfig' + nPNIdentityList: + type: array + items: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/NpnId-Type' + + mdtConfig-Type: + description: MDT config parameters. See details in 3GPP TS 28.622 clause 4.3.30. + type: object + properties: + anonymizationOfMdtData: + $ref: '#/components/schemas/anonymizationOfMdtData-Type' + areaScope: + type: array + items: + $ref: '#/components/schemas/AreaScope' + sensorInformation: + $ref: '#/components/schemas/sensorInformation-Type' + immediateMDTConfig: + $ref: '#/components/schemas/immediateMDTConfig-Type' + loggedMDTConfig: + $ref: '#/components/schemas/loggedMDTConfig-Type' + AreaScope: + oneOf: + - type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/EutraCellId' + - type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NrCellId' + - type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Tac' + - type: array + items: + $ref: '#/components/schemas/Tai' + - type: array + items: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/NpnId-Type' + Tai: + type: object + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + tac: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Tac' + + AreaConfig: + type: object + properties: + freqInfo: + $ref: '#/components/schemas/FreqInfo' + pciList: + type: array + items: + type: integer + FreqInfo: + description: specifies the carrier frequency and bands used in a cell. + type: object + properties: + arfcn: + type: integer + freqBands: + type: array + items: + type: integer + MbsfnArea: + type: object + properties: + mbsfnAreaId: + type: integer + minimum: 1 + earfcn: + type: integer + minimum: 1 + TraceJob-Attr: + type: object + description: abstract class used as a container of all TraceJob attributes + properties: + jobType: + $ref: '#/components/schemas/jobType-Type' + plmnTarget: + $ref: '#/components/schemas/plmnTarget-Type' + nPNTarget: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/NpnId-Type' + traceReportingConsumerUri: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + traceCollectionEntityIpAddress: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/IpAddr' + traceReference: + $ref: '#/components/schemas/traceReference-Type' + jobId: + type: string + traceReportingFormat: + $ref: '#/components/schemas/traceReportingFormat-Type' + traceTarget: + $ref: '#/components/schemas/traceTarget-Type' + traceConfig: + $ref: '#/components/schemas/traceConfig-Type' + mdtConfig: + $ref: '#/components/schemas/mdtConfig-Type' + +#-------- end of Definition of types used in Trace control NRM fragment ---------- + +#-------- Definition of concrete IOCs -------------------------------------------- + TraceJob-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: '#/components/schemas/TraceJob-Attr' + Files: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Files-Multiple' + +#-------- Definition of YAML arrays for name-contained IOCs ---------------------- + + TraceJob-Multiple: + type: array + items: + $ref: '#/components/schemas/TraceJob-Single' +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + resources-TraceControlNrm: + oneOf: + - $ref: '#/components/schemas/TraceJob-Single' diff --git a/TS29122_AsSessionWithQoS.yaml b/TS29122_AsSessionWithQoS.yaml index 05f566f6..888bfb4a 100644 --- a/TS29122_AsSessionWithQoS.yaml +++ b/TS29122_AsSessionWithQoS.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: 3gpp-as-session-with-qos - version: 1.3.0-alpha.3 + version: 1.3.0-alpha.4 description: | API for setting us an AS session with required QoS. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.122 V18.3.0 T8 reference point for Northbound APIs + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' security: @@ -502,13 +502,12 @@ components: listUeAddrs: type: array items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + $ref: '#/components/schemas/UeAddInfo' minItems: 1 - description: > - Identifies the list of UE address + description: Identifies the list of UE address. multiModalId: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MultiModalId' - pduSetProtDesc: + protoDesc: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ProtoDesc' qosReference: type: string @@ -607,6 +606,13 @@ components: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ServAuthInfo' qosMonConReq: $ref: '#/components/schemas/QosMonitoringInformation' + listUeConsDtRt: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + description: > + Identifies the list of UE addresses subject for Consolidated Data Rate monitoring. required: - notificationDestination @@ -640,12 +646,9 @@ components: listUeAddrs: type: array items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + $ref: '#/components/schemas/UeAddInfo' minItems: 1 - description: > - Identifies the list of UE address. - multiModalId: - $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MultiModalId' + description: Identifies the list of UE address. qosReference: type: string description: Pre-defined QoS reference @@ -713,7 +716,7 @@ components: 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. - pduSetProtDesc: + protoDesc: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ProtoDesc' periodInfo: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/PeriodicityInfo' @@ -729,6 +732,13 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' qosMonConReq: $ref: '#/components/schemas/QosMonitoringInformationRm' + listUeConsDtRt: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + description: > + Identifies the list of UE addresses subject for Consolidated Data Rate monitoring. QosMonitoringInformation: description: Represents QoS monitoring information. @@ -762,6 +772,10 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' repThreshDatRateUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + consDataRateThrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + consDataRateThrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' required: - reqQosMonParams - repFreqs @@ -800,6 +814,10 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' repThreshDatRateUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + consDataRateThrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + consDataRateThrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' QosMonitoringReport: description: Represents a QoS monitoring report. @@ -827,6 +845,10 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' dlDataRate: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulAggrDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlAggrDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' ulConInfo: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' dlConInfo: @@ -919,6 +941,17 @@ components: items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosMonitoringReport' minItems: 1 + description: > + Contains QoS Monitoring for data rate information. It shall be present when the notified + event is "QOS_MONITORING" and data rate measurements are available. + aggrDataRateRpts: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosMonitoringReport' + minItems: 1 + description: > + Contains QoS Monitoring for aggregated data rate information. It shall be present when + the notified event is "QOS_MONITORING" and data rate measurements are available. qosMonConInfoReps: type: array items: @@ -1010,8 +1043,7 @@ components: AsSessionMediaComponent: description: > - Representmedia component data for a single-modal data flow of - a multimodal service. + Representmedia component data for a single-modal data flow of a multi-modal service. type: object required: - medCompN @@ -1070,6 +1102,8 @@ components: description: Round-Trip latency requirement of the service data flow. pduSetQos: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' + evSubsc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqData' AsSessionMediaComponentRm: description: > @@ -1132,6 +1166,8 @@ components: description: Round-Trip latency requirement of the service data flow. pduSetQos: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' + evSubsc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqDataRm' nullable: true MultiModalFlows: @@ -1155,6 +1191,14 @@ components: required: - medCompN + UeAddInfo: + description: Represent the UE address information. + properties: + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + portNumber: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + UserPlaneEvent: anyOf: - type: string diff --git a/TS29122_CommonData.yaml b/TS29122_CommonData.yaml index 7b55331c..3d71ef52 100644 --- a/TS29122_CommonData.yaml +++ b/TS29122_CommonData.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: TS 29.122 Common Data Types - version: 1.3.0-alpha.3 + version: 1.3.0-alpha.4 description: | Data types applicable to several APIs. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.122 V18.3.0 T8 reference point for Northbound APIs + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' paths: {} @@ -640,7 +640,7 @@ components: schema: $ref: '#/components/schemas/ProblemDetails' '413': - description: Payload Too Large + description: Content Too Large content: application/problem+json: schema: diff --git a/TS29122_CpProvisioning.yaml b/TS29122_CpProvisioning.yaml index 01278ceb..2e08fd53 100644 --- a/TS29122_CpProvisioning.yaml +++ b/TS29122_CpProvisioning.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: 3gpp-cp-parameter-provisioning - version: 1.3.0-alpha.3 + version: 1.3.0-alpha.4 description: | API for provisioning communication pattern parameters. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.122 V18.3.0 T8 reference point for Northbound APIs + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' security: @@ -93,7 +93,7 @@ paths: '201': description: > Created. The subscription was created successfully. The SCEF shall return the created - subscription in the response payload body. + subscription in the response content. content: application/json: schema: @@ -215,7 +215,7 @@ paths: '200': description: > OK. The subscription was modified successfully. The SCEF shall return an updated - subscription in the response payload body. + subscription in the response content. content: application/json: schema: @@ -283,7 +283,7 @@ paths: responses: '204': description: > - No Content. The subscription was deleted successfully. The payload body shall be empty. + No Content. The subscription was deleted successfully. The content shall be empty. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': @@ -393,7 +393,7 @@ paths: '200': description: > OK. The CP parameter set resource was modified successfully. The SCEF shall return an - updated CP parameter set resource in the response payload body. + updated CP parameter set resource in the response content. content: application/json: schema: @@ -471,7 +471,7 @@ paths: responses: '204': description: > - No Content. The subscription was deleted successfully. The payload body shall be empty. + No Content. The subscription was deleted successfully. The content shall be empty. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': @@ -689,6 +689,10 @@ components: accuracyLevel: type: string pattern: '^[0]\.[0-9]{2}|[1.00]$' + failureCode: + $ref: '#/components/schemas/CpFailureCode' + validityTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' oneOf: - required: [appId] - required: [flowDescriptions] @@ -744,11 +748,14 @@ components: description: | Represents the failure reason of the CP parameter provisioning. Possible values are - - MALFUNCTION: This value indicates that something functions wrongly in CP parameter provisioning or the CP parameter provisioning does not function at all. + - MALFUNCTION: This value indicates that something functions wrongly in CP parameter + provisioning or the CP parameter provisioning does not function at all. - SET_ID_DUPLICATED: The received CP set identifier(s) are already provisioned. - OTHER_REASON: Other reason unspecified. - - CONFIDENCE_LEVEL_NOT_SUFFICIENT: The received confidence level for the expected UE parameter is not sufficient. - - ACCURACY_LEVEL_NOT_SUFFICIENT: The received accuracy level for the expected UE parameter is not sufficient. + - CONFIDENCE_LEVEL_NOT_SUFFICIENT: The received confidence level for the expected UE + parameter is not sufficient. + - ACCURACY_LEVEL_NOT_SUFFICIENT: The received accuracy level for the expected UE parameter + is not sufficient. BatteryIndication: anyOf: diff --git a/TS29122_GMDviaMBMSbyMB2.yaml b/TS29122_GMDviaMBMSbyMB2.yaml index 0ee30853..45b407f9 100644 --- a/TS29122_GMDviaMBMSbyMB2.yaml +++ b/TS29122_GMDviaMBMSbyMB2.yaml @@ -3,11 +3,11 @@ info: title: GMDviaMBMSbyMB2 description: | API for Group Message Delivery via MBMS by MB2 - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: 1.2.0 + version: 1.3.0-alpha.1 externalDocs: - description: 3GPP TS 29.122 V17.6.0 T8 reference point for Northbound APIs + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' security: - {} @@ -199,7 +199,9 @@ paths: schema: $ref: '#/components/schemas/TMGIAllocation' '204': - description: The TMGI expiration time renewal is successful, and no content is to be sent in the response message body. + description: > + The TMGI expiration time renewal is successful, and no content is to be sent in + the response message body. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': @@ -260,7 +262,9 @@ paths: schema: $ref: '#/components/schemas/TMGIAllocation' '204': - description: The TMGI expiration time renewal is successful, and no content is to be sent in the response message body. + description: > + The TMGI expiration time renewal is successful, and no content is to be sent + in the response message body. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': @@ -579,7 +583,9 @@ paths: schema: $ref: '#/components/schemas/GMDViaMBMSByMb2' '204': - description: The group message delivery is replaced successfully, and no content is to be sent in the response message body. + description: > + The group message delivery is replaced successfully, and no content is to be sent + in the response message body. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': @@ -646,7 +652,9 @@ paths: schema: $ref: '#/components/schemas/GMDViaMBMSByMb2' '204': - description: The group message delivery is modified successfully, and no content is to be sent in the response message body. + description: > + The group message delivery is modified successfully, and no content is to be sent + in the response message body. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': @@ -721,6 +729,7 @@ paths: $ref: 'TS29122_CommonData.yaml#/components/responses/503' default: $ref: 'TS29122_CommonData.yaml#/components/responses/default' + components: securitySchemes: oAuth2ClientCredentials: @@ -729,7 +738,8 @@ components: clientCredentials: tokenUrl: '{tokenUrl}' scopes: {} - schemas: + + schemas: TMGIAllocation: description: Represents an individual TMGI Allocation resource. type: object @@ -744,6 +754,7 @@ components: $ref: '#/components/schemas/MbmsLocArea' tmgiExpiration: $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTimeRo' + GMDViaMBMSByMb2: description: Represents a group message delivery via MBMS by MB2. type: object @@ -754,7 +765,9 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' requestTestNotification: type: boolean - description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. + description: > + Set to true by the SCS/AS to request the SCEF to send a test notification as + defined in clause 5.2.5.3. Set to false or omitted otherwise. websockNotifConfig: $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' externalGroupId: @@ -773,6 +786,7 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/PortRo' required: - notificationDestination + GMDByMb2Notification: description: Represents a group message delivery notification. type: object @@ -781,18 +795,23 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' deliveryTriggerStatus: type: boolean - description: Indicates whether delivery of group message payload corresponding to the TMGI was successful (TRUE) or not (FALSE) + description: > + Indicates whether delivery of group message payload corresponding to the TMGI was + successful (TRUE) or not (FALSE) required: - transaction - deliveryTriggerStatus + TMGIAllocationPatch: - description: Represents the parameters to request the modification of a TMGI Allocation resource. + description: > + Represents the parameters to request the modification of a TMGI Allocation resource. type: object properties: externalGroupId: $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' mbmsLocArea: $ref: '#/components/schemas/MbmsLocArea' + GMDViaMBMSByMb2Patch: description: Represents a modification request of a group message delivery via MBMS by MB2. type: object @@ -807,8 +826,11 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' notificationDestination: $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + MbmsLocArea: - description: Represents a user location area whithin which is sent a group message delivery via MBMS request. + description: > + Represents a user location area whithin which is sent a group message delivery + via MBMS request. type: object properties: cellId: @@ -816,7 +838,9 @@ components: items: type: string minItems: 1 - description: Indicates a Cell Global Identification of the user which identifies the cell the UE is registered. + description: > + Indicates a Cell Global Identification of the user which identifies the cell the + UE is registered. enodeBId: type: array items: diff --git a/TS29122_MonitoringEvent.yaml b/TS29122_MonitoringEvent.yaml index 8bed2d7b..b272d21a 100644 --- a/TS29122_MonitoringEvent.yaml +++ b/TS29122_MonitoringEvent.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: 3gpp-monitoring-event - version: 1.3.0-alpha.3 + version: 1.3.0-alpha.4 description: | API for Monitoring Event. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.122 V18.3.0 T8 reference point for Northbound APIs + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' security: @@ -616,6 +616,16 @@ components: $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes' codeWord: $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/CodeWord' + upLocRepIndAf: + description: > + Indicates whether location reporting over user plane is requested or not. + "true" indicates the location reporting over user plane is requested. + "false" indicates the location reporting over user plane is not requested. + Default value is "false" if omitted. + type: boolean + default: false + upLocRepAddrAf: + $ref: '#/components/schemas/UpLocRepAddrAfRm' associationType: $ref: '#/components/schemas/AssociationType' plmnIndication: @@ -684,6 +694,16 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' revocationNotifUri: $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + reqRangingSlRes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangingSlResult' + minItems: 1 + relatedUEs: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RelatedUE' + minItems: 1 required: - notificationDestination - monitoringType @@ -761,7 +781,7 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' appId: $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' - pduSessionInfo: + pduSessInfo: $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/PduSessionInformation' idleStatusInfo: $ref: '#/components/schemas/IdleStatusInfo' @@ -948,6 +968,9 @@ components: $ref: '#/components/schemas/ThreedrelativeLocation' relativeVelocity: $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + upCumEvtRep: + $ref: '#/components/schemas/UpCumEvtRep' + RangeDirection: description: Represents a range and direction from a point A to a point B. type: object @@ -1147,6 +1170,36 @@ components: - required: [addedUEs] - required: [removedUEs] + UpLocRepAddrAfRm: + description: Represents the user plane addressing information. + 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 + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + nullable: true + anyOf: + - required: [ipv4Addrs] + - required: [ipv6Addrs] + - required: [fqdn] + + UpCumEvtRep: + description: Represents the cumulative event report. + type: object + properties: + upLocRepStat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + + # # ENUMS # diff --git a/TS29122_PfdManagement.yaml b/TS29122_PfdManagement.yaml index 38cc38aa..8ccdf926 100644 --- a/TS29122_PfdManagement.yaml +++ b/TS29122_PfdManagement.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: 3gpp-pfd-management - version: 1.3.0-alpha.2 + version: 1.3.0-alpha.3 description: | API for PFD management. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.122 V18.2.0 T8 reference point for Northbound APIs + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' security: @@ -94,7 +94,7 @@ paths: '201': description: > Created. The transaction was created successfully. The SCEF shall return the created - transaction in the response payload body. PfdReport may be included to provide detailed + transaction in the response content. PfdReport may be included to provide detailed failure information for some applications. content: application/json: @@ -246,7 +246,7 @@ paths: '200': description: > OK. The transaction was modified successfully. The SCEF shall return an updated - transaction in the response payload body. + transaction in the response content. content: application/json: schema: @@ -359,7 +359,7 @@ paths: responses: '204': description: > - No Content. The transaction was deleted successfully. The payload body shall be empty. + No Content. The transaction was deleted successfully. The content shall be empty. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': @@ -450,7 +450,7 @@ paths: '200': description: > OK. The application resource was modified successfully. The SCEF shall return an updated - application resource in the response payload body. + application resource in the response content. content: application/json: schema: @@ -522,7 +522,7 @@ paths: '200': description: > OK. The transaction was modified successfully. The SCEF shall return an updated - transaction in the response payload body. + transaction in the response content. content: application/json: schema: @@ -586,7 +586,7 @@ paths: responses: '204': description: > - No Content. The application was deleted successfully. The payload body shall be empty. + No Content. The application was deleted successfully. The content shall be empty. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': diff --git a/TS29122_RacsParameterProvisioning.yaml b/TS29122_RacsParameterProvisioning.yaml index 3f214ecd..4e05031c 100644 --- a/TS29122_RacsParameterProvisioning.yaml +++ b/TS29122_RacsParameterProvisioning.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: 3gpp-racs-parameter-provisioning - version: 1.2.0-alpha.1 + version: 1.2.0-alpha.2 description: | API for provisioning UE radio capability parameters. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.122 V18.1.0 T8 reference point for Northbound APIs + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' security: @@ -302,7 +302,7 @@ paths: responses: '204': description: > - No Content. The provisioning was terminated successfully. The payload body shall + No Content. The provisioning was terminated successfully. The content shall be empty. '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' diff --git a/TS29175_Nimsas_MediaControl.yaml b/TS29175_Nimsas_MediaControl.yaml new file mode 100644 index 00000000..9895e497 --- /dev/null +++ b/TS29175_Nimsas_MediaControl.yaml @@ -0,0 +1,216 @@ +openapi: 3.0.0 + +info: + title: 'IMS AS MediaControl Service' + version: '1.0.0-alpha.1' + description: | + Nimsas_MediaControl Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.175 V1.0.0; IP Multimedia Subsystem; IP Multimedia Subsystem (IMS) Application + Server (AS) Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.175' + +servers: + - url: '{apiRoot}/nimsas-mc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nimsas-mc + +paths: + + /call-sessions/{sessionId}/media-instruction: + post: + summary: Update + operationId: UpdateCallSession + tags: + - Individual call session (Document) + parameters: + - name: sessionId + in: path + description: Session ID assigned by the IMS AS during the IMS session setup. + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SessionId' + requestBody: + description: Representation of the updates to apply to the call session. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MediaInstructionData' + responses: + '200': + description: > + Successful update of the call session, when the IMS AS needs to return information + in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/MediaInstructionData' + '204': + description: > + Successful update of the call session, when the IMS AS does not need to return + information in the response. + '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 UPF. + 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 UPF. + 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' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nimsas-mc: Access to the Nimsas_MediaControl API. + + schemas: + +# STRUCTURED DATA TYPES + + MediaInstructionData: + description: The media instruction data for a specific session. + type: object + required: + - sessionId + - mediaInstructionSet + properties: + sessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SessionId' + mediaInstructionSet: + description: > + Contains a set of instructions for each media flow to control. The mediaId + attribute within the MediaInstructions data type is the key of the map. + type: object + additionalProperties: + $ref: '#/components/schemas/MediaInstructions' + minProperties: 1 + + MediaInstructions: + description: The media instructions for a specific media flow. + type: object + required: + - mediaId + - mediaResourceType + properties: + mediaId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaId' + mediaResourceType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaResourceType' + mediaInstruction: + $ref: '#/components/schemas/MediaInstruction' + dcMediaSpecification: + $ref: '#/components/schemas/DcMediaSpecification' + mediaProcessingUrl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + + DcMediaSpecification: + description: The data channel media specification information. + type: object + required: + - streams + properties: + mediaProxyConfig: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaProxy' + replaceHttpUrls: + description: > + Contains a list of replacement HTTP URLs. The streamId + attribute within the ReplaceHttpUrl data type is the key of the map. + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReplaceHttpUrl' + minProperties: 1 + mdc1EndpointDcsf: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + mdc1EndpointMf: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + mdc2EndpointDcAs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + mdc2EndpointMf: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + mdc2Protocol: + type: string + streams: + description: > + Contains a data channel mapping and configuration information. The streamId + attribute within the DcStream data type is the key of the map. + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcStream' + minProperties: 1 + +# ENUMS + + MediaInstruction: + description: The media instruction for handling a specific media flow. + anyOf: + - type: string + enum: + - TERMINATE_MEDIA + - ORIGINATE_MEDIA + - TERMINATE_AND_ORIGINATE_MEDIA + - UPDATE_MEDIA + - DELETE_MEDIA + - REJECT_MEDIA + - 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. + diff --git a/TS29175_Nimsas_SessionEventControl.yaml b/TS29175_Nimsas_SessionEventControl.yaml new file mode 100644 index 00000000..3a956f66 --- /dev/null +++ b/TS29175_Nimsas_SessionEventControl.yaml @@ -0,0 +1,268 @@ +openapi: 3.0.0 + +info: + + title: 'IMS AS SessionEventControl Service' + version: '1.0.0-alpha.1' + description: | + Nimsas_SessionEventControl Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.175 V1.0.0; IP Multimedia Subsystem; IP Multimedia Subsystem (IMS) Application + Server (AS) Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.175/' + +servers: + - url: '{apiRoot}/nimsas-sec/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nimsas-sec + +paths: + /session-event-subscriptions: + post: + # This is a pseudo operation, NF service consumers shall NOT invoke this method! + summary: Nimsas_SessionEventControl Subscribe service operation, pseudo operation + tags: + - Session Event Subscriptions (Collection) + operationId: Subscribe + requestBody: + required: true + content: + application/json: + # Unspecified schema for the JSON body, since this is not used by consumer or producer. + schema: {} + responses: + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + callbacks: + eeNotification: + '{SessionEventNotificationUri}': + # The URI in {SessionEventNotificationUri} is not provided by NF service consumer via Nimsas_SessionEventControl API in this Release. + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SessionEventNotification' + 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' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nimsas-sec: Access to the Nimsas_SessionEventControl API + + schemas: + +# STRUCTURED DATA TYPES + + SessionEventNotification: + description: The session event notification item. + type: object + required: + - notificationEvent + - sessionId + properties: + notificationEvent: + $ref: '#/components/schemas/NotificationEvent' + sessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SessionId' + sessionInfo: + $ref: '#/components/schemas/SessionInfo' + mediaInfoList: + description: > + Contains a media related information. The mediaId attribute within the MediaInfo + data type is the key of the map. + type: object + additionalProperties: + $ref: '#/components/schemas/MediaInfo' + minItems: 1 + + NotificationEvent: + description: The notification event information. + type: object + required: + - eventType + properties: + eventType: + $ref: '#/components/schemas/EventType' + eventInitiator: + $ref: '#/components/schemas/EventInitiator' + + SessionInfo: + description: The session information related to the notification event. + type: object + properties: + callingIdentity: + $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ImsPublicId' + calledIdentity: + $ref: 'TS29562_Nhss_imsSDM.yaml#/components/schemas/ImsPublicId' + sessionCase: + $ref: '#/components/schemas/SessionCase' + + MediaInfo: + description: The media information related to the notification event. + type: object + required: + - mediaId + - mediaType + properties: + mediaId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaId' + mediaType: + $ref: '#/components/schemas/MediaType' + dcMediaSpecification: + $ref: '#/components/schemas/DcMediaSpecification' + + DcMediaSpecification: + description: > + The data channel media specification information contains media description attributes. + type: object + required: + - streams + properties: + streams: + description: > + Contains a data channel mapping and configuration information. The streamId + attribute within the DcStream data type is the key of the map. + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcEndpoint' + minItems: 1 + maxMessageSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxMessageSize' + localDcEndpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcEndpoint' + remoteDcEndpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcEndpoint' + securitySetup: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecuritySetup' + +# ENUMS + + EventType: + description: The type of the event for which the notification is generated. + anyOf: + - type: string + enum: + - SESSION_ESTABLISHMENT_REQUEST + - SESSION_ESTABLISHMENT_PROGRESS + - SESSION_ESTABLISHMENT_ALERTING + - SESSION_ESTABLISHMENT_SUCCESS + - SESSION_ESTABLISHMENT_FAILURE + - MEDIA_CHANGE_REQUEST + - MEDIA_CHANGE_SUCCESS + - MEDIA_CHANGE_FAILURE + - SESSION_TERMINATION + - 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. + + MediaType: + description: The type of the media for which the notification is generated. + anyOf: + - type: string + enum: + - DC + - AUDIO + - VIDEO + - 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. + + SessionCase: + description: The type of the session case. + anyOf: + - type: string + enum: + - ORIGINATING_IMS_SESSION + - TERMINATING_IMS_SESSION + - 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. + + EventInitiator: + description: The initiator of the event for which the notification is generated. + anyOf: + - type: string + enum: + - SERVED_IMS_SUBSCRIBER + - REMOTE_IMS_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. diff --git a/TS29176_Nmf_MRM.yaml b/TS29176_Nmf_MRM.yaml new file mode 100644 index 00000000..26f707df --- /dev/null +++ b/TS29176_Nmf_MRM.yaml @@ -0,0 +1,349 @@ +openapi: 3.0.0 + +info: + title: 'MF Media Resource Management (MRM) Service' + version: 1.0.0-alpha.1 + description: | + MF Media Resource Management (MRM) Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.176 V18.0.0; IP Multimedia Subsystem (IMS); Media Function (MF) Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.176/ + +servers: + - url: '{apiRoot}/nmf-mrm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nmf-mrm + +paths: + + /contexts: + post: + summary: Create a new media context. + operationId: CreateMediaContext + tags: + - MediaContext(Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MediaContext' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MediaContext' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nmf-mrm//contexts/{contextId} + required: true + 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 MF. + 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 MF. + 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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + /contexts/{contextId}: + + patch: + summary: Update Media Context + operationId: UpdateMediaContext + tags: + - Media Context ID (Document) + parameters: + - name: contextId + in: path + required: true + description: Unique ID of the Media Context to update. + 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/MediaContext' + '204': + description: Expected response with empty body + '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 MF. + 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 MF. + 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: Deletes a given Media Context + operationId: DeleteMediaContext + tags: + - Media Context ID (Document) + parameters: + - name: contextId + in: path + required: true + description: Unique ID of the Media Context to delete. + schema: + type: string + responses: + '204': + description: Expected response to a successful deletion. + '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' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nmf-mrm: Access to the Nmf_MRM API. + + schemas: + + MediaContext: + description: Information of a Media Context in a MF. + type: object + required: + - terminations + properties: + contextId: + type: string + terminations: + type: array + items: + $ref: '#/components/schemas/TerminationInfo' + minItems: 1 + + TerminationInfo: + description: Represents the termination information. + type: object + required: + - medias + properties: + terminationId: + type: string + medias: + type: array + items: + $ref: '#/components/schemas/MediaInfo' + minItems: 1 + + MediaInfo: + description: Represents the media information. + type: object + required: + - mediaId + - mediaResourceType + properties: + mediaId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaId' + mediaResourceType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaResourceType' + localMbEndpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + remoteMbEndpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + dcMedia: + $ref: '#/components/schemas/DcMedia' + mediaProcessingUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + + DcMedia: + description: Represents the DC media descriptor. + type: object + required: + - streams + properties: + mediaProxyConfig: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaProxy' + replaceHttpUrl: + type: object + description: > + Contains a list of replacement HTTP URLs. The streamId attribute + within the ReplaceHttpUrl data type is the key of the map. + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReplaceHttpUrl' + minProperties: 1 + remoteMdc1Endpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + remoteMdc2Endpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + localMdc1Endpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + localMdc2Endpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + mdc2Protocol: + type: string + streams: + type: object + description: > + Contains a data channel mapping and configuration information. The streamId + attribute within the DcStream data type is the key of the map. + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcStream' + minProperties: 1 + maxMessageSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxMessageSize' + localDcEndpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcEndpoint' + remoteDcEndpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcEndpoint' + securitySetup: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecuritySetup' diff --git a/TS29222_CAPIF_Discover_Service_API.yaml b/TS29222_CAPIF_Discover_Service_API.yaml index 716ff057..ca6fb3d9 100644 --- a/TS29222_CAPIF_Discover_Service_API.yaml +++ b/TS29222_CAPIF_Discover_Service_API.yaml @@ -4,12 +4,12 @@ info: title: CAPIF_Discover_Service_API description: | API for discovering service APIs. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: "1.3.0-alpha.1" + version: "1.3.0-alpha.2" externalDocs: - description: 3GPP TS 29.222 V18.0.0 Common API Framework for 3GPP Northbound APIs + description: 3GPP TS 29.222 V18.4.0 Common API Framework for 3GPP Northbound APIs url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ servers: @@ -78,6 +78,11 @@ paths: application/json: schema: $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/AefLocation' + - name: req-api-prov-name + in: query + description: Represents the required API provider name. + schema: + type: string - name: supported-features in: query description: Features supported by the NF consumer for the CAPIF Discover Service API. @@ -90,6 +95,18 @@ paths: This may only be present if api-name query parameter is present. schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: ue-ip-addr + in: query + description: Represents the UE IP address information. + schema: + $ref: '#/components/schemas/IpAddrInfo' + - name: service-kpis + in: query + description: > + Contains iInformation about service characteristics provided by the targeted + service API(s). + schema: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/ServiceKpis' responses: '200': description: > @@ -139,3 +156,15 @@ components: description: > Description of the service API as published by the service. Each service API description shall include AEF profiles matching the filter criteria. + + IpAddrInfo: + type: object + description: Represents the UE IP address information. + properties: + ipv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + oneOf: + - required: [ipv4Addr] + - required: [ipv6Addr] diff --git a/TS29222_CAPIF_Events_API.yaml b/TS29222_CAPIF_Events_API.yaml index b45675cb..68bec979 100644 --- a/TS29222_CAPIF_Events_API.yaml +++ b/TS29222_CAPIF_Events_API.yaml @@ -6,10 +6,10 @@ info: API for event subscription management. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: "1.3.0-alpha.3" + version: "1.3.0-alpha.4" externalDocs: - description: 3GPP TS 29.222 V18.3.0 Common API Framework for 3GPP Northbound APIs + description: 3GPP TS 29.222 V18.4.0 Common API Framework for 3GPP Northbound APIs url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ servers: @@ -443,26 +443,28 @@ components: Describes the CAPIF event. Possible values are: - SERVICE_API_AVAILABLE: - Events related to the availability of service APIs after the service APIs are published. + Events related to the availability of service APIs after the service APIs are + published. - SERVICE_API_UNAVAILABLE: - Events related to the unavailability of service APIs after the service APIs are - unpublished. + Events related to the unavailability of service APIs after the service APIs are + unpublished. - SERVICE_API_UPDATE: Events related to change in service API information. - API_INVOKER_ONBOARDED: Events related to API invoker onboarded to CAPIF. - API_INVOKER_OFFBOARDED: Events related to API invoker offboarded from CAPIF. - SERVICE_API_INVOCATION_SUCCESS: - Events related to the successful invocation of service APIs. + Events related to the successful invocation of service APIs. - SERVICE_API_INVOCATION_FAILURE: Events related to the failed invocation of service APIs. - ACCESS_CONTROL_POLICY_UPDATE: - Events related to the update for the access control policy related to the service APIs. + Events related to the update for the access control policy related to the service APIs. - ACCESS_CONTROL_POLICY_UNAVAILABLE: - Events related to the unavailability of the access control policy related to - the service APIs. - - API_INVOKER_AUTHORIZATION_REVOKED: Events related to the revocation of the authorization of API invokers to access the service APIs. + Events related to the unavailability of the access control policy related to + the service APIs. + - API_INVOKER_AUTHORIZATION_REVOKED: Events related to the revocation of the authorization + of API invokers to access the service APIs. - API_INVOKER_UPDATED: Events related to API invoker profile updated to CAPIF. - API_TOPOLOGY_HIDING_CREATED: - Events related to the creation or update of the API topology hiding - information of the service APIs after the service APIs are published. + Events related to the creation or update of the API topology hiding + information of the service APIs after the service APIs are published. - API_TOPOLOGY_HIDING_REVOKED: - Events related to the revocation of the API topology hiding information of - the service APIs after the service APIs are unpublished. + Events related to the revocation of the API topology hiding information of + the service APIs after the service APIs are unpublished. diff --git a/TS29222_CAPIF_Publish_Service_API.yaml b/TS29222_CAPIF_Publish_Service_API.yaml index 0a77577d..c122eceb 100644 --- a/TS29222_CAPIF_Publish_Service_API.yaml +++ b/TS29222_CAPIF_Publish_Service_API.yaml @@ -6,10 +6,10 @@ info: API for publishing service APIs. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: "1.3.0-alpha.3" + version: "1.3.0-alpha.4" externalDocs: - description: 3GPP TS 29.222 V18.2.0 Common API Framework for 3GPP Northbound APIs + description: 3GPP TS 29.222 V18.4.0 Common API Framework for 3GPP Northbound APIs url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ servers: @@ -333,6 +333,8 @@ components: to the CAPIF core function. Shall be present in the HTTP POST response from the CAPIF core function to the API publishing function and in the HTTP GET response from the CAPIF core function to the API invoker (discovery API). + apiStatus: + $ref: '#/components/schemas/ApiStatus' aefProfiles: type: array items: @@ -423,6 +425,10 @@ components: description: Interface details aefLocation: $ref: '#/components/schemas/AefLocation' + serviceKpis: + $ref: '#/components/schemas/ServiceKpis' + ueIpRange: + $ref: '#/components/schemas/IpAddrRange' required: - aefId - versions @@ -575,6 +581,8 @@ components: description: > Represents the parameters to request the modification of an APF published API resource. properties: + apiStatus: + $ref: '#/components/schemas/ApiStatus' aefProfiles: type: array items: @@ -597,6 +605,82 @@ components: type: string description: CAPIF core function identifier. + ApiStatus: + type: object + description: > + Represents the API status. + properties: + aefIds: + type: array + items: + type: string + description: > + Indicates the list of AEF ID(s) where the API is active. + If this attribute is omitted, the API is inactive at all AEF(s) + defined in the "aefProfiles" attribute within + the ServiceAPIDescription data structure. + required: + - aefIds + + ServiceKpis: + type: object + description: > + Represents information about the service characteristics provided by a service API. + properties: + maxReqRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + description: > + Unsigned integer identifying maximum request rate per second from the API Invoker + supported by the server. + maxRestime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + availability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + avalComp: + type: string + pattern: '^\d+(\.\d+)? (kFLOPS|MFLOPS|GFLOPS|TFLOPS|PFLOPS|EFLOPS|ZFLOPS)$' + description: > + The maximum compute resource available in FLOPS for the API Invoker. + avalGraComp: + type: string + pattern: '^\d+(\.\d+)? (kFLOPS|MFLOPS|GFLOPS|TFLOPS|PFLOPS|EFLOPS|ZFLOPS)$' + description: > + The maximum graphical compute resource in FLOPS available for the API Invoker. + avalMem: + type: string + pattern: '^\d+(\.\d+)? (KB|MB|GB|TB|PB|EB|ZB|YB)$' + description: > + The maximum memory resource available for the API Invoker. + avalStor: + type: string + pattern: '^\d+(\.\d+)? (KB|MB|GB|TB|PB|EB|ZB|YB)$' + description: > + The maximum storage resource available for the API Invoker. + conBand: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + description: > + The connection bandwidth in kbps advertised for the API Invoker's use. + + IpAddrRange: + description: Represents the list of public IP ranges + type: object + properties: + ueIpv4AddrRanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddressRange' + description: Represents the IPv4 Address ranges of the UE(s). + minItems: 1 + ueIpv6AddrRanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6AddressRange' + description: Represents the Ipv6 Address ranges of the UE(s). + minItems: 1 + anyOf: + - required: [ueIpv4AddrRanges] + - required: [ueIpv6AddrRanges] + Protocol: anyOf: - type: string diff --git a/TS29222_CAPIF_Security_API.yaml b/TS29222_CAPIF_Security_API.yaml index 5899bd84..53ddf1c1 100644 --- a/TS29222_CAPIF_Security_API.yaml +++ b/TS29222_CAPIF_Security_API.yaml @@ -6,10 +6,10 @@ info: API for CAPIF security management. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: "1.3.0-alpha.2" + version: "1.3.0-alpha.3" externalDocs: - description: 3GPP TS 29.222 V18.1.0 Common API Framework for 3GPP Northbound APIs + description: 3GPP TS 29.222 V18.4.0 Common API Framework for 3GPP Northbound APIs url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ servers: @@ -407,6 +407,11 @@ components: authorizationInfo: type: string description: Authorization related information + authorizationFlow: + type: array + items: + $ref: '#/components/schemas/AuthorizationFlow' + minItems: 1 required: - prefSecurityMethods oneOf: @@ -446,10 +451,14 @@ components: - client_credentials client_id: type: string + resOwnerId: + type: string client_secret: type: string scope: type: string + authCode: + type: string required: - grant_type - client_id @@ -481,6 +490,8 @@ components: properties: iss: type: string + resOwnerId: + type: string scope: type: string exp: @@ -510,6 +521,15 @@ components: required: - error + AuthorizationCodeRsp: + type: object + description: Represents the authorization code response information. + properties: + authCode: + type: string + required: + - authCode + Cause: anyOf: - type: string @@ -529,3 +549,24 @@ components: usage of the service API - UNEXPECTED_REASON: The revocation of the authorization of the API invoker is due to unexpected reason. + + AuthorizationFlow: + anyOf: + - type: string + enum: + - CLIENT_CREDENTIALS_FLOW + - AUTHORIZATION_CODE_FLOW + - AUTHORIZATION_CODE_FLOW_WITH_PKCE + - 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 supported authorization flow (e.g. client credentials flow, authorization code flow, etc.) to the API invoker. + Possible values are: + - CLIENT_CREDENTIALS_FLOW: + The supported authorization flow is client credentials flow. + - AUTHORIZATION_CODE_FLOW: + The supported authorization flow is authorization code flow. + - AUTHORIZATION_CODE_FLOW_WITH_PKCE: + The supported authorization flow is authorization code flow with PKCE. diff --git a/TS29257_UAE_DAASupport.yaml b/TS29257_UAE_DAASupport.yaml index 735ad393..992ca047 100644 --- a/TS29257_UAE_DAASupport.yaml +++ b/TS29257_UAE_DAASupport.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: UAE Server DAA Support Service - version: 1.0.0-alpha.1 + version: 1.0.0-alpha.2 description: | UAE Server DAA Support Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.257 V18.1.0; Application layer support for Uncrewed Aerial System (UAS); + 3GPP TS 29.257 V18.2.0; Application layer support for Uncrewed Aerial System (UAS); UAS Application Enabler (UAE) Server Services; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.257/ @@ -501,12 +501,9 @@ components: description: Represents the parameters to request for DAA. type: object properties: - uasId: - $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' status: $ref: '#/components/schemas/DAAPolConfigStatus' required: - - uasId - status DAAEventsInfo: diff --git a/TS29309_Nbsp_GBA.yaml b/TS29309_Nbsp_GBA.yaml index c85bf8f0..f76c9844 100644 --- a/TS29309_Nbsp_GBA.yaml +++ b/TS29309_Nbsp_GBA.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.1.0-alpha.1' + version: '1.1.0-alpha.2' title: 'GBA BSF Nbsp_GBA Service' description: | GBA BSF Nbsp_GBA Service. @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.309 V18.0.0; 5G System; Bootstrapping Server Function (GBA BSF) Services; Stage 3 + 3GPP TS 29.309 V18.1.0; 5G System; Bootstrapping Server Function (GBA BSF) Services; Stage 3 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.309/' servers: @@ -154,11 +154,12 @@ components: schemas: # -# COMPLEX TYPES +# STRUCTURED TYPES # BootstrappingInfoRequest: - description: Request body of the HTTP POST operation for resource /bootstrapping-info-request + description: > + Request body of the HTTP POST operation for resource /bootstrapping-info-request type: object required: - btId @@ -178,7 +179,8 @@ components: minItems: 1 BootstrappingInfoResponse: - description: Response body of the HTTP POST operation for resource /bootstrapping-info-request + description: > + Response body of the HTTP POST operation for resource /bootstrapping-info-request type: object required: - meKeyMaterial @@ -229,8 +231,10 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' privateIdRequest: type: boolean + default: false gbaUAware: type: boolean + default: false gsIds: type: array items: diff --git a/TS29435_NSCE_PolicyManagement.yaml b/TS29435_NSCE_PolicyManagement.yaml new file mode 100644 index 00000000..de61821b --- /dev/null +++ b/TS29435_NSCE_PolicyManagement.yaml @@ -0,0 +1,678 @@ +openapi: 3.0.0 + +info: + title: NSCE Server Policy Management Service + version: 1.0.0-alpha.1 + description: | + NSCE Server Policy Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.435 V0.1.0; Service Enabler Architecture Layer for Verticals (SEAL); + Network Slice Capability Exposure (NSCE) Server Service(s); Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.435/ + +servers: + - url: '{apiRoot}/nsce-pm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /provisionings: + post: + summary: Request the creation of a Policy Provisioning. + operationId: CreatePolProv + tags: + - Policy Provisionings (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyProv' + responses: + '201': + description: > + Created. The Policy Provisioning is successfully created and a representation of the + created Individual Policy Provisioning resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyProv' + headers: + Location: + description: > + Contains the URI of the created Individual Policy Provisioning resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /provisionings/{provId}: + parameters: + - name: provId + in: path + description: > + Represents the identifier of the Individual Policy Provisioning resource. + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual Policy Provisioning resource. + operationId: GetIndPolProv + tags: + - Individual Policy Provisioning (Document) + responses: + '200': + description: > + OK. The requested Individual Policy Provisioning resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyProv' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Request the update of an existing Individual Policy Provisioning resource. + operationId: UpdateIndDPolProv + tags: + - Individual Policy Provisioning (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyProv' + responses: + '200': + description: > + OK. The Individual Policy Provisioning resource is successfully updated and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyProv' + '204': + description: > + No Content. The Individual Policy Provisioning resource is successfully updated and no + content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Request the modification of an existing Individual Policy Provisioning resource. + operationId: ModifyIndPolProv + tags: + - Individual Policy Provisioning (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PolicyProvPatch' + responses: + '200': + description: > + OK. The Individual Policy Provisioning resource is successfully modified and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyProv' + '204': + description: > + No Content. The Individual Policy Provisioning resource is successfully modified and no + content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Request the deletion of an existing Individual Policy Provisioning resource. + operationId: DeleteIndPolProv + tags: + - Individual Policy Provisioning (Document) + responses: + '204': + description: > + No Content. The Individual Policy Provisioning resource is successfully deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /subscriptions: + post: + summary: Request the creation of a Policy Usage Subscription. + operationId: CreatePolUsageSubsc + tags: + - Policy Usage Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolUsageSubsc' + responses: + '201': + description: > + Created. The Policy Usage Subscription is successfully created and a representation + of the created Individual Policy Usage Subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolUsageSubsc' + headers: + Location: + description: > + Contains the URI of the created Individual Policy Usage Subscription resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + PolUsageNotif: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolUsageNotif' + responses: + '204': + description: > + No Content. The Policy Usage Notification is successfully received and + Acknowledged. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /subscriptions/{subscriptionId}: + parameters: + - name: subscriptionId + in: path + description: > + Represents the identifier of the Individual Policy Usage Subscription resource. + resource. + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual Policy Usage Subscription resource. + operationId: GetIndPolUsageSubsc + tags: + - Individual Policy Usage Subscription (Document) + responses: + '200': + description: > + OK. The requested Individual Policy Usage Subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolUsageSubsc' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Request the update of an existing Individual Policy Usage Subscription resource. + operationId: UpdateIndPolUsageSubsc + tags: + - Individual Policy Usage Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolUsageSubsc' + responses: + '200': + description: > + OK. The Individual Policy Usage Subscription resource is successfully updated and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/PolUsageSubsc' + '204': + description: > + No Content. The Individual Policy Usage Subscription resource is successfully updated + and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Request the modification of an existing Individual Policy Usage Subscription resource. + operationId: ModifyIndPolUsageSubsc + tags: + - Individual Policy Usage Subscription (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PolUsageSubscPatch' + responses: + '200': + description: > + OK. The Individual Policy Usage Subscription resource is successfully modified and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/PolUsageSubsc' + '204': + description: > + No Content. The Individual Policy Usage Subscription resource is successfully modified + and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Request the deletion of an existing Individual Policy Usage Subscription resource. + operationId: DeleteIndPolUsageSubsc + tags: + - Individual Policy Usage Subscription (Document) + responses: + '204': + description: > + No Content. The Individual Policy Usage Subscription resource is successfully deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + +# +# STRUCTURED DATA TYPES +# + + PolicyProv: + description: > + Represents a Policy Provisioning. + type: object + properties: + netSliceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + reqDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + polHarmInd: + type: boolean + default: false + description: > + Contains the policy harmonization indication. It indicates whether policy harmonization + is requested or not. + true means that policy harmonization is requested. + false means that policy harmonization is not requested. + The default value when omitted is "false". + defaultPolInd: + type: boolean + default: false + description: > + Contains the default policy indication. It indicates whether or not the provisioned + policy shall be used as a default policy for the network slices provisioned without any + policy. + true means that the provisioned policy shall be used as a default policy for the network + slices provisioned without any policy. + false means that the provisioned policy shall not be used as a default policy for the + network slices provisioned without any policy. + The default value when omitted is "false". + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + PolicyProvPatch: + description: > + Represents the requested modifications to a Policy Provisioning. + type: object + properties: + netSliceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + reqDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + defaultPolInd: + type: boolean + default: false + description: > + Contains the default policy indication. It indicates whether or not the provisioned + policy shall be used as a default policy for the network slices provisioned without any + policy. + true means that the provisioned policy shall be used as a default policy for the network + slices provisioned without any policy. + false means that the provisioned policy shall not be used as a default policy for the + network slices provisioned without any policy. + The default value when omitted is "false". + + PolUsageSubsc: + description: > + Represents a Policy Usage Subscription. + type: object + properties: + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + netSliceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + reqPolicyRep: + $ref: '#/components/schemas/ReqPolRep' + repPeriodicity: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - notifUri + - netSliceId + - reqPolicyRep + + PolUsageSubscPatch: + description: > + Represents the requested modifications to a Policy Usage Subscription. + type: object + properties: + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + reqPolicyRep: + $ref: '#/components/schemas/ReqPolRep' + repPeriodicity: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + + ReqPolRep: + description: > + Represents the requested policy usage reporting information. + type: object + properties: + policyId: + type: string + startTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + required: + - policyId + - startTime + - endTime + + PolUsageNotif: + description: > + Represents a Policy Usage Notification. + type: object + properties: + subscriptionId: + type: string + reports: + type: array + items: + $ref: '#/components/schemas/PolRepData' + minItems: 1 + required: + - subscriptionId + - reports + + PolRepData: + description: > + Represents data access statistics. + type: object + properties: + policyId: + type: string + count: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + timeSpent: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + preEmptCount: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + preEmptPolId: + type: string + required: + - policyId + - count + - timeSpent + + +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# diff --git a/TS29486_VAE_ApplicationRequirement.yaml b/TS29486_VAE_ApplicationRequirement.yaml index b13ce7e2..e2955464 100644 --- a/TS29486_VAE_ApplicationRequirement.yaml +++ b/TS29486_VAE_ApplicationRequirement.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: 1.2.0-alpha.1 + version: 1.2.0-alpha.2 title: VAE_ApplicationRequirement description: | API for VAE Application Requirement Service - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.486 V18.0.0 V2X Application Enabler (VAE) Services + description: 3GPP TS 29.486 V18.1.0 V2X Application Enabler (VAE) Services url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.486/' security: @@ -218,7 +218,7 @@ components: requestTestNotification: type: boolean description: > - Set to true by the NF service consumer to request the VAE server to send a test + Set to true by the service consumer to request the VAE server to send a test notification as defined in clause 6.3.5.3. Set to false or omitted otherwise. websockNotifConfig: $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' diff --git a/TS29486_VAE_DynamicGroup.yaml b/TS29486_VAE_DynamicGroup.yaml index fb6ac299..bdd82731 100644 --- a/TS29486_VAE_DynamicGroup.yaml +++ b/TS29486_VAE_DynamicGroup.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: 1.2.0-alpha.1 + version: 1.2.0-alpha.2 title: VAE_DynamicGroup description: | VAE_Dynamic_Group Service - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.486 V18.0.0 V2X Application Enabler (VAE) Services + description: 3GPP TS 29.486 V18.1.0 V2X Application Enabler (VAE) Services url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.486/' security: @@ -215,7 +215,7 @@ components: requestTestNotification: type: boolean description: > - Set to true by the NF service consumer to request the VAE server to test + Set to true by the service consumer to request the VAE server to test a notification connection. Set to false or omitted otherwise. websockNotifConfig: $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' diff --git a/TS29486_VAE_HDMapDynamicInfo.yaml b/TS29486_VAE_HDMapDynamicInfo.yaml index 79610804..580d4da4 100644 --- a/TS29486_VAE_HDMapDynamicInfo.yaml +++ b/TS29486_VAE_HDMapDynamicInfo.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: 1.1.0-alpha.1 + version: 1.1.0-alpha.2 title: VAE_HDMapDynamicInfo description: | API for VAE HDMapDynamicInfo Service - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.486 V18.0.0 V2X Application Enabler (VAE) Services + description: 3GPP TS 29.486 V18.1.0 V2X Application Enabler (VAE) Services url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.486/' security: @@ -212,7 +212,7 @@ components: requestTestNotification: type: boolean description: > - Set to true by the NF service consumer to request the VAE server to send a test + Set to true by the service consumer to request the VAE server to send a test notification as defined in clause 6.3.5.3. Set to false or omitted otherwise. websockNotifConfig: $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' diff --git a/TS29486_VAE_MessageDelivery.yaml b/TS29486_VAE_MessageDelivery.yaml index 87e862c1..34178a08 100644 --- a/TS29486_VAE_MessageDelivery.yaml +++ b/TS29486_VAE_MessageDelivery.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: 1.2.0-alpha.1 + version: 1.2.0-alpha.2 title: VAE_MessageDelivery description: | API for VAE Message Delivery Service - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.486 V18.0.0 V2X Application Enabler (VAE) Services + description: 3GPP TS 29.486 V18.1.0 V2X Application Enabler (VAE) Services url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.486/' security: @@ -418,7 +418,7 @@ components: requestTestNotification: type: boolean description: > - Set to true by the NF service consumer to request the VAE server to send a test + Set to true by the service consumer to request the VAE server to send a test notification as defined in clause 6.1.5.3. Set to false or omitted otherwise. websockNotifConfig: $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' @@ -461,7 +461,7 @@ components: content defined in the present version of this API. AppServerId: - description: Represents the V2X application specific server identifier. + description: Represents the service consumer identifier. type: string V2xUeId: diff --git a/TS29486_VAE_PC5ProvisioningRequirement.yaml b/TS29486_VAE_PC5ProvisioningRequirement.yaml index c9d5cacd..7f9a60fc 100644 --- a/TS29486_VAE_PC5ProvisioningRequirement.yaml +++ b/TS29486_VAE_PC5ProvisioningRequirement.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: 1.1.0-alpha.1 + version: 1.1.0-alpha.2 title: VAE_PC5ProvisioningRequirement description: | API for VAE_PC5ProvisioningRequirement - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.486 V18.0.0 V2X Application Enabler (VAE) Services + description: 3GPP TS 29.486 V18.1.0 V2X Application Enabler (VAE) Services url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.486/' security: @@ -274,7 +274,7 @@ components: requestTestNotification: type: boolean description: > - Set to true by the NF service consumer to request the VAE server to send a test + Set to true by the service consumer to request the VAE server to send a test notification as defined in clause 6.3.5.3. Set to false or omitted otherwise. websockNotifConfig: $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' diff --git a/TS29486_VAE_ServiceAndQoSControlInfo.yaml b/TS29486_VAE_ServiceAndQoSControlInfo.yaml new file mode 100644 index 00000000..d3a08c6d --- /dev/null +++ b/TS29486_VAE_ServiceAndQoSControlInfo.yaml @@ -0,0 +1,423 @@ +openapi: 3.0.0 + +info: + title: VAE Server Service And QoS Control Info Service + version: 1.0.0-alpha.1 + description: | + VAE Server Service And QoS Control Info Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.486 V18.1.0 V2X Application Enabler (VAE) Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.486/' + +servers: + - url: '{apiRoot}/vae-sqci/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /subscriptions: + post: + summary: Request the creation of a Service Adaptation And QoS Control Subscription. + operationId: CreateServAdaptQoSCtrlSubsc + tags: + - Service Adaptation And QoS Control Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServAdaptQoSCtrlSubsc' + responses: + '201': + description: > + Created. The Service Adaptation And QoS Control Subscription is successfully created + and a representation of the created Individual Service Adaptation And QoS Control + Subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ServAdaptQoSCtrlSubsc' + headers: + Location: + description: > + Contains the URI of the created Individual Service Adaptation And QoS Control + Subscription resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + ServReqQoSAdaptNotif: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AdaptNotif' + responses: + '200': + description: > + OK. The Service Requirements And QoS Adaptation notification is successfully + received and acknowledged and the acknowledgment related information shall be + returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/AdaptNotifResp' + '204': + description: > + No Content. The Service Requirements And QoS Adaptation notification is + successfully received and acknowledged and no content is returned in the + response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /subscriptions/{subscriptionId}: + parameters: + - name: subscriptionId + in: path + description: > + Represents the identifier of the Individual Service Adaptation And QoS Control + Subscription resource. + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual Service Adaptation And QoS Control Subscription resource. + operationId: GetIndServAdaptQoSCtrlSubsc + tags: + - Individual Service Adaptation And QoS Control Subscription (Document) + responses: + '200': + description: > + OK. The requested Individual Service Adaptation And QoS Control Subscription resource + shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ServAdaptQoSCtrlSubsc' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Request the update of an existing Individual Service Adaptation And QoS Control Subscription resource. + operationId: UpdateIndServAdaptQoSCtrlSubsc + tags: + - Individual Service Adaptation And QoS Control Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServAdaptQoSCtrlSubsc' + responses: + '200': + description: > + OK. The Individual Service Adaptation And QoS Control Subscription resource is + successfully updated and a representation of the updated resource shall be returned in + the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/ServAdaptQoSCtrlSubsc' + '204': + description: > + No Content. The Individual Service Adaptation And QoS Control Subscription resource is + successfully updated and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Request the modification of an existing Individual Service Adaptation And QoS Control Subscription resource. + operationId: ModifyIndServAdaptQoSCtrlSubsc + tags: + - Individual Service Adaptation And QoS Control Subscription (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/ServAdaptQoSCtrlSubscPatch' + responses: + '200': + description: > + OK. The Individual Service Adaptation And QoS Control Subscription resource is + successfully modified and a representation of the updated resource shall be returned in + the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/ServAdaptQoSCtrlSubsc' + '204': + description: > + No Content. The Individual Service Adaptation And QoS Control Subscription resource is + successfully modified and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Request the deletion of an existing Individual Service Adaptation And QoS Control Subscription resource. + operationId: DeleteIndServAdaptQoSCtrlSubsc + tags: + - Individual Service Adaptation And QoS Control Subscription (Document) + responses: + '204': + description: > + No Content. The Individual Service Adaptation And QoS Control Subscription resource is + successfully deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + ServAdaptQoSCtrlSubsc: + description: > + Represents a Service Adaptation And QoS Control Subscription. + type: object + properties: + subscTarget: + $ref: '#/components/schemas/V2xTarget' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - subscTarget + - notifUri + + ServAdaptQoSCtrlSubscPatch: + description: > + Represents the requested modifications to a Service Adaptation And QoS Control subscription. + type: object + properties: + subscTarget: + $ref: '#/components/schemas/V2xTarget' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + + AdaptNotif: + description: > + Represents a Service Requirements And QoS Adaptation Notification. + type: object + properties: + subscriptionId: + type: string + ueIdsList: + type: array + items: + $ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xUeId' + minItems: 1 + qosChangeInfo: + $ref: '#/components/schemas/QoSChangeInfo' + required: + - subscriptionId + - qosChangeInfo + + AdaptNotifResp: + description: > + Represents the Service Requirements And QoS Adaptation Notification acknowledgment related + information. + type: object + properties: + result: + $ref: '#/components/schemas/AckResult' + ueIdsList: + type: array + items: + $ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xUeId' + minItems: 1 + required: + - result + + QoSChangeInfo: + description: > + Represents the QoS change related information. + type: object + properties: + loa: + type: string + + V2xTarget: + description: > + Represents the targeted V2X entity. + type: object + properties: + groupId: + $ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xGroupId' + serviceId: + $ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xServiceId' + ueId: + $ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xUeId' + oneOf: + - required: [groupId] + - required: [serviceId] + - required: [ueId] + +# +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + AckResult: + anyOf: + - type: string + enum: + - POSITIVE + - NEGATIVE + - 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 reporting granularity. + Possible values are: + - POSITIVE: Indicates that the acknowledgement is positive. + - NEGATIVE: Indicates that the acknowledgement is negative. diff --git a/TS29486_VAE_SessionOrientedService.yaml b/TS29486_VAE_SessionOrientedService.yaml index e617ac87..928a0a6b 100644 --- a/TS29486_VAE_SessionOrientedService.yaml +++ b/TS29486_VAE_SessionOrientedService.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: 1.1.0-alpha.1 + version: 1.1.0-alpha.2 title: VAE_SessionOrientedService description: | API for VAE_SessionOrientedService - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.486 V18.0.0 V2X Application Enabler (VAE) Services + description: 3GPP TS 29.486 V18.1.0 V2X Application Enabler (VAE) Services url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.486/' security: @@ -268,7 +268,7 @@ components: requestTestNotification: type: boolean description: > - Set to true by the NF service consumer to request the VAE server to send a test + Set to true by the service consumer to request the VAE server to send a test notification as defined in clause 6.3.5.3. Set to false or omitted otherwise. websockNotifConfig: $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' diff --git a/TS29486_VAE_V2PApplicationRequirement.yaml b/TS29486_VAE_V2PApplicationRequirement.yaml new file mode 100644 index 00000000..7aac57ff --- /dev/null +++ b/TS29486_VAE_V2PApplicationRequirement.yaml @@ -0,0 +1,306 @@ +openapi: 3.0.0 + +info: + version: 1.1.0-alpha.1 + title: VAE Server V2P Application Requirement Service + description: | + API for VAE Server V2P Application Requirement Service + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.486 V18.1.0 V2X Application Enabler (VAE) Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.486/' + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/vae-v2P-app-req/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + /provisionings: + post: + summary: Request the creation of a V2P Application Requirements Provisioning. + tags: + - V2P Application Requirements Provisionings collection (Collection) + operationId: CreateV2PAppReqsProv + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V2pAppReqData' + required: true + responses: + '201': + description: > + Created. The V2P Application Requirements Provisioning is successfully created and a + representation of the created Individual V2P Application Requirements Provisioning + resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/V2pAppReqData' + headers: + Location: + description: > + Contains the URI of the created Individual V2P Application Requirements + Provisioning resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /provisionings/{provId}: + parameters: + - name: provId + in: path + description: > + Represents the identifier of the Individual V2P Application Requirements Provisioning + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual V2P Application Requirement Provisioning resource. + operationId: GetIndV2pAppReqsProv + tags: + - Individual V2P Application Requirements Provisioning (Document) + responses: + '200': + description: > + OK. The requested Individual V2P Application Requirements Provisioning resource + representation shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/V2pAppReqData' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Request the update of an existing Individual V2P Application Requirements Provisioning resource. + operationId: UpdateIndV2pAppReqsProv + tags: + - Individual V2P Application Requirements Provisioning (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/V2pAppReqData' + responses: + '200': + description: > + OK. The Individual V2P Application Requirements Provisioning resource is successfully + updated and a representation of the updated resource shall be returned in the response + body. + content: + application/json: + schema: + $ref: '#/components/schemas/V2pAppReqData' + '204': + description: > + No Content. The Individual V2P Application Requirements Provisioning resource is + successfully updated and no content is returned in the response body + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Request the modification of an existing Individual V2P Application Requirements Provisioning resource. + operationId: ModifyIndV2pAppReqsProv + tags: + - Individual V2P Application Requirements Provisioning (Document) + requestBody: + description: Parameters to modify the existing configuration. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/V2pAppReqDataPatch' + responses: + '200': + description: > + OK. The Individual V2P Application Requirements Provisioning resource is successfully + modified and a representation of the updated resource shall be returned in the response + body. + content: + application/json: + schema: + $ref: '#/components/schemas/V2pAppReqData' + '204': + description: > + No Content. The Individual V2P Application Requirements Provisioning resource is + successfully modified and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Request the deletion of an existing Individual V2P Application Requirements Provisioning resource. + operationId: DeleteIndV2pAppReqsProv + tags: + - Individual V2P Application Requirements Provisioning (Document) + responses: + '204': + description: > + No Content. The Individual V2P Application Requirements Provisioning resource is + successfully deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + V2pAppReqData: + description: Represents the V2P Application Requirements Provisioning. + type: object + properties: + requestorId: + type: string + serviceId: + $ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xServiceId' + groupId: + $ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xGroupId' + v2pQosReqs: + $ref: 'TS29486_VAE_VRUZoneManagement.yaml#/components/schemas/AppReqs' + appTrafficPattern: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + paramOverPc5: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverPc5' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oneOf: + - required: [serviceId] + - required: [groupId] + required: + - requestorId + - v2pQosReqs + - appTrafficPattern + + V2pAppReqDataPatch: + description: > + Represents the requested modifications to a V2P Application Requirements Provisioning. + type: object + properties: + v2pQosReqs: + $ref: 'TS29486_VAE_VRUZoneManagement.yaml#/components/schemas/AppReqs' + appTrafficPattern: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + paramOverPc5: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverPc5Rm' diff --git a/TS29486_VAE_VRUZoneManagement.yaml b/TS29486_VAE_VRUZoneManagement.yaml new file mode 100644 index 00000000..00aca1cf --- /dev/null +++ b/TS29486_VAE_VRUZoneManagement.yaml @@ -0,0 +1,511 @@ +openapi: 3.0.0 + +info: + title: VAE Server VRU Zone Management Service + version: 1.0.0-alpha.1 + description: | + VAE Server VRU Zone Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.486 V18.1.0 V2X Application Enabler (VAE) Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.486/' + +servers: + - url: '{apiRoot}/vae-vzm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /subscriptions: + post: + summary: Request the creation of a VRU Zone Management Subscription. + operationId: CreateVRUZoneMngtSubsc + tags: + - VRU Zone Management Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VRUZoneMngtSubsc' + responses: + '201': + description: > + Created. The VRU Zone Management Subscription is successfully created and a + representation of the created Individual VRU Zone Management Subscription resource + shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/VRUZoneMngtSubsc' + headers: + Location: + description: > + Contains the URI of the created Individual VRU Zone Management Subscription + resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + EnterLeaveNotif: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EnterLeaveNotif' + responses: + '204': + description: > + No Content. The VRU Zone Management Enter/Leave notification is successfully + received and acknowledged and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /subscriptions/{subscriptionId}: + parameters: + - name: subscriptionId + in: path + description: > + Represents the identifier of the Individual VRU Zone Management Subscription + resource. + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual VRU Zone Management Subscription resource. + operationId: GetIndVRUZoneMngtSubsc + tags: + - Individual VRU Zone Management Subscription (Document) + responses: + '200': + description: > + OK. The requested Individual VRU Zone Management Subscription resource shall be + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/VRUZoneMngtSubsc' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Request the update of an existing Individual VRU Zone Management Subscription resource. + operationId: UpdateIndVRUZoneMngtSubsc + tags: + - Individual VRU Zone Management Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VRUZoneMngtSubsc' + responses: + '200': + description: > + OK. The Individual VRU Zone Management Subscription resource is successfully updated + and a representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/VRUZoneMngtSubsc' + '204': + description: > + No Content. The Individual VRU Zone Management Subscription resource is successfully + updated and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Request the modification of an existing Individual VRU Zone Management Subscription resource. + operationId: ModifyIndVRUZoneMngtSubsc + tags: + - Individual VRU Zone Management Subscription (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/VRUZoneMngtSubscPatch' + responses: + '200': + description: > + OK. The Individual VRU Zone Management Subscription resource is successfully modified + and a representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/VRUZoneMngtSubsc' + '204': + description: > + No Content. The Individual VRU Zone Management Subscription resource is successfully + modified and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Request the deletion of an existing Individual VRU Zone Management Subscription resource. + operationId: DeleteIndVRUZoneMngtSubsc + tags: + - Individual VRU Zone Management Subscription (Document) + responses: + '204': + description: > + No Content. The Individual VRU Zone Management Subscription resource is successfully + deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + VRUZoneMngtSubsc: + description: > + Represents a VRU Zone Management Subscription. + type: object + properties: + requestorId: + type: string + ueIdsList: + type: array + items: + $ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xUeId' + minItems: 1 + vruZoneInfo: + $ref: '#/components/schemas/VRUZoneInfo' + vruAppReqs: + $ref: '#/components/schemas/AppReqs' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + vruZoneId: + type: string + areaOfInterest: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + timeValidity: + $ref: '#/components/schemas/TimeValidity' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - requestorId + - notifUri + - vruZoneInfo + - vruAppReqs + + VRUZoneMngtSubscPatch: + description: > + Represents the requested modifications to a VRU Zone Management Subscription. + type: object + properties: + vruZoneInfo: + $ref: '#/components/schemas/VRUZoneInfo' + vruAppReqs: + $ref: '#/components/schemas/AppReqs' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + areaOfInterest: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + timeValidity: + $ref: '#/components/schemas/TimeValidity' + + EnterLeaveNotif: + description: > + Represents a VRU Zone Management Enter/LeaveNotification. + type: object + properties: + groupId: + $ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xGroupId' + ueId: + $ref: 'TS29486_VAE_MessageDelivery.yaml#/components/schemas/V2xUeId' + vruZoneInfo: + $ref: '#/components/schemas/VRUZoneInfo' + vruZoneId: + type: string + enterLeaveInfo: + $ref: '#/components/schemas/EnterLeaveInfo' + mobilityInfo: + $ref: '#/components/schemas/MobilityInfo' + required: + - vruZoneInfo + - vruZoneId + - enterLeaveInfo + oneOf: + - required: [groupId] + - required: [ueId] + + VRUZoneInfo: + description: > + Represents VRU zone related information. + type: object + properties: + ueTypes: + type: array + items: + $ref: '#/components/schemas/UEType' + minItems: 1 + vruZoneType: + $ref: '#/components/schemas/VRUZoneType' + required: + - typeOfUes + - vruZoneType + + AppReqs: + description: > + Represents VRU application requirements. + type: object + properties: + supportedMsgs: + type: array + items: + $ref: '#/components/schemas/MsgType' + minItems: 1 + reliability: + format: float + type: number + minimum: 0 + maximum: 100 + delay: + type: integer + minimum: 1 + jitter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + anyOf: + - required: [reliability] + - required: [delay] + - required: [jitter] + + TimeValidity: + description: > + Represents the time validity information. + type: object + properties: + startTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + anyOf: + - required: [startTime] + - required: [endTime] + + EnterLeaveInfo: + description: > + Represents the information related to V2X UE(s) entering/leaving a VRU zone. + type: object + properties: + time: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + duration: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + required: + - time + + MobilityInfo: + description: > + Represents mobility information. + type: object + properties: + speed: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + direction: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/Direction' + anyOf: + - required: [speed] + - required: [direction] + + UEType: + anyOf: + - type: string + enum: + - V2X + - PEDESTRIAN + - 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 UE(s) to be considered. + Possible values are: + - V2X: Indicates V2X UE(s). + - PEDESTRIAN: Indicates pedestrian UE(s). + + VRUZoneType: + anyOf: + - type: string + enum: + - STATIC + - DYNAMIC + - 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 VRU zone type. + Possible values are: + - STATIC: Indicates that the VRU zone is static. + - DYNAMIC: Indicates that the VRU zone is dynamic. + + MsgType: + anyOf: + - type: string + enum: + - VAM + - CAM + - DENM + - BSM + - CPM + - 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 message type. + Possible values are: + - VAM: Indicates that the type of message is VAM. + - CAM: Indicates that the type of message is CAM. + - DENM: Indicates that the type of message is DENM. + - BSM: Indicates that the type of message is BSM. + - CPM: Indicates that the type of message is CPM. diff --git a/TS29500_CustomHeaders.abnf b/TS29500_CustomHeaders.abnf index 51e3a5e2..517436d6 100644 --- a/TS29500_CustomHeaders.abnf +++ b/TS29500_CustomHeaders.abnf @@ -191,7 +191,6 @@ qdtext = HTAB / SP / %x21 / %x23-5B / %x5D-7E / obs-text obs-text = %x80-FF - date1 = day-rfc9110 SP month-rfc9110 SP year-rfc9110 ; e.g., 02 Jun 1982 day-rfc9110 = 2DIGIT @@ -219,27 +218,25 @@ weight = OWS ";" OWS "q=" qvalue qvalue = ( "0" [ "." *3DIGIT ] ) / ( "1" [ "." *3"0" ] ) +credentials = auth-scheme [ 1*SP ( token68 + / [ ( "," / auth-param ) *( OWS "," [ OWS auth-param ] ) ] ) ] -credentials = auth-scheme [ 1*SP ( token68 - / [ ( "," / auth-param ) *( OWS "," [ OWS auth-param ] ) ] ) ] - -auth-scheme = token +auth-scheme = token -auth-param = token BWS "=" BWS ( token / quoted-string ) +auth-param = token BWS "=" BWS ( token / quoted-string ) -token68 = 1*( ALPHA / DIGIT / "-" / "." / "_" / "~" / "+" / "/" ) *"=" +token68 = 1*( ALPHA / DIGIT / "-" / "." / "_" / "~" / "+" / "/" ) *"=" ; ---------------------------------------- ; 3GPP TS 29.500 ; -; Version: 18.3.0 (September 2023) +; Version: 18.4.0 (December 2023) ; ; (c) 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). ; ---------------------------------------- - ; ; Header: 3gpp-Sbi-Message-Priority ; @@ -376,17 +373,17 @@ olcMetric = "Overload-Reduction-Metric:" RWS ( "100" / %x31-39 DIGIT / DIG olcScope = nfProducerScope / nfConsumerScope / scpScope / seppScope -nfProducerScope = ( ( "NF-Instance:" RWS nfinst ) - / ( "NF-Set:" RWS nfset ) - / ( "NF-Service-Instance:" RWS nfservinst [ ";" RWS "NF-Inst:" RWS nfinst ] ) - / ( "NF-Service-Set:" RWS nfserviceset ) +nfProducerScope = ( ( "NF-Instance:" RWS nfinst ) + / ( "NF-Set:" RWS nfset ) + / ( "NF-Service-Instance:" RWS nfservinst [ ";" RWS "NF-Inst:" RWS nfinst ] ) + / ( "NF-Service-Set:" RWS nfserviceset ) ) [ ";" RWS sNssaiList ";" RWS dnnList ] nfConsumerScope = ( "NFC-Instance:" RWS nfinst [ ";" RWS "Service-Name:" RWS servname ] ) - / ( "NFC-Set:" RWS nfset [ ";" RWS "Service-Name:" RWS servname ]) + / ( "NFC-Set:" RWS nfset [ ";" RWS "Service-Name:" RWS servname ] ) / ( "NFC-Service-Instance:" RWS nfservinst [";" RWS "NF-Inst:" RWS nfinst ] ) / ( "NFC-Service-Set:" RWS nfserviceset ) - / ( "Callback-Uri:" RWS DQUOTE URI DQUOTE *( RWS "&" RWS DQUOTE URI DQUOTE )) + / ( "Callback-Uri:" RWS DQUOTE URI DQUOTE *( RWS "&" RWS DQUOTE URI DQUOTE ) ) servname = token @@ -416,10 +413,10 @@ lcMetric = "Load-Metric:" RWS ( "100" / %x31-39 DIGIT / DIGIT ) "%" lcScope = lcNfProducerScope / scpScope / seppScope -lcNfProducerScope = ( ( "NF-Instance:" RWS nfinst ) - / ( "NF-Set:" RWS nfset) - / ( "NF-Service-Instance:" RWS nfservinst [ ";" RWS "NF-Inst:" RWS nfinst ] ) - / ( "NF-Service-Set:" RWS nfserviceset) +lcNfProducerScope = ( ( "NF-Instance:" RWS nfinst ) + / ( "NF-Set:" RWS nfset ) + / ( "NF-Service-Instance:" RWS nfservinst [ ";" RWS "NF-Inst:" RWS nfinst ] ) + / ( "NF-Service-Set:" RWS nfserviceset ) ) [ ";" RWS sNssaiList ";" RWS dnnList ";" RWS relativeCapacity ] relativeCapacity = "Relative-Capacity:" RWS ( "100" / 1*2DIGIT ) "%" @@ -643,7 +640,7 @@ consumer-info-element = ( supportedService ";" OWS supportedVersions supportedService = "service=" servicename -servicename = 1*( "-" / %x61-7A ) +servicename = 1*( "-" / %x30-39 / %x41-5A / "_" / %x61-7A ) supportedVersions = "apiversion=" "(" OWS [ apimajorversion *( RWS apimajorversion ) OWS ] ")" @@ -699,6 +696,7 @@ Sbi-Selection-Info-Header = "3gpp-Sbi-Selection-Info:" OWS selection-info-element = ( "reselection=" reselectionvalue *( ";" OWS selection-criteria ) ) / ( selection-criteria *( ";" OWS selection-criteria ) ) + reselectionvalue = "true" / "false" selection-criteria = selection-action "=" token @@ -760,4 +758,3 @@ req-param-value = token Sbi-Retry-Info-Header = "3gpp-Sbi-Retry-Info:" OWS retriesindication OWS retriesindication = "no-retries" - diff --git a/TS29502_CustomHeaders.abnf b/TS29502_CustomHeaders.abnf index cfff8dff..bccb796c 100644 --- a/TS29502_CustomHeaders.abnf +++ b/TS29502_CustomHeaders.abnf @@ -11,17 +11,12 @@ DIGIT = %x30-39 ; 0-9 ; ---------------------------------------- -; RFC 7230 +; RFC 9110 ; ---------------------------------------- OWS = *( SP / HTAB ) - -; ---------------------------------------- -; RFC 7231 -; ---------------------------------------- - date1 = day SP month SP year ; e.g., 02 Jun 1982 day = 2DIGIT @@ -62,7 +57,7 @@ second = 2DIGIT ; ---------------------------------------- ; 3GPP TS 29.502 ; -; Version: 18.4.0 (September 2023) +; Version: 18.5.0 (December 2023) ; ; (c) 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). ; ---------------------------------------- diff --git a/TS29502_Nsmf_PDUSession.yaml b/TS29502_Nsmf_PDUSession.yaml index 632425e2..3624c492 100644 --- a/TS29502_Nsmf_PDUSession.yaml +++ b/TS29502_Nsmf_PDUSession.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.3.0-alpha.5' + version: '1.3.0-alpha.6' title: 'Nsmf_PDUSession' description: | SMF PDU Session Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.502 V18.4.0; 5G System; Session Management Services; Stage 3 + description: 3GPP TS 29.502 V18.5.0; 5G System; Session Management Services; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.502/ servers: @@ -819,7 +819,7 @@ paths: schema: type: string requestBody: - description: representation of the payload of Send MO Data Request + description: representation of the content of Send MO Data Request required: true content: multipart/related: # message with a binary body part @@ -1089,7 +1089,7 @@ paths: - Individual PDU session (V-SMF) operationId: TransferMtData requestBody: - description: representation of the payload of Transfer MT Data Request + description: representation of the content of Transfer MT Data Request required: true content: multipart/related: # message with a binary body part @@ -1156,7 +1156,7 @@ paths: - Individual PDU session (I-SMF) operationId: TransferMtData-ismf requestBody: - description: representation of the payload of Transfer MT Data Request + description: representation of the content of Transfer MT Data Request required: true content: multipart/related: # message with a binary body part @@ -1581,7 +1581,7 @@ paths: schema: type: string requestBody: - description: representation of the payload of the Retrieve Request + description: representation of the content of the Retrieve Request required: true content: application/json: @@ -1639,7 +1639,7 @@ paths: schema: type: string requestBody: - description: representation of the payload of Transfer MO Data Request + description: representation of the content of Transfer MO Data Request required: true content: multipart/related: # message with a binary body part @@ -1715,6 +1715,8 @@ components: unauthenticatedSupi: type: boolean default: false + roamingUeInd: + type: boolean pei: $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' gpsi: @@ -1946,8 +1948,6 @@ components: upipSupported: type: boolean default: false - uavAuthenticated: - type: boolean disasterRoamingInd: type: boolean default: false @@ -1960,6 +1960,12 @@ components: hrsboAllowedInd: type: boolean default: false + estabRejectionInd: + type: boolean + enum: + - true + estabRejectionCause: + $ref: '#/components/schemas/EstablishmentRejectionCause' required: - servingNfId - servingNetwork @@ -2319,6 +2325,8 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' interPlmnApiRoot: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' required: - statusInfo @@ -2426,6 +2434,8 @@ components: 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: @@ -2453,9 +2463,6 @@ components: maNwUpgradeInd: type: boolean default: false - n3gPathSwitchSupportInd: - type: boolean - default: false dnaiList: type: array items: @@ -2507,6 +2514,14 @@ components: 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 required: - dnn - servingNetwork @@ -2595,12 +2610,11 @@ components: maAcceptedInd: type: boolean default: false - n3gPathSwitchSupportInd: - 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 @@ -2823,6 +2837,17 @@ components: $ref: '#/components/schemas/HrsboInfoFromVplmn' altSnssai: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + disasterRoamingInd: + type: boolean + enum: + - true + pduSetSupportInd: + type: boolean + ecnMarkingCongestionInfoStatus: + type: array + items: + $ref: '#/components/schemas/EcnMarkingCongestionInfoStatus' + minItems: 1 required: - requestIndication @@ -2850,6 +2875,8 @@ components: 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: @@ -3108,6 +3135,11 @@ components: $ref: '#/components/schemas/N4Information' modifiedEbiListNotDelivered: type: boolean + ecnMarkingCongestionInfoStatus: + type: array + items: + $ref: '#/components/schemas/EcnMarkingCongestionInfoStatus' + minItems: 1 StatusNotification: description: Data within Notify Status Request @@ -3171,6 +3203,8 @@ components: $ref: '#/components/schemas/QosFlowAccessType' defaultQosRuleInd: type: boolean + ecnMarkingCongestInfoReq: + $ref: '#/components/schemas/EcnMarkingCongestInfoReq' required: - qfi - qosRules @@ -3191,6 +3225,12 @@ components: $ref: '#/components/schemas/QosFlowProfile' associatedAnType: $ref: '#/components/schemas/QosFlowAccessType' + ecnMarkingCongestInfoReq: + $ref: '#/components/schemas/EcnMarkingCongestInfoReq' + tscaiUl: + $ref: '#/components/schemas/TscAssistanceInformation' + tscaiDl: + $ref: '#/components/schemas/TscAssistanceInformation' required: - qfi @@ -3229,6 +3269,8 @@ components: $ref: '#/components/schemas/QosMonitoringReq' qosRepPeriod: $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + pduSetQosPara: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' required: - 5qi @@ -3300,6 +3342,11 @@ components: 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 @@ -3628,6 +3675,8 @@ components: 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: @@ -3668,9 +3717,6 @@ components: type: boolean n9fscSupportInd: type: boolean - disasterRoamingInd: - type: boolean - default: false anchorSmfOauth2Required: type: boolean fullDnaiList: @@ -3684,13 +3730,29 @@ components: $ref: '#/components/schemas/IpAddress' hPlmnAddr: $ref: '#/components/schemas/IpAddress' - vplmnOffloadingInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnOffloadingInfo' + vplmnOffloadingInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnOffloadingInfo' + minItems: 1 + offloadIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OffloadIdentifier' + minItems: 1 + easIpReplacementInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EasIpReplacementInfo' + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' pendingUpdateInfoList: type: array items: $ref: '#/components/schemas/PendingUpdateInfo' minItems: 1 + easInfoToRefresh: + $ref: '#/components/schemas/EasInfoToRefresh' + pduSetSupportInd: + type: boolean required: - pduSessionId - dnn @@ -3965,6 +4027,10 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' packetErrRate: $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + maxDataBurstVol: + type: integer + minimum: 1 + maximum: 2000000 required: - index @@ -4101,6 +4167,13 @@ components: type: boolean enum: - true + easInfoToRefresh: + $ref: '#/components/schemas/EasInfoToRefresh' + storedOffloadIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OffloadIdentifier' + minItems: 1 HrsboInfoFromHplmn: description: HR-SBO Information in response message @@ -4112,13 +4185,85 @@ components: $ref: '#/components/schemas/IpAddress' hPlmnAddr: $ref: '#/components/schemas/IpAddress' - vplmnOffloadingInfo: - $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnOffloadingInfo' + vplmnOffloadingInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnOffloadingInfo' + offloadIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OffloadIdentifier' internalGroupIds: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' minItems: 1 + easIpReplacementInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EasIpReplacementInfo' + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + + 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 + + EcnMarkingCongestInfoReq: + description: ECN Marking or Congestion Information Request + type: object + properties: + ecnMarkingReq: + $ref: '#/components/schemas/EcnMarkingReq' + congestionInfoReq: + $ref: '#/components/schemas/CongestionInfoReq' + oneOf: + - required: [ ecnMarkingReq ] + - 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' # # SIMPLE DATA TYPES @@ -4351,6 +4496,7 @@ components: - 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 - type: string description: > This string provides forward-compatibility with future @@ -4415,6 +4561,7 @@ components: - 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 ResourceStatus: anyOf: @@ -4778,6 +4925,76 @@ components: - 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 + # # HTTP request bodies # @@ -5080,7 +5297,7 @@ components: schema: $ref: '#/components/schemas/ExtProblemDetails' '413': - description: Payload Too Large + description: Content Too Large content: application/problem+json: schema: diff --git a/TS29503_Nudm_EE.yaml b/TS29503_Nudm_EE.yaml index f1de4b0f..329ec57d 100644 --- a/TS29503_Nudm_EE.yaml +++ b/TS29503_Nudm_EE.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.3.0-alpha.4' + version: '1.3.0-alpha.5' title: 'Nudm_EE' description: | Nudm Event Exposure Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.503 Unified Data Management Services, version 18.3.0 + description: 3GPP TS 29.503 Unified Data Management Services, version 18.4.0 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' servers: @@ -70,7 +70,11 @@ paths: '401': $ref: 'TS29571_CommonData.yaml#/components/responses/401' '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/EeSubscriptionError' '404': description: Not Found content: @@ -88,7 +92,11 @@ paths: '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '501': - $ref: 'TS29571_CommonData.yaml#/components/responses/501' + description: Not Implemented + content: + application/problem+json: + schema: + $ref: '#/components/schemas/EeSubscriptionError' '502': $ref: 'TS29571_CommonData.yaml#/components/responses/502' '503': @@ -637,12 +645,15 @@ components: - newServingPlmn properties: roaming: - type: - boolean + type: boolean newServingPlmn: $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' accessType: $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + purged: + type: boolean + enum: + - true CnTypeChangeReport: type: object @@ -818,6 +829,24 @@ components: properties: subType: $ref: '#/components/schemas/SubscriptionType' + failedMonitoringConfigs: + description: > + A map (list of key-value pairs where referenceId converted from integer to string serves + as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration + type: object + additionalProperties: + $ref: '#/components/schemas/FailedMonitoringConfiguration' + minProperties: 1 + failedMoniConfigsEPC: + description: > + A map (list of key-value pairs where referenceId converted from integer to string serves + as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration, the key value "ALL" may + be used to identify a map entry which contains the failed cause of the EE subscription + was not successful in EPC domain. + type: object + additionalProperties: + $ref: '#/components/schemas/FailedMonitoringConfiguration' + minProperties: 1 EeSubscriptionError: description: EE Subscription Error. diff --git a/TS29503_Nudm_PP.yaml b/TS29503_Nudm_PP.yaml index 3f46d61f..2aae6770 100644 --- a/TS29503_Nudm_PP.yaml +++ b/TS29503_Nudm_PP.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.3.0-alpha.3' + version: '1.3.0-alpha.4' title: 'Nudm_PP' description: | Nudm Parameter Provision Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.503 Unified Data Management Services, version 18.3.0 + description: 3GPP TS 29.503 Unified Data Management Services, version 18.4.0 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' servers: @@ -194,7 +194,7 @@ paths: content: application/merge-patch+json: schema: - $ref: '#/components/schemas/5GVnGroupConfiguration' + $ref: '#/components/schemas/5GVnGroupConfigurationModification' required: true responses: '204': @@ -753,6 +753,35 @@ components: $ref: '#/components/schemas/GpsiInfo' minProperties: 1 + 5GVnGroupConfigurationModification: + description: > + Contains the attributes to modify on the 5GVnGroupConfiguration data structure; + the attributes to be deleted need to be set to the null value. + type: object + properties: + 5gVnGroupData: + $ref: '#/components/schemas/5GVnGroupDataModification' + afInstanceId: + type: string + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + members: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + nullable: true + membersData: + description: > + Contains the list of 5G VN Group members, each member is identified by GPSI. + A map (list of key-value pairs where Gpsi serves as key) of GpsiInfo. + The value in each entries of the map shall be an empty JSON object. + type: object + additionalProperties: + $ref: '#/components/schemas/GpsiInfo' + minProperties: 1 + nullable: true + 5GVnGroupData: type: object required: @@ -791,6 +820,46 @@ components: maxGroupDataRate: $ref: '#/components/schemas/MaxGroupDataRate' + 5GVnGroupDataModification: + description: > + Contains the attributes to modify on the 5GVnGroupData data structure; + the attributes to be deleted need to be set to the null value. + type: object + properties: + appDescriptors: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/AppDescriptor' + minItems: 1 + nullable: true + secondaryAuth: + type: boolean + nullable: true + dnAaaIpAddressAllocation: + type: boolean + nullable: true + dnAaaAddress: + type: object + nullable: true + allOf: + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' + additionalDnAaaAddresses: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' + minItems: 1 + nullable: true + dnAaaFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnRm' + 5gVnGroupCommunicationInd: + type: boolean + nullable: true + maxGroupDataRate: + type: object + nullable: true + allOf: + - $ref: '#/components/schemas/MaxGroupDataRate' + nullable: true ExpectedUeBehaviour: type: object @@ -1106,9 +1175,10 @@ components: defQos: $ref: '#/components/schemas/AfReqDefaultQoS' afReqServArea: - $ref: 'TS29571_CommonData.yaml#/components/schemas/GeoServiceArea' - groupMbr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 nullable: true AfReqDefaultQoS: diff --git a/TS29503_Nudm_SDM.yaml b/TS29503_Nudm_SDM.yaml index 4241b310..a2ae93ca 100644 --- a/TS29503_Nudm_SDM.yaml +++ b/TS29503_Nudm_SDM.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '2.3.0-alpha.4' + version: '2.3.0-alpha.5' title: 'Nudm_SDM' description: | Nudm Subscriber Data Management Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.503 Unified Data Management Services, version 18.3.0 + description: 3GPP TS 29.503 Unified Data Management Services, version 18.4.0 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' servers: @@ -63,13 +63,13 @@ paths: - name: adjacent-plmns in: query description: List of PLMNs adjacent to the UE's serving PLMN - schema: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' - minItems: 1 - style: form - explode: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 - name: single-nssai in: query content: @@ -99,12 +99,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -116,15 +116,15 @@ paths: $ref: '#/components/schemas/SubscriptionDataSets' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -188,12 +188,12 @@ paths: default: false - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -205,15 +205,15 @@ paths: $ref: '#/components/schemas/Nssai' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -323,13 +323,13 @@ paths: - name: adjacent-plmns in: query description: List of PLMNs adjacent to the UE's serving PLMN - schema: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' - minItems: 1 - style: form - explode: false + 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 @@ -350,12 +350,12 @@ paths: explode: false - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -367,15 +367,15 @@ paths: $ref: '#/components/schemas/AccessAndMobilitySubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -425,12 +425,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -442,15 +442,15 @@ paths: $ref: '#/components/schemas/EnhancedCoverageRestrictionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -514,12 +514,12 @@ paths: default: false - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -531,15 +531,15 @@ paths: $ref: '#/components/schemas/SmfSelectionSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -700,12 +700,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -717,15 +717,15 @@ paths: $ref: '#/components/schemas/TraceDataResponse' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -798,12 +798,12 @@ paths: default: false - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -815,15 +815,15 @@ paths: $ref: '#/components/schemas/SmSubsData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -879,12 +879,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -896,15 +896,15 @@ paths: $ref: '#/components/schemas/SmsSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -960,12 +960,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -977,15 +977,15 @@ paths: $ref: '#/components/schemas/SmsManagementSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -1035,12 +1035,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -1052,15 +1052,15 @@ paths: $ref: '#/components/schemas/LcsPrivacyData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -1111,12 +1111,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -1128,15 +1128,15 @@ paths: $ref: '#/components/schemas/LcsMoData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -1192,12 +1192,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -1209,15 +1209,15 @@ paths: $ref: '#/components/schemas/LcsBroadcastAssistanceTypesData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -1268,12 +1268,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -1285,15 +1285,15 @@ paths: $ref: '#/components/schemas/LcsSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -1344,12 +1344,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -1361,15 +1361,15 @@ paths: $ref: '#/components/schemas/V2xSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -1420,12 +1420,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -1437,15 +1437,15 @@ paths: $ref: '#/components/schemas/ProseSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -1496,12 +1496,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -1513,15 +1513,15 @@ paths: $ref: '#/components/schemas/MbsSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -1577,12 +1577,12 @@ paths: $ref: '#/components/schemas/UcPurpose' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -1594,15 +1594,15 @@ paths: $ref: '#/components/schemas/UcSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -1942,12 +1942,12 @@ paths: $ref: '#/components/schemas/GpsiType' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -1959,15 +1959,15 @@ paths: $ref: '#/components/schemas/IdTranslationResult' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -2273,12 +2273,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -2292,15 +2292,15 @@ paths: $ref: '#/components/schemas/SharedData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -2570,12 +2570,12 @@ paths: type: string - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -2587,15 +2587,15 @@ paths: $ref: '#/components/schemas/GroupIdentifiers' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -2646,12 +2646,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -2663,15 +2663,15 @@ paths: $ref: '#/components/schemas/SharedData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -2734,15 +2734,15 @@ paths: $ref: '#/components/schemas/UeIdentifiers' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -2781,12 +2781,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -2798,15 +2798,15 @@ paths: $ref: '#/components/schemas/TimeSyncSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -2857,12 +2857,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -2874,15 +2874,15 @@ paths: $ref: '#/components/schemas/RangingSlPosSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -2933,12 +2933,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: @@ -2950,15 +2950,15 @@ paths: $ref: '#/components/schemas/A2xSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 2.2 schema: type: string '400': @@ -3213,6 +3213,9 @@ components: default: false rgWirelineCharacteristics: $ref: 'TS29571_CommonData.yaml#/components/schemas/RgWirelineCharacteristics' + aun3DeviceConnectivityAllowed: + type: boolean + default: false ecRestrictionDataWb: $ref: '#/components/schemas/EcRestrictionDataWb' ecRestrictionDataNb: @@ -3286,6 +3289,38 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/QmcConfigInfo' mbsrOperationAllowed: $ref: '#/components/schemas/MbsrOperationAllowed' + ladnServiceAreas: + description: A map(list of key-value pairs where singleNssai serves as key) of DnnLadnServiceAreas + type: object + additionalProperties: + $ref: '#/components/schemas/DnnLadnServiceAreas' + + DnnLadnServiceAreas: + type: object + required: + - dnnLadnServiceAreas + properties: + dnnLadnServiceAreas: + type: array + items: + $ref: '#/components/schemas/DnnLadnServiceArea' + minItems: 1 + + DnnLadnServiceArea: + 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: type: object @@ -3473,11 +3508,6 @@ components: hrSboAllowed: type: boolean default: false - ladnServiceArea: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' - minItems: 1 Nssai: type: object @@ -4038,6 +4068,8 @@ components: $ref: '#/components/schemas/SorTransparentContainer' sorCmci: $ref: '#/components/schemas/SorCmci' + sorSnpnSi: + $ref: '#/components/schemas/SorSnpnSi' sorSnpnSiLs: $ref: '#/components/schemas/SorSnpnSiLs' storeSorCmciInMe: @@ -4235,7 +4267,7 @@ components: areaUsageInd: allOf: - $ref: '#/components/schemas/AreaUsageInd' - default: POSITIVE_SENSE + default: INSIDE_REPORTING upLocRepIndAf: allOf: - $ref: '#/components/schemas/UpLocRepIndAf' @@ -4630,7 +4662,7 @@ components: items: $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' minItems: 1 - mbsAssistanceInfo: + ueMbsAssistanceInfo: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' @@ -4704,13 +4736,44 @@ components: AfRequestAuthorization: description: AF Request Authorization type: object + properties: + gptpAllowedInfo: + $ref: '#/components/schemas/GptpAllowedInfo' + astiAllowedInfo: + $ref: '#/components/schemas/AstiAllowedInfo' + oneOf: + - required: [ gptpAllowedInfo ] + - 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' - gtptAllowed: + 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 + required: + - gptpAllowed + + AstiAllowedInfo: + description: AF authorization information for ASTI + type: object + properties: astiAllowed: type: boolean coverageArea: @@ -4725,6 +4788,8 @@ components: items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' minItems: 1 + required: + - astiAllowed TimeSyncServiceId: description: Time Synchronization Service ID @@ -4768,9 +4833,17 @@ components: AppSpecificExpectedUeBehaviourData: 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: @@ -4921,6 +4994,9 @@ components: SorCmci: $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + SorSnpnSi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + SorSnpnSiLs: $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' @@ -5263,12 +5339,13 @@ components: AreaUsageInd: description: > Indicates one of the mutually exclusive global settings - (if the event report allowed area can be used in opposite sense or positive sense). + (whether the UE is allowed to generate and send the reports inside or outside the event + report expected area). anyOf: - type: string enum: - - OPPOSITE_SENSE - - POSITIVE_SENSE + - INSIDE_REPORTING + - OUTSIDE_REPORTING - type: string description: > This string provides forward-compatibility with future diff --git a/TS29503_Nudm_UEAU.yaml b/TS29503_Nudm_UEAU.yaml index 814439c5..77c83211 100644 --- a/TS29503_Nudm_UEAU.yaml +++ b/TS29503_Nudm_UEAU.yaml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - version: '1.3.0-alpha.3' + version: '1.3.0-alpha.4' title: 'Nudm_UEAU' description: | UDM UE Authentication Service. @@ -8,7 +8,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.503 Unified Data Management Services, version 18.3.0 + description: 3GPP TS 29.503 Unified Data Management Services, version 18.4.0 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' servers: @@ -124,12 +124,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 3.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 3.3 schema: type: string responses: diff --git a/TS29503_Nudm_UECM.yaml b/TS29503_Nudm_UECM.yaml index 892be97f..5b3a36c6 100644 --- a/TS29503_Nudm_UECM.yaml +++ b/TS29503_Nudm_UECM.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.3.0-alpha.4' + version: '1.3.0-alpha.5' title: 'Nudm_UECM' description: | Nudm Context Management Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.503 Unified Data Management Services, version 18.3.0 + description: 3GPP TS 29.503 Unified Data Management Services, version 18.4.0 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' servers: @@ -223,6 +223,12 @@ paths: responses: '204': description: Successful Notification response + '200': + description: Successful Notification response with information to UDM + content: + application/json: + schema: + $ref: '#/components/schemas/DeregistrationRespData' '307': $ref: 'TS29571_CommonData.yaml#/components/responses/307' '308': @@ -1541,7 +1547,7 @@ paths: schema: type: string ETag: - description: Entity Tag, containing a strong validator, as described in IETF RFC 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, 2.3 schema: type: string '200': @@ -1552,14 +1558,14 @@ paths: $ref: '#/components/schemas/SmsfRegistration' headers: ETag: - description: Entity Tag, containing a strong validator, as described in IETF RFC 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, 2.3 schema: type: string '204': description: No content headers: ETag: - description: Entity Tag, containing a strong validator, as described in IETF RFC 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, 2.3 schema: type: string '400': @@ -1654,7 +1660,7 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' - name: If-Match in: header - description: Validator for conditional requests, as described in IETF RFC 7232, 3.1 + description: Validator for conditional requests, as described in IETF RFC 9110, 3.1 schema: type: string responses: @@ -1837,7 +1843,7 @@ paths: schema: type: string ETag: - description: Entity Tag, containing a strong validator, as described in IETF RFC 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, 2.3 schema: type: string '200': @@ -1848,14 +1854,14 @@ paths: $ref: '#/components/schemas/SmsfRegistration' headers: ETag: - description: Entity Tag, containing a strong validator, as described in IETF RFC 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, 2.3 schema: type: string '204': description: No content headers: ETag: - description: Entity Tag, containing a strong validator, as described in IETF RFC 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, 2.3 schema: type: string '400': @@ -1950,7 +1956,7 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' - name: If-Match in: header - description: Validator for conditional requests, as described in IETF RFC 7232, 3.1 + description: Validator for conditional requests, as described in IETF RFC 9110, 3.1 schema: type: string responses: @@ -3463,6 +3469,14 @@ components: supi: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + DeregistrationRespData: + type: object + properties: + smfEventRemovedInd: + type: boolean + enum: + - true + # SIMPLE TYPES: PurgeFlag: @@ -3519,6 +3533,7 @@ components: - DUPLICATE_PDU_SESSION - PDU_SESSION_REACTIVATION_REQUIRED - DISASTER_CONDITION_TERMINATED + - OPERATOR_DETERMINED_BARRING - type: string description: > This string provides forward-compatibility with future diff --git a/TS29504_CustomHeaders.abnf b/TS29504_CustomHeaders.abnf index bfe72385..81abb910 100644 --- a/TS29504_CustomHeaders.abnf +++ b/TS29504_CustomHeaders.abnf @@ -49,7 +49,7 @@ comment = "(" *( [ FWS ] ccontent ) [ FWS ] ")" ; ---------------------------------------- -; RFC 7230 +; RFC 9110 ; ---------------------------------------- OWS = *( SP / HTAB ) @@ -64,7 +64,7 @@ obs-text = %x80-FF ; ---------------------------------------- -; RFC 7232 +; RFC 9110 ; ---------------------------------------- entity-tag = [ weak ] opaque-tag diff --git a/TS29504_Nudr_DR.yaml b/TS29504_Nudr_DR.yaml index bdd42756..8080d2d0 100644 --- a/TS29504_Nudr_DR.yaml +++ b/TS29504_Nudr_DR.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 2.3.0-alpha.4 + version: 2.3.0-alpha.5 title: 'Nudr_DataRepository API OpenAPI file' description: | Unified Data Repository Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.504 V18.3.0; 5G System; Unified Data Repository Services; Stage 3 + description: 3GPP TS 29.504 V18.4.0; 5G System; Unified Data Repository Services; Stage 3 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.504/' servers: @@ -338,6 +338,8 @@ components: nudr-dr:policy-data:ues:operator-specific-data:create: Access to create the UEs operator specific policy data nudr-dr:policy-data:slice-control-data:read: Access to read Slice specific Policy Control Data nudr-dr:policy-data:slice-control-data:modify: Access to update Slice specific Policy Control Data + nudr-dr:policy-data:group-control-data:read: Access to read Group Control Data + nudr-dr:policy-data:group-control-data:modify: Access to update Group Control Data nudr-dr:exposure-data: Access to the ExposureData data set nudr-dr:exposure-data:access-and-mobility-data:create: Access to create ExposureData nudr-dr:exposure-data:access-and-mobility-data:read: Access to read ExposureData @@ -375,6 +377,13 @@ components: nudr-dr:application-data:eas-deploy-data:read: Access to read EAS Deployment Information Data nudr-dr:application-data:eas-deploy-data:create: Access to create EAS Deployment Information Data nudr-dr:application-data:eas-deploy-data:modify: Access to update EAS Deployment Information Data + nudr-dr:application-data:ecs-address-roaming:read: Access to read ECS Address Roaming Data + nudr-dr:application-data:ecs-address-roaming:create: Access to create ECS Address Roaming Data + nudr-dr:application-data:ecs-address-roaming:modify: Access to update ECS Address Roaming Data + nudr-dr:application-data:dnai-eas:read: Access to read DNAI-EAS Mapping Data + nudr-dr:application-data:af-qos-data-sets:read: Access to read AF Qos Data Sets + nudr-dr:application-data:af-qos-data-sets:create: Access to create AF Qos Data Sets + nudr-dr:application-data:af-qos-data-sets:modify: Access to update AF Qos Data Sets schemas: DataRestorationNotification: diff --git a/TS29504_Nudr_GroupIDmap.yaml b/TS29504_Nudr_GroupIDmap.yaml index 6c389385..3770ae3d 100644 --- a/TS29504_Nudr_GroupIDmap.yaml +++ b/TS29504_Nudr_GroupIDmap.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: 1.2.0-alpha.1 + version: 1.2.0-alpha.2 title: 'Nudr_GroupIDmap' description: | Unified Data Repository Service for NF-Group ID retrieval. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.504 V18.0.0; 5G System; Unified Data Repository Services; Stage 3 + description: 3GPP TS 29.504 V18.4.0; 5G System; Unified Data Repository Services; Stage 3 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.504/' servers: @@ -78,6 +78,52 @@ paths: default: description: Unexpected error + /routing-ids: + get: + summary: Retrieves Routing Indicators for the provided NF type and NF Group ID + operationId: GetRoutingIDs + tags: + - Routing IDs (Document) + parameters: + - name: nf-type + in: query + description: Type of NF + required: true + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + - name: nf-group-id + in: query + description: Identifier of the NF Group + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingIdResult' + '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: @@ -93,20 +139,34 @@ components: schemas: -# COMPLEX TYPES: +# STRUCTURED TYPES: NfGroupIdMapResult: - description: Contains the NFGroupIds for the requested NF types. The NFType is the key of the map. + description: > + Contains the NFGroupIds for the requested NF types. The NFType is the key of the map. type: object additionalProperties: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' minProperties: 1 + RoutingIdResult: + description: > + Contains the Routing Indicators for the requested NF type and NF Group ID. + type: object + properties: + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + # SIMPLE TYPES: SubscriberId: - description: Represents the Subscription Identifier SUPI or GPSI or IMPI or IMPU. + description: > + Represents the Subscription Identifier SUPI or GPSI or IMPI or IMPU, or Routing Indicator. type: string - pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|impi-.+|impu-.+|.+)$' + pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|impi-.+|impu-.+|rid-[0-9]{1,4}|.+)$' # ENUMS: diff --git a/TS29505_Subscription_Data.yaml b/TS29505_Subscription_Data.yaml index 61877149..9323872e 100644 --- a/TS29505_Subscription_Data.yaml +++ b/TS29505_Subscription_Data.yaml @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.505 V18.3.0; 5G System; Usage of the Unified Data Repository Service for subscription data; Stage 3 + description: 3GPP TS 29.505 V18.4.0; 5G System; Usage of the Unified Data Repository Service for subscription data; Stage 3 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.505/' paths: @@ -526,7 +526,9 @@ paths: /subscription-data/{ueId}/ue-update-confirmation-data/sor-data: put: - summary: To store the SoR acknowledgement information of a UE and ME support of SOR CMCI + summary: > + To store the SoR acknowledgement information of a UE, ME support of SOR CMCI, + and ME support of SOR-SNPN-SI and ME support of SOR-SNPN-SI-LS. operationId: CreateAuthenticationSoR tags: - Authentication SoR (Document) @@ -584,7 +586,9 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/responses/default' get: - summary: Retrieves the SoR acknowledgement information of a UE and ME support of SOR CMCI + summary: > + Retrieves the SoR acknowledgement information of a UE, ME support of SOR CMCI + ME support of SOR-SNPN-SI and ME support of SOR-SNPN-SI-LS operationId: QueryAuthSoR tags: - Authentication SoR (Document) @@ -636,7 +640,9 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/responses/default' patch: - summary: Updates the ME support of SOR CMCI information of a UE + summary: > + Updates the ME support of SOR CMCI ME support of SOR-SNPN-SI + and ME support of SOR-SNPN-SI-LS information of a UE operationId: UpdateAuthenticationSoR tags: - Authentication SoR (Document) @@ -1196,12 +1202,12 @@ paths: explode: false - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 13.1.29110, 13.1.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.39110, 13.1.3 schema: type: string responses: @@ -1213,15 +1219,15 @@ paths: $ref: '#/components/schemas/AccessAndMobilitySubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + description: Cache-Control containing max-age, as described in RFC 91119111, 5.2 schema: type: string ETag: - description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.39110, 8.8.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.29110, 8.8.2 schema: type: string '400': @@ -1289,12 +1295,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 13.1.29110, 13.1.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.39110, 13.1.3 schema: type: string responses: @@ -1306,15 +1312,15 @@ paths: $ref: '#/components/schemas/SmfSelectionSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + description: Cache-Control containing max-age, as described in RFC 91119111, 5.2 schema: type: string ETag: - description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.39110, 8.8.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.29110, 8.8.2 schema: type: string '400': @@ -1396,12 +1402,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 13.1.29110, 13.1.2 schema: type: string - name: If-Modified-Since in: header - description: Validator for conditional requests, as described in RFC 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.39110, 13.1.3 schema: type: string responses: @@ -1413,15 +1419,15 @@ paths: $ref: '#/components/schemas/SmSubsData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + description: Cache-Control containing max-age, as described in RFC 91119111, 5.2 schema: type: string ETag: - description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, 8.8.39110, 8.8.3 schema: type: string Last-Modified: - description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.29110, 8.8.2 schema: type: string '400': @@ -2260,12 +2266,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -2280,15 +2286,15 @@ paths: $ref: '#/components/schemas/OperatorSpecificDataContainer' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -3345,12 +3351,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -3362,15 +3368,15 @@ paths: $ref: '#/components/schemas/SmsManagementSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -3427,12 +3433,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -3444,15 +3450,15 @@ paths: $ref: '#/components/schemas/SmsSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -3503,12 +3509,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -3520,15 +3526,15 @@ paths: $ref: '#/components/schemas/PpData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -6043,12 +6049,12 @@ paths: parameters: - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string - name: sharedDataId @@ -6066,15 +6072,15 @@ paths: $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -6491,12 +6497,12 @@ paths: $ref: '#/components/schemas/VarPlmnId' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -6508,15 +6514,15 @@ paths: $ref: '#/components/schemas/TraceDataOrSharedTraceDataId' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -6569,12 +6575,12 @@ paths: $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/AppPortId' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -6586,15 +6592,15 @@ paths: $ref: '#/components/schemas/IdentityData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -7097,12 +7103,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -7114,15 +7120,15 @@ paths: $ref: '#/components/schemas/LcsPrivacyData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -7184,12 +7190,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -7201,15 +7207,15 @@ paths: $ref: '#/components/schemas/LcsSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -7271,12 +7277,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -7288,15 +7294,15 @@ paths: $ref: '#/components/schemas/LcsMoData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -7368,12 +7374,12 @@ paths: type: string - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -7385,15 +7391,15 @@ paths: $ref: '#/components/schemas/AuthorizationData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -7444,12 +7450,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -7461,15 +7467,15 @@ paths: $ref: '#/components/schemas/EnhancedCoverageRestrictionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -7573,12 +7579,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -7590,15 +7596,15 @@ paths: $ref: '#/components/schemas/V2xSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -7649,12 +7655,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -7666,15 +7672,15 @@ paths: $ref: '#/components/schemas/ProseSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -7724,12 +7730,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -7741,15 +7747,15 @@ paths: $ref: '#/components/schemas/LcsBroadcastAssistanceTypesData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -8123,12 +8129,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -8140,15 +8146,15 @@ paths: $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/MbsSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -8329,12 +8335,12 @@ paths: type: string - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -8346,15 +8352,15 @@ paths: $ref: '#/components/schemas/AuthorizationData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -9557,12 +9563,12 @@ paths: $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/UcPurpose' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -9574,15 +9580,15 @@ paths: $ref: '#/components/schemas/UcSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -9633,12 +9639,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -9650,15 +9656,15 @@ paths: $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/TimeSyncSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -10080,12 +10086,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -10097,15 +10103,15 @@ paths: $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/RangingSlPosSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -10156,12 +10162,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -10173,15 +10179,15 @@ paths: $ref: '#/components/schemas/A2xSubscriptionData' headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string '400': @@ -10667,6 +10673,12 @@ components: $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SorMac' meSupportOfSorCmci: type: boolean + meSupportOfSorSnpnSi: + type: boolean + default: false + meSupportOfSorSnpnSiLs: + type: boolean + default: false required: - provisioningTime - ueUpdateStatus diff --git a/TS29508_Nsmf_EventExposure.yaml b/TS29508_Nsmf_EventExposure.yaml index 80a08a16..7291766c 100644 --- a/TS29508_Nsmf_EventExposure.yaml +++ b/TS29508_Nsmf_EventExposure.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 1.3.0-alpha.4 + version: 1.3.0-alpha.5 title: Nsmf_EventExposure description: | Session Management Event Exposure Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.508 V18.3.0; 5G System; Session Management Event Exposure Service. + description: 3GPP TS 29.508 V18.4.0; 5G System; Session Management Event Exposure Service. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.508/ servers: @@ -413,6 +413,19 @@ components: $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 @@ -460,6 +473,8 @@ components: 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: @@ -529,6 +544,8 @@ components: 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: @@ -555,6 +572,11 @@ components: $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: @@ -640,13 +662,17 @@ components: items: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' minItems: 1 - ulConInfo: + ulCongInfo: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - dlConInfo: + dlCongInfo: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' cimf: type: boolean description: Represents the congestion information measurement failure indicator. + 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: @@ -684,6 +710,8 @@ components: 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 @@ -799,6 +827,38 @@ components: 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] + - anyOf: + - required: [easFqdn] + - required: [easIpAddr] + SmfEvent: anyOf: - type: string @@ -821,7 +881,7 @@ components: - UPF_INFO - UP_STATUS_INFO - SATB_CH - - 5QI_INFO + - TRAFFIC_CORRELATION - type: string description: > This string provides forward-compatibility with future @@ -849,7 +909,8 @@ components: - UPF_INFO: The UPF information, including the UPF ID/address/FQDN information. - UP_STATUS_INFO: The User Plane status information. - SATB_CH: Satellite backhaul category change. - - 5QI_INFO: Indicates that the event subscribed is related to 5QI. + - TRAFFIC_CORRELATION: Indicates that the SMF provides 5GC determined traffic correlation + information for a set of UEs identified by Traffic Correlation ID. NotificationMethod: anyOf: diff --git a/TS29509_Nausf_UEAuthentication.yaml b/TS29509_Nausf_UEAuthentication.yaml index 9f25a827..b00dd01f 100644 --- a/TS29509_Nausf_UEAuthentication.yaml +++ b/TS29509_Nausf_UEAuthentication.yaml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - version: 1.3.0-alpha.3 + version: 1.3.0-alpha.4 title: AUSF API description: | AUSF UE Authentication Service. @@ -8,7 +8,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.509 V18.2.0; 5G System; 3GPP TS Authentication Server services. + description: 3GPP TS 29.509 V18.3.0; 5G System; 3GPP TS Authentication Server services. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.509' servers: @@ -527,7 +527,7 @@ paths: $ref: '#/components/schemas/ProSeEapSession' responses: '200': - description: Use to handle or close the EAP session for 5G ProSe Remote UE + description: Use to handle or close the EAP session for 5G ProSe Remote UE or a 5G ProSe End UE content: application/json: schema: diff --git a/TS29510_Nnrf_AccessToken.yaml b/TS29510_Nnrf_AccessToken.yaml index 871c6094..793c4caf 100644 --- a/TS29510_Nnrf_AccessToken.yaml +++ b/TS29510_Nnrf_AccessToken.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: '1.2.1' + version: '1.3.0-alpha.1' title: 'NRF OAuth2' description: | NRF OAuth2 Authorization. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.510 V17.7.0; 5G System; Network Function Repository Services; Stage 3 + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' paths: @@ -22,12 +22,12 @@ paths: parameters: - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string requestBody: @@ -67,11 +67,11 @@ paths: Pragma: $ref: '#/components/headers/pragma' Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string '307': diff --git a/TS29510_Nnrf_Bootstrapping.yaml b/TS29510_Nnrf_Bootstrapping.yaml index 8afe0738..787238dd 100644 --- a/TS29510_Nnrf_Bootstrapping.yaml +++ b/TS29510_Nnrf_Bootstrapping.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: '1.1.0' + version: '1.2.0-alpha.1' title: 'NRF Bootstrapping' description: | NRF Bootstrapping. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.510 V17.6.0; 5G System; Network Function Repository Services; Stage 3 + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' paths: @@ -22,7 +22,7 @@ paths: parameters: - name: If-None-Match in: header - description: Validator for conditional requests, as described in IETF RFC 7232, 3.2 + description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.2 schema: type: string responses: @@ -34,11 +34,12 @@ paths: $ref: '#/components/schemas/BootstrappingInfo' headers: Cache-Control: - description: Cache-Control containing max-age, described in IETF RFC 7234, 5.2 + 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 7232, 2.3 + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 schema: type: string '307': diff --git a/TS29510_Nnrf_NFDiscovery.yaml b/TS29510_Nnrf_NFDiscovery.yaml index 22490d59..31b9261e 100644 --- a/TS29510_Nnrf_NFDiscovery.yaml +++ b/TS29510_Nnrf_NFDiscovery.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.3.0-alpha.5' + version: '1.3.0-alpha.6' title: 'NRF NFDiscovery Service' description: | NRF NFDiscovery Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.510 V18.4.0; 5G System; Network Function Repository Services; Stage 3 + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' servers: @@ -37,7 +37,7 @@ paths: parameters: - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string - name: target-nf-type @@ -140,6 +140,16 @@ paths: 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 @@ -440,7 +450,7 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/ComplexQuery' - name: max-payload-size in: query - description: Maximum payload size of the response expressed in kilo octets + description: Maximum content size of the response expressed in kilo octets required: false schema: type: integer @@ -449,7 +459,7 @@ paths: - name: max-payload-size-ext in: query description: > - Extended query for maximum payload size of the response expressed in kilo octets + Extended query for maximum content size of the response expressed in kilo octets required: false schema: type: integer @@ -513,7 +523,7 @@ paths: explode: false - name: If-None-Match in: header - description: Validator for conditional requests, as described in IETF RFC 7232, 3.2 + description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.2 schema: type: string - name: target-snpn @@ -1008,6 +1018,11 @@ paths: 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 @@ -1091,7 +1106,15 @@ paths: $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/A2xCapability' - name: ml-model-storage-ind in: query - description: Indicating the support for ML model storage capability. + 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: @@ -1125,13 +1148,29 @@ paths: type: boolean enum: - true - - name: rangingSlPos-support-ind + - 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 responses: '200': @@ -1157,15 +1196,16 @@ paths: 'searchId' parameter in the GET request to '/searches/{searchId}/complete' headers: Cache-Control: - description: Cache-Control containing max-age, described in IETF RFC 7234, 5.2 + 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 7232, 2.3 + 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 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -1228,7 +1268,7 @@ paths: - $ref: '#/components/parameters/searchId' - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string responses: @@ -1268,7 +1308,7 @@ paths: - $ref: '#/components/parameters/searchId' - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string responses: @@ -1321,7 +1361,7 @@ paths: default: false - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string responses: @@ -1333,7 +1373,7 @@ paths: $ref: '#/components/schemas/ScpDomainRoutingInformation' headers: Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -1387,12 +1427,12 @@ paths: parameters: - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string requestBody: @@ -1417,11 +1457,11 @@ paths: schema: type: string Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string '400': @@ -1455,11 +1495,11 @@ paths: parameters: - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string requestBody: - description: Notification Payload + description: Notification content content: application/json: schema: @@ -1469,7 +1509,7 @@ paths: description: Expected response to a successful callback processing headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string '400': @@ -1579,15 +1619,16 @@ components: $ref: '#/components/schemas/StoredSearchResult' headers: Cache-Control: - description: Cache-Control containing max-age, described in IETF RFC 7234, 5.2 + 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 7232, 2.3 + 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 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string @@ -1597,6 +1638,7 @@ components: description: Contains the list of NF Profiles returned in a Discovery response type: object required: + - validityPeriod - nfInstances properties: validityPeriod: @@ -2117,8 +2159,11 @@ components: minItems: 1 apiPrefix: type: string - callbackUriPrefix: - type: string + callbackUriPrefixList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/CallbackUriPrefixItem' + minItems: 1 defaultNotificationSubscriptions: type: array items: diff --git a/TS29510_Nnrf_NFManagement.yaml b/TS29510_Nnrf_NFManagement.yaml index 64695d2d..b92f9de5 100644 --- a/TS29510_Nnrf_NFManagement.yaml +++ b/TS29510_Nnrf_NFManagement.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.3.0-alpha.5' + version: '1.3.0-alpha.6' title: 'NRF NFManagement Service' description: | NRF NFManagement Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.510 V18.4.0; 5G System; Network Function Repository Services; Stage 3 + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' servers: @@ -74,7 +74,8 @@ paths: $ref: '#/components/schemas/UriList' headers: ETag: - description: Entity Tag containing a strong validator, described in IETF RFC 7232, 2.3 + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 schema: type: string '307': @@ -141,14 +142,14 @@ paths: $ref: '#/components/schemas/OptionsResponse' headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + 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 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -226,7 +227,8 @@ paths: description: Expected response to a valid request headers: ETag: - description: Entity Tag containing a strong validator, described in IETF RFC 7232, 2.3 + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 schema: type: string content: @@ -304,12 +306,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string requestBody: @@ -327,15 +329,16 @@ paths: $ref: '#/components/schemas/NFProfile' headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string ETag: - description: Entity Tag containing a strong validator, described in IETF RFC 7232, 2.3 + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 schema: type: string '201': @@ -353,15 +356,16 @@ paths: schema: type: string Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string ETag: - description: Entity Tag containing a strong validator, described in IETF RFC 7232, 2.3 + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 schema: type: string '307': @@ -433,17 +437,17 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + 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 7232, 3.2 + description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.1 schema: type: string requestBody: @@ -464,22 +468,23 @@ paths: $ref: '#/components/schemas/NFProfile' headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string ETag: - description: Entity Tag containing a strong validator, described in IETF RFC 7232, 2.3 + 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 7231 + 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 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -615,12 +620,12 @@ paths: parameters: - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string requestBody: @@ -645,11 +650,11 @@ paths: schema: type: string Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -707,11 +712,11 @@ paths: parameters: - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string requestBody: - description: Notification Payload + description: Notification content content: application/json: schema: @@ -721,7 +726,7 @@ paths: description: Expected response to a successful callback processing headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -793,12 +798,12 @@ paths: pattern: '^([0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?)?[^-]+$' - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string requestBody: @@ -818,18 +823,18 @@ paths: $ref: '#/components/schemas/SubscriptionData' headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + 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 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -1452,8 +1457,11 @@ components: minItems: 1 apiPrefix: type: string - callbackUriPrefix: - type: string + callbackUriPrefixList: + type: array + items: + $ref: '#/components/schemas/CallbackUriPrefixItem' + minItems: 1 defaultNotificationSubscriptions: type: array items: @@ -1629,6 +1637,7 @@ components: - MRF - MRFP - MF + - SLPKMF - type: string NefId: @@ -2035,6 +2044,7 @@ components: - APPLICATION - A_PFD - A_AFTI + - A_AFQOS - A_IPTV - A_BDT - A_SPD @@ -2046,6 +2056,8 @@ components: - P_PLMNUE - P_NSSCD - P_PDTQ + - P_MBSCD + - P_GROUP - type: string UdmInfo: @@ -2351,6 +2363,11 @@ components: redundantTransport: type: boolean default: false + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 DnnUpfInfoItem: description: Set of parameters supported by UPF for a given DNN @@ -2413,6 +2430,11 @@ components: additionalProperties: type: string minProperties: 1 + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 not: required: [ networkInstance, dnaiNwInstanceList ] @@ -2456,6 +2478,21 @@ components: - N6MB - N19MB - NMB9 + - S1U + - S5U + - S8U + - S11U + - S12 + - S2AU + - S2BU + - N3TRUSTEDN3GPP + - N3UNTRUSTEDN3GPP + - N9ROAMING + - SGI + - N19 + - SXAU + - SXBU + - N4U - type: string WAgfInfo: @@ -2543,6 +2580,10 @@ components: rangingSlPosSupportInd: type: boolean default: false + upPositioningInd: + description: user plane positioning capability is supported by the LMF + type: boolean + default: false BsfInfo: description: Information of a BSF NF Instance @@ -2997,6 +3038,9 @@ components: - nnef-smcontext - nnef-eventexposure - nnef-eas-deployment-info + - nnef-dnai-mapping + - nnef-traffic-influence-data + - nnef-ecs-addr-cfg-info - 3gpp-cp-parameter-provisioning - 3gpp-device-triggering - 3gpp-bdt @@ -3033,6 +3077,8 @@ components: - npcf-ue-policy-control - npcf-am-policyauthorization - npcf-pdtq-policy-control + - npcf-mbspolicycontrol + - npcf-mbspolicyauth - nsmsf-sms - nnssf-nsselection - nnssf-nssaiavailability @@ -3048,6 +3094,8 @@ components: - nnwdaf-analyticsinfo - nnwdaf-datamanagement - nnwdaf-mlmodelprovision + - nnwdaf-mlmodeltraining + - nnwdaf-mlmodelmonitor - ngmlc-loc - nucmf-provisioning - nucmf-uecapabilitymanagement @@ -3080,21 +3128,25 @@ components: - nmbsmf-tmgi - nmbsmf-mbssession - nadrf-dm + - nadrf-mlmodelmanagement - nbsp-gba - ntsctsf-time-sync - ntsctsf-qos-tscai - ntsctsf-asti - npkmf-keyreq - npkmf-userid + - npkmf-discovery - nmnpf-npstatus - niwmsc-smservice - - nmbsf-mbsuserserv - - nmbsf-mbsuserdataing + - nmbsf-mbs-us + - nmbsf-mbs-ud-ingest - nmbstf-distsession - npanf-prosekey - npanf-userid - nupf-ee - nupf-gueip + - naf-prose + - naf-eventexposure - type: string N2InterfaceAmfInfo: @@ -4075,7 +4127,7 @@ components: minItems: 1 OptionsResponse: - description: Communication options of the NRF sent in response payload of OPTIONS method + description: Communication options of the NRF sent in response content of OPTIONS method type: object properties: supportedFeatures: @@ -4332,16 +4384,28 @@ components: 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: > @@ -4365,6 +4429,15 @@ components: 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: > @@ -4423,6 +4496,16 @@ components: $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 @@ -5026,19 +5109,9 @@ components: minItems: 1 MediaCapability: - description: IMS media capability offered by NF instance - anyOf: - - type: string - enum: - - VIDEO_TRANSCODING - - DATA_CHANNEL_SERVICES - - VOICE_CONFERENCING - - IN_CALL_ANNOUNCEMENTS - - 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: media capability offered by NF instance + type: string + pattern: '^[a-zA-Z0-9_]+$' A2xCapability: description: Indicate the supported A2X Capability by the PCF. @@ -5110,7 +5183,10 @@ components: description: Information of an ADRF NF Instance type: object properties: - mlModelStorageCapability: + mlModelStorageInd: + type: boolean + default: false + dataStorageInd: type: boolean default: false @@ -5200,3 +5276,17 @@ components: 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 diff --git a/TS29512_Npcf_SMPolicyControl.yaml b/TS29512_Npcf_SMPolicyControl.yaml index 81a0d5f4..da300f09 100644 --- a/TS29512_Npcf_SMPolicyControl.yaml +++ b/TS29512_Npcf_SMPolicyControl.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: Npcf_SMPolicyControl API - version: 1.3.0-alpha.4 + version: 1.3.0-alpha.5 description: | Session Management Policy Control Service © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.512 V18.3.0; 5G System; Session Management Policy Control Service. + description: 3GPP TS 29.512 V18.4.0; 5G System; Session Management Policy Control Service. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.512/' security: @@ -503,7 +503,7 @@ components: 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. + supported. Default value is "false" if omitted. required: - supi - pduSessionId @@ -679,6 +679,8 @@ components: $ref: '#/components/schemas/UePolicyContainer' sliceUsgCtrlInfo: $ref: '#/components/schemas/SliceUsgCtrlInfo' + vplmnOffload: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnOffloadingInfo' SmPolicyNotification: description: Represents a notification on the update of the SM policies. @@ -706,7 +708,7 @@ components: $ref: '#/components/schemas/ApplicationDescriptor' contVer: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' - pduSetProtDesc: + protoDesc: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ProtoDesc' pccRuleId: type: string @@ -1037,6 +1039,11 @@ components: 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 @@ -1511,7 +1518,7 @@ components: $ref: '#/components/schemas/UrspEnforcementInfo' sscMode: $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' - ueReqDnn: + ueReqDnn: $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' redundantPduSessionInfo: $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/RedundantPduSessionInformation' @@ -1529,7 +1536,7 @@ components: 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. + supported. If present and set to "false", it indicates that the HR-SBO is not supported. allOf: - not: required: [multiIpv6Prefixes, ipv6AddressPrefix] @@ -2086,6 +2093,8 @@ components: $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 @@ -2250,7 +2259,7 @@ components: properties: callingPartyAddrs: type: array - items: + items: type: string minItems: 1 calleeInfo: @@ -2319,22 +2328,6 @@ components: - refPccRuleIds - notifType - VplmnOffloadData: - description: VPLMN Specific Offloading Policy. - type: object - properties: - IpRange: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' - minItems: 1 - description: IP address range(s) allowed to be routed to the local part of DN in VPLMN. - fqdnRange: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnPatternMatchingRule' - minItems: 1 - description: FQDN(s) allowed to be routed to the local part of DN in VPLMN. SliceUsgCtrlInfo: description: Represents network slice usage control information. @@ -2498,7 +2491,7 @@ components: - URSP_ENFORCEMENT_INFO - HR_SBO_IND_CHG - L4S_SUPP - - SNSSAI_REPLACEMENT + - NET_SLICE_REPL - BAT_OFFSET_INFO - type: string description: > @@ -2571,13 +2564,14 @@ components: 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 new UE policy container is available. + - UE_POL_CONT_IND: Indicates that a UE policy container 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. - - SNSSAI_REPLACEMENT: Indicates that the existing S-NSSAI for the PDU session has been - replaced. + - 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. diff --git a/TS29514_Npcf_PolicyAuthorization.yaml b/TS29514_Npcf_PolicyAuthorization.yaml index e0fefdfe..4b60b5a3 100644 --- a/TS29514_Npcf_PolicyAuthorization.yaml +++ b/TS29514_Npcf_PolicyAuthorization.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: Npcf_PolicyAuthorization Service API - version: 1.3.0-alpha.4 + version: 1.3.0-alpha.5 description: | PCF Policy Authorization Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.514 V18.3.0; 5G System; Policy Authorization Service; Stage 3. + description: 3GPP TS 29.514 V18.4.0; 5G System; Policy Authorization Service; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.514/' servers: @@ -1348,6 +1348,8 @@ components: $ref: '#/components/schemas/TosTrafficClass' flowUsage: $ref: '#/components/schemas/FlowUsage' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqData' MediaSubComponentRm: description: > @@ -1396,6 +1398,8 @@ components: $ref: '#/components/schemas/TosTrafficClassRm' flowUsage: $ref: '#/components/schemas/FlowUsage' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqDataRm' nullable: true EventsNotification: diff --git a/TS29515_Ngmlc_Location.yaml b/TS29515_Ngmlc_Location.yaml index f152a1cf..b8ceabcb 100644 --- a/TS29515_Ngmlc_Location.yaml +++ b/TS29515_Ngmlc_Location.yaml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - version: '1.2.0-alpha.4' + version: '1.2.0-alpha.5' title: 'Ngmlc_Location' description: | GMLC Location Service. @@ -8,7 +8,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.515 V18.3.0; 5G System; Gateway Mobile Location Services; Stage 3 + description: 3GPP TS 29.515 V18.4.0; 5G System; Gateway Mobile Location Services; Stage 3 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.515/' servers: @@ -49,7 +49,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LocationData' + $ref: '#/components/schemas/LocationDataExt' '307': $ref: 'TS29571_CommonData.yaml#/components/responses/307' '308': @@ -461,9 +461,29 @@ components: reportingInd: allOf: - $ref: '#/components/schemas/ReportingInd' - default: POSITIVE_SENSE + default: INSIDE_REPORTING integrityRequirements: $ref: '#/components/schemas/IntegrityRequirements' + upLocRepInfoAf: + $ref: '#/components/schemas/UpLocRepInfoAf' + requestedRangingSlResult: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangingSlResult' + minItems: 1 + relatedUEs: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RelatedUE' + minItems: 1 + mappedQoSEps: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MappedLocationQoSEps' + + LocationDataExt: + description: Extended Location Data for UEs + allOf: + - $ref: '#/components/schemas/LocationData' + - $ref: '#/components/schemas/AddLocationDatas' @@ -520,6 +540,18 @@ components: $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/HighAccuracyGnssMetrics' losNlosMeasureInd: $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LosNlosMeasureInd' + indoorOutdoorInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/IndoorOutdoorInd' + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' CancelLocData: description: Contains the input parameters in CancelLocation service operation @@ -642,6 +674,20 @@ components: $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/HighAccuracyGnssMetrics' losNlosMeasureInd: $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LosNlosMeasureInd' + upLocRepStatAf: + type: integer + indoorOutdoorInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/IndoorOutdoorInd' + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' UePrivacyRequirements: @@ -761,6 +807,28 @@ components: verticalProtectionLevel: $ref: '#/components/schemas/VerticalProtectionLevel' + UpLocRepInfoAf: + description: Information for the location reporting over user plane + type: object + properties: + upLocRepAfInd: + type: boolean + enum: + - true + upLocRepAddrAf: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/UpLocRepAddrAfRm' + upCumEvtRptCriteria: + $ref: '#/components/schemas/UpCumEvtRptCriteria' + + UpCumEvtRptCriteria: + description: Criteria for sending cumulative events reports over control plane + type: object + properties: + evtRptTimeCriteria: + type: integer + evtRptCountCriteria: + type: integer + # # SIMPLE TYPES @@ -849,6 +917,7 @@ components: - UE_MOBILITY_FOR_DEFERRED_LOCATION - 5GC_MT_LR - DIRECT_REPORT_EVENT + - CUMULATIVE_EVENT_REPORT - type: string FailureCause: description: Positioning failure cause @@ -873,10 +942,18 @@ components: ReportingInd: description: > - Indicates one of the mutually exclusive global settings + Indicates whether the UE is allowed to generate and send the event report inside or outside + the event report allowed(expected) area + anyOf: - type: string enum: - - OPPOSITE_SENSE - - POSITIVE_SENSE + - INSIDE_REPORTING + - OUTSIDE_REPORTING - type: string + + AddLocationDatas: + type: array + items: + $ref: '#/components/schemas/LocationData' + minItems: 1 diff --git a/TS29517_Naf_EventExposure.yaml b/TS29517_Naf_EventExposure.yaml index f62a5144..0ba5bea3 100644 --- a/TS29517_Naf_EventExposure.yaml +++ b/TS29517_Naf_EventExposure.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 1.3.0-alpha.4 + version: 1.3.0-alpha.5 title: Naf_EventExposure description: | AF Event Exposure Service. @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.517 V18.3.0; 5G System; Application Function Event Exposure Service; Stage 3. + 3GPP TS 29.517 V18.4.0; 5G System; Application Function Event Exposure Service; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.517/ servers: @@ -376,28 +376,64 @@ components: items: $ref: '#/components/schemas/MsQoeMetricsCollection' minItems: 1 + deprecated: true + msQoeMetrics: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/QoEMetricsCollection' + minItems: 1 + description: Represents the Media Streaming QoE metrics event records. msConsumpInfos: type: array items: $ref: '#/components/schemas/MsConsumptionCollection' minItems: 1 + deprecated: true + msConsumpRpts: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/ConsumptionReportingUnitsCollection' + minItems: 1 + description: Represents the Media Streaming Consumption event records. msNetAssInvInfos: type: array items: $ref: '#/components/schemas/MsNetAssInvocationCollection' minItems: 1 + deprecated: true + msNetAssistInvs: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/NetworkAssistanceInvocationsCollection' + minItems: 1 + description: > + Represents the Media Streaming Network Assistance Invocations event records. msDynPlyInvInfos: type: array items: $ref: '#/components/schemas/MsDynPolicyInvocationCollection' minItems: 1 + deprecated: true + msDynPlyInvs: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/DynamicPolicyInvocationsCollection' + minItems: 1 + description: Represents the Media Streaming Dynamic Policy Invocations event records. msAccActInfos: type: array items: $ref: '#/components/schemas/MSAccessActivityCollection' minItems: 1 + deprecated: true + msAccesses: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/MediaStreamingAccessesCollection' + minItems: 1 + description: Represents the Media Streaming access event records. gnssAssistDataInfo: - $ref: 'TS29591_Nnef_EventExposure.yaml#/components/schemas/GNSSAssistDataInfo' + $ref: 'TS29591_Nnef_EventExposure.yaml#/components/schemas/GNSSAssistDataInfo' datVolTransTimeInfos: type: array items: diff --git a/TS29518_Namf_Communication.yaml b/TS29518_Namf_Communication.yaml index 49b5268a..6d056f7f 100644 --- a/TS29518_Namf_Communication.yaml +++ b/TS29518_Namf_Communication.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 1.3.0-alpha.4 + version: 1.3.0-alpha.5 title: Namf_Communication description: | AMF Communication Service. @@ -14,7 +14,7 @@ security: - namf-comm externalDocs: - description: 3GPP TS 29.518 V18.3.0; 5G System; Access and Mobility Management Services + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' servers: @@ -2409,6 +2409,8 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' supportedFeatures: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + notifCorrelationId: + type: string required: - n2InformationClass - n2NotifyCallbackUri @@ -2487,8 +2489,11 @@ components: notifySourceNgRan: type: boolean default: false + notifCorrelationId: + type: string required: - n2NotifySubscriptionId + N2InfoContainer: description: N2 information container type: object @@ -2509,8 +2514,8 @@ components: $ref: '#/components/schemas/ProSeInformation' tssInfo: $ref: '#/components/schemas/TssInformation' - rsppInfo: - $ref: '#/components/schemas/RsppInformation' + rslpInfo: + $ref: '#/components/schemas/RslpInformation' a2xInfo: $ref: '#/components/schemas/A2xInformation' required: @@ -2695,6 +2700,7 @@ components: - ranNodeId - initialAmfName - userLocation + AreaOfValidity: description: Area of validity information for N2 information transfer type: object @@ -2704,6 +2710,11 @@ components: 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: @@ -2985,6 +2996,12 @@ components: $ref: '#/components/schemas/A2xContext' mbsrOperationAllowed: $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/MbsrOperationAllowed' + lcsUpContext: + $ref: '#/components/schemas/LcsUpContext' + reconnectInd: + type: boolean + default: false + N2SmInformation: @@ -3944,11 +3961,11 @@ components: required: - tssContainer - RsppInformation: + RslpInformation: description: Represents Ranging/SL positioning related N2 information. type: object properties: - n2Pc5RsppPol: + n2Pc5RslpPol: $ref: '#/components/schemas/N2InfoContent' A2xContext: @@ -3984,6 +4001,14 @@ components: $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' # # SIMPLE DATA TYPES # @@ -4054,7 +4079,6 @@ components: - SMS - UPDP - LCS - - PRU - type: string N1N2MessageTransferCause: description: Enumeration for N1N2Message Transfer Cause diff --git a/TS29518_Namf_EventExposure.yaml b/TS29518_Namf_EventExposure.yaml index e0ac4adb..3b773c02 100644 --- a/TS29518_Namf_EventExposure.yaml +++ b/TS29518_Namf_EventExposure.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 1.3.0-alpha.3 + version: 1.3.0-alpha.4 title: Namf_EventExposure description: | AMF Event Exposure Service. @@ -14,7 +14,7 @@ security: - namf-evts externalDocs: - description: 3GPP TS 29.518 V18.2.0; 5G System; Access and Mobility Management Services + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' servers: @@ -337,6 +337,7 @@ components: - eventNotifyUri - notifyCorrelationId - nfId + AmfEvent: description: Describes an event to be subscribed type: object @@ -407,6 +408,16 @@ components: ranTimingSynchroStatusChange: type: boolean default: false + notifyForSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + notifyForSnssaiDnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SnssaiDnnItem' + minItems: 1 required: - type AmfEventNotification: @@ -652,7 +663,7 @@ components: - replace path: type: string - pattern: '^\/eventList\/-|(\/eventList\/0|\/eventList\/[1-9][0-9]*){1}(\/presenceInfoList\/0|\/presenceInfoList\/[1-9][0-9]*)?|\/excludeSupiList|\/excludeGpsiList|\/includeSupiList|\/includeGpsiList$' + pattern: '^\/eventList\/-|(\/eventList\/0|\/eventList\/[1-9][0-9]*){1}(\/presenceInfoList\/0|\/presenceInfoList\/[1-9][0-9]* |\/notifyForSupiList|\/notifyForSnssaiDnnList)?|\/excludeSupiList|\/excludeGpsiList|\/includeSupiList|\/includeGpsiList$' value: $ref: '#/components/schemas/AmfEvent' presenceInfo: @@ -677,6 +688,16 @@ components: items: $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' minItems: 1 + notifyForSupiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + notifyForSnssaiDnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SnssaiDnnItem' + minItems: 1 required: - op - path @@ -1107,4 +1128,5 @@ components: - type: string enum: - INVALID_SUBSCRIPTION + - SUBSCRIPTION_NOT_AUTHORIZED - type: string diff --git a/TS29518_Namf_Location.yaml b/TS29518_Namf_Location.yaml index 1cfcde7d..c434cf65 100644 --- a/TS29518_Namf_Location.yaml +++ b/TS29518_Namf_Location.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 1.3.0-alpha.4 + version: 1.3.0-alpha.5 title: Namf_Location description: | AMF Location Service. @@ -14,7 +14,7 @@ security: - namf-loc externalDocs: - description: 3GPP TS 29.518 V18.3.0; 5G System; Access and Mobility Management Services + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' servers: @@ -51,7 +51,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProvidePosInfo' + $ref: '#/components/schemas/ProvidePosInfoExt' '204': description: Successful accept of location request with no information returned. '307': @@ -99,7 +99,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NotifiedPosInfo' + $ref: '#/components/schemas/NotifiedPosInfoExt' responses: '204': description: Expected response to a successful callback processing @@ -346,14 +346,24 @@ components: reportingInd: allOf: - $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/ReportingInd' - default: POSITIVE_SENSE + default: INSIDE_REPORTING integrityRequirements: $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/IntegrityRequirements' - - + upLocRepInfoAf: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpLocRepInfoAf' + mappedQoSEps: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MappedLocationQoSEps' required: - lcsClientType - lcsLocation + + + ProvidePosInfoExt: + description: Extended provided positioning information for UEs + allOf: + - $ref: '#/components/schemas/ProvidePosInfo' + - $ref: '#/components/schemas/AddProvidePosInfos' + ProvidePosInfo: description: Data within Provide Positioning Information Response type: object @@ -419,8 +429,24 @@ components: $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/IndoorOutdoorInd' losNlosMeasureInd: $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LosNlosMeasureInd' + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + NotifiedPosInfoExt: + description: Extended notified positioning information for UEs + allOf: + - $ref: '#/components/schemas/NotifiedPosInfo' + - $ref: '#/components/schemas/AddNotifiedPosInfos' + NotifiedPosInfo: description: Data within EventNotify notification type: object @@ -491,6 +517,16 @@ components: $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/IndoorOutdoorInd' losNlosMeasureInd: $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LosNlosMeasureInd' + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' required: - locationEvent @@ -513,6 +549,7 @@ components: default: false supportedFeatures: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + ProvideLocInfo: description: Data within Provide Location Information Response type: object @@ -535,6 +572,7 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' oldGuami: $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + CancelPosInfo: description: Data within a Cancel Location Request type: object @@ -560,6 +598,24 @@ components: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' - $ref: '#/components/schemas/ProvidePosInfo' + AddNotifiedPosInfos: + type: object + properties: + addProvidePosInfos: + type: array + items: + $ref: '#/components/schemas/NotifiedPosInfo' + minItems: 1 + + AddProvidePosInfos: + type: object + properties: + addProvidePosInfos: + type: array + items: + $ref: '#/components/schemas/ProvidePosInfo' + minItems: 1 + LocationType: description: Type of location measurement requested @@ -570,8 +626,8 @@ components: - CURRENT_OR_LAST_KNOWN_LOCATION - NOTIFICATION_VERIFICATION_ONLY - DEFERRED_LOCATION - - RANGING_SL_LOCATION - type: string + LocationEvent: description: Type of events initiating location procedures anyOf: diff --git a/TS29518_Namf_MBSBroadcast.yaml b/TS29518_Namf_MBSBroadcast.yaml index cf5dd67b..d5864fc4 100644 --- a/TS29518_Namf_MBSBroadcast.yaml +++ b/TS29518_Namf_MBSBroadcast.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 1.1.0-alpha.2 + version: 1.1.0-alpha.3 title: Namf_MBSBroadcast description: | AMF MBSBroadcast Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.518 V18.1.0; 5G System; Access and Mobility Management Services + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' servers: @@ -162,6 +162,108 @@ paths: schema: type: string responses: + '200': + description: successful notification response with content + content: + multipart/related: # notification response with binary body part(s) + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/ContextStatusNotificationResponse' + 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 '204': description: successful notification '307': @@ -581,6 +683,8 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' mbsmfServiceInstId: type: string + associatedSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AssociatedSessionId' required: - mbsSessionId - n2MbsSmInfo @@ -667,6 +771,24 @@ components: required: - mbsSessionId + ContextStatusNotificationResponse: + description: Data within ContextStatusNotify Response + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + areaSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' + n2MbsSmInfoList: + type: array + items: + $ref: '#/components/schemas/N2MbsSmInfo' + minItems: 1 + maxItems: 10 + required: + - mbsSessionId + + ContextUpdateRspData: description: Data within ContextUpdate Response type: object @@ -688,12 +810,11 @@ components: $ref: '#/components/schemas/NgapIeType' ngapData: $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' - randId: + ranId: $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' required: - ngapIeType - ngapData - - randId OperationEvent: description: Operation Event for a Broadcast MBS Session. @@ -754,6 +875,9 @@ components: - MBS_SES_RSP - MBS_SES_FAIL - MBS_SES_REL_RSP + - BC_TRA_REQ + - BC_TRA_RSP + - BC_TRA_FAIL - type: string OpEventType: diff --git a/TS29518_Namf_MT.yaml b/TS29518_Namf_MT.yaml index d8c6e469..c4403c67 100644 --- a/TS29518_Namf_MT.yaml +++ b/TS29518_Namf_MT.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 1.3.0-alpha.3 + version: 1.3.0-alpha.4 title: Namf_MT description: | AMF Mobile Terminated Service. @@ -14,7 +14,7 @@ security: - namf-mt externalDocs: - description: 3GPP TS 29.518 V18.2.0; 5G System; Access and Mobility Management Services + description: 3GPP TS 29.518 V18.4.0; 5G System; Access and Mobility Management Services url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' servers: diff --git a/TS29519_Application_Data.yaml b/TS29519_Application_Data.yaml index f7ed5aac..42bcecd4 100644 --- a/TS29519_Application_Data.yaml +++ b/TS29519_Application_Data.yaml @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.519 V18.3.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, + 3GPP TS 29.519 V18.4.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/' @@ -2348,6 +2348,294 @@ paths: default: $ref: 'TS29571_CommonData.yaml#/components/responses/default' + /application-data/af-qos-data-sets: + get: + summary: Retrieve AF Requested QoS Data + operationId: ReadAFReqQoSData + tags: + - AF Requested QoS Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:read + parameters: + - name: dnns + in: query + description: Each element identifies a DNN + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + - name: snssais + in: query + description: Each element identifies a slice. + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + - name: internal-group-ids + in: query + description: Each element identifies a group of users. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + - name: supis + in: query + description: Each element identifies the user. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + - name: data-set-ids + in: query + description: Each element identifies an Individual AF requested QoS resource. + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: supp-feat + in: query + required: false + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: The AF requested QoS Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AfRequestedQosData' + '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' + + /application-data/af-qos-data-sets/{afReqQosId}: + put: + summary: Create or update an Individual AF Requested QoS Data resource. + operationId: CreateIndividualAFReqQoSData + tags: + - Individual AF Requested QoS Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AfRequestedQosData' + parameters: + - name: afReqQosId + in: path + description: > + The Identifier of an Individual AF Requested QoS Data to be created or updated. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual AF Requested QoS Data resource is confirmed and a + representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AfRequestedQosData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/af-qos-data-sets/{afReqQosId} + 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: Modify part of the properties of an individual AF requested QoS Data resource + operationId: UpdateIndividualAFRequestedQoSData + tags: + - Individual AF requested QoS Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AfRequestedQosDataPatch' + parameters: + - name: afReqQosId + in: path + description: > + The Identifier of an Individual AF Requested QoS Data to be updated. + required: true + schema: + type: string + responses: + '200': + description: > + The update of an Individual AF Requested QoS Data resource is confirmed and + a response body containing AF Requested QoS Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AfRequestedQosData' + '204': + description: No content + '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 an individual AF requested QoS Data resource + operationId: DeleteIndividualAFRequestedQosData + tags: + - Individual AF requested QoS Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:modify + parameters: + - name: afReqQosId + in: path + description: > + The Identifier of an Individual AF Requested QoS Data to be deleted. + required: true + schema: + type: string + responses: + '204': + description: The Individual AF requested QoS Data was deleted successfully. + '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' + /application-data/subs-to-notify/{subsId}: parameters: - name: subsId @@ -2356,10 +2644,286 @@ paths: schema: type: string put: - summary: Modify a subscription to receive notification of application data changes - operationId: ReplaceIndividualApplicationDataSubscription + summary: Modify a subscription to receive notification of application data changes + operationId: ReplaceIndividualApplicationDataSubscription + tags: + - IndividualApplicationDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:modify + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + responses: + '200': + description: The individual subscription resource was updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + '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 Application Data subscription + operationId: DeleteIndividualApplicationDataSubscription + tags: + - IndividualApplicationDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:modify + 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' + get: + summary: Get an existing individual Application Data Subscription resource + operationId: ReadIndividualApplicationDataSubscription + tags: + - IndividualApplicationDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:read + parameters: + - name: subsId + in: path + description: > + String identifying a subscription to the Individual Application Data Subscription + required: true + schema: + type: string + responses: + '200': + description: The subscription information is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + '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' + + /application-data/eas-deploy-data: + get: + summary: Retrieve EAS Deployment Information Data + operationId: ReadEasDeployData + tags: + - EAS Deployment Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:eas-deploy-data:read + parameters: + - name: dnn + in: query + description: Identifies a DNN. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: snssai + in: query + description: Identifies an S-NSSAI. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + - name: internal-group-id + in: query + description: Identifies a group of users. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + - name: appId + in: query + description: Identifies an application. + required: false + schema: + type: string + responses: + '200': + description: The EAS Deployment Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + minItems: 1 + '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' + /application-data/eas-deploy-data/{easDeployInfoId}: + get: + summary: Retrieve an individual EAS Deployment Data resource + operationId: ReadIndividualEasDeployData + tags: + - Individual EAS Deployment Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:eas-deploy-data:read + parameters: + - name: easDeployInfoId + description: > + String identifying an Individual EAS Deployment Information Data resource. + in: path + required: true + schema: + type: string + responses: + '200': + description: > + The EAS Deployment Data stored in the UDR for an Individual EAS Deployment + Information Data resource is returned. + content: + application/json: + schema: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + '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 update an individual EAS Deployment Data resource + operationId: CreateOrReplaceIndividualEasDeployData tags: - - IndividualApplicationDataSubscription (Document) + - Individual EAS Deployment Data (Document) security: - {} - oAuth2ClientCredentials: @@ -2370,24 +2934,49 @@ paths: - oAuth2ClientCredentials: - nudr-dr - nudr-dr:application-data - - nudr-dr:application-data:subs-to-notify:modify + - nudr-dr:application-data:eas-deploy-data:create requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/ApplicationDataSubs' + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + parameters: + - name: easDeployInfoId + in: path + description: > + The Identifier of an Individual EAS Deployment Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + type: string responses: + '201': + description: > + The creation of an Individual EAS Deployment Data resource is confirmed and a + representation of that resource is returned. + content: + application/json: + schema: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/eas-deploy-data/{easDeployInfoId} + required: true + schema: + type: string '200': - description: The individual subscription resource was updated successfully. + description: > + The update of an Individual EAS Deployment Data resource is confirmed and a response + body containing EAS Deployment Data shall be returned. content: application/json: schema: - $ref: '#/components/schemas/ApplicationDataSubs' + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' '204': - description: > - The individual subscription resource was updated successfully and no - additional content is to be sent in the response message. + description: No content '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '401': @@ -2400,6 +2989,8 @@ paths: $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': @@ -2413,10 +3004,10 @@ paths: default: $ref: 'TS29571_CommonData.yaml#/components/responses/default' delete: - summary: Delete the individual Application Data subscription - operationId: DeleteIndividualApplicationDataSubscription + summary: Delete an individual EAS Deployment Data resource + operationId: DeleteIndividualEasDeployData tags: - - IndividualApplicationDataSubscription (Document) + - Individual EasDeployment Data (Document) security: - {} - oAuth2ClientCredentials: @@ -2427,10 +3018,19 @@ paths: - oAuth2ClientCredentials: - nudr-dr - nudr-dr:application-data - - nudr-dr:application-data:subs-to-notify:modify + - nudr-dr:application-data:eas-deploy-data:modify + parameters: + - name: easDeployInfoId + in: path + description: > + The Identifier of an Individual EAS Deployment Data to be deleted. + It shall apply the format of Data type string. + required: true + schema: + type: string responses: '204': - description: Upon success, an empty response body shall be returned. + description: The Individual EAS Deployment Data was deleted successfully. '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '401': @@ -2443,17 +3043,23 @@ paths: $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' + + /application-data/dnai-eas-mappings/{dnai}: + parameters: + - name: dnai + in: path + required: true + schema: + type: string get: - summary: Get an existing individual Application Data Subscription resource - operationId: ReadIndividualApplicationDataSubscription + summary: Retrieves the EAS address information for a DNAI. + operationId: ReadDnaiEasMapping tags: - - IndividualApplicationDataSubscription (Document) + - DnaiEasMapping (Document) security: - {} - oAuth2ClientCredentials: @@ -2464,22 +3070,23 @@ paths: - oAuth2ClientCredentials: - nudr-dr - nudr-dr:application-data - - nudr-dr:application-data:subs-to-notify:read + - nudr-dr:application-data:dnai-eas:read parameters: - - name: subsId - in: path - description: > - String identifying a subscription to the Individual Application Data Subscription - required: true + - name: supp-feat + in: query + description: Supported Features + required: false schema: - type: string + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' responses: '200': - description: The subscription information is returned. + description: > + Upon success, a response body containing EAS address information for a DNAI + is returned. content: application/json: schema: - $ref: '#/components/schemas/ApplicationDataSubs' + $ref: '#/components/schemas/DnaiEasMapping' '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '401': @@ -2503,12 +3110,12 @@ paths: default: $ref: 'TS29571_CommonData.yaml#/components/responses/default' - /application-data/eas-deploy-data: + /application-data/ecs-address-roaming: get: - summary: Retrieve EAS Deployment Information Data - operationId: ReadEasDeployData + summary: Retrieve ECS Address Roaming Data + operationId: ReadEcsRoamingData tags: - - EAS Deployment Data (Store) + - ECS Address Roaming Data (Store) security: - {} - oAuth2ClientCredentials: @@ -2519,41 +3126,31 @@ paths: - oAuth2ClientCredentials: - nudr-dr - nudr-dr:application-data - - nudr-dr:application-data:eas-deploy-data:read + - nudr-dr:application-data:ecs-address-roaming:read parameters: - - name: dnn - in: query - description: Identifies a DNN. - required: false - schema: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' - - name: snssai - in: query - description: Identifies an S-NSSAI. - required: false - schema: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - name: internal-group-id in: query description: Identifies a group of users. required: false schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' - - name: appId + - name: any-ue in: query - description: Identifies an application. + description: > + Indicates that any UE is targetted if included and set to true, otherwise set to false. + Default value is false if omitted. required: false schema: - type: string + type: boolean responses: '200': - description: The EAS Deployment Data stored in the UDR are returned. + description: The ECS Address Roaming Data stored in the UDR are returned. content: application/json: schema: type: array items: - $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + $ref: '#/components/schemas/EcsAddrData' minItems: 1 '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' @@ -2577,12 +3174,13 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: $ref: 'TS29571_CommonData.yaml#/components/responses/default' - /application-data/eas-deploy-data/{easDeployInfoId}: + + /application-data/ecs-address-roaming/{ecsAddrInfoId}: get: - summary: Retrieve an individual EAS Deployment Data resource - operationId: ReadIndividualEasDeployData + summary: Retrieve an individual ECS Address Roaming Data resource + operationId: ReadIndividualEcsAddr tags: - - Individual EAS Deployment Data (Document) + - Individual ECS Address Roaming Data (Document) security: - {} - oAuth2ClientCredentials: @@ -2593,11 +3191,11 @@ paths: - oAuth2ClientCredentials: - nudr-dr - nudr-dr:application-data - - nudr-dr:application-data:eas-deploy-data:read + - nudr-dr:application-data:ecs-address-roaming:read parameters: - - name: easDeployInfoId + - name: ecsAddrInfoId description: > - String identifying an Individual EAS Deployment Information Data resource. + String identifying an Individual ECS Address Roaming Data resource. in: path required: true schema: @@ -2605,12 +3203,12 @@ paths: responses: '200': description: > - The EAS Deployment Data stored in the UDR for an Individual EAS Deployment - Information Data resource is returned. + The ECS Address Roaming Data stored in the UDR for an Individual ECS Address Roaming + Data resource is returned. content: application/json: schema: - $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + $ref: '#/components/schemas/EcsAddrData' '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '401': @@ -2632,10 +3230,10 @@ paths: default: $ref: 'TS29571_CommonData.yaml#/components/responses/default' put: - summary: Create or update an individual EAS Deployment Data resource - operationId: CreateOrReplaceIndividualEasDeployData + summary: Create or update an individual ECS Address Roaming Data resource + operationId: CreateOrReplaceIndividualEcsAddressData tags: - - Individual EAS Deployment Data (Document) + - Individual ECS Address Roaming Data (Document) security: - {} - oAuth2ClientCredentials: @@ -2646,47 +3244,45 @@ paths: - oAuth2ClientCredentials: - nudr-dr - nudr-dr:application-data - - nudr-dr:application-data:eas-deploy-data:create + - nudr-dr:application-data:ecs-address-roaming:create requestBody: required: true content: application/json: schema: - $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + $ref: '#/components/schemas/EcsAddrData' parameters: - - name: easDeployInfoId + - name: ecsAddrInfoId in: path description: > - The Identifier of an Individual EAS Deployment Data to be created or updated. - It shall apply the format of Data type string. + The Identifier of an Individual ECS Address Roaming Data to be created or updated. required: true schema: type: string responses: '201': description: > - The creation of an Individual EAS Deployment Data resource is confirmed and a - representation of that resource is returned. + The creation of an Individual EECS Address Roaming Data resource is confirmed + and a representation of that resource is returned. content: application/json: schema: - $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + $ref: '#/components/schemas/EcsAddrData' headers: Location: description: > - Contains the URI of the newly created resource, according to the structure: - {apiRoot}/nudr-dr//application-data/eas-deploy-data/{easDeployInfoId} + Contains the URI of the newly created resource. required: true schema: type: string '200': description: > - The update of an Individual EAS Deployment Data resource is confirmed and a response - body containing EAS Deployment Data shall be returned. + The update of an Individual ECS Address Roaming Data resource is confirmed + and a response body containing ECS Address Roaming Data is returned. content: application/json: schema: - $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + $ref: '#/components/schemas/EcsAddrData' '204': description: No content '400': @@ -2701,8 +3297,6 @@ paths: $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': @@ -2716,10 +3310,10 @@ paths: default: $ref: 'TS29571_CommonData.yaml#/components/responses/default' delete: - summary: Delete an individual EAS Deployment Data resource - operationId: DeleteIndividualEasDeployData + summary: Delete an individual ECS Address Roaming Data resource + operationId: DeleteIndividualEcsAddrData tags: - - Individual EasDeployment Data (Document) + - Individual ECS Address Roaming Data (Document) security: - {} - oAuth2ClientCredentials: @@ -2730,19 +3324,18 @@ paths: - oAuth2ClientCredentials: - nudr-dr - nudr-dr:application-data - - nudr-dr:application-data:eas-deploy-data:modify + - nudr-dr:application-data:ecs-address-roaming:modify parameters: - - name: easDeployInfoId + - name: ecsAddrInfoId in: path description: > - The Identifier of an Individual EAS Deployment Data to be updated. It shall apply the - format of Data type string. + The Identifier of an Individual ECS Address Roaming Data to be updated. required: true schema: type: string responses: '204': - description: The Individual Influence Data was deleted successfully. + description: The Individual ECS Address Roaming Data was deleted successfully. '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '401': @@ -2904,8 +3497,6 @@ components: - required: [supi] - required: [interGroupId] - required: [interGroupIdList] - not: - required: [interGroupId, interGroupIdList] TrafficInfluDataPatch: description: Represents the Traffic Influence Data to be updated in the UDR. @@ -3062,11 +3653,8 @@ components: - required: [dnns] - required: [snssais] - required: [internalGroupIds] - - required: [internalGroupIds] - required: [internalGroupIdsAdd] - required: [supis] - not: - required: [internalGroupIds, internalGroupIdsAdd] TrafficInfluDataNotif: description: Represents traffic influence data for notification. @@ -3355,7 +3943,9 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' anyUeInd: type: boolean - description: Indicates whether the data is applicable for any UE. + description: > + When set to true, it indicates whether the data is applicable for any UE. Otherwise set + to "false". Default value is "false" if omitted. roamUePlmnIds: type: array items: @@ -3385,7 +3975,9 @@ components: minItems: 1 thruReq: type: boolean - description: Indicates whether high throughput is desired for the indicated UE traffic. + description: > + When set to true, it indicates whether high throughput is desired for the + indicated UE traffic. Otherwise set to "false". Default value is "false" if omitted. covReq: type: array items: @@ -3514,6 +4106,12 @@ components: $ref: '#/components/schemas/ServiceParameterData' amInfluData: $ref: '#/components/schemas/AmInfluData' + dnaiEasData: + $ref: '#/components/schemas/DnaiEasMapping' + afReqQosData: + $ref: '#/components/schemas/AfRequestedQosData' + ecsAddrData: + $ref: '#/components/schemas/EcsAddrData' required: - resUri @@ -3573,6 +4171,11 @@ components: items: $ref: 'TS29522_AMInfluence.yaml#/components/schemas/DnnSnssaiInformation' minItems: 1 + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 required: - dataInd @@ -3581,7 +4184,7 @@ components: Contains the information for traffic correlation. type: object properties: - correType: + corrType: $ref: '#/components/schemas/CorrelationType' tfcCorrId: type: string @@ -3600,11 +4203,177 @@ components: nullable: true notifUri: $ref: 'TS29571_CommonData.yaml#/components/schemas/UriRm' - notifId: + notifCorrId: type: string nullable: true + description: Notification correlation identifier. nullable: true + AfRequestedQosData: + description: Represents AF Requested QoS data. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + afAppId: + type: string + description: Identifies an AF application. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + evSubsc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqData' + flowInfos: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + qosReference: + type: string + altSerReqs: + type: array + items: + type: string + minItems: 1 + altSerReqsData: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Contains alternative service requirements that include individual QoS parameter sets. + disUeNotif: + type: boolean + 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' + tempInValidity: + $ref: 'TS29565_Ntsctsf_QoSandTSCAssistance.yaml#/components/schemas/TemporalInValidity' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - suppFeat + oneOf: + - required: [supi] + - required: [interGroupId] + + AfRequestedQosDataPatch: + description: Represents modification of Individual AF Requested QoS data. + type: object + properties: + afAppId: + type: string + description: Identifies an AF application. + nullable: true + evSubsc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqDataRm' + flowInfos: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + nullable: true + qosReference: + type: string + nullable: true + altSerReqs: + type: array + items: + type: string + minItems: 1 + nullable: true + altSerReqsData: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Contains removable alternative service requirements that include individual QoS + parameter sets. + nullable: true + disUeNotif: + type: boolean + nullable: true + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + tempInValidity: + $ref: 'TS29565_Ntsctsf_QoSandTSCAssistance.yaml#/components/schemas/TemporalInValidity' + + DnaiEasMapping: + description: Contains DNAI to EAS mapping information. + type: object + properties: + dnaiEasInfos: + type: array + items: + $ref: '#/components/schemas/DnaiEasInfo' + minItems: 1 + description: Each element conrtains EAS address information for a DNAI. + required: + - dnaiEasInfos + + DnaiEasInfo: + description: Contains EAS information for a DNAI. + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + easIpAddrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + description: Each element contains EAS addresses, address ranges, and/or prefixes. + fqdns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnPatternMatchingRule' + minItems: 1 + description: Each element conrtains FQDN matching rules for the EAS(s) of a DNAI. + anyOf: + - required: [dnn] + - required: [snssai] + oneOf: + - required: [easIpAddrs] + - required: [fqdns] + EcsAddrData: + description: Represents ECS Address Data. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + ecsServerAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EcsServerAddr' + spatialValidityCond: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond' + anyUeInd: + type: boolean + description: > + If provided and set to true it indicates that all the UEs are targetted, + otherwise set to false. The default value is false if omitted. + internalGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ecsServerAddr + DataInd: anyOf: - type: string @@ -3614,6 +4383,9 @@ components: - BDT - SVC_PARAM - AM + - DNAI_EAS + - REQ_QOS + - ECS - type: string description: > This string provides forward-compatibility with future @@ -3627,6 +4399,9 @@ components: - BDT: BDT data. - SVC_PARAM: Service parameter data. - AM: AM influence data. + - DNAI_EAS: DNAI EAS mapping data. + - REQ_QOS: AF Requested QoS data for a UE or group of UE(s) not identified by UE address(es). + - ECS: ECS Address data. CorrelationType: description: Indicates that a common DNAI or common EAS should be selected. diff --git a/TS29519_Policy_Data.yaml b/TS29519_Policy_Data.yaml index e7f2b577..abc40bdf 100644 --- a/TS29519_Policy_Data.yaml +++ b/TS29519_Policy_Data.yaml @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.519 V18.3.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, + 3GPP TS 29.519 V18.4.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/' @@ -2098,6 +2098,10 @@ paths: - 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 @@ -2138,6 +2142,17 @@ paths: 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: @@ -2394,11 +2409,6 @@ components: The limit identifier is used as the key of the map. suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - resetIds: - type: array - items: - type: string - minItems: 1 required: - smPolicySnssaiData @@ -2464,8 +2474,8 @@ components: $ref: '#/components/schemas/LimitIdToMonitoringKey' minProperties: 1 description: > - A reference to the UsageMonitoringDataLimit or UsageMonitoringData instances - for this DNN and SNSSAI that may also include the related monitoring key(s). + 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 @@ -2645,6 +2655,13 @@ components: $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: @@ -2940,6 +2957,10 @@ components: $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. @@ -2955,11 +2976,6 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - resetIds: - type: array - items: - type: string - minItems: 1 SlicePolicyDataPatch: description: Contains the modified network slice specific policy control information. @@ -3029,8 +3045,6 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' snssai: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' - policyStatus: - $ref: '#/components/schemas/PolicyStatus' altQosParamSets: type: array items: @@ -3054,6 +3068,8 @@ components: 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: > @@ -3076,8 +3092,12 @@ components: properties: pdtqPolicy: $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqPolicy' - policyStatus: - $ref: '#/components/schemas/PolicyStatus' + + 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 subscription information. @@ -3089,11 +3109,6 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - resetIds: - type: array - items: - type: string - minItems: 1 GroupPolicyDataPatch: description: > @@ -3126,6 +3141,13 @@ components: 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 + # ENUMS: UsageMonLevel: @@ -3181,22 +3203,3 @@ components: 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. - - PolicyStatus: - description: Indicates the validation status of a negotiated PDTQ 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. - - 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 diff --git a/TS29520_Nnwdaf_AnalyticsInfo.yaml b/TS29520_Nnwdaf_AnalyticsInfo.yaml index 46c5cba8..9858123a 100644 --- a/TS29520_Nnwdaf_AnalyticsInfo.yaml +++ b/TS29520_Nnwdaf_AnalyticsInfo.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 1.3.0-alpha.4 + version: 1.3.0-alpha.5 title: Nnwdaf_AnalyticsInfo description: | Nnwdaf_AnalyticsInfo Service API. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.520 V18.3.0; 5G System; Network Data Analytics Services. + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/' security: @@ -319,6 +319,11 @@ components: items: $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MovBehavInfo' minItems: 1 + relProxInfos: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RelProxInfo' + minItems: 1 suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' @@ -335,6 +340,8 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' minItems: 1 description: Identification(s) of network slice. + roamingInfo: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RoamingInfo' appIds: type: array items: @@ -520,6 +527,11 @@ components: items: $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MovBehavReq' minItems: 1 + relProxReqs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RelProxReq' + minItems: 1 not: required: [anySlice, snssais] @@ -803,6 +815,7 @@ components: - E2E_DATA_VOL_TRANS_TIME - MOVEMENT_BEHAVIOUR - LOC_ACCURACY + - RELATIVE_PROXIMITY - type: string description: > This string provides forward-compatibility with future @@ -837,6 +850,7 @@ components: - E2E_DATA_VOL_TRANS_TIME: Represents the analytics of E2E data volume transfer time. - MOVEMENT_BEHAVIOUR: Represents the analytics of the Movement Behaviour information. - LOC_ACCURACY: Represents the analytics of location accuracy. + - RELATIVE_PROXIMITY: Represents the analytics of Relative Proximity information. ContextType: diff --git a/TS29520_Nnwdaf_DataManagement.yaml b/TS29520_Nnwdaf_DataManagement.yaml index 5d1777cb..60226017 100644 --- a/TS29520_Nnwdaf_DataManagement.yaml +++ b/TS29520_Nnwdaf_DataManagement.yaml @@ -1,13 +1,13 @@ openapi: 3.0.0 info: title: Nnwdaf_DataManagement - version: 1.1.0-alpha.3 + version: 1.1.0-alpha.4 description: | Nnwdaf_DataManagement API Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.520 V18.2.0; 5G System; Network Data Analytics Services. + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/' servers: - url: '{apiRoot}/nnwdaf-datamanagement/v1' @@ -240,6 +240,13 @@ paths: responses: '204': description: No Content. Resource was succesfully deleted + '200': + description: > + Resource was succesfully deleted and including the stored unsent events in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafDataManagementNotif' '307': $ref: 'TS29571_CommonData.yaml#/components/responses/307' '308': @@ -361,6 +368,8 @@ components: $ref: 'TS29576_Nmfaf_3caDataManagement.yaml#/components/schemas/FetchInstruction' notifTimestamp: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + pendNotifCause: + $ref: '#/components/schemas/PendingNotificationCause' required: - notifCorrId - notifTimestamp @@ -368,3 +377,22 @@ components: - required: [dataNotification] - required: [dataReports] - required: [fetchInstruct] + +# +# ENUMERATIONS DATA TYPES +# + PendingNotificationCause: + anyOf: + - type: string + enum: + - UE_OUT_OF_NF_SERVING_AREA + - 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 Pending Notification Cause for the stored unsent data. + Possible values are: + - UE_OUT_OF_NF_SERVING_AREA: The UE moved out of the NF serving area. + - OTHER: Other cause. diff --git a/TS29520_Nnwdaf_EventsSubscription.yaml b/TS29520_Nnwdaf_EventsSubscription.yaml index afc0dc8c..1e78b45d 100644 --- a/TS29520_Nnwdaf_EventsSubscription.yaml +++ b/TS29520_Nnwdaf_EventsSubscription.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 1.3.0-alpha.4 + version: 1.3.0-alpha.5 title: Nnwdaf_EventsSubscription description: | Nnwdaf_EventsSubscription Service API. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.520 V18.3.0; 5G System; Network Data Analytics Services. + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/' security: @@ -576,6 +576,8 @@ components: 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: @@ -695,6 +697,13 @@ components: 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: @@ -873,6 +882,11 @@ components: items: $ref: '#/components/schemas/LocAccuracyInfo' minItems: 1 + relProxInfos: + type: array + items: + $ref: '#/components/schemas/RelProxInfo' + minItems: 1 required: - event @@ -1031,10 +1045,7 @@ components: 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 when - the subscription event is NF_LOAD, UE_COMM, DISPERSION, NETWORK_PERFORMANCE, - WLAN_PERFORMANCE, DN_PERFORMANCE, SERVICE_EXPERIENCE or E2E_DATA_VOL_TRANS_TIME, - UE_MOBILITY, PDU_SESSION_TRAFFIC or MOVEMENT_BEHAVIOUR. + present if the "listOfAnaSubsets" attribute is present in the subscription request. startTs: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' endTs: @@ -1135,6 +1146,8 @@ components: items: $ref: '#/components/schemas/GeoDistributionInfo' minItems: 1 + distThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' required: - loc @@ -1146,9 +1159,14 @@ components: $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: - type: string - description: String identifying the moving direction of the UE. + $ref: '#/components/schemas/Direction' required: - direction oneOf: @@ -2380,8 +2398,15 @@ components: ueLocOrderInd: type: boolean description: > - UE Location order indication. Set to "true" to indicate the NWDAF to provide the UE - Mobility analytics in a UE Location order, otherwise set to "false" or omit. + 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. @@ -2391,8 +2416,11 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' sscMode: $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' - accessType: - $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + 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. @@ -2427,6 +2455,8 @@ components: description: Represents Domain name matching criteria. dnProtocol: $ref: 'TS29122_PfdManagement.yaml#/components/schemas/DomainNameProtocol' + pfdConfidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' required: - appId @@ -2525,11 +2555,10 @@ components: $ref: '#/components/schemas/E2eDataVolTransTimeCriterion' order: $ref: '#/components/schemas/MatchingDirection' - reportThresholds: - type: array - items: - type: string - minItems: 1 + 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: @@ -2538,6 +2567,9 @@ components: $ref: '#/components/schemas/DataVolume' maxNumberUes: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + oneOf: + - required: [repeatDataTrans] + - required: [tsIntervalDataTrans] DataVolume: description: Data Volume including UL/DL. @@ -2572,6 +2604,8 @@ components: items: $ref: '#/components/schemas/GeoDistributionInfo' minItems: 1 + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' required: - e2eDataVolTransTimes @@ -2588,10 +2622,6 @@ components: items: $ref: '#/components/schemas/E2eDataVolTransTimePerUe' minItems: 1 - repeatDataTrans: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - tsIntervalDataTrans: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' required: - tsStart - tsDuration @@ -2601,15 +2631,10 @@ components: description: Represents the E2E data volume transfer time per UE. type: object properties: - supis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - minItems: 1 - gpsis: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' snssai: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' appId: @@ -2673,13 +2698,13 @@ components: uplinkVolume: $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' avgTransTimeUl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + $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/DurationSec' + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' varTransTimeDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' @@ -2845,19 +2870,155 @@ components: ratio: $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' - DirectionUeInfo: - description: Heading directions information of the UE flow in the target area. + RelProxReq: + description: Represents the Relative Proximity analytics requirements. 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. + 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. + 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. + 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: - - direction + - timestampedLocs + oneOf: + - required: [supi] + - required: [gpsi] + + TimestampedLocation: + description: The timestamped locations of the trajectory of the UE. + 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. + 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. + 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 @@ -2910,6 +3071,7 @@ components: - SPEED_THRESHOLD - MOV_UE_DIRECTION - LOC_ACCURACY + - RELATIVE_PROXIMITY - type: string description: > This string provides forward-compatibility with future @@ -2948,6 +3110,8 @@ components: - 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: @@ -3143,6 +3307,7 @@ components: enum: - UNAVAILABLE_DATA - BOTH_STAT_PRED_NOT_ALLOWED + - PREDICTION_NOT_ALLOWED - UNSATISFIED_REQUESTED_ANALYTICS_TIME - OTHER - type: string @@ -3158,6 +3323,8 @@ components: - 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. @@ -3297,7 +3464,6 @@ components: - NUMBER_OF_UE - UE_GEOG_DIST - UE_DIRECTION - - USER_LOCATION - AVG_E2E_UL_PKT_DELAY - VAR_E2E_UL_PKT_DELAY - AVG_E2E_DL_PKT_DELAY @@ -3308,6 +3474,7 @@ components: - 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 @@ -3422,8 +3589,6 @@ components: 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. - - USER_LOCATION: Indicates the user location. 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 @@ -3456,6 +3621,8 @@ components: 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: oneOf: @@ -3832,6 +3999,10 @@ components: - SOUTH - EAST - WEST + - NORTHWEST + - NORTHEAST + - SOUTHWEST + - SOUTHEAST - type: string description: > This string provides forward-compatibility with future extensions to the enumeration but @@ -3842,3 +4013,26 @@ components: - SOUTH: South direction. - EAST: EAST direction. - WEST: WEST direction. + - NORTHWEST: Northwest direction. + - NORTHEAST: Northeast direction. + - SOUTHWEST: Southwest direction. + - SOUTHEAST: Southeast direction. + + ProximityCriterion: + anyOf: + - type: string + enum: + - VELOCITY + - AVG_SPD + - ORIENTATION + - TRAJECTORY + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration but + is not used to encode content defined in the present version of this API. + description: | + Possible values are: + - VELOCITY: Velocity. + - AVG_SPD: Average speed. + - ORIENTATION: Orientation. + - TRAJECTORY: Mobility trajectory. diff --git a/TS29520_Nnwdaf_MLModelMonitor.yaml b/TS29520_Nnwdaf_MLModelMonitor.yaml new file mode 100644 index 00000000..9c47c946 --- /dev/null +++ b/TS29520_Nnwdaf_MLModelMonitor.yaml @@ -0,0 +1,461 @@ +openapi: 3.0.0 + +info: + title: Nnwdaf_MLModelMonitor + version: 1.0.0-alpha.1 + description: | + Nnwdaf_MLModelMonitor API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +servers: + - url: '{apiRoot}/nnwdaf-mlmodelmonitor/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-mlmodelmonitor + +paths: + /registrations: + post: + summary: Create a new Individual NWDAF ML Model monitoring registration resource. + operationId: CreateNWDAFMLModelMonitoringRegistration + tags: + - registrations (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorReg' + responses: + '201': + description: Create a new Individual NWDAF ML Model monitoring registration resource. + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorReg' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-mlmodelmonitor//registrations/{registrationId}. + 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' + + /registrations/{registrationId}: + delete: + summary: Delete an existing Individual NWDAF ML model monitoring registration. + operationId: DeleteNWDAFMLModelMonitoringRegistration + tags: + - Individual NWDAF ML model monitoring registration (Document) + parameters: + - name: registrationId + in: path + description: String identifying a registration to the Nnwdaf_MLModelMonitor Service. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF ML Model monitoring registration matching the + registrationId 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' + '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: + post: + summary: Create a new Individual NWDAF ML model monitoring Subscription. + operationId: CreateNWDAFMLModelMonitoringSubscription + tags: + - NWDAF ML model monitoring Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + responses: + '201': + description: Create a new Individual NWDAF ML model monitoring Subscription resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + '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/MLModelMonitorNotify' + 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}: + put: + summary: Update an existing Individual NWDAF ML model monitoring Subscription resource. + operationId: UpdateNWDAFMLModelMonitoringSubscription + tags: + - Individual NWDAF ML model monitoring Subscription resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelMonitor Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF ML model monitoring Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + '204': + description: > + The Individual NWDAF ML model monitoring 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' + delete: + summary: Delete an existing Individual NWDAF ML model monitoring Subscription. + operationId: DeleteNWDAFMLModelMonitoringSubscription + tags: + - Individual NWDAF ML model monitoring Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelMonitor Service + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF ML model monitoring 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' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdaf-mlmodelmonitor: Access to the Nnwdaf_MLModelMonitor API + + schemas: + MLModelMonitorReg: + description: Represents a ML Model monitoring registration. + type: object + properties: + consumerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + consumerSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + modelId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + modelAccuInd: + type: boolean + description: > + Indicates the ML Model accuracy transfer indication. Set to "true" to indicate that the + monitoring of the accuracy of the ML model is supported, otherwise set to "false". + Default value is "false" if omitted. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - modelId + oneOf: + - required: [consumerId] + - required: [consumerSetId] + + MLModelMonitorSub: + description: > + Represents parameters to request the modification of a ML Model monitoring registration. + type: object + properties: + modelIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minItems: 1 + description: Represents the ML Model IDs. + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + modelMetric: + $ref: 'TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLModelMetric' + accuThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + eventReportReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + immReports: + $ref: '#/components/schemas/MLModelMonitorNotify' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - modelIds + - notificationUri + - notifCorrId + + MLModelMonitorNotify: + description: Represents notifications on events that occurred. + type: object + properties: + notifCorrId: + type: string + description: Notification correlation identifier. + modelAccuInfos: + type: array + items: + $ref: '#/components/schemas/MLModelAccuracyInfo' + minItems: 1 + description: The accuracy related information of the ML model. + anaFeedbacks: + type: array + items: + $ref: '#/components/schemas/AnalyticsFeedback' + minItems: 1 + description: The analytics feedback information. + validPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + required: + - notifCorrId + anyOf: + - required: [modelAccuInfos] + - required: [anaFeedbacks] + + MLModelAccuracyInfo: + description: Represents the ML Model accuracy information. + type: object + properties: + modelId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + deviation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + inferenceNum: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + adrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + dataSetTag: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSetTag' + modelMetric: + $ref: 'TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLModelMetric' + required: + - modelId + + AnalyticsFeedback: + description: Represents the analytics feedback. + type: object + properties: + events: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + description: Indicates the Analytics IDs that were used to take this action. + modelIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minItems: 1 + description: Indicates the ML Model identifier that were used to take this action. + groundDataImpactInd: + type: boolean + description: > + Indication whether the action will affect on ground truth data. Set to "true" to + indicate that the action will affect on ground truth data. Otherwise set to "false", + default value is "false" if omitted. + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - events + - modelIds diff --git a/TS29520_Nnwdaf_MLModelProvision.yaml b/TS29520_Nnwdaf_MLModelProvision.yaml index c2b592ce..43cbc8e9 100644 --- a/TS29520_Nnwdaf_MLModelProvision.yaml +++ b/TS29520_Nnwdaf_MLModelProvision.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: Nnwdaf_MLModelProvision - version: 1.1.0-alpha.4 + version: 1.1.0-alpha.5 description: | Nnwdaf_MLModelProvision API Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.520 V18.3.0; 5G System; Network Data Analytics Services. + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ servers: @@ -275,16 +275,12 @@ components: consuumer NF. type: object properties: - modelInterInfo: - type: string - description: > - Vendor-specific information about the ML models. reqRepRatio: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' inferInpDataInfos: type: array items: - $ref: '#/components/schemas/TrainInputInfo' + $ref: '#/components/schemas/InputDataInfo' minItems: 1 description: > Inference information that is used by NWDAF containing AnLF during inference. @@ -301,7 +297,7 @@ components: description: > Provided accuracy levels of interest for ML models. - TrainInputInfo: + InputDataInfo: description: Contains information about inference that is used by NWDAF containing AnLF. type: object properties: @@ -341,12 +337,10 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' expiryTime: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - modelMetric: - $ref: '#/components/schemas/MLModelMetric' + timeModelNeeded: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' mlEvRepCon: $ref: '#/components/schemas/MLRepEventCondition' - preDetStatus: - $ref: '#/components/schemas/MLModelStatus' modelInterInfo: type: string description: String representing the ML Model Interoperability Information. @@ -362,9 +356,12 @@ components: description: > Indicates the context of usage of the analytics. The value and format of this parameter are not standardized. + inferDataForModel: + $ref: '#/components/schemas/InferenceDataForModelTrain' required: - mLEvent - mLEventFilter + NwdafMLModelProvNotif: description: Represents notifications on events that occurred. type: object @@ -390,6 +387,13 @@ components: $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' notifCorreId: type: string + description: > + Contains notification correlation ID used to identify the subscription to which the + notification relates. It shall be set to the same value as the "notifCorreId" attribute + of NwdafMLModelProvSubsc data type. + mlFile: + type: string + description: Contains the ML model file. mLFileAddr: $ref: '#/components/schemas/MLModelAddr' mLModelAdrf: @@ -399,10 +403,17 @@ components: spatialValidity: $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' addModelInfo: - $ref: '#/components/schemas/AdditionalMLModelInformation' - required: - - event - - mLFileAddr + type: array + items: + $ref: '#/components/schemas/AdditionalMLModelInformation' + minItems: 1 + description: Contains the additional ML Model Information besides the ML Model Address + allOf: + - required: [event] + - oneOf: + - required: [mLFileAddr] + - required: [mLModelAdrf] + FailureEventInfoForMLModel: description: > Represents the event(s) that the subscription is not successful including the failure @@ -430,25 +441,6 @@ components: - required: [mLModelUrl] - required: [mlFileFqdn] - MLModelMetric: - description: Indicates the ML model metric. - type: object - properties: - mlModelAcc: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - mlModelPre: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - mlModelRec: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - - MLModelStatus: - description: Indicates the pre-determined status of the ML model or training. - type: object - properties: - mlReqAcc: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - mlTrainTime: - $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' MLRepEventCondition: description: Indicates the ML event reporting condition. @@ -460,7 +452,8 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' mlAccuracyThreshold: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - + modelMetric: + $ref: '#/components/schemas/MLModelMetric' AdditionalMLModelInformation: description: Represents the additional ML Model Information. @@ -468,6 +461,8 @@ components: properties: mLFileAddr: $ref: '#/components/schemas/MLModelAddr' + mLModelAdrf: + $ref: '#/components/schemas/MLModelAdrf' validityPeriod: $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' spatialValidity: @@ -487,16 +482,15 @@ components: trainInpInfos: type: array items: - $ref: '#/components/schemas/TrainInputInfo' + $ref: '#/components/schemas/TrainInputDataInfo' minItems: 1 description: > Training information that is used by NWDAF containing MTLF during training. modelMetric: $ref: '#/components/schemas/MLModelMetric' accMLModel: - $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/Accuracy' - required: - - mLFileAddr + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + MLModelAdrf: description: ADRF (Set) information of the ML Model. @@ -510,8 +504,37 @@ components: type: string description: String identifying a Storage Transaction ID. oneOf: - - required: [adrfId] - - required: [adrfSetId] + - required: [adrfId] + - required: [adrfSetId] + + TrainInputDataInfo: + description: Contains Training input data information that is used by NWDAF containing MTLF. + type: object + properties: + dataInfo: + $ref: '#/components/schemas/InputDataInfo' + time: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dataStatisticsInfos: + type: string + + InferenceDataForModelTrain: + description: > + Indicates the inference data stored in ADRF which can be used by MTLF to retrain or + reprovision of the ML model. + type: object + properties: + adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + adrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + dataSetTag: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSetTag' + modelId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + oneOf: + - required: [adrfId] + - required: [adrfSetId] # # ENUMERATIONS DATA TYPES @@ -529,3 +552,17 @@ components: Represents the failure code. Possible values are: - UNAVAILABLE_ML_MODEL: Indicates the requested ML model for the event is unavailable. + + MLModelMetric: + anyOf: + - type: string + enum: + - 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 metric of the ML model. + Possible values are: + - ACCURACY: ML Model Accuracy metric. diff --git a/TS29520_Nnwdaf_MLModelTraining.yaml b/TS29520_Nnwdaf_MLModelTraining.yaml index 163849a6..ab4cd49f 100644 --- a/TS29520_Nnwdaf_MLModelTraining.yaml +++ b/TS29520_Nnwdaf_MLModelTraining.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: Nnwdaf_MLModelTraining - version: 1.0.0-alpha.2 + version: 1.0.0-alpha.3 description: | Nnwdaf_MLModelTraining API Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.520 V18.3.0; 5G System; Network Data Analytics Services. + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ servers: @@ -290,7 +290,7 @@ components: schemas: NwdafMLModelTrainSubsc: - description: Represents a ML Model Training subscription.. + description: Represents a ML Model Training subscription. type: object properties: mLEventSubscs: @@ -313,7 +313,7 @@ components: description: > Supplied by the NWDAF containing MTLF when available, shall contain the event(s) that the subscription is not successful including the failure reason(s). - mLCorreId: + mlCorreId: type: string description: String identifying the subscription is for a Federated Learning procedure. mLModelInfos: @@ -359,7 +359,7 @@ components: type: string description: > String identifying the use case context of the ML model. The value and format of this - parameter are not standardized. + parameter is not standardized. required: - mLEventSubscs - notifUri @@ -415,7 +415,7 @@ components: properties: delayEventNotif: $ref: '#/components/schemas/DelayEventNotif' - mLCorreId: + mlCorreId: type: string description: String identifying the subscription is for a Federated Learning procedure. mLModelInfos: @@ -447,7 +447,6 @@ components: - required: [termTrainReq] - required: [mLModelInfos, termTrainReq] - MLModelTrainInfo: description: > Represents the ML Model training information, include requirement on data availability and @@ -480,7 +479,6 @@ components: - mLTrainEvent - failureCodeTrain - DataAvReq: description: Represents the requirement on available data for the ML model training. type: object diff --git a/TS29520_Nnwdaf_RoamingAnalytics.yaml b/TS29520_Nnwdaf_RoamingAnalytics.yaml new file mode 100644 index 00000000..c6ac221a --- /dev/null +++ b/TS29520_Nnwdaf_RoamingAnalytics.yaml @@ -0,0 +1,294 @@ +openapi: 3.0.0 + +info: + title: Nnwdaf_RoamingAnalytics + version: 1.0.0-alpha.1 + description: | + Nnwdaf_RoamingAnalytics API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +servers: + - url: '{apiRoot}/nnwdaf-roaminganalytics/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-roaminganalytics + +paths: + /subscriptions: + post: + summary: Create a new Individual NWDAF Roaming Analytics Subscription + operationId: CreateNwdafRoamingAnalyticsSubscription + tags: + - NWDAF Roaming Analytics Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + responses: + '201': + description: Create a new Individual Roaming Analytics Subscription resource. + headers: + Location: + description: > + Contains the URI of the newly created resource. + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + '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: + type: array + items: + $ref: '#/components/schemas/RoamingAnalyticsNotification' + 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}: + put: + summary: Update an existing Individual Roaming Analytics Subscription resource. + operationId: UpdateNwdafRoamingAnalyticsSubscription + tags: + - Individual NWDAF Roaming Analytics Subscription resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingAnalytics service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF Roaming Analytics Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + '204': + description: > + The Individual NWDAF Roaming Analytics 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' + delete: + summary: Delete an existing Individual NWDAF Roaming Analytics Subscription. + operationId: DeleteNwdafRoamingAnalyticsSubscription + tags: + - Individual NWDAF Roaming Analytics Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingAnalytics service + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF Roaming Analytics 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' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdaf-roaminganalytics: Access to the Nnwdaf_RoamingAnalytics API + + schemas: + RoamingAnalyticsSubscription: + description: Represents a Roaming Analytics subscription. + type: object + properties: + roamEventSubs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventSubscription' + minItems: 1 + description: Represents Roaming Analytics subscription for a specific event. + evtReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + consPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + roamEventNotifs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventNotification' + minItems: 1 + description: Contains immediate reports for Roaming Analytics. + failEventReports: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/FailureEventInfo' + minItems: 1 + description: Contains information about failed events. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - roamEventSubs + - notifUri + - notifCorrId + - consPlmnId + + RoamingAnalyticsNotification: + description: Represents a Roaming Analytics notification. + type: object + properties: + roamEventNotifs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventNotification' + minItems: 1 + description: Contains Roaming Analytics notification for a specific event. + notifCorrId: + type: string + description: Notification correlation identifier. + termCause: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TermCause' + required: + - roamEventNotifs + - notifCorrId diff --git a/TS29520_Nnwdaf_RoamingData.yaml b/TS29520_Nnwdaf_RoamingData.yaml new file mode 100644 index 00000000..4946a3e8 --- /dev/null +++ b/TS29520_Nnwdaf_RoamingData.yaml @@ -0,0 +1,278 @@ +openapi: 3.0.0 + +info: + title: Nnwdaf_RoamingData + version: 1.0.0-alpha.1 + description: | + Nnwdaf_RoamingData API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.3.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +servers: + - url: '{apiRoot}/nnwdaf-roamingdata/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-roamingdata + +paths: + /subscriptions: + post: + summary: Create a new Individual NWDAF Roaming Data Subscription + operationId: CreateNWDAFRoamingDataSubscription + tags: + - NWDAF Roaming Data Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' + responses: + '201': + description: Create a new Individual NWDAF Roaming Data Subscription resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' + '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: 'TS29520_Nnwdaf_DataManagement.yaml#/components/schemas/NnwdafDataManagementNotif' + 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}: + put: + summary: Update an existing Individual NWDAF Roaming Data Subscription resource. + operationId: UpdateNWDAFRoamingDataSubscription + tags: + - Individual NWDAF Roaming Data Subscription resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingData Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF Roaming Data Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' + '204': + description: > + The Individual NWDAF Roaming Data 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' + delete: + summary: Delete an existing Individual NWDAF Roaming Data Subscription. + operationId: DeleteNWDAFRoamingDataSubscription + tags: + - Individual NWDAF Roaming Data Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingData Service + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF Roaming Data 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' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdaf-roamingdata: Access to the Nnwdaf_RoamingData API + + schemas: + RoamingDataSub: + description: > + Represents roaming data subscription information. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + dataSub: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSubscription' + anaSub: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' + formatInstruct: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/FormattingInstruction' + procInstructs: + type: array + items: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/ProcessingInstruction' + minItems: 1 + description: Processing instructions to be used for sending event notifications. + timePeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + targetNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + targetNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + immReport: + $ref: 'TS29520_Nnwdaf_DataManagement.yaml#/components/schemas/NnwdafDataManagementNotif' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - notificationUri + - notifCorrId + - plmnId + oneOf: + - required: [anaSub] + - required: [dataSub] diff --git a/TS29522_ASTI.yaml b/TS29522_ASTI.yaml index 801e6ad0..28b2bce9 100644 --- a/TS29522_ASTI.yaml +++ b/TS29522_ASTI.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-asti - version: 1.1.0-alpha.1 + version: 1.1.0-alpha.2 description: | API for ASTI. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.1.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -125,6 +125,46 @@ paths: $ref: 'TS29122_CommonData.yaml#/components/responses/503' default: $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + astiNotification: + '{$request.body#/astiNotifUri}': + post: + requestBody: + description: Notification of an ASTI configuration change event. + required: true + content: + application/json: + schema: + $ref: 'TS29565_Ntsctsf_ASTI.yaml#/components/schemas/AstiConfigNotification' + responses: + '204': + description: No Content, Notification was succesfull + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' /{afId}/configurations/retrieve: post: @@ -359,6 +399,8 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + astiNotifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' required: - asTimeDisParam oneOf: @@ -398,8 +440,8 @@ components: ActiveUe: description: > - Contains the UE identifier whose status of the access stratum time distribution is active and - the optional requested time synchronization error budget. + Contains the UE identifier whose status of the access stratum time distribution is active + and the optional requested time synchronization error budget. type: object properties: gpsi: diff --git a/TS29522_AnalyticsExposure.yaml b/TS29522_AnalyticsExposure.yaml index 3e8ac844..f7e4d58a 100644 --- a/TS29522_AnalyticsExposure.yaml +++ b/TS29522_AnalyticsExposure.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-analyticsexposure - version: 1.2.0-alpha.4 + version: 1.2.0-alpha.5 description: | API for Analytics Exposure. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.3.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -418,7 +418,7 @@ components: analyRepInfo: $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' notifUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' notifId: type: string eventNotifis: @@ -471,7 +471,7 @@ components: analyEvent: $ref: '#/components/schemas/AnalyticsEvent' expiry: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' timeStamp: $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' failNotifyCode: @@ -533,10 +533,20 @@ components: items: $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MovBehavInfo' minItems: 1 + wlanInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerformInfo' + minItems: 1 + relProxInfos: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RelProxInfo' + minItems: 1 start: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' timeStampGen: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' locArea: $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' pauseInd: @@ -549,6 +559,8 @@ components: 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. + accuInfo: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AccuracyInfo' required: - analyEvent - timeStamp @@ -686,6 +698,11 @@ components: items: $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' minItems: 1 + wlanReqs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/WlanPerformanceReq' + minItems: 1 extraReportReq: $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventReportingRequirement' maxNumOfTopAppUl: @@ -723,6 +740,11 @@ components: items: $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MovBehavReq' minItems: 1 + relProxReqs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RelProxReq' + minItems: 1 useCaseCxt: type: string description: > @@ -738,6 +760,10 @@ components: 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. + accuReq: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AccuracyReq' + feedback: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnalyticsFeedbackInfo' TargetUeId: description: Represents the target UE(s) information. @@ -782,6 +808,8 @@ components: properties: loc: $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + geoLoc: + $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' ratio: $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' confidence: @@ -900,6 +928,11 @@ components: items: $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' minItems: 1 + wlanReqs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/WlanPerformanceReq' + minItems: 1 maxNumOfTopAppUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' maxNumOfTopAppDl: @@ -940,17 +973,19 @@ components: description: > Indicates the context of usage of the analytics. The value and format of this parameter are not standardized. + accuReq: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AccuracyReq' AnalyticsData: description: Represents analytics data. type: object properties: start: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' expiry: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' timeStampGen: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' ueMobilityInfos: type: array items: @@ -1011,6 +1046,13 @@ components: items: $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MovBehavInfo' minItems: 1 + wlanInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerformInfo' + minItems: 1 + accuInfo: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AccuracyInfo' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: @@ -1137,6 +1179,28 @@ components: - startTs - endTs + WlanPerformInfo: + description: The WLAN performance related information. + type: object + properties: + locArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + wlanPerSsidInfos: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/WlanPerSsIdPerformanceInfo' + minItems: 1 + wlanPerUeIdInfos: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/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 + AnalyticsFailureEventInfo: description: > Represents an event for which the subscription request was not successful @@ -1166,6 +1230,9 @@ components: - SERVICE_EXPERIENCE - E2E_DATA_VOL_TRANS_TIME - MOVEMENT_BEHAVIOUR + - RELATIVE_PROXIMITY + - WLAN_PERFORMANCE + - NSI_LOAD_LEVEL - type: string description: > This string provides forward-compatibility with future @@ -1190,10 +1257,16 @@ components: performance. - SERVICE_EXPERIENCE: The AF requests to be notified about analytics information of service experience. - - 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 + - E2E_DATA_VOL_TRANS_TIME: The AF requests to be notified about analytics information of + E2E data volume transfer time. + - MOVEMENT_BEHAVIOUR: The AF requests to be notified about analytics information of + Movement Behaviour. + - RELATIVE_PROXIMITY: The AF requests to be notified about analytics information of + Relative Proximity. + - WLAN_PERFORMANCE: Indicates that the event subscribed is the Wlan Performance information. + - NSI_LOAD_LEVEL: Indicates that the event subscribed is load level information of Network + Slice and the optionally associated Network Slice Instance. AnalyticsFailureCode: anyOf: diff --git a/TS29522_DNAIMapping.yaml b/TS29522_DNAIMapping.yaml index 2b40e169..d86d4a25 100644 --- a/TS29522_DNAIMapping.yaml +++ b/TS29522_DNAIMapping.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-dnaimapping - version: 1.0.0-alpha.2 + version: 1.0.0-alpha.3 description: | API for DNAI Mapping. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.3.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -267,7 +267,7 @@ components: schemas: DnaiMapSub: - description: Represents an Dnai Mapping subscription. + description: Represents a DNAI Mapping subscription. type: object properties: easIpAddrs: @@ -278,7 +278,7 @@ components: description: > IP address(es) of the EASs in the Local part of the DN or the IP address ranges(IPv4 subnetwork(s) and/or IPv6 prefix(es) of the Local part of the DN where the EAS is - deployed for each DNAI. + deployed. fqdn: $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' dnn: @@ -287,10 +287,13 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' eventReq: $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' - dnai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + immReport: + $ref: '#/components/schemas/DnaiMapUpdateNotif' notifUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. requestTestNotification: type: boolean description: > @@ -305,6 +308,7 @@ components: - required: [fqdn] required: - notifUri + - notifCorrId DnaiMapUpdateNotif: description: Represents an updated DNAI Mapping notification. @@ -313,28 +317,13 @@ components: dnaiEasAddrMap: type: array items: - $ref: '#/components/schemas/DnaiEasAddrMap' + $ref: 'TS29519_Application_Data.yaml#/components/schemas/DnaiEasInfo' minItems: 1 description: > - Repsent the mapping information between DNAI(s) and EAS address(es). + Contains the mapping information between DNAI(s) and EAS address(es). + notifCorrId: + type: string + description: Notification correlation identifier. required: - dnaiEasAddrMap - - DnaiEasAddrMap: - description: defines the mapping between DNAI and EAS IP address(es). - type: object - properties: - dnai: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' - easIpAddrs: - type: array - items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' - minItems: 1 - description: > - IP address(es) of the EASs in the Local part of the DN or the IP address ranges (IPv4 - subnetwork(s) and/or IPv6 prefix(es) of the Local part of the DN where the EAS is - deployed for each DNAI. - required: - - dnai - - easIpAddrs + - notifCorrId diff --git a/TS29522_EASDeployment.yaml b/TS29522_EASDeployment.yaml index 9cdf401d..61061f81 100644 --- a/TS29522_EASDeployment.yaml +++ b/TS29522_EASDeployment.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-eas-deployment - version: 1.1.0-alpha.2 + version: 1.1.0-alpha.3 description: | API for AF provisioned EAS Deployment. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.2.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -364,6 +364,8 @@ components: description: > Identifier of the AF that is responsible for the EAS associated with this EAS deployment information. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: - fqdnPatternList diff --git a/TS29522_ECSAddress.yaml b/TS29522_ECSAddress.yaml new file mode 100644 index 00000000..f3cf76b6 --- /dev/null +++ b/TS29522_ECSAddress.yaml @@ -0,0 +1,369 @@ +openapi: 3.0.0 + +info: + title: 3gpp-ecs-address + version: 1.0.0-alpha.1 + description: | + API for AF provisioned ECS Address Configuration Information. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/3gpp-ecs-address/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. + +paths: + /{afId}/ecs-address-info: + get: + summary: Read all ECS Address Configuration Information for a given AF + operationId: ReadAllEACIs + tags: + - ECS Address Configuration Information (Collection) + parameters: + - name: afId + in: path + description: Identifier of the AF + required: true + schema: + type: string + responses: + '200': + description: OK (Successful retrieval of the ECS Address Configuration Information) + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EcsAddrInfo' + minItems: 0 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + post: + summary: Create a new Individual ECS Address Configuration Information resource. + operationId: CreateEACI + tags: + - ECS Address Configuration Information (Collection) + parameters: + - name: afId + in: path + description: Identifier of the AF + required: true + schema: + type: string + requestBody: + description: new resource creation + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrInfo' + responses: + '201': + description: Created (Successful creation) + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrInfo' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /{afId}/ecs-address-info/{ecsAddrInfoId}: + get: + summary: Read an active Individual ECS Address Configuration Information resource for the AF + operationId: ReadEACI + tags: + - Individual ECS Address Configuration Information + parameters: + - name: afId + in: path + description: Identifier of the AF + required: true + schema: + type: string + - name: ecsAddrInfoId + in: path + description: Identifier of ECS Address Configuration Information. + required: true + schema: + type: string + responses: + '200': + description: OK (Successful retrieval of the active resource) + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrInfo' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Fully updates/replaces an existing resource + operationId: UpdateEACI + tags: + - Individual ECS Address Configuration Information + parameters: + - name: afId + in: path + description: Identifier of the AF + required: true + schema: + type: string + - name: ecsAddrInfoId + in: path + description: Identifier of the ECS Address Configuration Information resource + required: true + schema: + type: string + requestBody: + description: Parameters to update/replace the existing resource + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrInfo' + responses: + '200': + description: OK (Successful update of the existing resource) + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrInfo' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content is + sent in the response message. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Deletes an existing ECS Address Configuration Information resource + operationId: DeleteEACI + tags: + - Individual ECS Address Configuration Information + parameters: + - name: afId + in: path + description: Identifier of the AF + required: true + schema: + type: string + - name: ecsAddrInfoId + in: path + description: Identifier of the ECS Address Configuration Information resource + required: true + schema: + type: string + responses: + '204': + description: No Content (Successful deletion of the existing resource) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /remove-ecsaddr: + post: + summary: Remove ECS Address Configuration Information based on given criteria. + operationId: DeleteEACIs + tags: + - ECS Address Configuration Information removal + requestBody: + description: Criteria to be used for deleting ECS Address Configuration Information. + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrDeleteCriteria' + required: true + responses: + '204': + description: > + No Content. The entries matching the provided criteria have been successfully deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + EcsAddrInfo: + description: Represents ECS Address Configuration Information. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + ecsServerAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EcsServerAddr' + spatialValidityCond: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond' + tgtUe: + $ref: 'TS29522_AnalyticsExposure.yaml#/components/schemas/TargetUeId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ecsServerAddr + + EcsAddrDeleteCriteria: + description: > + Contains criteria to be used for deleting ECS Address Configuration Information. + type: object + properties: + afIds: + type: array + items: + $ref: 'TS29522_AKMA.yaml#/components/schemas/AfId' + minItems: 1 + description: AF identifiers to be used as deletion criterion. + ecsAddrInfo: + $ref: '#/components/schemas/EcsAddrInfo' + anyOf: + - required: [afIds] + - required: [ecsAddrInfo] diff --git a/TS29522_EcsAddressProvision.yaml b/TS29522_EcsAddressProvision.yaml index 26fa0a86..f126fbe5 100644 --- a/TS29522_EcsAddressProvision.yaml +++ b/TS29522_EcsAddressProvision.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-ecs-address-provision - version: 1.1.0-alpha.1 + version: 1.1.0-alpha.2 description: | API for ECS Address Provisioning. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.1.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -302,6 +302,8 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond' tgtUe: $ref: 'TS29522_AnalyticsExposure.yaml#/components/schemas/TargetUeId' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: diff --git a/TS29522_MBSGroupMsgDelivery.yaml b/TS29522_MBSGroupMsgDelivery.yaml index 95e073ac..1d269c7e 100644 --- a/TS29522_MBSGroupMsgDelivery.yaml +++ b/TS29522_MBSGroupMsgDelivery.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-mbs-group-msg - version: 1.0.0-alpha.3 + version: 1.0.0-alpha.4 description: | API for MBS Group Message Delivery. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.3.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -40,7 +40,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/MbsGroupMsgDelData' + $ref: '#/components/schemas/MbsGroupMsgDel' '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': @@ -74,7 +74,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MbsGroupMsgDelReq' + $ref: '#/components/schemas/MbsGroupMsgDel' responses: '201': description: > @@ -83,7 +83,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MbsGroupMsgDelResp' + $ref: '#/components/schemas/MbsGroupMsgDel' headers: Location: description: Contains the URI of the newly created resource. @@ -179,7 +179,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MbsGroupMsgDelData' + $ref: '#/components/schemas/MbsGroupMsgDel' '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': @@ -211,7 +211,7 @@ paths: requestBody: required: true content: - application/json-patch+json: + application/merge-patch+json: schema: $ref: '#/components/schemas/MbsGroupMsgDelPatch' responses: @@ -222,7 +222,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MbsGroupMsgDelResp' + $ref: '#/components/schemas/MbsGroupMsgDel' '204': description: > No Content. Successful case. The MBS Group Message Delivery is @@ -297,76 +297,58 @@ components: # STRUCTURED DATA TYPES - MbsGroupMsgDelReq: - description: > - Represents the full set of parameters to initiate an MBS group message delivery request. - type: object - properties: - mbsGroupMsgDelData: - $ref: '#/components/schemas/MbsGroupMsgDelData' - suppFeat: - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - required: - - mbsGroupMsgDelData - - MbsGroupMsgDelData: - description: Represents MBS Group Message Delivery data. + MbsGroupMsgDel: + description: Represents the MBS Group Message Delivery. type: object properties: + afId: + type: string externalGroupId: $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + groupMsgDelPayload: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' mbsServArea: - $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' - extMbsServArea: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalMbsServiceArea' + $ref: '#/components/schemas/MbsServArea' startTime: $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' stopTime: $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' notifUri: $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' - required: - - externalGroupId - - startTime - - stopTime - - notifUri - oneOf: - - required: [mbsServArea] - - required: [extMbsServArea] - - MbsGroupMsgDelResp: - description: > - Represents a response to a requested MBS group message delivery. - type: object - properties: - mbsGroupMsgDelData: - $ref: '#/components/schemas/MbsGroupMsgDelData' delStatus: type: boolean + description: > + Indicates the status of Group Message Delivery. + true indicates a successful delivery. + false indicates a failed delivery. + The default value if omitted is true. mbsUserServiceAnmt: $ref: 'TS26517_MBSUserServiceAnnouncement.yaml#/components/schemas/UserServiceDescription' + servAreaWithoutMbs: + $ref: '#/components/schemas/MbsServArea' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: - - mbsGroupMsgDelData - - delStatus + - externalGroupId + - mbsServArea + - startTime + - stopTime + - notifUri MbsGroupMsgDelPatch: description: Represents the requested modifications to an existing MBS Group Message Delivery. type: object properties: + groupMsgDelPayload: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' mbsServArea: - $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' - extMbsServArea: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalMbsServiceArea' + $ref: '#/components/schemas/MbsServArea' startTime: $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' stopTime: $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' notifUri: $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' - not: - required: [mbsServArea, extMbsServArea] MbsGroupMsgDelStatusNotif: description: Represents the status notification information for an MBS group message delivery. @@ -374,6 +356,10 @@ components: properties: delStatus: type: boolean + description: > + Indicates the status of Group Message Delivery. + true indicates a successful delivery. + false indicates a failed delivery. required: - delStatus @@ -382,3 +368,12 @@ components: # # ENUMERATIONS + +# +# Data types describing alternative data types or combinations of data types + + MbsServArea: + description: Represents an MBS Service Area. + oneOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalMbsServiceArea' diff --git a/TS29522_MBSSession.yaml b/TS29522_MBSSession.yaml index cf6078f9..4b73f86d 100644 --- a/TS29522_MBSSession.yaml +++ b/TS29522_MBSSession.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-mbs-session - version: 1.2.0-alpha.1 + version: 1.2.0-alpha.2 description: | API for MBS Session Management. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.1.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' servers: @@ -59,7 +59,13 @@ paths: '401': $ref: 'TS29122_CommonData.yaml#/components/responses/401' '403': - $ref: 'TS29122_CommonData.yaml#/components/responses/403' + description: > + The request is rejected by the NEF and more details (along with ProblemDetails) may be + returned. + content: + application/problem+json: + schema: + $ref: 'TS29522_MBSTMGI.yaml#/components/schemas/ProblemDetailsTmgiAlloc' '404': $ref: 'TS29122_CommonData.yaml#/components/responses/404' '411': @@ -101,6 +107,14 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' minItems: 1 responses: + '200': + description: > + OK. The Individual MBS Session was successfully updated and MBS Session update related + information shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsSessionUpdateResp' '204': description: > No Content. The concerned Individual MBS Session resource was successfully modified. @@ -714,6 +728,8 @@ components: type: string mbsSessAuthData: $ref: '#/components/schemas/MbsSessAuthData' + mbsSessAssistInfo: + $ref: '#/components/schemas/MbsSessAssistInfo' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: @@ -747,9 +763,37 @@ components: properties: mbsSessAuthData: $ref: '#/components/schemas/MbsSessAuthData' + mbsSessAssistInfo: + $ref: '#/components/schemas/MbsSessAssistInfo' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + MbsSessAssistInfo: + description: > + Represents the MBS Session Assistance information. + type: object + properties: + mbsSessAssistData: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/MbsAssistanceInfo' + minItems: 1 + required: + - mbsSessAssistData + + MbsSessionUpdateResp: + description: > + Represents the parameters to be returned in an MBS Session update response during + partial success. + type: object + properties: + reducedMbsServArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' + reducedExtMbsServArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalMbsServiceArea' + not: + required: [reducedMbsServArea, reducedExtMbsServArea] + # # SIMPLE DATA TYPES # diff --git a/TS29522_MBSTMGI.yaml b/TS29522_MBSTMGI.yaml index 17d34786..d8f2f9cf 100644 --- a/TS29522_MBSTMGI.yaml +++ b/TS29522_MBSTMGI.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-mbs-tmgi - version: 1.1.0-alpha.2 + version: 1.1.0-alpha.3 description: | API for the allocation, deallocation and management of TMGI(s) for MBS. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.2.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -55,7 +55,13 @@ paths: '401': $ref: 'TS29122_CommonData.yaml#/components/responses/401' '403': - $ref: 'TS29122_CommonData.yaml#/components/responses/403' + description: > + The request is rejected by the NEF and more details (along with ProblemDetails) may be + returned. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsTmgiAlloc' '404': $ref: 'TS29122_CommonData.yaml#/components/responses/404' '411': @@ -235,3 +241,24 @@ components: minItems: 1 required: - tmgis + + ReducedMbsServArea: + description: > + Represents the reduced MBS Service Area information. + type: object + properties: + reducedMbsServArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' + reducedExtMbsServArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalMbsServiceArea' + oneOf: + - required: [reducedMbsServArea] + - required: [reducedExtMbsServArea] + + ProblemDetailsTmgiAlloc: + description: > + Represents an extension to the ProblemDetails data structure with additional error + information related to TMGI Allocation. + allOf: + - $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ReducedMbsServArea' diff --git a/TS29522_MemberUESelectionAssistance.yaml b/TS29522_MemberUESelectionAssistance.yaml index 1a86fed0..343ae5a7 100644 --- a/TS29522_MemberUESelectionAssistance.yaml +++ b/TS29522_MemberUESelectionAssistance.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-musa - version: 1.0.0-alpha.1 + version: 1.0.0-alpha.2 description: | API for Member UE Selection Assistance. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.1.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' servers: @@ -299,22 +299,233 @@ components: minItems: 1 description: Identifies the list of UEs for Member Selection Assistance Reporting. notifUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' notifId: type: string - filterCriters: - type: string - appId: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' expTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - timeWins: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + qosFilters: + type: array + items: + $ref: '#/components/schemas/QoSFilterCriteria' + minItems: 1 + description: The QoS filtering criteria for Member UE selection. + accRatTypeFilters: + type: array + items: + $ref: '#/components/schemas/AccessRatTypeFilterCriteria' + minItems: 1 + description: The Access types and Rat types filtering criteria for Member UE selection. + e2eTransTimeFilters: + type: array + items: + $ref: '#/components/schemas/E2ETransTimeFilterCriteria' + minItems: 1 + description: > + The End-to-end data volume transfer time filtering criteria for Member UE selection. + ueLocFilters: + type: array + items: + $ref: '#/components/schemas/UeLocFilterCriteria' + minItems: 1 + description: The UE location filtering criteria for Member UE selection. + ueHisLocFilters: + type: array + items: + $ref: '#/components/schemas/UeHisLocFilterCriteria' + minItems: 1 + description: The UE historical location filtering criteria for Member UE selection. + ueDirFilters: + type: array + items: + $ref: '#/components/schemas/UeDirectionFilterCriteria' + minItems: 1 + description: The UE direction filtering criteria for Member UE selection. + ueDistanceFilters: + type: array + items: + $ref: '#/components/schemas/UeDistanceFilterCriteria' + minItems: 1 + description: The UE distance filtering criteria for Member UE selection. + serviceExpFilters: + type: array + items: + $ref: '#/components/schemas/ServiceExpFilterCriteria' + minItems: 1 + description: The Service Experience filtering criteria for Member UE selection. + dnnFilters: + type: array + items: + $ref: '#/components/schemas/DnnFilterCriteria' + minItems: 1 + description: The DNN filtering criteria for Member UE selection. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: - tgtUes - notifUri - notifId - - filterCriters + anyOf: + - required: [qosFilters] + - required: [accRatTypeFilters] + - required: [e2eTransTimeFilters] + - required: [ueLocFilters] + - required: [ueHisLocFilters] + - required: [ueDirFilters] + - required: [ueDistanceFilters] + - required: [serviceExpFilters] + - required: [dnnFilters] + + QoSFilterCriteria: + description: The QoS filtering criteria for Member UE selection. + type: object + properties: + event: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/SmfEvent' + appId: + type: string + description: Identifies an application. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + ulDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + dlDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + rtDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + + AccessRatTypeFilterCriteria: + description: The Access types and Rat types filtering criteria for Member UE selection. + type: object + properties: + events: + type: array + items: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/SmfEvent' + minItems: 1 + description: > + Indicates the SMF event(s) which may be used to retrieve the Access Type and/or RAT Type + of the selected UE. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + accTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + description: Indicates the Access Types of the selected UE. + ratTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + description: Indicate the RAT Types of the selected UE. + + E2ETransTimeFilterCriteria: + description: > + The End-to-end data volume transfer time filtering criteria for Member UE selection. + type: object + properties: + event: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + appId: + type: string + description: Identifies an application. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dataVolTransTime: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DataVolumeTransferTime' + locationArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + timeWin: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + + UeLocFilterCriteria: + description: The UE location filtering criteria for Member UE selection. + type: object + properties: + event: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/AmfEventType' + loc: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + + UeHisLocFilterCriteria: + description: The UE historical location filtering criteria for Member UE selection. + type: object + properties: + event: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + loc: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + startTs: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + endTs: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + + UeDirectionFilterCriteria: + description: The UE direction filtering criteria for Member UE selection. + type: object + properties: + event: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + directions: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/Direction' + minItems: 1 + description: Indicates the moving directions of the UEs. + + UeDistanceFilterCriteria: + description: The UE distance filtering criteria for Member UE selection. + type: object + properties: + event: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + distance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + + ServiceExpFilterCriteria: + description: The Service Experience filtering criteria for Member UE selection. + type: object + properties: + event: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appId: + type: string + description: Identifies an application. + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + loc: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + contribWeightThr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + timeWin: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + expTypes: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ServiceExperienceType' + minItems: 1 + description: Indicates the Service Experience Types. + + DnnFilterCriteria: + description: The DNN filtering criteria for Member UE selection. + type: object + properties: + event: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/SmfEvent' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' MemUeSeletAssistNotif: description: Represents a Member UE Selection Assistance notification. @@ -322,12 +533,76 @@ components: properties: notifId: type: string - remdUes: + candiUeInfos: type: array items: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + $ref: '#/components/schemas/CandiUeInfo' + minItems: 1 + description: > + Identifies the lists of candidate UEs information for Member Selection Assistance + Reporting. + memUeSelectRpts: + type: array + items: + $ref: '#/components/schemas/MemUeSeletReport' minItems: 1 description: Identifies the list of UEs for Member Selection Assistance Reporting. required: - notifId - - remdUes + - candiUeInfos + + MemUeSeletReport: + description: Indicates the Member UE selection report. + type: object + properties: + criterionType: + $ref: '#/components/schemas/FilterCriterionType' + numForCriterion: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + required: + - criterionType + - numForCriterion + + CandiUeInfo: + description: Identifies the list of candidate UEs information. + type: object + properties: + candiUes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + remdTimeWin: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + required: + - candiUes + + FilterCriterionType: + anyOf: + - type: string + enum: + - QOS + - ACCESS_RAT_TYPE + - E2E_DATA_VOLUME_TRANSFER_TIME + - UE_LOCATION + - UE_HISTORICAL_LOCATION + - UE_DIRECTION + - UE_DISTANCE + - SERVICE_EXPERIENCE + - DNN + - 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 filter criterion event + Possible values are: + - QOS: Indicates QoS criterion. + - ACCESS_RAT_TYPE: Indicates Access and Rat types criterion. + - E2E_DATA_VOLUME_TRANSFER_TIME: Indicates End-to-end data volume transfer time criterion. + - UE_LOCATION: Indicates UE location criterion. + - UE_HISTORICAL_LOCATION: Indicates UE historical location criterion. + - UE_DIRECTION: Indicates UE direction criterion. + - UE_DISTANCE: Indicates UE distance criterion. + - SERVICE_EXPERIENCE: Indicates the Service Experience criterion. + - DNN: Indicates the DNN criterion. diff --git a/TS29522_PDTQPolicyNegotiation.yaml b/TS29522_PDTQPolicyNegotiation.yaml index b7a22861..8aae8993 100644 --- a/TS29522_PDTQPolicyNegotiation.yaml +++ b/TS29522_PDTQPolicyNegotiation.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-pdtq-policy-negotiation - version: 1.0.0-alpha.2 + version: 1.0.0-alpha.3 description: | API for PDTQ policy negotiation. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.3.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -400,8 +400,6 @@ components: properties: pdtqRefId: $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqReferenceId' - locationArea5G: - $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' candPolicies: type: array items: @@ -409,6 +407,7 @@ components: minItems: 1 description: > This IE indicates a list of the candidate PDTQ policies from which the AF may select - a new PDTQ policy due to network performance degradation. + a new PDTQ policy due to network performance or DN performance degradation. required: - pdtqRefId + - candPolicies diff --git a/TS29522_ServiceParameter.yaml b/TS29522_ServiceParameter.yaml index 4b103156..d5f44693 100644 --- a/TS29522_ServiceParameter.yaml +++ b/TS29522_ServiceParameter.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-service-parameter - version: 1.2.0-alpha.4 + version: 1.2.0-alpha.5 description: | API for AF service paramter © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.3.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -426,8 +426,11 @@ components: items: $ref: '#/components/schemas/Event' minItems: 1 + description: > + Identifies the AF subscribed event(s) notifications related to AF provisioned + service parameters. notificationDestination: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' requestTestNotification: type: boolean description: > @@ -517,8 +520,11 @@ components: $ref: '#/components/schemas/Event' minItems: 1 nullable: true + description: > + Identifies the AF subscribed event(s) notifications related to AF provisioned + service parameters. notificationDestination: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' ParameterOverPc5: description: > @@ -686,6 +692,8 @@ components: Indicates the TAIs in which the route selection parameters apply. This attribute is applicable only within the 5GC and it shall not be included in the request messages of untrusted AFs for URSP guidance. + pduSessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' Event: anyOf: @@ -787,13 +795,18 @@ components: description: > This is matched against the information provided by a UE application when it requests a network connection with certain capabilities. - anyOf: - - required: [appDescs] - - required: [flowDescs] - - required: [domainDescs] - - required: [ethFlowDescs] - - required: [dnns] - - required: [connCaps] + pinId: + type: string + description: This is matched against a PIN ID for a specific PIN configured in the PEGC. + oneOf: + - required: [pinId] + - anyOf: + - required: [appDescs] + - required: [flowDescs] + - required: [domainDescs] + - required: [ethFlowDescs] + - required: [dnns] + - required: [connCaps] NetworkDescription: description: > @@ -810,6 +823,7 @@ components: items: $ref: 'TS29571_CommonData.yaml#/components/schemas/Mnc' minItems: 1 + description: Represents the applicable MNC(s) for the indicated MCC. anyPlmnInd: type: boolean description: Indicates any PLMN. @@ -839,6 +853,8 @@ components: properties: failureCause: $ref: '#/components/schemas/Failure' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' Failure: oneOf: diff --git a/TS29522_SliceParamProvision.yaml b/TS29522_SliceParamProvision.yaml index 475ef106..fe086458 100644 --- a/TS29522_SliceParamProvision.yaml +++ b/TS29522_SliceParamProvision.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: Slice Parameters Provisionings - version: 1.0.0-alpha.1 + version: 1.0.0-alpha.2 description: | API for Slice Parameters Provisionings. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.3.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -44,7 +44,7 @@ paths: type: array items: $ref: '#/components/schemas/SlicePpData' - minItems: 1 + minItems: 0 '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': diff --git a/TS29522_TimeSyncExposure.yaml b/TS29522_TimeSyncExposure.yaml index 7b1ebc7f..0d0c1b3e 100644 --- a/TS29522_TimeSyncExposure.yaml +++ b/TS29522_TimeSyncExposure.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-time-sync-exposure - version: 1.1.0-alpha.4 + version: 1.1.0-alpha.5 description: | API for time synchronization exposure. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.3.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -690,7 +690,7 @@ components: type: string description: Notification Correlation ID assigned by the NF service consumer. subsNotifUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' subscribedEvents: type: array items: @@ -710,7 +710,7 @@ components: maxReportNbr: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' expiry: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' repPeriod: $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' requestTestNotification: @@ -725,6 +725,10 @@ components: required: - subsNotifUri - subsNotifId + oneOf: + - required: [gpsis] + - required: [anyUeInd] + - required: [externalGroupId] TimeSyncCapability: description: Contains time synchronization capability. @@ -736,6 +740,8 @@ components: type: array items: $ref: '#/components/schemas/GmCapable' + description: > + Indicates whether user plane node supports acting as a gPTP and/or PTP grandmaster. asTimeRes: $ref: '#/components/schemas/AsTimeResource' ptpCapForUes: @@ -775,18 +781,15 @@ components: type: string description: Notification Correlation ID assigned by the NF service consumer. configNotifUri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' tempValidity: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' coverageArea: $ref: 'TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond' - timeSyncStatusParam: - type: array - items: - $ref: '#/components/schemas/TimeSyncStatusParam' - minItems: 1 - description: > - This contains the clock quality detail level and clock quality acceptance criteria. + clkQltDetLvl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityDetailLevel' + clkQltAcptCri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' required: - upNodeId - reqPtpIns @@ -806,6 +809,8 @@ components: items: $ref: '#/components/schemas/SubsEventNotification' minItems: 1 + description: > + Notifications about subscribed Individual Events. required: - subsNotifId - eventNotifs @@ -821,6 +826,8 @@ components: items: $ref: '#/components/schemas/TimeSyncCapability' minItems: 1 + description: > + Contains a list of time synchronization capabilities for the UE(s). required: - event @@ -836,6 +843,7 @@ components: required: - configNotifId - stateOfConfig + PtpCapabilitiesPerUe: description: Contains the supported PTP capabilities per UE. type: object @@ -847,6 +855,8 @@ components: items: $ref: '#/components/schemas/EventFilter' minItems: 1 + description: > + Contains the reported PTP capabilities for the UE. required: - gpsi - ptpCaps @@ -862,16 +872,22 @@ components: items: $ref: '#/components/schemas/InstanceType' minItems: 1 + description: > + Indicates the PTP instance type(s). transProtocols: type: array items: $ref: '#/components/schemas/Protocol' minItems: 1 + description: > + Indicates the transport protocol type(s). ptpProfiles: type: array items: type: string minItems: 1 + description: > + Identifies the supported PTP profiles. PtpInstance: description: Contains PTP instance configuration and activation requested by the AF. @@ -882,12 +898,15 @@ components: protocol: $ref: '#/components/schemas/Protocol' ptpProfile: - type: string + type: string + description: Identifies the PTP profile. portConfigs: type: array items: $ref: '#/components/schemas/ConfigForPort' minItems: 1 + description: > + Contains the configurations for the PTP port(s) in the PTP instance. required: - instanceType - protocol @@ -901,16 +920,38 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' n6Ind: type: boolean + description: > + Indicates the N6 termination which the parameters below apply. ptpEnable: type: boolean + description: > + This is used to set the portDS.portEnable. If omitted, the default value as described + in the PTP Profile is used. logSyncInter: type: integer + description: > + Specifies the mean time interval between successive Sync messages. logSyncInterInd: type: boolean + description: > + When set to "false", the value of "logSyncInter" attribute is used to set the + initialLogSyncInterval as described in IEEE Std 802.1AS [46]. When set to "true", + the value of "logSyncInter" attribute is used to set the mgtSettableLogSyncInterval + as described in IEEE Std 802.1AS [46]. logAnnouInter: type: integer + description: > + Specifies the mean time interval between successive Announce messages. logAnnouInterInd: type: boolean + description: > + When set to "false", the value of "logAnnouInter" attribute is used to set the + initialLogAnnounceInterval as described in IEEE 802.1AS [46]. When set to "true", + the value of "logAnnouInter" attribute is used to set the + mgtSettableLogAnnounceInterval as described in IEEE Std 802.1AS [46]. + oneOf: + - required: [gpsi] + - required: [n6Ind] StateOfConfiguration: description: Contains the state of the time synchronization configuration. @@ -930,13 +971,6 @@ components: items: $ref: '#/components/schemas/StateOfDstt' minItems: 1 - clkQltAcptCriReports: - description: > - Indicates if the clock quality acceptance criteria is met or not for the indicated UE(s). - type: array - items: - $ref: '#/components/schemas/ClockQualityAcceptanceCriteriaResult' - minItems: 1 StateOfDstt: description: Contains the PTP port state of a DS-TT. @@ -955,24 +989,6 @@ components: - gpsi - state - ClockQualityAcceptanceCriteriaResult: - description: > - Indicates whether the clock quality acceptance criteria is met or not for the indicated - PTP port, i.e. per the indicated UE. - type: object - properties: - supi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - gpsi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - clkQltAcptCriResInd: - $ref: '#/components/schemas/AcceptanceCriteriaResultIndication' - required: - - clkQltAcptCriResInd - anyOf: - - required: [supi] - - required: [gpsi] - Protocol: anyOf: - type: string @@ -1073,30 +1089,18 @@ components: - OTHER: Indicates other source of time is supported. AcceptanceCriteriaResultIndication: - description: > - Contains the acceptable/not acceptable indication of the clock quality acceptance criteria - result information. anyOf: - - type: string - enum: - - ACCEPTABLE - - NON_ACCEPTABLE - - type: string - - TimeSyncStatusParam: - description: > - Contains clock quality detail level and optionally clock quality acceptance criteria - per UE. - type: object - properties: - supi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - gpsi: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - clkQltDetLvl: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityDetailLevel' - clkQltAcptCri: - $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' - anyOf: - - required: [supi] - - required: [gpsi] + - type: string + enum: + - ACCEPTABLE + - NON_ACCEPTABLE + - type: string + description: > + Contains the acceptable/not acceptable indication of the clock quality acceptance criteria + result information. + description: | + Identifies the supported acceptable / not acceptable indication. + Possible values are: + - ACCEPTABLE: PTP port in (g)PTP service meets the clock quality acceptance criteria. + - NON_ACCEPTABLE: PTP port in (g)PTP service does not meet the clock quality acceptance + criteria. diff --git a/TS29522_TrafficInfluence.yaml b/TS29522_TrafficInfluence.yaml index d334ee1c..af968b14 100644 --- a/TS29522_TrafficInfluence.yaml +++ b/TS29522_TrafficInfluence.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 3gpp-traffic-influence - version: 1.3.0-alpha.3 + version: 1.3.0-alpha.4 description: | API for AF traffic influence © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.522 V18.3.0; 5G System; Network Exposure Function Northbound APIs. + 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: @@ -538,6 +538,10 @@ components: omitted. tfcCorreInfo: $ref: 'TS29519_Application_Data.yaml#/components/schemas/TrafficCorrelationInfo' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + portNumber: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' allOf: diff --git a/TS29522_UEAddress.yaml b/TS29522_UEAddress.yaml new file mode 100644 index 00000000..981b8cc9 --- /dev/null +++ b/TS29522_UEAddress.yaml @@ -0,0 +1,103 @@ +openapi: 3.0.0 + +info: + title: 3gpp-ue-address + version: 1.0.0-alpha.1 + description: | + API for UE Address service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/3gpp-ue-address/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122. + +paths: + /retrieve: + post: + summary: Retrieve UE Address. + operationId: RetrieveUEAddress + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UeAddressReq' + responses: + '200': + description: The requested information was returned successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/UeAddressInfo' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + schemas: + UeAddressReq: + description: Represents the parameters to request the retrieval of UE Address. + type: object + properties: + afId: + type: string + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - afId + - gpsi + + UeAddressInfo: + description: Represents UE Address information. + type: object + properties: + ueIpAddrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + required: + - ueIpAddrs diff --git a/TS29522_UEId.yaml b/TS29522_UEId.yaml index 1ee345e9..23b74791 100644 --- a/TS29522_UEId.yaml +++ b/TS29522_UEId.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: 3gpp-ueid - version: 1.1.0-alpha.1 + version: 1.1.0-alpha.2 description: | API for UE ID service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.522 V18.3.0; 5G System; Network Exposure Function Northbound APIs. + description: 3GPP TS 29.522 V18.4.0; 5G System; Network Exposure Function Northbound APIs. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/' security: - {} @@ -98,16 +98,21 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' ueMacAddr: $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: - afId oneOf: - required: [ueIpAddr] - required: [ueMacAddr] + UeIdInfo: description: Represents UE ID information. type: object properties: externalId: $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: - externalId diff --git a/TS29525_Npcf_UEPolicyControl.yaml b/TS29525_Npcf_UEPolicyControl.yaml index f9d5f51f..7f2669ce 100644 --- a/TS29525_Npcf_UEPolicyControl.yaml +++ b/TS29525_Npcf_UEPolicyControl.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 1.3.0-alpha.4 + version: 1.3.0-alpha.5 title: Npcf_UEPolicyControl description: | UE Policy Control Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.525 V18.3.0; 5G System; UE Policy Control Service. + description: 3GPP TS 29.525 V18.4.0; 5G System; UE Policy Control Service. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.525/' servers: @@ -364,6 +364,8 @@ components: description: Combination of DNN and S-NSSAIs for which LBO information is requested. suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + n2Pc5RsppPol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' required: - suppFeat @@ -456,8 +458,9 @@ components: $ref: '#/components/schemas/UePolicyParameters' minProperties: 1 description: > - Contains the service parameter used to guide the VPLMN-specific URSP. - The key of the map represents the AF request to guide VPLMN-specific URS rules. + 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 @@ -469,6 +472,13 @@ components: This attribute only applies in roaming and when the AMF is the NF service consumer. suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + rangingSlCapab: + type: boolean + description: > + It indicates whether the PC5 Capability for Ranging/SL is supported by the UE or not. + "true": Indicates that the PC5 Capability for Ranging/SL is supported by the UE. + "false": Indicates that the PC5 Capability for Ranging/SL is not supported by the UE. + Default value when omitted is "false". required: - notificationUri - suppFeat @@ -558,9 +568,39 @@ components: 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. + 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 + accessStatus: + $ref: '#/components/schemas/AccessStatus' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - + rangingSlCapab: + type: boolean + description: > + It indicates whether the PC5 Capability for Ranging/SL is supported by the UE or not. + "true": Indicates that the PC5 Capability for Ranging/SL is supported by the UE. + "false": Indicates that the PC5 Capability for Ranging/SL is not supported by the UE. PolicyUpdate: description: > Represents updated policies that the PCF provides in a notification or in the reply to an @@ -598,6 +638,17 @@ components: type: boolean description: > Indication that the updated ANDSP/WLANSP has been successfully delivered to the UE. + 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: @@ -608,6 +659,8 @@ components: nullable: true suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + n2Pc5RsppPol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' required: - resourceUri @@ -632,7 +685,9 @@ components: type: object properties: cause: - $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N1N2MessageTransferCause' + $ref: '#/components/schemas/UePolicyTransferFailureCause' + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' ptis: type: array items: @@ -686,7 +741,11 @@ components: 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 UePolicyParameters: description: > Contains the service parameters used to guide the VPLMN-specific URSP rule determination. @@ -697,7 +756,16 @@ components: items: $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/UrspRuleRequest' minItems: 1 - description: Contains the service parameter used to guide the URSP. + 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. LboRoamingInformation: description: > @@ -718,7 +786,7 @@ components: UrspEnforcementPduSession: description: > - Represents URSP enforcement information for a PDU session. + Represents URSP rule enforcement information for a PDU session. type: object required: - urspEnfInfo @@ -738,6 +806,20 @@ components: pduSessInfo: $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/PduSessionInformation' + UePolicyNotification: + description: > + Contains the delivery outcome of VPLMN-specific URSP rules. + type: object + 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' @@ -764,6 +846,7 @@ components: - LBO_INFO_CH - FEAT_RENEG - URSP_ENF_INFO + - ACCESS_TYPE_CH - type: string description: > This string provides forward-compatibility with future @@ -773,16 +856,17 @@ components: 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. + - 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 + - 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. @@ -797,8 +881,10 @@ components: 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 enforcement information for one or more URSP + - URSP_ENF_INFO: The V-PCF has received URSP rule enforcement information for one or more URSP rules. This trigger applies in roaming scenarios and to the V-PCF. + - ACCESS_TYPE_CH: Access Type change. The registered access type has changed, an access type + is added or an access type is removed. PolicyAssociationReleaseCause: anyOf: @@ -906,3 +992,44 @@ components: Possible values are: - N3IWF: Non-3gpp Interworking Function. - TNGF: Trusted Non-3gpp Gateway Function. + + AccessStatus: + anyOf: + - type: string + enum: + - ADDITION + - REMOVAL + - 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 whether the type of change is a replacement, addition or removal. + Possible values are: + - ADDITION: The type of change is an addition. + - REMOVAL: The type of change is a removal. + + 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. + +# + UePolicyTransferFailureCause: + description: UE Policy Transfer Failure Cause. + anyOf: + - $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N1N2MessageTransferCause' + - $ref: '#/components/schemas/N1N2MessTransferErrorReply' diff --git a/TS29531_Nnssf_NSSAIAvailability.yaml b/TS29531_Nnssf_NSSAIAvailability.yaml index 99a4fab1..dc62a999 100644 --- a/TS29531_Nnssf_NSSAIAvailability.yaml +++ b/TS29531_Nnssf_NSSAIAvailability.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.3.0-alpha.4' + version: '1.3.0-alpha.5' title: 'NSSF NSSAI Availability' description: | NSSF NSSAI Availability Service. @@ -18,7 +18,7 @@ servers: default: https://example.com description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 externalDocs: - description: 3GPP TS 29.531 V18.4.0; 5G System; Network Slice Selection Services; Stage 3 + description: 3GPP TS 29.531 V18.5.0; 5G System; Network Slice Selection Services; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.531/ paths: /nssai-availability/{nfId}: @@ -36,12 +36,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string requestBody: @@ -60,11 +60,11 @@ paths: $ref: '#/components/schemas/AuthorizedNssaiAvailabilityInfo' headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string '204': @@ -113,12 +113,12 @@ paths: type: string - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string requestBody: @@ -138,11 +138,11 @@ paths: $ref: '#/components/schemas/AuthorizedNssaiAvailabilityInfo' headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string '204': @@ -230,7 +230,7 @@ paths: parameters: - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string requestBody: @@ -247,7 +247,7 @@ paths: parameters: - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string requestBody: # contents of the callback message @@ -261,7 +261,7 @@ paths: description: No Content (successful notification) headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -310,7 +310,7 @@ paths: schema: type: string Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -399,7 +399,7 @@ paths: type: string - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string requestBody: @@ -419,7 +419,7 @@ paths: $ref: '#/components/schemas/NssfEventSubscriptionCreatedData' headers: Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -462,7 +462,7 @@ paths: description: OK headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -518,7 +518,7 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' amfSetId: type: string - pattern: '^[0-9]{3}-[0-9]{2-3}-[A-Fa-f0-9]{2}-[0-3][A-Fa-f0-9]{2}$' + pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{2}-[0-3][A-Fa-f0-9]{2}$' SupportedNssaiAvailabilityData: description: This contains the Nssai availability data information per TA supported by the AMF @@ -646,7 +646,7 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' amfSetId: type: string - pattern: '^[0-9]{3}-[0-9]{2-3}-[A-Fa-f0-9]{2}-[0-3][A-Fa-f0-9]{2}$' + pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{2}-[0-3][A-Fa-f0-9]{2}$' taiRangeList: type: array items: diff --git a/TS29532_Nmbsmf_MBSSession.yaml b/TS29532_Nmbsmf_MBSSession.yaml index 32dd3f70..20f98a3c 100644 --- a/TS29532_Nmbsmf_MBSSession.yaml +++ b/TS29532_Nmbsmf_MBSSession.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 'Nmbsmf-MBSSession' - version: 1.2.0-alpha.1 + version: 1.2.0-alpha.2 description: | MB-SMF MBSSession Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.532 V18.0.0; 5G System; 5G Multicast-Broadcast Session Management Services; + 3GPP TS 29.532 V18.3.0; 5G System; 5G Multicast-Broadcast Session Management Services; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.532/ @@ -132,6 +132,13 @@ paths: '204': description: > Successful modification of the MBS session without content in the response. + '200': + description: > + Successful modification of the MBS session with content in the response + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRspData' '307': $ref: 'TS29571_CommonData.yaml#/components/responses/307' '308': @@ -370,11 +377,11 @@ paths: parameters: - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string requestBody: - description: Notification Payload + description: Notification Content content: application/json: schema: @@ -384,7 +391,7 @@ paths: description: Expected response to a successful callback processing headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -594,11 +601,11 @@ paths: parameters: - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string requestBody: - description: Notification Payload + description: Notification Content content: application/json: schema: @@ -608,7 +615,7 @@ paths: description: Expected response to a successful callback processing headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -808,6 +815,8 @@ components: contactPcfInd: type: boolean default: false + areaSessionPolicyId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionPolicyId' ContextUpdateReqData: description: Data within ContextUpdate Request @@ -1104,6 +1113,15 @@ components: accMbsServiceInfo: $ref: 'TS29537_Npcf_MBSPolicyAuthorization.yaml#/components/schemas/AcceptableMbsServInfo' + UpdateRspData: + description: Data within Update Response + type: object + properties: + mbsSession: + $ref: '#/components/schemas/ExtMbsSession' + required: + - mbsSession + # # SIMPLE DATA TYPES diff --git a/TS29536_Nnsacf_NSAC.yaml b/TS29536_Nnsacf_NSAC.yaml index c2a50fe2..26e27a0e 100644 --- a/TS29536_Nnsacf_NSAC.yaml +++ b/TS29536_Nnsacf_NSAC.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: Nnsacf_NSAC - version: 1.1.0-alpha.3 + version: 1.1.0-alpha.4 description: | Nnsacf_NSAC Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.536 V18.3.0; 5G System; Network Slice Admission Control Services; Stage 3. + description: 3GPP TS 29.536 V18.4.0; 5G System; Network Slice Admission Control Services; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.536/ servers: @@ -174,7 +174,7 @@ paths: '504': $ref: 'TS29571_CommonData.yaml#/components/responses/504' - /slices/configs: + /slices/local-configs/update: post: summary: > Network Slice Admission Control update of the local maximum number of registered UEs and/or @@ -188,7 +188,7 @@ paths: - nnsacf-nsac - oAuth2ClientCredentials: - nnsacf-nsac - - nnsacf-nsac:ac-info-update + - nnsacf-nsac:local-configs-update requestBody: content: application/json: @@ -285,7 +285,7 @@ components: nnsacf-nsac:slice-pdus: > Access to service operations applying to the collection of slice subject to NSAC for PDU sessions - nnsacf-nsac:ac-info-update: > + nnsacf-nsac:local-configs-update: > Access to the NSAC update of the local maximum number of registered UEs and/or PDU sessions of the network slice at NSACF @@ -309,9 +309,8 @@ components: $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' eacNotificationUri: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' -# Data type of nsacServiceArea IE is FFS -# nsacServiceArea: -# type: FFS + nsacServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsacSai' supportedFeatures: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: @@ -411,9 +410,8 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' pgwFqdn: $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' -# Data type of nsacServiceArea IE is FFS -# nsacServiceArea: -# type: FFS + nsacServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsacSai' supportedFeatures: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: @@ -471,7 +469,9 @@ components: maxNumUes: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' ueAdmissionThreshold: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + type: integer + minimum: 0 + maximum: 100 required: - snssai diff --git a/TS29536_Nnsacf_SliceEventExposure.yaml b/TS29536_Nnsacf_SliceEventExposure.yaml index 6a9c3f28..7c956ad6 100644 --- a/TS29536_Nnsacf_SliceEventExposure.yaml +++ b/TS29536_Nnsacf_SliceEventExposure.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: Nnsacf_SliceEventExposure - version: 1.1.0-alpha.3 + version: 1.1.0-alpha.4 description: | Nnsacf_SliceEventExposure Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.536 V18.3.0; 5G System; Network Slice Admission Control Services; Stage 3. + description: 3GPP TS 29.536 V18.4.0; 5G System; Network Slice Admission Control Services; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.536/ servers: @@ -314,6 +314,16 @@ components: type: integer expiry: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + 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' supportedFeatures: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' diff --git a/TS29537_Npcf_MBSPolicyAuthorization.yaml b/TS29537_Npcf_MBSPolicyAuthorization.yaml index 56645cf1..bf1a06d1 100644 --- a/TS29537_Npcf_MBSPolicyAuthorization.yaml +++ b/TS29537_Npcf_MBSPolicyAuthorization.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: Npcf_MBSPolicyAuthorization API - version: 1.1.0-alpha.1 + version: 1.1.0-alpha.2 description: | MBS Policy Authorization Service. © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -9,7 +9,7 @@ info: externalDocs: description: > - 3GPP TS 29.537 V18.0.0; 5G System; Multicast/Broadcast Policy Control Services. + 3GPP TS 29.537 V18.3.0; 5G System; Multicast/Broadcast Policy Control Services. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.537/' security: @@ -244,6 +244,11 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' snssai: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + areaSessPolId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionPolicyId' + reqForLocDepMbs: + type: boolean + default: false contactPcfInd: type: boolean default: false diff --git a/TS29537_Npcf_MBSPolicyControl.yaml b/TS29537_Npcf_MBSPolicyControl.yaml index 8796d2d1..ddcc3097 100644 --- a/TS29537_Npcf_MBSPolicyControl.yaml +++ b/TS29537_Npcf_MBSPolicyControl.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: Npcf_MBSPolicyControl API - version: 1.1.0-alpha.2 + version: 1.1.0-alpha.3 description: | MBS Policy Control Service © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.537 V18.1.0; 5G System; Multicast/Broadcast Policy Control Services. + 3GPP TS 29.537 V18.3.0; 5G System; Multicast/Broadcast Policy Control Services. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.537/' security: @@ -258,6 +258,8 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' snssai: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + areaSessPolId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionPolicyId' mbsServInfo: $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceInfo' suppFeat: diff --git a/TS29538_MSGG_BGDelivery.yaml b/TS29538_MSGG_BGDelivery.yaml index 175759a9..489ee238 100644 --- a/TS29538_MSGG_BGDelivery.yaml +++ b/TS29538_MSGG_BGDelivery.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: MSGG_BGDelivery - version: 1.0.0-alpha.1 + version: 1.0.0-alpha.2 description: | API for Broadcast Message Delivery Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.538 V18.2.0; Enabling MSGin5G Service; Application Programming Interfaces (API) + 3GPP TS 29.538 V18.4.0; Enabling MSGin5G Service; Application Programming Interfaces (API) specification; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.538/ @@ -23,8 +23,7 @@ servers: security: - {} - - oAuth2ClientCredentials: - - msgg-bgdelivery + - oAuth2ClientCredentials: [] paths: /deliver-message: @@ -71,9 +70,8 @@ components: type: oauth2 flows: clientCredentials: - tokenUrl: '{nrfApiRoot}/oauth2/token' - scopes: - msgg-bgdelivery: Access to the MSGG_BGDelivery API + tokenUrl: '{tokenUrl}' + scopes: {} schemas: @@ -87,7 +85,6 @@ components: - oriAddr - destAddr - msgId - - payload properties: oriAddr: $ref: 'TS29538_MSGG_L3GDelivery.yaml#/components/schemas/Address' @@ -101,3 +98,9 @@ components: type: boolean payload: type: string + segInd: + type: boolean + segParams: + $ref: 'TS29538_MSGS_MSGDelivery.yaml#/components/schemas/MessageSegmentParameters' + priority: + $ref: 'TS29538_MSGS_MSGDelivery.yaml#/components/schemas/Priority' diff --git a/TS29538_MSGG_L3GDelivery.yaml b/TS29538_MSGG_L3GDelivery.yaml index f60903b0..048f69f8 100644 --- a/TS29538_MSGG_L3GDelivery.yaml +++ b/TS29538_MSGG_L3GDelivery.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: MSGG_L3GDelivery - version: 1.1.0-alpha.1 + version: 1.1.0-alpha.2 description: | API for MSGG L3G Message Delivery Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -9,7 +9,7 @@ info: externalDocs: description: > - 3GPP TS 29.538 V18.1.0; Enabling MSGin5G Service; Application Programming Interfaces (API) + 3GPP TS 29.538 V18.4.0; Enabling MSGin5G Service; Application Programming Interfaces (API) specification; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.538/ @@ -22,8 +22,8 @@ servers: security: - {} - - oAuth2ClientCredentials: - - msgg-l3gdelivery + - oAuth2ClientCredentials: [] + paths: /deliver-message: @@ -107,9 +107,9 @@ components: type: oauth2 flows: clientCredentials: - tokenUrl: '{nrfApiRoot}/oauth2/token' - scopes: - msgg-l3gdelivery: Access to the MSGG_L3GDelivery API + tokenUrl: '{tokenUrl}' + scopes: {} + schemas: diff --git a/TS29538_MSGG_N3GDelivery.yaml b/TS29538_MSGG_N3GDelivery.yaml index 17dde707..dc32b877 100644 --- a/TS29538_MSGG_N3GDelivery.yaml +++ b/TS29538_MSGG_N3GDelivery.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: title: MSGG_N3GDelivery - version: 1.0.0 + version: 1.1.0-alpha.1 description: | API for MSGG N3G Message Delivery Service. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > - 3GPP TS 29.538 V17.1.0; Enabling MSGin5G Service; Application Programming Interfaces (API) + 3GPP TS 29.538 V18.4.0; Enabling MSGin5G Service; Application Programming Interfaces (API) specification; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.538/ @@ -22,8 +22,7 @@ servers: security: - {} - - oAuth2ClientCredentials: - - msgg-n3gdelivery + - oAuth2ClientCredentials: [] paths: /deliver-message: @@ -107,9 +106,9 @@ components: type: oauth2 flows: clientCredentials: - tokenUrl: '{nrfApiRoot}/oauth2/token' - scopes: - msgg-n3gdelivery: Access to the MSGG_N3GDelivery API + tokenUrl: '{tokenUrl}' + scopes: {} + schemas: diff --git a/TS29538_MSGS_ASRegistration.yaml b/TS29538_MSGS_ASRegistration.yaml index 5b56afa2..7a3a1b96 100644 --- a/TS29538_MSGS_ASRegistration.yaml +++ b/TS29538_MSGS_ASRegistration.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: title: MSGS_ASRegistration - version: 1.1.0-alpha.1 + version: 1.1.0-alpha.2 description: | API for MSGS AS Registration Service. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > - 3GPP TS 29.538 V18.0.0; Enabling MSGin5G Service; Application Programming Interfaces (API) + 3GPP TS 29.538 V18.4.0; Enabling MSGin5G Service; Application Programming Interfaces (API) specification; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.538/ @@ -22,8 +22,7 @@ servers: security: - {} - - oAuth2ClientCredentials: - - msgs-asregistration + - oAuth2ClientCredentials: [] paths: /registrations: @@ -119,9 +118,8 @@ components: type: oauth2 flows: clientCredentials: - tokenUrl: '{nrfApiRoot}/oauth2/token' - scopes: - msgs-asregistration: Access to the as registration API + tokenUrl: '{tokenUrl}' + scopes: {} schemas: diff --git a/TS29538_MSGS_MSGDelivery.yaml b/TS29538_MSGS_MSGDelivery.yaml index 6e7b3d9a..dfd27512 100644 --- a/TS29538_MSGS_MSGDelivery.yaml +++ b/TS29538_MSGS_MSGDelivery.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: MSGS_MSGDelivery - version: 1.1.0-alpha.2 + version: 1.1.0-alpha.3 description: | API for MSGG MSGin5G Server Message Delivery Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -9,7 +9,7 @@ info: externalDocs: description: > - 3GPP TS 29.538 V18.3.0; Enabling MSGin5G Service; Application Programming Interfaces (API) + 3GPP TS 29.538 V18.4.0; Enabling MSGin5G Service; Application Programming Interfaces (API) specification; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.538/ @@ -22,8 +22,8 @@ servers: security: - {} - - oAuth2ClientCredentials: - - msgs-msgdelivery + - oAuth2ClientCredentials: [] + paths: /deliver-as-message: @@ -156,9 +156,8 @@ components: type: oauth2 flows: clientCredentials: - tokenUrl: '{nrfApiRoot}/oauth2/token' - scopes: - msgs-msgdelivery: Access to the MSGS_MSGDelivery API + tokenUrl: '{tokenUrl}' + scopes: {} schemas: diff --git a/TS29540_Nsmsf_SMService.yaml b/TS29540_Nsmsf_SMService.yaml index 8f986437..62c7c7a2 100644 --- a/TS29540_Nsmsf_SMService.yaml +++ b/TS29540_Nsmsf_SMService.yaml @@ -58,14 +58,14 @@ paths: schema: type: string ETag: - description: Entity Tag, containing a strong validator, as described in IETF RFC 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110 schema: type: string '204': description: UE Context for SMS is updated in SMSF headers: ETag: - description: Entity Tag, containing a strong validator, as described in IETF RFC 7232, 2.3 + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110 schema: type: string '307': @@ -201,7 +201,7 @@ paths: type: string - name: If-Match in: header - description: Validator for conditional requests, as described in IETF RFC 7232, 3.1 + description: Validator for conditional requests, as described in IETF RFC 9110 schema: type: string responses: diff --git a/TS29543_Npcf_PDTQPolicyControl.yaml b/TS29543_Npcf_PDTQPolicyControl.yaml index c5188054..943f1a33 100644 --- a/TS29543_Npcf_PDTQPolicyControl.yaml +++ b/TS29543_Npcf_PDTQPolicyControl.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: Npcf_PDTQPolicyControl API - version: 1.0.0-alpha.2 + version: 1.0.0-alpha.4 description: | PCF PDTQ Policy Control service. © <2023>, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.543 V0.3.0; 5G System; Data Transfer Policy Control Services; Stage 3. + description: 3GPP TS 29.543 V1.0.0; 5G System; Data Transfer Policy Control Services; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.543/' servers: @@ -397,6 +397,7 @@ components: type: object required: - pdtqRefId + - candPolicies properties: pdtqRefId: $ref: '#/components/schemas/PdtqReferenceId' @@ -408,8 +409,6 @@ components: items: $ref: '#/components/schemas/PdtqPolicy' minItems: 1 - nwAreaInfo: - $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' # Simple data types diff --git a/TS29548_SDD_DDContext.yaml b/TS29548_SDD_DDContext.yaml index 18e9c011..2d1b3aa3 100644 --- a/TS29548_SDD_DDContext.yaml +++ b/TS29548_SDD_DDContext.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: SEALDD Server Data Delivery Context Relocation - version: 1.0.0-alpha.1 + version: 1.0.0-alpha.4 description: | SEALDD Server Data Delivery Context Relocation. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.548 V0.3.0 Service Enabler Architecture Layer for Verticals (SEAL); + 3GPP TS 29.548 V1.0.0 Service Enabler Architecture Layer for Verticals (SEAL); SEAL Data Delivery (SEALDD) Server Services; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.548/ @@ -45,7 +45,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DdContextPushReq' + $ref: '#/components/schemas/DdContextResp' '400': $ref: 'TS29122_CommonData.yaml#/components/responses/400' '401': @@ -83,14 +83,14 @@ paths: schema: $ref: '#/components/schemas/DdContextPushReq' responses: - '200': + '201': description: > - Successful case. The DD context is successfully pushed to the SEALDD Server and the - related information is returned in the response body. + Created. Successful case. The DD context is successfully pushed to the SEALDD Server and + the related information is returned in the response body. content: application/json: schema: - $ref: '#/components/schemas/DdContextPushResp' + $ref: '#/components/schemas/DdContextResp' '307': $ref: 'TS29122_CommonData.yaml#/components/responses/307' '308': @@ -128,12 +128,24 @@ components: scopes: {} schemas: + +# +# STRUCTURED DATA TYPES +# + DdContext: description: Represents the DD context. type: object properties: + uuContext: + $ref: '#/components/schemas/SddUuContext' + sContext: + $ref: '#/components/schemas/SddSContext' trLayerContext: $ref: '#/components/schemas/TranspLayerContext' + required: + - uuContext + - sContext TranspLayerContext: description: Represents the transport layer context. @@ -145,19 +157,93 @@ components: - transProtoc DdContextPushReq: - description: Represents the DD context relocation push request. + description: Represents the DD context push request. type: object properties: ddContext: $ref: '#/components/schemas/DdContext' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ddContext - DdContextPushResp: - description: Represents the DD context relocation push response. + DdContextResp: + description: Represents the DD context push response. type: object properties: + ddContext: + $ref: '#/components/schemas/DdContext' endPoint: $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteInformation' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + SddUuContext: + description: Represents the context related to the SEALDD-Uu connection. + type: object + properties: + sddFlowId: + type: string + description: Represents the SEALDD flow ID. + valServiceId: + type: string + description: Contains the identifier of the VAL service. + valServerId: + type: string + description: Contains the identifier of the VAL Server. + valServEndPoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteInformation' + ddClientConnInfo: + $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ConnInfo' + ddServConnInfo: + $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ConnInfo' + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + comLifetime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + valUsersBdw: + $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ValUsersBdw' + pendingTimer: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + required: + - sddFlowId + - valServEndPoint + + SddSContext: + description: Represents the context related to the SEALDD-S connection. + type: object + properties: + valServerId: + type: string + description: Contains the identifier of the VAL Server. + valServiceId: + type: string + description: Contains the identifier of the VAL service. + valTargetUeId: + type: string + description: Contains the identifier of the target VAL UE. + valServerConnInfo: + $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ConnInfo' + ddServerConnInfo: + $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ConnInfo' + qosInfo: + $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/QosInfo' + valServerBdw: + $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ValServBdw' + valUsersBdw: + $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ValUsersBdw' + required: + - valServerId + - valServerConnInfo + + +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + +# Data types describing alternative data types or combinations of data types: +# + diff --git a/TS29548_SDD_DataStorage.yaml b/TS29548_SDD_DataStorage.yaml new file mode 100644 index 00000000..b3465a94 --- /dev/null +++ b/TS29548_SDD_DataStorage.yaml @@ -0,0 +1,983 @@ +openapi: 3.0.0 + +info: + title: SEALDD Server Data Storage Service + version: 1.0.0-alpha.2 + description: | + SEALDD Server Data Storage Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.548 V1.0.0; Service Enabler Architecture Layer for Verticals (SEAL); + SEAL Data Delivery (SEALDD) Server Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.548/ + +servers: + - url: '{apiRoot}/sdd-ds/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /storages: + get: + summary: Retrieve one or several existing Individual Data Storage resource(s). + operationId: GetDataStorages + tags: + - Data Storages (Collection) + parameters: + - name: storage-ids + in: query + description: Contains the identifier(s) of the targeted Data Storage resource(s). + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: supp-feats + in: query + description: Contains the list of supported features. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + OK. The requested Individual Data Storage resource shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DataStorage' + minItems: 0 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + post: + summary: Request the creation of a Data Storage. + operationId: CreateDataStorage + tags: + - Data Storages (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataStorageReq' + responses: + '201': + description: > + Created. The Data Storage is successfully created and a representation of the created + Individual Data Storage resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/DataStorage' + headers: + Location: + description: > + Contains the URI of the created Individual Data Storage resource. + required: true + schema: + type: string + '200': + description: > + OK. The Data Storage resource is successfully reserved and Data Storage resource + reservation related information shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ReservRespData' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + DataMngtNotif: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataMngtNotif' + responses: + '204': + description: > + No Content. The Data Management and or Status Information Notification is + successfully received and acknowledged. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /storages/{storageId}: + parameters: + - name: storageId + in: path + description: > + Represents the identifier of the Individual Data Storage resource. + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual Data Storage resource. + operationId: GetIndDataStorage + tags: + - Individual Data Storage (Document) + responses: + '200': + description: > + OK. The requested Individual Data Storage resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/DataStorage' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Request the update of an existing Individual Data Storage resource. + operationId: UpdateIndDataStorage + tags: + - Individual Data Storage (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataStorage' + responses: + '200': + description: > + OK. The Individual Data Storage resource is successfully updated and a representation + of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/DataStorage' + '204': + description: > + No Content. The Individual Data Storage resource is successfully updated and no content + is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Request the modification of an existing Individual Data Storage resource. + operationId: ModifyIndDataStorage + tags: + - Individual Data Storage (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/DataStoragePatch' + responses: + '200': + description: > + OK. The Individual Data Storage resource is successfully modified and a representation + of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/DataStorage' + '204': + description: > + No Content. The Individual Data Storage resource is successfully modified and no content + is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Request the deletion of an existing Individual Data Storage resource. + operationId: DeleteIndDataStorage + tags: + - Individual Data Storage (Document) + responses: + '204': + description: > + No Content. The Individual Data Storage resource is successfully deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /subscriptions: + post: + summary: Request the creation of a Data Storage Delivery Subscription. + operationId: CreateDataDelSubsc + tags: + - Data Storage Delivery Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataDelSubsc' + responses: + '201': + description: > + Created. The Data Storage Delivery Subscription is successfully created and a + representation of the created Individual Data Storage Delivery Subscription resource + shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/DataDelSubsc' + headers: + Location: + description: > + Contains the URI of the created Individual Data Storage Delivery Subscription + resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + DataDelNotif: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataDelNotif' + responses: + '204': + description: > + No Content. The Data Storage Delivery Notification is successfully received + and acknowledged. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /subscriptions/{subscriptionId}: + parameters: + - name: subscriptionId + in: path + description: > + Represents the identifier of the Individual Data Storage Delivery Subscription resource. + resource. + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual Data Storage Delivery Subscription resource. + operationId: GetIndDataDelSubsc + tags: + - Individual Data Storage Delivery Subscription (Document) + responses: + '200': + description: > + OK. The requested Individual Data Storage Delivery Subscription resource shall be + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/DataDelSubsc' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Request the update of an existing Individual Data Storage Delivery Subscription resource. + operationId: UpdateIndDataDelSubsc + tags: + - Individual Data Storage Delivery Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataDelSubsc' + responses: + '200': + description: > + OK. The Individual Data Storage Delivery Subscription resource is successfully + updated and a representation of the updated resource shall be returned in the + response body. + content: + application/json: + schema: + $ref: '#/components/schemas/DataDelSubsc' + '204': + description: > + No Content. The Individual Data Storage Delivery Subscription resource is successfully + updated and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Request the modification of an existing Individual Data Storage Delivery Subscription resource. + operationId: ModifyIndDataDelSubsc + tags: + - Individual Data Storage Delivery Subscription (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/DataDelSubscPatch' + responses: + '200': + description: > + OK. The Individual Data Storage Delivery Subscription resource is successfully modified + and a representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/DataDelSubsc' + '204': + description: > + No Content. The Individual Data Storage Delivery Subscription resource is successfully + modified and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Request the deletion of an existing Individual Data Storage Delivery Subscription resource. + operationId: DeleteIndDataDelSubsc + tags: + - Individual Data Storage Delivery Subscription (Document) + responses: + '204': + description: > + No Content. The Individual Data Storage Delivery Subscription resource is successfully + deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /request-del: + post: + summary: Enables a service consumer to request SEALDD data storage delivery. + operationId: DataDeliveryRequest + tags: + - SEALDD Data Delivery Request + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataDelReq' + responses: + '204': + description: > + No Content. The SEALDD Data Storage delivery request is successfully received and + processed. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + +# +# STRUCTURED DATA TYPES +# + + DataStorage: + description: > + Represents a SEALDD Data Storage. + type: object + properties: + data: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + ctrlPolicies: + type: array + items: + $ref: '#/components/schemas/AccessCtrlPolicy' + minItems: 1 + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + mngtSubsc: + $ref: '#/components/schemas/DataMngtSubsc' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - data + + ReservReqData: + description: > + Represents a Data Storage reservation request. + type: object + properties: + valServiceId: + type: string + dataLength: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - valServiceId + + ReservRespData: + description: > + Represents a Data Storage reservation response. + type: object + properties: + resourceAddr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + required: + - resourceAddr + + DataStoragePatch: + description: > + Represents the requested modifications to a SEALDD Data Storage. + type: object + properties: + data: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + ctrlPolicies: + type: array + items: + $ref: '#/components/schemas/AccessCtrlPolicy' + minItems: 1 + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + mngtSubsc: + $ref: '#/components/schemas/DataMngtSubsc' + + AccessCtrlPolicy: + description: > + Represents the data access control policy. + type: object + properties: + entityName: + $ref: '#/components/schemas/EntityName' + entityId: + type: string + rights: + type: array + items: + $ref: '#/components/schemas/DataAccessRight' + minItems: 1 + required: + - rights + anyOf: + - required: [entityName] + - required: [entityId] + + DataMngtSubsc: + description: > + Represents the stored data management and/or status information subscription related + information. + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/DataMngtEvent' + minItems: 1 + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + repPeriodicity: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + required: + - events + - notifUri + + DataMngtNotif: + description: > + Represents a SEALDD Data Management and/or Status Information Notification. + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/DataMngtEvent' + minItems: 1 + accessStats: + $ref: '#/components/schemas/DataAccessStats' + mngtStats: + $ref: '#/components/schemas/DataMngtStats' + required: + - events + anyOf: + - required: [accessStats] + - required: [mngtStats] + + DataAccessStats: + description: > + Represents data access statistics. + type: object + properties: + genAccessStats: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + detAccessStats: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minProperties: 1 + description: > + Represents the data access statistics of the stored data detailed per consumer SEALDD + entity. It contains how many times the stored data was accessed (i.e., retrieved or + updated) per SEALDD entity. + The key of the map shall be the name of the SEALDD entity, encoded using the EntityName + data type as specified in clause 6.2.6.3.3, to which the data access statistics provided + within the map value are + related. + anyOf: + - required: [genAccessStats] + - required: [detAccessStats] + + DataMngtStats: + description: > + Represents data management statistics. + type: object + properties: + genMngtStats: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + detMngtStats: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minProperties: 1 + description: > + Represents the data management statistics of the stored data detailed per consumer + SEALDD entity. It contains how many times the stored data was accessed for management + purposes (i.e., data update) per SEALDD entity. + The key of the map shall be the name of the SEALDD entity, encoded using the EntityName + data type as specified in clause 6.2.6.3.3, to which the data management statistics + provided within the map value are related. + anyOf: + - required: [genMngtStats] + - required: [detMngtStats] + + DataDelSubsc: + description: > + Represents a SEALDD Data Storage Delivery Subscription. + type: object + properties: + requestorId: + type: string + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTimeRo' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - requestorId + - notifUri + + DataDelSubscPatch: + description: > + Represents the requested modification to a SEALDD Data Storage Delivery Subscription. + type: object + properties: + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + + DataDelNotif: + description: > + Represents a SEALDD Data Storage Delivery Notification. + type: object + properties: + data: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + storageId: + type: string + oneOf: + - required: [data] + - required: [storageId] + + DataDelReq: + description: > + Represents a SEALDD Data Storage Delivery request. + type: object + properties: + targetId: + type: string + sealddServId: + type: string + storageId: + type: string + data: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - targetId + oneOf: + - required: [data] + - required: [storageId] + + +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + + EntityName: + anyOf: + - type: string + enum: + - SEALDD_SERVER + - SEALDD_CLIENT + - VAL_SERVER + - 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 name of a SEALDD entity. + Possible values are: + - SEALDD_SERVER: Indicates the SEALDD Server. + - SEALDD_CLIENT: Indicates the SEALDD Client. + - VAL_SERVER: Indicates the VAL Server. + + DataAccessRight: + anyOf: + - type: string + enum: + - RETRIEVE + - UPDATE + - DELETE + - 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 data access rights. + Possible values are: + - RETRIEVE: Indicates that the access right is data storage retrieval. + - UPDATE: Indicates that the access right is data storage update. + - DELETE: Indicates that the access right is data storage deletion. + + DataMngtEvent: + anyOf: + - type: string + enum: + - DATA_ACCESS_STATISTICS + - DATA_MNGT_STATISTICS + - 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 Data Management and (or) Status Information events. + Possible values are: + - DATA_ACCESS_STATISTICS: Indicates that the Data Management Event is data access statistics + (i.e., how often the stored data is accessed). + - DATA_MNGT_STATISTICS: Indicates that the Data Management Event is data management + statistics (i.e., how often the stored data is managed). + + +# Data types describing alternative data types or combinations of data types: +# + + DataStorageReq: + description: Represents a SEALDD Data Storage creation or reservation request. + oneOf: + - $ref: '#/components/schemas/DataStorage' + - $ref: '#/components/schemas/ReservReqData' diff --git a/TS29548_SDD_PolicyConfiguration.yaml b/TS29548_SDD_PolicyConfiguration.yaml new file mode 100644 index 00000000..79bca0f8 --- /dev/null +++ b/TS29548_SDD_PolicyConfiguration.yaml @@ -0,0 +1,397 @@ +openapi: 3.0.0 + +info: + title: SEALDD Server Policy Configuration Service + version: 1.0.0-alpha.3 + description: | + SEALDD Server Policy Configuration Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.548 V1.0.0; Service Enabler Architecture Layer for Verticals (SEAL); + SEAL Data Delivery (SEALDD) Server Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.548/ + +servers: + - url: '{apiRoot}/sdd-pc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /configurations: + post: + summary: Request the creation of a Policy Configuration. + operationId: CreatePolicyConfig + tags: + - Policy Configurations (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyConfig' + responses: + '201': + description: > + Created. The Policy Configuration is successfully created and a representation of + the created Individual Policy Configuration resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyConfig' + headers: + Location: + description: > + Contains the URI of the created Individual Policy Configuration resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /configurations/{configId}: + parameters: + - name: configId + in: path + description: > + Represents the identifier of the Individual Policy Configuration resource. + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual Policy Configuration resource. + operationId: GetIndPolicyConfig + tags: + - Individual Policy Configuration (Document) + responses: + '200': + description: > + OK. The requested Individual Policy Configuration resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyConfig' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Request the update of an existing Individual Policy Configuration resource. + operationId: UpdateIndPolicyConfig + tags: + - Individual Policy Configuration (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyConfig' + responses: + '200': + description: > + OK. The Individual Policy Configuration resource is successfully updated and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyConfig' + '204': + description: > + No Content. The Individual Policy Configuration resource is successfully updated + and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Request the modification of an existing Individual Policy Configuration resource. + operationId: ModifyIndPolicyConfig + tags: + - Individual Policy Configuration (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PolicyConfigPatch' + responses: + '200': + description: > + OK. The Individual Policy Configuration resource is successfully modified and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyConfig' + '204': + description: > + No Content. The Individual Policy Configuration resource is successfully modified and + no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Request the deletion of an existing Individual Policy Configuration resource. + operationId: DeleteIndPolicyConfig + tags: + - Individual Policy Configuration (Document) + responses: + '204': + description: > + No Content. The Individual Policy Configuration resource is successfully deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + +# +# STRUCTURED DATA TYPES +# + + PolicyConfig: + description: > + Represents a SEALDD Policy Configuration. + type: object + properties: + appTrafficIds: + type: array + items: + type: string + minItems: 1 + valUeId: + type: string + sealddPol: + $ref: '#/components/schemas/SealddPolicy' + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTimeRo' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - appTrafficIds + - sealddPol + + PolicyConfigPatch: + description: > + Represents the requested modifications to a SEALDD Policy Configuration. + type: object + properties: + sealddPol: + $ref: '#/components/schemas/SealddPolicy' + + SealddPolicy: + description: > + Represents a SEALDD Policy. + type: object + properties: + qualGuarSets: + type: array + items: + $ref: '#/components/schemas/QualGuarPolicy' + minItems: 1 + qualOptimSets: + type: array + items: + $ref: '#/components/schemas/QualOptimPolicy' + minItems: 1 + bdwCtrlSets: + type: array + items: + $ref: '#/components/schemas/BdwCtrlPolicy' + minItems: 1 + anyOf: + - required: [qualGuarantee] + - required: [qualOptimSets] + - required: [bdwControl] + + +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + + QualGuarPolicy: + anyOf: + - type: string + enum: + - ESTABLISH_REDUNDANT_TRANS_PATH + - REESTABLISH_TRANS_PATH + - SWITCH_TO_BACKUP_TRANS_PATH + - CHANGE_SEALDD_SERVER + - 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 quality guarantee policy. + Possible values are: + - ESTABLISH_REDUNDANT_TRANS_PATH: Indicates that the quality guarantee action is to + establish a redundant transmission path. + - REESTABLISH_TRANS_PATH: Indicates that the quality guarantee action is to + reestablish the transmission path. + - SWITCH_TO_BACKUP_TRANS_PATH: Indicates that the quality guarantee action is to + switch to the backup transmission path. + - CHANGE_SEALDD_SERVER: Indicates that the quality guarantee action is to change the + connected SEALDD Server. + + QualOptimPolicy: + anyOf: + - type: string + enum: + - BACK_TO_SINGLE_TRANS_PATH + - 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 quality optimization policy. + Possible values are: + - BACK_TO_SINGLE_TRANS_PATH: Indicates that the quality optimization action is to switch + back to a single transmission path. + + BdwCtrlPolicy: + anyOf: + - type: string + enum: + - REALLOCATE_DL + - REALLOCATE_UL + - NOT_REALLOCATE_DL + - NOT_REALLOCATE_UL + - 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 bandwidth control policy. + Possible values are: + - REALLOCATE_DL: Indicates that the bandwidth control action is to reallocate the + bandwidth limit between different VAL users for DL traffic. + - REALLOCATE_UL: Indicates that the bandwidth control action is to reallocate the + bandwidth limit between different VAL users for UL traffic. + - NOT_REALLOCATE_DL: Indicates that the bandwidth control action is to not reallocate + the bandwidth limit between different VAL users for DL traffic. + - NOT_REALLOCATE_UL: Indicates that the bandwidth control action is to not reallocate + the bandwidth limit between different VAL users for UL traffic. + + +# Data types describing alternative data types or combinations of data types: +# + diff --git a/TS29548_SDD_Transmission.yaml b/TS29548_SDD_Transmission.yaml index 10f2ac46..3b62b492 100644 --- a/TS29548_SDD_Transmission.yaml +++ b/TS29548_SDD_Transmission.yaml @@ -1,8 +1,8 @@ openapi: 3.0.0 info: - title: SEALDD Data Transmission Service - version: 1.0.0-alpha.1 + title: SEALDD Server Data Transmission Service + version: 1.0.0-alpha.4 description: | SEALDD Server Data Transmission Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.548 V0.3.0; Service Enabler Architecture Layer for Verticals (SEAL); + 3GPP TS 29.548 V1.0.0; Service Enabler Architecture Layer for Verticals (SEAL); SEAL Data Delivery (SEALDD) Server Services; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.548/ @@ -19,7 +19,7 @@ servers: variables: apiRoot: default: https://example.com - description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 security: - {} @@ -31,13 +31,13 @@ paths: - name: transType in: path description: > - Represents the requested transmission type (i.e., regular or URLLC). + Represents the requested transmission type. required: true schema: $ref: '#/components/schemas/TransType' post: - summary: Request SEALDD enabled regular or URLLC Data Transmission. + summary: Request SEALDD enabled Regular or URLLC Data Transmission. operationId: RequestTrans tags: - Request SEALDD Data Transmission @@ -50,7 +50,7 @@ paths: responses: '200': description: > - OK. The SEALDD enabled regular or URLLC application data transmission service request + OK. The SEALDD enabled Regular or URLLC application data transmission service request was successfully received and processed. content: application/json: @@ -83,6 +83,100 @@ paths: default: $ref: 'TS29122_CommonData.yaml#/components/responses/default' + /subscriptions: + post: + summary: Request the Creation of a new Connection Status Subscription. + operationId: CreateConnStatusSubsc + tags: + - Connection Status Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConnStatusSubsc' + responses: + '201': + description: > + Successful case. The requested Connection Status Subscription resource is successfully + created and a representation of the created "Individual Connection Status Subscription" + resource is returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/ConnStatusSubsc' + headers: + Location: + description: > + Contains the URI of the newly created Individual Connection Status Subscription + resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + ConnStatusNotif: + '{$request.body#/notifUri}': + post: + summary: Notify a previously subscribed service consumer on SEALDD connection status event(s). + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConnStatusNotif' + responses: + '204': + description: > + Successful case. The Connection Status Notification is successfully received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + components: securitySchemes: @@ -94,9 +188,14 @@ components: scopes: {} schemas: + +# +# STRUCTURED DATA TYPES +# + TransReq: description: > - Represents the parameters to request the SEALDD enabled regular or URLLC application data + Represents the parameters to request the SEALDD enabled Regular or URLLC application data transmission service. type: object properties: @@ -105,9 +204,11 @@ components: valServiceId: type: string valTargetUeId: - $ref: 'TS29548_SDD_TransmissionQualityMeasurement.yaml#/components/schemas/ValTargetUeId' + type: string valServerConnInfo: $ref: '#/components/schemas/ConnInfo' + qosInfo: + $ref: '#/components/schemas/QosInfo' valServerBdw: $ref: '#/components/schemas/ValServBdw' valUsersBdw: @@ -120,7 +221,7 @@ components: TransResp: description: > - Represents a SEALDD enabled regular or URLLC application data transmission service response. + Represents a SEALDD enabled Regular or URLLC application data transmission service response. type: object properties: ddServerConnInfo: @@ -146,6 +247,32 @@ components: - required: [ipv6Addr] - required: [uri] + QosInfo: + description: > + Represents SEALDD related QoS requirements. + type: object + properties: + qosReference: + type: string + altQoSReferences: + type: array + items: + type: string + minItems: 1 + altQosReqs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + anyOf: + - required: [qosReference] + - required: [altQoSReferences] + - required: [altQosReqs] + - not: + required: [altQoSReferences, altQosReqs] + - not: + required: [qosReference, altQosReqs] + ValServBdw: description: > Represents VAL Server related bandwidth information. @@ -178,7 +305,109 @@ components: - maxUlBdw - maxDlBdw - TransType: + ConnStatusSubsc: description: > - Represents the requested transmission type (i.e., regular or URLLC). - type: string + Represents a Connection Status Subscription. + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/ConnStatusEvent' + minItems: 1 + description: > + Represents the subscribed event(s). + valServiceId: + type: string + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + valServerConnInfo: + $ref: '#/components/schemas/ConnInfo' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - events + - valServerConnInfo + - notifUri + + ConnStatusNotif: + description: > + Represents a Connection Status Notification. + type: object + properties: + reports: + type: array + items: + $ref: '#/components/schemas/ConnStatusReport' + minItems: 1 + required: + - reports + + ConnStatusReport: + description: > + Represents a Connection Status Event report. + type: object + properties: + event: + $ref: '#/components/schemas/ConnStatusEvent' + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + connEstData: + $ref: '#/components/schemas/ConnEstabData' + required: + - event + + ConnEstabData: + description: > + Represents SEALDD connection status establishment data. + type: object + properties: + comLifetime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + + +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + + ConnStatusEvent: + anyOf: + - type: string + enum: + - ESTABLISHED + - RELEASED + - 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 Connection Status Events. + Possible values are: + - ESTABLISHED: Indicates that the SEALDD connection is established. + - RELEASED: Indicates that the SEALDD connection is released. + + TransType: + anyOf: + - type: string + enum: + - regular + - urllc + - 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 requested transmission type. + Possible values are: + - regular: Indicates that the requested transmission type is Regular transmission. + - urllc: Indicates that the requested transmission type is URLLC transmission. + + +# Data types describing alternative data types or combinations of data types: +# + diff --git a/TS29548_SDD_TransmissionQualityMeasurement.yaml b/TS29548_SDD_TransmissionQualityMeasurement.yaml index 36b594cf..97bf7413 100644 --- a/TS29548_SDD_TransmissionQualityMeasurement.yaml +++ b/TS29548_SDD_TransmissionQualityMeasurement.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: SEALDD Server Data Transmission Quality Measurement Service - version: 1.0.0-alpha.2 + version: 1.0.0-alpha.5 description: | SEALDD Server Data Transmission Quality Measurement Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.548 V0.3.0; Service Enabler Architecture Layer for Verticals (SEAL); + 3GPP TS 29.548 V1.0.0; Service Enabler Architecture Layer for Verticals (SEAL); SEAL Data Delivery (SEALDD) Server Services; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.548/ @@ -19,7 +19,7 @@ servers: variables: apiRoot: default: https://example.com - description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 security: - {} @@ -39,11 +39,11 @@ paths: schema: $ref: '#/components/schemas/TransQualMeasSubsc' responses: - '200': + '201': description: > - OK. The Transmission Quality Measurement Subscription is successfully created and a - representation of the created Individual Transmission Quality Measurement Subscription - resource shall be returned. + Created. The Transmission Quality Measurement Subscription is successfully created + and a representation of the created Individual Transmission Quality Measurement + Subscription resource shall be returned. content: application/json: schema: @@ -78,6 +78,47 @@ paths: $ref: 'TS29122_CommonData.yaml#/components/responses/503' default: $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + TransQualMeasNotif: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TransQualMeasNotif' + responses: + '204': + description: > + No Content. The Transmission Quality Measurement notification is successfully + received and acknowledged. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' /subscriptions/{subscriptionId}: parameters: @@ -282,7 +323,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/ValTargetUeId' + type: string minItems: 1 - name: all-val-ues in: query @@ -337,9 +378,14 @@ components: scopes: {} schemas: + +# +# STRUCTURED DATA TYPES +# + TransQualMeasSubsc: description: > - Represents a Transmission Quality Measurement subscription. + Represents a Transmission Quality Measurement Subscription. type: object properties: appTrafficIds: @@ -352,7 +398,7 @@ components: valUeIdsList: type: array items: - $ref: '#/components/schemas/ValTargetUeId' + type: string minItems: 1 allValUesInd: type: boolean @@ -362,12 +408,26 @@ components: items: $ref: 'TS29549_SS_Events.yaml#/components/schemas/ValidityConditions' minItems: 1 + reqs: + type: object + additionalProperties: + $ref: '#/components/schemas/TransQualMeasReq' + minProperties: 1 + nullable: true + description: > + Represents the transmission quality measurement reporting requirements of the + subscription. + The key of the map shall be any unique string encoded value. subsExpTime: $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTimeRo' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: - appTrafficIds + - reqs + - notifUri oneOf: - required: [valGroupId] - required: [valUeIdsList] @@ -379,7 +439,10 @@ components: type: object properties: measId: - $ref: '#/components/schemas/MeasurementId' + type: array + items: + $ref: '#/components/schemas/MeasurementId' + minItems: 1 repType: $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NotificationMethod' repPeriodicity: @@ -389,13 +452,15 @@ components: measWindow: $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' measExpTime: - $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + repCriteria: + $ref: '#/components/schemas/TransQualMeasCriteria' required: - measId TransQualMeasSubscPatch: description: > - Represents the requested modifications to a Transmission Quality Measurement subscription. + Represents the requested modifications to a Transmission Quality Measurement Subscription. type: object properties: measConds: @@ -403,10 +468,24 @@ components: items: $ref: 'TS29549_SS_Events.yaml#/components/schemas/ValidityConditions' minItems: 1 + reqs: + type: object + additionalProperties: + $ref: '#/components/schemas/TransQualMeasReq' + minProperties: 1 + nullable: true + description: > + Represents the transmission quality measurement reporting requirements of the + subscription. + The key of the map shall be any unique string encoded value and shall be set to the same + value as the one provided during the creation of the transmission quality measurement + subscription. + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' TransQualMeasNotif: description: > - Represents a Transmission Quality Measurement notification. + Represents a Transmission Quality Measurement Notification. type: object properties: reports: @@ -414,6 +493,8 @@ components: items: $ref: '#/components/schemas/TransQualMeasReport' minItems: 1 + required: + - reports TransQualMeasReport: description: > @@ -421,34 +502,113 @@ components: type: object properties: measId: - $ref: '#/components/schemas/MeasurementId' + type: array + items: + $ref: '#/components/schemas/MeasurementId' + minItems: 1 valUeIds: type: array items: - $ref: '#/components/schemas/ValTargetUeId' + type: string minItems: 1 + measData: + $ref: '#/components/schemas/TransQualMeasData' required: - measId - ValTargetUeId: - description: Represents the identifier of a targeted VAL UE. + TransQualMeasCriteria: + description: > + Represents the Transmission Quality Measurement reporting criteria. type: object properties: - valUserId: - type: string - valUeId: - type: string - valUeIpv4Addr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' - valUeIpv6Addr: - $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' - port: - $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' - oneOf: - - required: [valUserId] - - required: [valUeId] - - required: [valUeIpv4Addr] - - required: [valUeIpv6Addr] + minLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' + maxLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' + minBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + minPackLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPackLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + minJitter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32Rm' + maxJitter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32Rm' + anyOf: + - required: [minLatency] + - required: [maxLatency] + - required: [minBitRate] + - required: [maxBitRate] + - required: [minPackLossRate] + - required: [maxPackLossRate] + - required: [minJitter] + - required: [maxJitter] + + TransQualMeasData: + description: > + Represents the Transmission Quality Measurement data. + type: object + properties: + minLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + maxLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + avgLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + stdDevLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + kPercLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + avgBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + stdDevBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + kPercBitRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minPackLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + maxPackLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + avgPackLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + stdDevPackLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + kPercPackLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + minJitter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + maxJitter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + avgJitter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + stdDevJitter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + kPercJitter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + measPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + timestamp: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + anyOf: + - required: [minLatency] + - required: [maxLatency] + - required: [avgLatency] + - required: [minBitRate] + - required: [maxBitRate] + - required: [avgBitRate] + - required: [minPackLossRate] + - required: [maxPackLossRate] + - required: [avgPackLossRate] + - required: [minJitter] + - required: [maxJitter] + - required: [avgJitter] HistTransQualMeasReports: description: > @@ -465,6 +625,14 @@ components: required: - reports + +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + MeasurementId: anyOf: - type: string @@ -500,6 +668,11 @@ components: description: | Represents the reporting granularity. Possible values are: - - INDIVIDUAL_VAL_UE: Indicates that the requested granularity is individual VAL UE. - - VAL_GROUP: Indicates that the requested granularity is VAL Group. - - ALL_UES: Indicates that the requested granularity is all UE(s). + - INDIVIDUAL_VAL_UE: Indicates that the granularity is individual VAL UE. + - VAL_GROUP: Indicates that the granularity is VAL Group. + - ALL_UES: Indicates that the granularity is all VAL UE(s). + + +# Data types describing alternative data types or combinations of data types: +# + diff --git a/TS29549_SS_IdmParameterProvisioning.yaml b/TS29549_SS_IdmParameterProvisioning.yaml new file mode 100644 index 00000000..8abf9947 --- /dev/null +++ b/TS29549_SS_IdmParameterProvisioning.yaml @@ -0,0 +1,378 @@ +openapi: 3.0.0 + +info: + title: SS_IdmParameterProvisioning + description: | + API for SEAL Identity management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.0.0-alpha.1" + +externalDocs: + description: > + 3GPP TS 29.549 V18.4.0 Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/ss-ipp/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +paths: + /configurations: + post: + description: Provisions VAL Services configuration information. + operationId: CreateValServiceConf + tags: + - VAL Services Configurations (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + responses: + '201': + description: VAL services configuration created sucessfully. + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + headers: + Location: + description: Contains the URI of the newly created resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + get: + description: Retrieves VAL services configuration satisfying filter criteria + operationId: RetrieveValServiceConf + tags: + - VAL Services Configurations (Collection) + parameters: + - name: val-server-id + in: query + description: String identifying the VAL server. + required: false + schema: + type: string + - name: config-ids + in: query + description: Identifying the list of the val services configuration resources. + required: false + schema: + type: array + items: + type: string + minItems: 1 + responses: + '200': + description: List of VAL services configurations matching the query parameters in the request. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VALServicesConfig' + minItems: 0 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /configurations/{confId}: + get: + description: Retrieves Individual VAL services configuration information. + operationId: RetrieveIndValServicesConf + tags: + - Individual VAL Services Configuration (Document) + parameters: + - name: confId + in: path + description: String identifying an individual VAL services configuration resource. + required: true + schema: + type: string + responses: + '200': + description: The whole Individual VAL services configuration resource. + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + description: Updates an individual VAL services configuration resource. + operationId: UpdateIndValServicesConf + tags: + - Individual VAL Services Configuration (Document) + parameters: + - name: confId + in: path + description: String identifying an individual VAL services configuration resource + required: true + schema: + type: string + requestBody: + description: VAL services configuration to be updated in IM server. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + responses: + '200': + description: VAL services configuration updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + '204': + description: No Content + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + description: Modify an existing VAL services configuration. + operationId: ModifyIndValServicesConf + tags: + - Individual VAL Services Configuration (Document) + parameters: + - name: confId + in: path + description: Identifier of an individual VAL services configuration resource. + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/VALServicesConfigPatch' + responses: + '200': + description: > + The individual VAL services configuration resource is modified successfully and a + representation of the updated VAL services configuration resource is returned in + the request body. + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + '204': + description: No Content. The individual VAL services configuration is modified successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + description: Deletes a VAL Services Configuration. + operationId: DeleteIndValServicesConf + tags: + - Individual VAL Services Configuration (Document) + parameters: + - name: confId + in: path + description: String identifying an individual VAL Service Configuration resource. + required: true + schema: + type: string + responses: + '204': + description: The individual VAL services configuration matching confId was deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + VALServicesConfig: + description: Represents details of the VAL services configuration information. + type: object + properties: + valServerId: + type: string + description: The Identifier of the VAL server provisioning the VAL services configuration. + valSvcConf: + type: array + description: The list of VAL service parameters provisioned. + items: + $ref: '#/components/schemas/VALServiceParams' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - valServerId + - valSvcConf + + VALServiceParams: + description: Represents details of VAL service parameters information. + type: object + properties: + valServiceId: + type: string + description: The identifier of the VAL service. + idList: + type: array + description: The list of VAL User IDs or VAL UE IDs provisioned to the VAL service. + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + required: + - valServiceId + - idList + + VALServicesConfigPatch: + description: Represents details of the partial update of VAL service configuration information. + type: object + properties: + valSvcConf: + type: array + description: The list of VAL service parameters provisioned. + items: + $ref: '#/components/schemas/VALServiceParams' + minItems: 1 diff --git a/TS29549_SS_LocationReporting.yaml b/TS29549_SS_LocationReporting.yaml index 6d3e57af..fd9a2c56 100644 --- a/TS29549_SS_LocationReporting.yaml +++ b/TS29549_SS_LocationReporting.yaml @@ -4,13 +4,13 @@ info: title: SS_LocationReporting description: | API for SEAL Location Reporting Configuration. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: "1.2.0-alpha.1" + version: "1.2.0-alpha.2" externalDocs: description: > - 3GPP TS 29.549 V18.0.0 Service Enabler Architecture Layer for Verticals (SEAL); + 3GPP TS 29.549 V18.4.0 Service Enabler Architecture Layer for Verticals (SEAL); Application Programming Interface (API) specification; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ @@ -73,6 +73,46 @@ paths: $ref: 'TS29122_CommonData.yaml#/components/responses/503' default: $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + NotifyLocationTriggerEvent: + '{$request.body#/notifUri}': + post: + summary: Notify on location event. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LocationReport' + responses: + '204': + description: The notification is successfully received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' /trigger-configurations/{configurationId}: get: @@ -288,10 +328,23 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' repPeriod: $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' accuracy: $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy' + valSvcAreaIds: + type: array + minItems: 1 + items: + type: string + description: > + Represents the VAL service area ID(s). + triggCriteria: + $ref: '#/components/schemas/TriggeringCriteria' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + report: + $ref: '#/components/schemas/LocationReport' required: - valServerId - valTgtUe @@ -306,5 +359,110 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' repPeriod: $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' accuracy: $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy' + valSvcAreaIds: + type: array + minItems: 1 + items: + type: string + description: > + Represents the VAL service area ID(s). + triggCriteria: + $ref: '#/components/schemas/TriggeringCriteria' + + TriggeringCriteria: + description: Represents the location reporting triggering criteria. + type: object + properties: + reportingMode: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NotificationMethod' + repPer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + locChgCond: + $ref: '#/components/schemas/LocChangeCond' + ioInd: + $ref: '#/components/schemas/InsideOutsideInd' + repSchedules: + type: array + minItems: 1 + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime' + description: > + Indicates the requested reporting schedule, e.g., day(s) of the week + and/or time period(s) for the location reporting. + required: + - reportingMode + + LocationReport: + description: Represents the location trigger report. + type: object + properties: + subscriptionId: + type: string + description: Represents the subscription ID. + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + locInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - subscriptionId + - valTgtUe + - locInfo + +# Simple data types and Enumerations + InsideOutsideInd: + anyOf: + - type: string + enum: + - INSIDE + - OUTSIDE + - 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 a desired condition of the location reporting, + e.g., inside or outside the given area. + Possible values are: + - INSIDE: Indicates that the reporting shall occur when the UE is inside the given location. + - OUTSIDE: Indicates that the reporting shall occur when the UE is outside the given + location. + + LocChangeCond: + anyOf: + - type: string + enum: + - CELL + - NODEB + - TA_RA + - WLAN_AN + - CIVIC_ADDR + - GPS + - SAI + - ECGI + - RAT + - VAL_SERVICE_AREA + - 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 a desired condition of the requested location change. + Possible values are: + - CELL: The condition is cell change. + - NODEB: The condition is eNodeB or gNodeB change. + - TA_RA: The condition is TA or RA change. + - WLAN_AN: The condition is WLAN access network change (e.g., SSID or BSSID change). + - CIVIC_ADDR: The condition is civic address change. + - GPS: The condition is GPS coordinate change. + - SAI: The condition is SAI change.. + - ECGI: The condition is ECGI change. + - RAT: The condition is RAT change. + - VAL_SERVICE_AREA: The condition is VAL service area change. diff --git a/TS29549_SS_NetworkResourceAdaptation.yaml b/TS29549_SS_NetworkResourceAdaptation.yaml index f97e8d31..1bfb8529 100644 --- a/TS29549_SS_NetworkResourceAdaptation.yaml +++ b/TS29549_SS_NetworkResourceAdaptation.yaml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - version: 1.2.0-alpha.3 + version: 1.2.0-alpha.4 title: SS_NetworkResourceAdaptation description: | SS Network Resource Adaptation Service. @@ -9,7 +9,7 @@ info: externalDocs: description: > - 3GPP TS 29.549 V18.3.0; Service Enabler Architecture Layer for Verticals (SEAL); + 3GPP TS 29.549 V18.4.0; Service Enabler Architecture Layer for Verticals (SEAL); Application Programming Interface (API) specification; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ @@ -327,6 +327,51 @@ paths: default: $ref: 'TS29122_CommonData.yaml#/components/responses/default' + put: + summary: Request the update of an existing Individual MBS Resource. + operationId: UpdateIndivMBSResource + tags: + - Individual MBS Resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MBSResource' + responses: + '200': + description: > + OK. Successful case. The targeted Individual MBS Resource resource is successfully + updated and a representation of the updated resource is returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/MBSResource' + '204': + description: > + No Content. Successful case. The targeted Individual MBS Resource resource is + successfully updated and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + patch: summary: Request the modification of an existing Individual MBS Resource. operationId: ModifyIndivMBSResource @@ -346,7 +391,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MBSResourceResp' + $ref: '#/components/schemas/MBSResource' '204': description: > No Content. Successful case. The targeted Individual MBS Resource resource is @@ -910,6 +955,168 @@ paths: $ref: 'TS29122_CommonData.yaml#/components/responses/503' default: $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /bdt-policy-configs: + post: + summary: Creates a new Individual BDT Policy Configuration + operationId: CreateBDTPolicyConfig + tags: + - BDT Policy Configurations (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolConfig' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolConfig' + headers: + Location: + description: > + Contains the URI of the created individual BDT Policy configuration resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + BdtNotification: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BdtNotification' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /bdt-policy-configs/{bdtPolConfigId}: + parameters: + - name: bdtPolConfigId + in: path + description: Represents the identifier of the Individual BDT Policy Configuration. + required: true + schema: + type: string + + get: + summary: Reads an existing Individual BDT Policy Configuration + operationId: GetBDTPolicyConfig + tags: + - Individual BDT Policy Configuration(Document)Config + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolConfig' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Delete an existing Individual BDT policy Configuration + operationId: DeleteBDTPolicyConfig + tags: + - Individual BDT Policy Configuration (Document) + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + components: securitySchemes: oAuth2ClientCredentials: @@ -1162,6 +1369,10 @@ components: $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' upPortNum: $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + mbs5GInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSession' + epsMbmsInfo: + $ref: '#/components/schemas/EpsMbmsInfo' anyOf: - required: [upIpv4Addr] - required: [upIpv6Addr] @@ -1223,8 +1434,82 @@ components: - mbs5gSessionId + BdtPolConfig: + description: Represents the parameters related to the BDT Policy configuration. + type: object + properties: + valServId: + type: string + valGroupId: + type: string + valUeIds: + type: array + items: + type: string + minItems: 1 + dataVolUe: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + desiredTimeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + grantTimeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + geoArea: + $ref: '#/components/schemas/GeoArea' + bdtPolRefId: + type: string + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oneOf: + - required: [valGroupId] + - required: [valUeIds] + required: + - valServId + - notifUri + + + GeoArea: + description: Represents a Geographical area. + type: object + properties: + geographicAreas: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + description: Represents a list of Geographical area. + civicAddresses: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + minItems: 1 + description: Represents a list of Civic address of an area. + + + BdtNotification: + description: Represents a notification on update related to BDT Policy configuration resource. + type: object + properties: + notifId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + bdtConfigId: + type: string + grantTimeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + bdtPolicyRemoveInd: + type: boolean + default: false + required: + - notifId + - bdtConfigId + + # Simple data types and Enumerations + EpsMbmsInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + ServiceAnnoucementMode: anyOf: - type: string diff --git a/TS29549_SS_VALServiceAreaConfiguration.yaml b/TS29549_SS_VALServiceAreaConfiguration.yaml index 11e344e5..9d37da90 100644 --- a/TS29549_SS_VALServiceAreaConfiguration.yaml +++ b/TS29549_SS_VALServiceAreaConfiguration.yaml @@ -6,11 +6,11 @@ info: API for SEAL VAL Service Area Configuration Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: "1.0.0-alpha.1" + version: "1.0.0-alpha.2" externalDocs: description: > - 3GPP TS 29.549 V18.2.0 Service Enabler Architecture Layer for Verticals (SEAL); + 3GPP TS 29.549 V18.4.0 Service Enabler Architecture Layer for Verticals (SEAL); Application Programming Interface (API) specification; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ @@ -210,6 +210,275 @@ paths: default: $ref: 'TS29122_CommonData.yaml#/components/responses/default' + /subscriptions: + post: + summary: Create individual VAL service area change event(s) subscription. + operationId: SubscribeChangeEvents + tags: + - VAL Service Area Change Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + responses: + '201': + description: > + The requested individual VAL service area change event(s) subscription + resource is successfully created and a representation of the created + resource is returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + headers: + Location: + description: Contains the URI of the newly created resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + NotifyValServiceAreaChange: + '{$request.body#/notifUri}': + post: + summary: Notify on changes of the VAL service area(s) accodring to the requested reporting settings. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaNotif' + responses: + '204': + description: The notification is successfully received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /subscriptions/{subscriptionId}: + parameters: + - name: subscriptionId + in: path + description: > + Represents the identifier of an individual VAL service area change event(s) + subscription resource. + required: true + schema: + type: string + + get: + summary: Read an existing individual unicast monitoring subscription resource according to the subscriptionId. + operationId: ReadValServiceAreaChange + tags: + - Individual VAL Service Area Change Subscription (Document) + responses: + '200': + description: > + The requested individual VAL service area change event(s) subscription is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Update individual VAL service area change event(s) subscription. + operationId: UpdateIndValServAreaChangeSubsc + tags: + - Individual VAL Service Area Change Subscription (Document) + requestBody: + description: Updated details of the unicast VAL service area change event(s) subscription. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + responses: + '200': + description: > + The subscription is updated successfully, and the updated subscription + information returned in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + '204': + description: No Content. The subscription is updated successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Modify the individual VAL service area change event(s) subscription. + operationId: ModifyIndValServAreaChangeSubsc + tags: + - Individual VAL Service Area Change Subscription (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubscPatch' + responses: + '200': + description: > + The individual VAL service area change event(s) subscription is + modified successfully, and the representation of the modified resource + is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + '204': + description: No Content. The subscription is modified successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Remove the existing individual VAL service area change event(s) subscription resource according to the subscriptionId. + operationId: UnsubscribeValServiceAreaChange + tags: + - Individual VAL Service Area Change Subscription (Document) + responses: + '204': + description: > + The individual VAL service area change event(s) subscription resource + matching the subscriptionId is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + components: securitySchemes: oAuth2ClientCredentials: @@ -225,8 +494,7 @@ components: type: object properties: valSvcAreaId: - description: Represents the VAL service area ID. - type: string + $ref: '#/components/schemas/ValSvcAreaId' locations: description: Represents the locations associated with the VAL service area. minItems: 1 @@ -275,3 +543,108 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: - valSvcAreaIds + + ValServiceAreaSubscPatch: + description: Represents the VAL service area change event(s) modification request. + type: object + properties: + events: + type: array + description: Represents the subscribed VAL service area change event(s). + items: + $ref: '#/components/schemas/ValServiceAreaEventType' + minItems: 1 + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + subscDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + + ValSvcAreaId: + type: string + description: > + Represents the VAL Service Area identifier encoded as a string and generated + either based on VAL Server ID or using the Universally Unique Identifier (UUID) + version 4 as described in IETF RFC 4122. + + ValServiceAreaSubsc: + description: Represents the VAL service area change event(s) subscription. + type: object + properties: + events: + description: Represents the subscribed VAL service area change event(s). + minItems: 1 + items: + $ref: '#/components/schemas/ValServiceAreaEventType' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + subscDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - events + - notifUri + + ValServiceAreaEventType: + description: Represents the VAL service area change event type. + type: object + properties: + event: + $ref: '#/components/schemas/ValServiceAreaEvent' + valSvcAreaIds: + description: Represents the VAL service area ID(s) associated with the event. + minItems: 1 + items: + type: string + required: + - event + - valSvcAreaIds + + ValServiceAreaNotif: + description: Represents the VAL service area change event(s) notifcation. + type: object + properties: + valSvcAreaConts: + description: Represents the VAL service area change event(s) content. + minItems: 1 + items: + $ref: '#/components/schemas/ValServiceAreaEventInfo' + required: + - valSvcAreaConts + + ValServiceAreaEventInfo: + description: Represents the VAL service area change event(s) content. + type: object + properties: + event: + $ref: '#/components/schemas/ValServiceAreaEvent' + valSvcAreas: + description: Represents the VAL service area(s) associated with the event. + minItems: 1 + items: + $ref: '#/components/schemas/ValServiceArea' + valSvcAreaIds: + description: Represents the VAL service area(s) associated with the event. + minItems: 1 + items: + type: string + required: + - event + +# Simple data types and Enumerations + ValServiceAreaEvent: + anyOf: + - type: string + enum: + - UPDATE + - DELETE + - 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 VAL service area change event. + Possible values are: + - UPDATE: Indicates that the VAL service area change event is VAL service area update. + - DELETE: Indicates that the VAL service area change event is VAL service area delete. diff --git a/TS29550_Nsoraf_SOR.yaml b/TS29550_Nsoraf_SOR.yaml index 87891951..17d90f39 100644 --- a/TS29550_Nsoraf_SOR.yaml +++ b/TS29550_Nsoraf_SOR.yaml @@ -1,13 +1,13 @@ openapi: 3.0.0 info: title: 'Nsoraf_SOR' - version: 1.2.0-alpha.2 + version: 1.2.0-alpha.3 description: | Nsoraf Steering Of Roaming Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.550 V18.1.0; Steering Of Roaming Application Function Services. + description: 3GPP TS 29.550 V18.2.0; Steering Of Roaming Application Function Services. url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.550/ servers: - url: '{apiRoot}/nsoraf-sor/v1' @@ -60,7 +60,7 @@ paths: $ref: '#/components/schemas/SorInformation' headers: Cache-Control: - description: Cache-Control (as described in RFC 7234) with value "no-cache" to indicate that the returned SoR information should not be cached + description: Cache-Control (as described in RFC 9111) with value "no-cache" to indicate that the returned SoR information should not be cached schema: type: string '307': diff --git a/TS29551_Nnef_PFDmanagement.yaml b/TS29551_Nnef_PFDmanagement.yaml index 73c1411c..4955047f 100644 --- a/TS29551_Nnef_PFDmanagement.yaml +++ b/TS29551_Nnef_PFDmanagement.yaml @@ -1,14 +1,14 @@ openapi: 3.0.0 info: title: Nnef_PFDmanagement Service API - version: 1.3.0-alpha.1 + version: 1.3.0-alpha.2 description: | Packet Flow Description Management Service. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. # externalDocs: - description: 3GPP TS 29.551 v18.0.0, 5G System; Packet Flow Description Management Service + description: 3GPP TS 29.551 v18.3.0, 5G System; Packet Flow Description Management Service url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.551/' # servers: @@ -503,6 +503,12 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' partialFlag: type: boolean + description: > + Indication of partial update of PFDs for an existing application identifier if it is + included and set to true. Otherwise set to false indicates not supporting partial + update of PFDs for an existing application identifier. The default value false + applies if the attribute is not present. + default: false supportedFeatures: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' required: @@ -533,9 +539,20 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' removalFlag: type: boolean + description: > + Indication of removal of PFDs for an existing application identifier. + Set to true indicates the PFDs are removed. + Set to false indicates the PFDs are not removed. + Default value is false if omitted. default: false partialFlag: type: boolean + description: > + Indication of partial update of PFDs for an existing application identifier + if this operation is supported according to feature negotiation. + Set to true indicates partial update PFDs for the included application identifier. + Set to false indicates not partial update PFDs for the included application identifier. + Default value is "false" if omitted. default: false pfds: type: array diff --git a/TS29553_Npanf_ResolveRemoteUserId.yaml b/TS29553_Npanf_ResolveRemoteUserId.yaml index 8c606d93..ad6a5b58 100644 --- a/TS29553_Npanf_ResolveRemoteUserId.yaml +++ b/TS29553_Npanf_ResolveRemoteUserId.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: '1.0.0' + version: '1.1.0-alpha.1' title: 'Npanf_ResolveRemoteUserId' description: | - PANF Resolve Remote User Id Service. + PAnF Resolve Remote User Id Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.559 V17.2.0; 5G System; 5G ProSe Key Management Services; Stage 3. - url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.559/ + description: 3GPP TS 29.553 V18.3.0; 5G System; 5G ProSe Anchor Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.553/ servers: - url: '{apiRoot}/npanf-userid/v1' diff --git a/TS29555_N5g-ddnmf_Discovery.yaml b/TS29555_N5g-ddnmf_Discovery.yaml index e6eb0b4d..23ce1a75 100644 --- a/TS29555_N5g-ddnmf_Discovery.yaml +++ b/TS29555_N5g-ddnmf_Discovery.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: N5g-ddnmf_Discovery API - version: '1.1.0-alpha.2' + version: '1.1.0-alpha.3' description: | N5g-ddnmf_Discovery Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.555 V18.2.0; 5G System; 5G Direct Discovery Name Management Services; Stage 3. + description: 3GPP TS 29.555 V18.4.0; 5G System; 5G Direct Discovery Name Management Services; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.555/ servers: @@ -55,11 +55,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnnounceAuthReqData' + $ref: '#/components/schemas/AnnounceAuthData' required: true responses: '201': description: Successful creation of the resource + content: + application/json: + schema: + $ref: '#/components/schemas/AnnounceAuthData' headers: Location: description: > @@ -606,7 +610,7 @@ components: # COMPLEX TYPES: - AnnounceAuthReqData: + AnnounceAuthData: type: object description: Represents Data used to request the authorization to announce for a UE required: diff --git a/TS29556_Neasdf_DNSContext.yaml b/TS29556_Neasdf_DNSContext.yaml index 9fa30ef7..130ce881 100644 --- a/TS29556_Neasdf_DNSContext.yaml +++ b/TS29556_Neasdf_DNSContext.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.1.0-alpha.3' + version: '1.1.0-alpha.4' title: 'Neasdf_DNSContext' description: | EASDF DNS Context Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.556 V18.2.0; 5G System; Edge Application Server Discovery Services; Stage3 + description: 3GPP TS 29.556 V18.4.0; 5G System; Edge Application Server Discovery Services; Stage3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.556/ servers: @@ -328,6 +328,8 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' hplmnId: $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + n6RoutingInfo: + $ref: '#/components/schemas/N6RoutingInfo' dnsRules: description: map of DNS message handling rules where a valid JSON string serves as key type: object @@ -678,6 +680,17 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' minItems: 1 + N6RoutingInfo: + description: N6 traffic routing information + type: object + properties: + ipv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + portNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + # # SIMPLE DATA TYPES # diff --git a/TS29558_Eecs_EESRegistration.yaml b/TS29558_Eecs_EESRegistration.yaml index f242e52e..bfb6fb10 100644 --- a/TS29558_Eecs_EESRegistration.yaml +++ b/TS29558_Eecs_EESRegistration.yaml @@ -6,11 +6,11 @@ info: API for EES Registration. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: 1.1.0-alpha.4 + version: 1.1.0-alpha.5 externalDocs: description: > - 3GPP TS 29.558 V18.3.0 Enabling Edge Applications; + 3GPP TS 29.558 V18.4.0 Enabling Edge Applications; Application Programming Interface (API) specification; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ @@ -316,6 +316,10 @@ components: minProperties: 1 description: > The key used in this map for each entry is the EAS ID of the concerned EAS. + Within each EASBundleInfo encoded map entry of this attribute, the "mainEasId" attribute + shall not be present. + ednInfoSets: + $ref: '#/components/schemas/EDNInfo' easInstInfo: type: object additionalProperties: @@ -342,11 +346,23 @@ components: $ref: '#/components/schemas/ACRScenario' minItems: 1 description: The ACR scenarios supported by the EES for service continuity. + svcContSuppExt1: + type: array + items: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EASBundleInfo' + minItems: 1 + description: > + Represents the information related to the EES ability to handle bundled EAS ACRs. + This attribute may be present only when the "svcContSupp" attribute is also present. + When this attribute is present, it indicates that the EES (identified by the "eesId" + attribute) is able to handle bundled EAS ACRs and contains the information of the EAS + bundle(s) for which the EES is able to handle bundled EAS ACRs. eecRegConf: type: boolean description: > Set to true if the EEC is required to register to the EES to use edge service. - Set to false if the EEC is not required to register to use edge services. + Set to false if the EEC is not required to register to use edge services. Default + Value is false if omitted. required: - eesId - endPt @@ -436,11 +452,37 @@ components: description: Represents the instantiation criteria for an EAS. properties: instantiationTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + instWindows: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + minItems: 1 + description: A list time windows at which the EAS is instantiated. + scheds: type: array items: - $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime' minItems: 1 - description: A list of date time periods when the EAS is instiantiable. + description: Represents the EAS instantiation schedule. + oneOf: + - required: [instantiationTime] + - required: [instWindows] + - required: [scheds] + + EDNInfo: + type: object + description: Represents EDN related information. + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + required: + - dnn ACRScenario: anyOf: diff --git a/TS29558_Eecs_TargetEESDiscovery.yaml b/TS29558_Eecs_TargetEESDiscovery.yaml index f28e31ac..8b26c359 100644 --- a/TS29558_Eecs_TargetEESDiscovery.yaml +++ b/TS29558_Eecs_TargetEESDiscovery.yaml @@ -5,10 +5,10 @@ info: API for Target EES Discovery. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: 1.1.0-alpha.2 + version: 1.1.0-alpha.3 externalDocs: description: > - 3GPP TS 29.558 V18.3.0 Enabling Edge Applications; + 3GPP TS 29.558 V18.4.0 Enabling Edge Applications; Application Programming Interface (API) specification; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ security: @@ -102,7 +102,14 @@ paths: description: > Set to true if edge node sharing is requested. Set to false if edge node sharing is not requested. - The default value when omitted is false. + The default value when omitted is false. + - name: app-grp-id + in: query + description: > + Contains the application group identifier. + required: false + schema: + type: string responses: '200': description: The EDN configuration and the T-EES information determined by ECS. diff --git a/TS29558_Eees_ACRManagementEvent.yaml b/TS29558_Eees_ACRManagementEvent.yaml index 3c32c53e..ed431e31 100644 --- a/TS29558_Eees_ACRManagementEvent.yaml +++ b/TS29558_Eees_ACRManagementEvent.yaml @@ -6,11 +6,11 @@ info: API for EES ACR Management Event. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: 1.1.0-alpha.4 + version: 1.1.0-alpha.5 externalDocs: description: > - 3GPP TS 29.558 V18.3.0 Enabling Edge Applications; + 3GPP TS 29.558 V18.4.0 Enabling Edge Applications; Application Programming Interface (API) specification; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ @@ -50,6 +50,12 @@ paths: schema: $ref: '#/components/schemas/AcrMgntEventsNotification' responses: + '200': + description: OK (The notification is received successfully) + content: + application/json: + schema: + $ref: '#/components/schemas/EasAckInformation' '204': description: No Content (successful notification) '307': @@ -480,9 +486,9 @@ components: type: boolean description: > Identifies whether EAS acknowledgement of UP path change event notifications is to be - expected. Set to "true" if the EAS acknowledgement is expected. Default value is - "false". This attribute may be provided only if the "event" attribute is set to - "UP_PATH_CHG". + expected. Set to "true" if the EAS acknowledgement is expected. Set to "false" if + the EAS acknowledgement is not expected. Default value is "false" if ommited. + This attribute may be provided only if the "event" attribute is set to "UP_PATH_CHG". easChars: type: array items: @@ -499,6 +505,14 @@ components: When set to true, it indicates that service continuity planning is required. When set to false, it indicates that Service continuity planning is not required. The default value when this attribute is omitted is false. + easAckSvcCont: + type: boolean + description: > + Indicates that the EAS will provide an acknowledgement as a response to the notification + of ACR management notification related to service continuity planning. Set to "true" if + the EAS acknowledgement is expected. Default value is "false". This attribute may be + provided only if the "event" attribute is set to "ACR_MONITORING" and/or + "ACR_FACILITATION". required: - event @@ -560,6 +574,12 @@ components: items: $ref: '#/components/schemas/SelectedACRScenarios' minItems: 1 + easInBdlInfoList: + type: array + items: + $ref: '#/components/schemas/EasInBundleInfo' + minItems: 1 + description: Represents the list of EAS in a bundle related information. servContPlanInd: type: boolean description: > @@ -710,6 +730,31 @@ components: - acId - ueId + EasAckInformation: + type: object + description: Represents the EAS acknowledgement information. + properties: + resCode: + $ref: '#/components/schemas/ResultCode' + required: + - resCode + + EasInBundleInfo: + type: object + description: > + Represents EAS in a bundle information. + properties: + easId: + type: string + description: Contains the identifier of the EAS that is within an EAS bundle. + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + svcArea: + $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea' + # # ENUMERATIONS DATA TYPES # @@ -722,6 +767,7 @@ components: - ACR_MONITORING - ACR_FACILITATION - ACT_START_STOP + - ACR_SELECTION - type: string description: > This string provides forward-compatibility with future extensions to the enumeration @@ -729,10 +775,11 @@ components: description: | Represents the ACR Management event. Possible values are: - - UP_PATH_CHG: User plane path change event. - - ACR_MONITORING: ACR monitoring event. - - ACR_FACILITATION: ACR facilitation event. - - ACT_START_STOP: ACT start/stop event. + - UP_PATH_CHG: Indicates that ACR Management Event is the User plane path change event. + - ACR_MONITORING: Indicates that ACR Management Event is the ACR monitoring event. + - ACR_FACILITATION: Indicates that ACR Management Event is the ACR facilitation event. + - ACT_START_STOP: Indicates that ACR Management Event is the ACT start/stop event. + - ACR_SELECTION: Indicates that ACR Management Event is the ACR selection event. AcrMgntEventFilter: anyOf: @@ -800,4 +847,20 @@ components: Represents the availability status. Possible values are: - AVAILABLE: Indicates availability. - - NOT_AVAILABLE: Indicates unavailability. + - NOT_AVAILABLE: Indicates unavailability. + + ResultCode: + anyOf: + - type: string + enum: + - ACCEPTED + - REJECTED + - 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 result code of ACT acceptance by EAS. + Possible values are: + - ACCEPTED: Indicates acceptance of the ACT. + - REJECTED: Indicates rejection of the ACT. diff --git a/TS29558_Eees_CommonEASAnnouncement.yaml b/TS29558_Eees_CommonEASAnnouncement.yaml index 1ddb5711..b5f82aa3 100644 --- a/TS29558_Eees_CommonEASAnnouncement.yaml +++ b/TS29558_Eees_CommonEASAnnouncement.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: EES Announce Common EAS Information Service - version: 1.0.0-alpha.1 + version: 1.0.0-alpha.2 description: | EES Announce Common EAS Information Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.558 V18.3.0; Enabling Edge Applications; + 3GPP TS 29.558 V18.4.0; Enabling Edge Applications; Application Programming Interface (API) specification; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ @@ -26,12 +26,12 @@ servers: description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 paths: - /announce-common-eas: + /declare: post: - summary: Request to announce common EAS information. - operationId: Request + summary: Request to declare common EAS information. + operationId: Declare tags: - - Announce common EAS Information + - Declare common EAS Information requestBody: required: true content: @@ -86,16 +86,19 @@ components: Represents the common EAS information. type: object properties: - eesId: + requestorId: type: string description: Represents the identifier of the announcing EES sending the request. easId: type: string - description: Represents the EAS ID of the common EAS + description: Represents the EAS ID of the selected common EAS appGrpId: type: string - description: Represents the unique identifier of the group of UEs using same application. + description: Represents the application group identifier. + endPt: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' required: - - eesId + - requestorId - easId - appGrpId + - endPt diff --git a/TS29558_Eees_EASRegistration.yaml b/TS29558_Eees_EASRegistration.yaml index 6b226144..5b164d1e 100644 --- a/TS29558_Eees_EASRegistration.yaml +++ b/TS29558_Eees_EASRegistration.yaml @@ -6,11 +6,11 @@ info: API for EAS Registration. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. - version: 1.1.0-alpha.4 + version: 1.1.0-alpha.5 externalDocs: description: > - 3GPP TS 29.558 V18.3.0 Enabling Edge Applications; + 3GPP TS 29.558 V18.4.0 Enabling Edge Applications; Application Programming Interface (API) specification; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ @@ -356,6 +356,17 @@ components: $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario' minItems: 1 description: The ACR scenarios supported by the EAS for service continuity. + svcContSuppExt1: + type: array + items: + $ref: '#/components/schemas/EASBundleInfo' + minItems: 1 + description: > + Represents the information related to the EAS ability to handle bundled EAS ACRs. + This attribute may be present only when the "svcContSupp" attribute is also present. + When this attribute is present, it indicates that the EAS (identified by the "easId" + attribute) is able to handle bundled EAS ACRs and contains the information of the EAS + bundle(s) for which the EAS is able to handle bundled EAS ACRs. transContSupp: $ref: '#/components/schemas/TransContSuppDetails' avlRep: @@ -365,6 +376,13 @@ components: description: EAS status information. genCtxDur: $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + easSyncSupp: + type: boolean + default: false + description: > + Set to true to indicate that content synchronization between EASs is supported. + Set to false to indicate that content synchronization between EASs is not supported. + The default value when this attribute is omitted is false. required: - easId - endPt @@ -405,6 +423,8 @@ components: type: object description: Represents the EAS bundle information. properties: + bdlType: + $ref: '#/components/schemas/BdlType' bdlId: type: string description: Indicates a bundle ID. @@ -413,15 +433,13 @@ components: items: type: string minItems: 1 - bdlType: - $ref: '#/components/schemas/BdlType' easBdlReqs: $ref: '#/components/schemas/EASBdlReqs' mainEasId: type: string required: - bdlType - oneOf: + anyOf: - required: [bdlId] - required: [easIdsList] diff --git a/TS29558_Eees_UEIdentifier.yaml b/TS29558_Eees_UEIdentifier.yaml index 1a9eb0ff..cb55dede 100644 --- a/TS29558_Eees_UEIdentifier.yaml +++ b/TS29558_Eees_UEIdentifier.yaml @@ -2,15 +2,15 @@ openapi: 3.0.0 info: title: EES UE Identifier Service - version: 1.1.0-alpha.1 + version: 1.1.0-alpha.2 description: | EES UE Identifier Service. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > - 3GPP TS 29.558 V18.0.0; Enabling Edge Applications; + 3GPP TS 29.558 V18.4.0; Enabling Edge Applications; Application Programming Interface (API) specification; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ @@ -28,6 +28,7 @@ servers: paths: /fetch: post: + deprecated: true summary: Fetch the identifier of an UE. operationId: FetchUEId tags: @@ -74,6 +75,55 @@ paths: default: $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /get: + post: + summary: Get the identifier of an UE. + operationId: GetUEId + tags: + - Get UE Identifier + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserInfo' + responses: + '200': + description: > + The operation is successful and the corresponding UE Identifier information, returned + by the Edge Enabler Server is included in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/UeIdInfo' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + components: securitySchemes: oAuth2ClientCredentials: @@ -85,6 +135,7 @@ components: schemas: UserInformation: + deprecated: true description: > Represents information about the User or the UE, that used by EES to use 3GPP CN capability to retrieve the EAS specific UE identifier. @@ -105,3 +156,62 @@ components: required: - easId - ipAddr + + UserInfo: + description: > + Represents information about the User or the UE, that used by EES to retrieve the UE + Identifier information. + type: object + properties: + easIds: + type: array + items: + type: string + minItems: 1 + description: > + The additional list of EAS Identifier for which the UE IDs are requested for by EAS or + EEC given the User information (e.g. IP address). + easProviderId: + description: Identifier of the ASP that provides the EAS. + type: string + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ipAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + anyOf: + - required: [ueId] + - required: [ipAddr] + + UeIdInfo: + description: > + Represents UE Identifier Information, including list of UE Identifier related information. + type: object + properties: + ueIds: + type: array + items: + $ref: '#/components/schemas/UeId' + minItems: 1 + required: + - ueIds + + UeId: + description: > + Represents UE Identifier Information, including list of UE Identifier related information. + type: object + properties: + edgeUeId: + description: Represents EDGE UE Identifier. + type: string + afSpecUeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + easId: + description: > + The application identifier of the EAS, e.g. URI, FQDN, requesting the UE Identifier + Information. + type: string + oneOf: + - required: [edgeUeId] + - required: [afSpecUeId] diff --git a/TS29559_Npkmf_Discovery.yaml b/TS29559_Npkmf_Discovery.yaml new file mode 100644 index 00000000..45a91420 --- /dev/null +++ b/TS29559_Npkmf_Discovery.yaml @@ -0,0 +1,372 @@ +openapi: 3.0.0 + +info: + title: Npkmf_Discovery API + version: '1.0.0' + description: | + Npkmf_Discovery Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.559 V17.5.0; 5G System; 5G ProSe Key Management Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.559/ + +servers: + - url: '{apiRoot}/npkmf-discovery/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npkmf-discovery + +paths: + /{ueId}/announce-authorize/{userInfoId}: + put: + summary: Obtain the authorization from the 5G PKMF for announcing in the PLMN + operationId: ObtainAnnounceAuth + tags: + - Obtain the authorization from the 5G PKMF for announcing in the PLMN + security: + - {} + - oAuth2ClientCredentials: + - npkmf-disc + - oAuth2ClientCredentials: + - npkmf-disc + - npkmf-disc:announce-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: userInfoId + in: path + description: User Info Id + required: true + schema: + $ref: '#/components/schemas/UserInfoId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnnounceAuthData' + required: true + responses: + '201': + description: Successful creation of the resource + content: + application/json: + schema: + $ref: '#/components/schemas/AnnounceAuthData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/npkmf-disc>//{ueId}/announce-authorize/{userInfoId} + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '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 + + /{ueId}/monitor-key/{userInfoId}: + put: + summary: Obtain the discovery key from the 5G PKMF for monitoring in the PLMN + operationId: ObtainMonitorKey + tags: + - Obtain the discovery key from the 5G PKMF for monitoring in the PLMN + security: + - {} + - oAuth2ClientCredentials: + - npkmf-disc + - oAuth2ClientCredentials: + - npkmf-disc + - npkmf-disc:monitor-key:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: userInfoId + in: path + description: User Info Id + required: true + schema: + $ref: '#/components/schemas/UserInfoId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorKeyReqData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorKeyRespData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/npkmf-disc>//{ueId}/monitor-key/{userInfoId} + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '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 + + /{ueId}/discovery-key/{userInfoId}: + put: + summary: Obtain the discovery key from the 5G PKMF for a discoverer UE + operationId: ObtainDiscKey + tags: + - Obtain the discovery key for a discoverer UE + security: + - {} + - oAuth2ClientCredentials: + - npkmf-disc + - oAuth2ClientCredentials: + - npkmf-disc + - npkmf-disc:discovery-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: userInfoId + in: path + description: User Info Id + required: true + schema: + $ref: '#/components/schemas/UserInfoId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoveryKeyReqData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoveryKeyRespData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/npkmf-disc>//{ueId}/discovery-key/{userInfoId} + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '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 + + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npkmf-disc: Access to the Npkmf_Discovery API + npkmf-disc:announce-authorize:modify: > + Access to modify the authorization to announce for a UE in the PLMN + npkmf-disc:monitor-key:modify: > + Access to modify the authorization for monitoring for an UE in the PLMN + npkmf-disc:discovery-key:modify: > + Access to modify the authorization from the 5G DDNMF for a discoverer UE + in the PLMN to operate Model B restricted discovery + + schemas: + +# STRUCTURED TYPES: + + AnnounceAuthData: + type: object + description: Represents Data used to request the authorization to announce for a UE + required: + - relayServCode + properties: + relayServCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RelayServiceCode' + + MonitorKeyReqData: + type: object + description: Data used to request the discovery key to monitor for a UE + required: + - relayServCode + - ueSecurityCapability + properties: + relayServCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RelayServiceCode' + ueSecurityCapability: + $ref: '#/components/schemas/UeSecurityCapability' + + MonitorKeyRespData: + type: object + description: Represents the obtained Monitor Discovery Key Data for a UE + required: + - chosenPc5CipheringAlgorithm + - discSecMaterials + properties: + chosenPc5CipheringAlgorithm: + $ref: '#/components/schemas/ChosenPc5CipheringAlgorithm' + discSecMaterials: + $ref: '#/components/schemas/DiscSecMaterials' + DiscoveryKeyReqData: + type: object + description: Data used to request the discovery key to monitor for a discoverer UE + required: + - relayServCode + - ueSecurityCapability + properties: + relayServCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RelayServiceCode' + ueSecurityCapability: + $ref: '#/components/schemas/UeSecurityCapability' + + DiscoveryKeyRespData: + type: object + description: Represents the obtained Monitor Discovery Key Data for a discoverer UE + required: + - chosenPc5CipheringAlgorithm + - discSecMaterials + properties: + chosenPc5CipheringAlgorithm: + $ref: '#/components/schemas/ChosenPc5CipheringAlgorithm' + discSecMaterials: + $ref: '#/components/schemas/DiscSecMaterials' + DiscSecMaterials: + type: object + description: Represents the discovery security materials + properties: + duik: + $ref: '#/components/schemas/Duik' + dusk: + $ref: '#/components/schemas/Dusk' + duck: + $ref: '#/components/schemas/Duck' + + + +# SIMPLE TYPES: + UserInfoId: + type: string + + UeSecurityCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + ChosenPc5CipheringAlgorithm: + description: Contains the chosen PC5 ciphering algorithm. + type: integer + + Duik: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + Dusk: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + Duck: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +# ENUMS: diff --git a/TS29563_Nhss_EE.yaml b/TS29563_Nhss_EE.yaml index 7fcdd1bc..6cb1023a 100644 --- a/TS29563_Nhss_EE.yaml +++ b/TS29563_Nhss_EE.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.2.0-alpha.2' + version: '1.2.0-alpha.3' title: 'Nhss_EE' description: | HSS Event Exposure. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.3.0 + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' servers: @@ -53,7 +53,9 @@ paths: $ref: '#/components/schemas/CreatedEeSubscription' headers: Location: - description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nhss-ee/v1/{ueId}/ee-subscriptions/{subscriptionId}' + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-ee/v1/{ueId}/ee-subscriptions/{subscriptionId} required: true schema: type: string @@ -66,7 +68,11 @@ paths: '401': $ref: 'TS29571_CommonData.yaml#/components/responses/401' '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/EeSubscriptionError' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '411': @@ -80,7 +86,11 @@ paths: '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '501': - $ref: 'TS29571_CommonData.yaml#/components/responses/501' + description: Not Implemented + content: + application/problem+json: + schema: + $ref: '#/components/schemas/EeSubscriptionError' '502': $ref: 'TS29571_CommonData.yaml#/components/responses/502' '503': @@ -141,10 +151,10 @@ paths: parameters: - name: ueId in: path - description: IMSI of the subscriber + description: IMSI of the subscriber or the identity of a group of UEs required: true schema: - $ref: '#/components/schemas/Imsi' + $ref: '#/components/schemas/UeIdOrGroupId' - name: subscriptionId in: path description: Id of the EE Subscription @@ -176,6 +186,7 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error + patch: summary: Patch operationId: UpdateEeSubscription @@ -184,10 +195,10 @@ paths: parameters: - name: ueId in: path - description: IMSI of the subscriber + description: IMSI of the subscriber or the identity of a group of UEs required: true schema: - $ref: '#/components/schemas/Imsi' + $ref: '#/components/schemas/UeIdOrGroupId' - name: subscriptionId in: path description: Id of the EE Subscription @@ -253,10 +264,13 @@ components: schemas: -# COMPLEX TYPES: +# STRUCTURED TYPES: EeSubscription: - description: It represents the request body of the subscription request sent to HSS, containing data related to the subscription to be created, such as the SCEF, Monitoring Configurations and reporting options + description: > + It represents the request body of the subscription request sent to HSS, containing data + related to the subscription to be created, such as the SCEF, Monitoring Configurations and + reporting options type: object required: - callbackReference @@ -268,7 +282,9 @@ components: scefDiamRealm: $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' monitoringConfigurations: - description: A map (list of key-value pairs where ReferenceId serves as key) of MonitoringConfigurations + description: > + A map (list of key-value pairs where ReferenceId serves as key) of + MonitoringConfigurations type: object additionalProperties: $ref: '#/components/schemas/MonitoringConfiguration' @@ -314,7 +330,9 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' FailedMonitoringConfiguration: - description: Contains the event type and failed cause of the failed Monitoring Configuration in the EE subscription + description: > + Contains the event type and failed cause of the failed Monitoring Configuration + in the EE subscription type: object required: - eventType @@ -326,7 +344,9 @@ components: $ref: '#/components/schemas/FailedCause' MonitoringConfiguration: - description: Contains data for each Monitoring Configuration (such as event type, etc.) and the configuration data needed depending on each event type + description: > + Contains data for each Monitoring Configuration (such as event type, etc.) and + the configuration data needed depending on each event type type: object required: - eventType @@ -365,7 +385,8 @@ components: $ref: '#/components/schemas/Report' ReportingOptions: - description: Contains the different reporting options associated to a given subscription created in HSS + description: > + Contains the different reporting options associated to a given subscription created in HSS type: object properties: maxNumOfReports: @@ -391,7 +412,9 @@ components: $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/PdnConnectivityStatReport' ReachabilityForSmsReport: - description: Contains data for a Monitoring Event Report, specific to the 'Reachability For SMS' event type + description: > + Contains data for a Monitoring Event Report, specific to the 'Reachability For SMS' + event type type: object required: - reachabilitySmsStatus @@ -402,7 +425,9 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' ReachabilityForDataReport: - description: Contains data for a Monitoring Event Report, specific to the 'Reachability For Data' event type + description: > + Contains data for a Monitoring Event Report, specific to the 'Reachability For Data' + event type type: object required: - reachabilityDataStatus @@ -413,14 +438,18 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' LossConnectivityConfiguration: - description: Contains data needed for a Monitoring Configuration, specific to the 'Loss of Connectivity' event type + description: > + Contains data needed for a Monitoring Configuration, specific to the 'Loss of Connectivity' + event type type: object properties: maxDetectionTime: $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' LocationReportingConfiguration: - description: Contains data needed for a Monitoring Configuration, specific to the 'Location Reporting' event type + description: > + Contains data needed for a Monitoring Configuration, specific to the 'Location Reporting' + event type type: object required: - currentLocation @@ -431,7 +460,9 @@ components: $ref: '#/components/schemas/LocationAccuracy' ReachabilityForDataConfiguration: - description: Contains data needed for a Monitoring Configuration, specific to the 'Reachability for Data' event type + description: > + Contains data needed for a Monitoring Configuration, specific to the 'Reachability for Data' + event type type: object anyOf: - required: [ maximumLatency ] @@ -447,12 +478,33 @@ components: minimum: 1 PduSessionStatusCfg: - description: Contains data needed for a Monitoring Configuration, specific to the 'PDN Connectivity Status' event type + description: > + Contains data needed for a Monitoring Configuration, specific to the 'PDN Connectivity + Status' event type type: object properties: apn: $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + EeSubscriptionErrorAddInfo: + description: Additional Information for EE Subscription Error. + type: object + properties: + failedMonitoringConfigs: + description: > + A map (list of key-value pairs where referenceId converted from integer to string serves + as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration + type: object + additionalProperties: + $ref: '#/components/schemas/FailedMonitoringConfiguration' + minProperties: 1 + + EeSubscriptionError: + description: EE Subscription Error. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/EeSubscriptionErrorAddInfo' + # SIMPLE TYPES: Imsi: @@ -497,7 +549,8 @@ components: - type: string FailedCause: - description: Indicates the Failed cause of the failed Monitoring Configuration in the EE subscription + description: > + Indicates the Failed cause of the failed Monitoring Configuration in the EE subscription anyOf: - type: string enum: diff --git a/TS29563_Nhss_SDM.yaml b/TS29563_Nhss_SDM.yaml index d66c20ff..149744a7 100644 --- a/TS29563_Nhss_SDM.yaml +++ b/TS29563_Nhss_SDM.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: '1.2.0-alpha.1' + version: '1.2.0-alpha.2' title: 'Nhss_SDM' description: | HSS Subscriber Data Management. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.0.0 + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' servers: @@ -100,7 +100,9 @@ paths: $ref: '#/components/schemas/SubscriptionData' headers: Location: - description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nhss-sdm//{ueId}/subscriptions/{subscriptionId}' + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nhss-sdm//{ueId}/subscriptions/{subscriptionId} required: true schema: type: string @@ -294,10 +296,12 @@ components: schemas: -# COMPLEX TYPES: +# STRUCTURED TYPES: UeContextInPgwData: - description: Contains data about APNs and PGW-C+SMF FQDNs used in interworking with UDM, and the PGW-C+SMF FQDN to be used for emergency session + description: > + Contains data about APNs and PGW-C+SMF FQDNs used in interworking with UDM, and the + PGW-C+SMF FQDN to be used for emergency session type: object properties: pgwInfo: @@ -315,7 +319,10 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' SubscriptionData: - description: Contains data about a subscription request, to be created by a consumer to an URI of the HSS_SDM API to be monitored; it also represents the response containing data about the created subscription + description: > + Contains data about a subscription request, to be created by a consumer to an URI of the + HSS_SDM API to be monitored; it also represents the response containing data about the + created subscription type: object required: - nfInstanceId @@ -340,7 +347,9 @@ components: $ref: '#/components/schemas/SubscriptionDataSets' SubscriptionDataSets: - description: Contains data to be reported as an immediate report in the response to a subscription creation request + description: > + Contains data to be reported as an immediate report in the response to a subscription + creation request type: object properties: ueContextInPgwData: diff --git a/TS29563_Nhss_UEAU.yaml b/TS29563_Nhss_UEAU.yaml index f87de601..891d3604 100644 --- a/TS29563_Nhss_UEAU.yaml +++ b/TS29563_Nhss_UEAU.yaml @@ -1,14 +1,14 @@ openapi: 3.0.0 info: - version: '1.2.0-alpha.1' + version: '1.2.0-alpha.2' title: 'NhssUEAU' description: | HSS UE Authentication Service. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.0.0 + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' servers: @@ -88,10 +88,12 @@ components: schemas: -# COMPLEX TYPES: +# STRUCTURED TYPES: AvGenerationRequest: - description: It represents the request body in the Authentication Vector (AV) request sent by UDM to HSS, containing the IMSI of the UE, authentication type, serving network, etc. + description: > + It represents the request body in the Authentication Vector (AV) request sent by UDM to HSS, + containing the IMSI of the UE, authentication type, serving network, etc. type: object required: - imsi @@ -109,7 +111,9 @@ components: $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ResynchronizationInfo' AvGenerationResponse: - description: It represents the response body in the AV response sent by HSS to UDM, containing the 5G-AKA or EAP-AKA-prime authentication vector + description: > + It represents the response body in the AV response sent by HSS to UDM, containing the 5G-AKA + or EAP-AKA-prime authentication vector type: object oneOf: - required: diff --git a/TS29563_Nhss_UECM.yaml b/TS29563_Nhss_UECM.yaml index 993f2477..3de9f4a9 100644 --- a/TS29563_Nhss_UECM.yaml +++ b/TS29563_Nhss_UECM.yaml @@ -1,15 +1,15 @@ openapi: 3.0.0 info: - version: '1.2.0-alpha.1' + version: '1.2.0-alpha.2' title: 'Nhss_UECM' description: | HSS UE Context Management. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.0.0 + description: 3GPP TS 29.563 HSS Services for Interworking With UDM, version 18.4.0 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.563/' servers: @@ -181,10 +181,12 @@ components: schemas: -# COMPLEX TYPES: +# STRUCTURED TYPES: DeregistrationRequest: - description: It represents the request body of the deregistration request sent by UDM to HSS and contains the IMSI of the UE, the deregistration reason, etc. + description: > + It represents the request body of the deregistration request sent by UDM to HSS and contains + the IMSI of the UE, the deregistration reason, etc. type: object required: - imsi diff --git a/TS29564_Nupf_EventExposure.yaml b/TS29564_Nupf_EventExposure.yaml index 96f3254c..82a68d4d 100644 --- a/TS29564_Nupf_EventExposure.yaml +++ b/TS29564_Nupf_EventExposure.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: 'UPF Event Exposure Service' - version: 1.1.0-alpha.3 + version: 1.1.0-alpha.4 description: | UPF Event Exposure Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.564 V18.2.0; 5G System; User Plane Function Services; Stage 3. + description: 3GPP TS 29.564 V18.3.0; 5G System; User Plane Function Services; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.564/ servers: @@ -269,6 +269,8 @@ components: minItems: 1 correlationId: type: string + achievedSampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' NotificationItem: description: represents a report on one subscribed event @@ -372,6 +374,14 @@ components: 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 @@ -441,7 +451,7 @@ components: type: object properties: reportingUrgency: - type: boolean + $ref: '#/components/schemas/ReportingUrgency' reportingTimeInfo: $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' required: @@ -471,24 +481,18 @@ components: type: boolean enum: - true - dlMinThroughput: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - dlMaxThroughput: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' dlAveThroughput: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - ulMinThroughput: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' - ulMaxThroughput: - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' ulAveThroughput: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' dlCongestion: type: string ulCongestion: type: string -# Editor's note: whether and how to report the minimum, maximum and average DL and/or UL throughput -# over the measurement period is FFS. + defaultQosFlowInd: + type: boolean + default: false + # Editor's note: the encoding of the dlCongestion and ulCongestion IEs is FFS TscManagementInfo: @@ -654,5 +658,14 @@ components: - TLS_SCN - type: string + ReportingUrgency: + description: Reporting Urgency + anyOf: + - type: string + enum: + - DELAY_TOLERANT + - NON_DELAY_TOLERANT + - type: string + # SIMPLE TYPES diff --git a/TS29564_Nupf_GetPrivateUEIPaddr.yaml b/TS29564_Nupf_GetPrivateUEIPaddr.yaml index 426b281a..0c53892b 100644 --- a/TS29564_Nupf_GetPrivateUEIPaddr.yaml +++ b/TS29564_Nupf_GetPrivateUEIPaddr.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.0.0-alpha.2' + version: '1.0.0-alpha.3' title: 'UPF GET Private UE IP address Service' description: | Nupf_GetPrivateUEIPaddr Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.564 V18.1.0; 5G System; 5G System; User Plane Function Services; Stage 3 + description: 3GPP TS 29.564 V18.3.0; 5G System; 5G System; User Plane Function Services; Stage 3 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.564/' servers: @@ -146,5 +146,9 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' snssai: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + hplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' supi: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' diff --git a/TS29565_Ntsctsf_ASTI.yaml b/TS29565_Ntsctsf_ASTI.yaml index 69a627e6..ca4f55af 100644 --- a/TS29565_Ntsctsf_ASTI.yaml +++ b/TS29565_Ntsctsf_ASTI.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: Ntsctsf_ASTI Service API - version: 1.1.0-alpha.2 + version: 1.1.0-alpha.3 description: | TSCTSF Access Stratum time distribution configuration Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.565 V18.1.0; 5G System; Time Sensitive Communication and + 3GPP TS 29.565 V18.4.0; 5G System; Time Sensitive Communication and Time Synchronization Function Services; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/' @@ -335,6 +335,10 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' tempValidity: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + clkQltDetLvl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityDetailLevel' + clkQltAcptCri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' StatusRequestData: description: > @@ -402,13 +406,53 @@ components: properties: astiNotifId: type: string - stateOfAstiConfigs: + stateConfigs: type: array items: - type: string + $ref: '#/components/schemas/AstiConfigStateNotification' minItems: 1 description: > It is FFS the parameters of the AstiConfigEventNotification data type. required: - astiNotifId - - stateOfAstiConfigs + - stateConfigs + + AstiConfigStateNotification: + description: > + Contains the report of a change in the 5G Access Stratum Time Distribution + parameters applied to a UE. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + event: + $ref: '#/components/schemas/AstiEvent' + required: + - event + oneOf: + - required: [supi] + - required: [gpsi] +# +# ENUMERATIONS DATA TYPES +# + AstiEvent: + anyOf: + - type: string + enum: + - ASTI_ENABLED + - ASTI_DISABLED + - CLOCK_QUAL_ACCEPTABLE + - CLOCK_QUAL_NON_ACCEPTABLE + - 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 an ASTI event to notify to the AF/NEF. + Possible values are: + - ASTI_ENABLED: Access stratum time distribution via Uu reference point is activated. + - ASTI_DISABLED: Access stratum time distribution via Uu reference point is deactivated. + - CLOCK_QUAL_ACCEPTABLE: The UE meets the clock quality acceptance criteria. + - CLOCK_QUAL_NON_ACCEPTABLE: The UE does not meet the clock quality acceptance criteria. diff --git a/TS29565_Ntsctsf_TimeSynchronization.yaml b/TS29565_Ntsctsf_TimeSynchronization.yaml index 4f629ac6..c7730b06 100644 --- a/TS29565_Ntsctsf_TimeSynchronization.yaml +++ b/TS29565_Ntsctsf_TimeSynchronization.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: Ntsctsf_TimeSynchronization Service API - version: 1.1.0-alpha.4 + version: 1.1.0-alpha.5 description: | TSCTSF Time Synchronization Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.565 V18.3.0; 5G System; Time Sensitive Communication and Time Synchronization Function + 3GPP TS 29.565 V18.4.0; 5G System; Time Sensitive Communication and Time Synchronization Function Services; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/' servers: @@ -697,29 +697,28 @@ components: - stateOfConfig StateOfConfiguration: - description: Contains the state of the time synchronization configuration. + description: > + Contains the state of the time synchronization configuration and the clock quality + acceptance criteria result. type: object properties: stateNwtt: type: boolean description: > - When the PTP port state is Leader, Follower or Passive, it is included and set to true - to indicate the state of configuration for NW-TT port is active; when PTP port state is - in any other case, it is included and set to false to indicate the state of - configuration for NW-TT port is inactive. Default value is false. + When any of the PTP port state(s)in NW-TT is Leader, Follower or Passive, it is + included and set to trueto indicate the current state of the time synchronization + configuration for the NW-TT port(s) of the PTP instance is active; when + PTP port state isin any other case, it is included and set to false to indicate + the state ofconfiguration for the NW-TT port(s) of the PTP instance + is inactive. Default value is false. stateOfDstts: - description: Contains the PTP port states of the DS-TT(s). + description: > + Contains the PTP port states and the clock quality acceptance criteria result of the + DS-TT(s). type: array items: $ref: '#/components/schemas/StateOfDstt' minItems: 1 - clkQltAcptCriReports: - type: array - items: - $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/ClockQualityAcceptanceCriteriaResult' - minItems: 1 - description: > - Indicates if the clock quality acceptance criteria is met or not for the indicated UE(s). StateOfDstt: description: Contains the PTP port state of a DS-TT. @@ -736,6 +735,8 @@ components: to indicate the state of configuration for DS-TT port is active; when PTP port state is in any other case, it is included and set to false to indicate the state of configuration for DS-TT port is inactive. Default value is false. + clkQltIndOfDstts: + $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/AcceptanceCriteriaResultIndication' required: - state oneOf: @@ -770,12 +771,16 @@ components: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' covReq: type: array - description: Identifies a list of Tracking Areas per serving network where time synchronization service configuration is allowed. + description: > + Identifies a list of Tracking Areas per serving network where time + synchronization service configuration is allowed. items: $ref: 'TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo' minItems: 1 - timeSyncStatusParam: - $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/TimeSyncStatusParam' + clkQltDetLvl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityDetailLevel' + clkQltAcptCri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' required: - upNodeId - reqPtpIns diff --git a/TS29571_CommonData.yaml b/TS29571_CommonData.yaml index a8cc39ba..e6e56d8a 100644 --- a/TS29571_CommonData.yaml +++ b/TS29571_CommonData.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.5.0-alpha.4' + version: '1.5.0-alpha.5' title: 'Common Data Types' @@ -11,7 +11,7 @@ info: All rights reserved.   externalDocs: - description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 18.3.0 + description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 18.4.0 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.571/' paths: {} @@ -262,7 +262,9 @@ components: type: integer minimum: 0 maximum: 65535 - description: Integer where the allowed values correspond to the value range of an unsigned 16-bit integer. + description: > + Integer where the allowed values correspond to the value range of an + unsigned 16-bit integer. Uint16Rm: type: integer @@ -1124,6 +1126,11 @@ components: 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 @@ -1486,13 +1493,14 @@ components: minimum: 0 maximum: 16777215 description: > - Relay Service Code to identify a connectivity service provided by the UE-to-Network relay. + 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 remote UE. The CP-PRUK ID is a string in NAI - format as specified in clause 28.7.11 of 3GPP TS 23.003. + 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: @@ -1512,6 +1520,12 @@ components: 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 # @@ -1555,6 +1569,18 @@ components: - 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 - type: string description: Indicates the radio access used. @@ -2281,6 +2307,8 @@ components: to be used. globalGnbId: $ref: '#/components/schemas/GlobalRanNodeId' + ntnTaiInfo: + $ref: '#/components/schemas/NtnTaiInfo' required: - tai - ncgi @@ -2833,9 +2861,14 @@ components: $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" and "areaCodeC" attributes - shall be included in a WirelineArea data structure + 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 @@ -3595,13 +3628,26 @@ components: 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 properties: + offloadIdentifier: + $ref: '#/components/schemas/OffloadIdentifier' vplmnId: $ref: '#/components/schemas/PlmnId' + allowedTraffic: + type: boolean + default: true ipv4AddressRanges: type: array items: @@ -3612,7 +3658,7 @@ components: items: $ref: '#/components/schemas/Ipv4AddrMask' minItems: 1 - Ipv6AddressRanges: + ipv6AddressRanges: type: array items: $ref: '#/components/schemas/Ipv6AddressRange' @@ -3699,6 +3745,7 @@ components: $ref: '#/components/schemas/UeAuth' SliceUsageControlInfo: + description: The network slice usage control related information type: object required: - sNssai @@ -3713,6 +3760,41 @@ components: - 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' + # # Data types describing alternative data types or combinations of data types @@ -4210,6 +4292,37 @@ components: 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. + + RtpHeaderExtType: + anyOf: + - type: string + enum: + - PDU_SET_MARKING + - type: string + description: > + The enumeration indicates the type of Rtp Header Extension type + + + RtpPayloadFormat: + anyOf: + - type: string + enum: + - H264 + - H265 + - type: string + description: > + The enumeration RtpPayloadFormat indicates the RTP Payload format + # # # STRUCTURED DATA TYPES @@ -4347,6 +4460,46 @@ components: - $ref: '#/components/schemas/PduSetQosPara' - $ref: '#/components/schemas/NullValue' + + 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 + + RtpHeaderExtInfo: + description: RTP Header Extension information + type: object + properties: + rtpHeaderExtType: + $ref: '#/components/schemas/RtpHeaderExtType' + rtpHeaderExtId: + type: integer + minimum: 1 + maximum: 255 + + 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' + # # Data Types related to 5G Trace as defined in clause 5.6 # @@ -5055,6 +5208,8 @@ components: minItems: 1 containerForAppLayerMeasConfig: $ref: '#/components/schemas/Bytes' + mbsCommunicationServiceType: + $ref: '#/components/schemas/MbsServiceType' QmcAreaScope: description: > @@ -5159,10 +5314,15 @@ components: 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. + description: > + Application provided charging identifier allowing correlation of charging information. RatingGroup: $ref: '#/components/schemas/Uint32' @@ -5265,6 +5425,9 @@ components: AreaSessionId: $ref: '#/components/schemas/Uint16' + AreaSessionPolicyId: + $ref: '#/components/schemas/Uint16' + MbsFsaId: description: MBS Frequency Selection Area Identifier type: string @@ -5443,6 +5606,12 @@ components: allOf: - $ref: '#/components/schemas/ExternalMbsServiceArea' writeOnly: true + redMbsServArea: + $ref: '#/components/schemas/MbsServiceArea' + readOnly: true + extRedMbsServArea: + $ref: '#/components/schemas/ExternalMbsServiceArea' + readOnly: true dnn: allOf: - $ref: '#/components/schemas/Dnn' @@ -5481,6 +5650,8 @@ components: anyOf: - required: [ mbsSessionId ] - required: [ tmgiAllocReq ] + not: + required: [redMbsServArea, extRedMbsServArea] MbsSessionSubscription: @@ -5570,10 +5741,13 @@ components: 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 + 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' @@ -5749,6 +5923,7 @@ components: anyOf: - type: string enum: + - SYNC_E - PTP - GNSS - ATOMIC_CLOCK @@ -5911,6 +6086,9 @@ components: type: integer default: 256 description: priority of data channel relative to other data channels + appBindingInfo: + type: string + description: application binding information of the Data Channel. ReplaceHttpUrl: @@ -5925,6 +6103,23 @@ components: 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' + + + # # HTTP responses # @@ -6022,7 +6217,7 @@ components: schema: $ref: '#/components/schemas/ProblemDetails' '413': - description: Payload Too Large + description: Content Too Large content: application/problem+json: schema: diff --git a/TS29572_Nlmf_Location.yaml b/TS29572_Nlmf_Location.yaml index 4884bd9d..091e2b9c 100644 --- a/TS29572_Nlmf_Location.yaml +++ b/TS29572_Nlmf_Location.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.3.0-alpha.4' + version: '1.3.0-alpha.5' title: 'LMF Location' description: | LMF Location Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.572 V18.3.0; 5G System; Location Management Services; Stage 3 + description: 3GPP TS 29.572 V18.4.0; 5G System; Location Management Services; Stage 3 url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/' servers: @@ -34,10 +34,10 @@ paths: security: - {} - oAuth2ClientCredentials: - - nlmf_loc + - nlmf-loc - oAuth2ClientCredentials: - - nlmf_loc - - nlmf_loc:determine-location:invoke + - nlmf-loc + - nlmf-loc:determine-location:invoke requestBody: content: application/json: @@ -80,7 +80,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LocationData' + $ref: '#/components/schemas/LocationDataExt' '204': description: Expected response for MO-LR requesting location assistance data. '307': @@ -122,7 +122,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EventNotifyData' + $ref: '#/components/schemas/EventNotifyDataExt' responses: '204': description: Expected response to a valid notification @@ -165,10 +165,10 @@ paths: security: - {} - oAuth2ClientCredentials: - - nlmf_loc + - nlmf-loc - oAuth2ClientCredentials: - - nlmf_loc - - nlmf_loc:up-subscription:invoke + - nlmf-loc + - nlmf-loc:up-subscription:invoke requestBody: content: application/json: @@ -261,10 +261,10 @@ paths: security: - {} - oAuth2ClientCredentials: - - nlmf_loc + - nlmf-loc - oAuth2ClientCredentials: - - nlmf_loc - - nlmf_loc:cancel-location:invoke + - nlmf-loc + - nlmf-loc:cancel-location:invoke requestBody: content: application/json: @@ -313,10 +313,10 @@ paths: security: - {} - oAuth2ClientCredentials: - - nlmf_loc + - nlmf-loc - oAuth2ClientCredentials: - - nlmf_loc - - nlmf_loc:location-context-transfer:invoke + - nlmf-loc + - nlmf-loc:location-context-transfer:invoke requestBody: content: application/json: @@ -365,10 +365,10 @@ paths: security: - {} - oAuth2ClientCredentials: - - nlmf_loc + - nlmf-loc - oAuth2ClientCredentials: - - nlmf_loc - - nlmf_loc:location-measure:invoke + - nlmf-loc + - nlmf-loc:location-measure:invoke requestBody: content: application/json: @@ -413,6 +413,59 @@ paths: default: $ref: 'TS29571_CommonData.yaml#/components/responses/default' + /up-configure: + 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:up-configure: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: @@ -422,11 +475,12 @@ components: 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: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:location-measure:invoke: Access to invoke Location Measurement + nlmf-loc:location-measure:invoke: Access to invoke Location Measurement nlmf-loc:up-subscription:invoke: Access to invoke UP Subscription + nlmf-loc:up-configure:invoke: Access to invoke UP Config schemas: # @@ -552,16 +606,33 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' lpHapType: $ref: 'TS29518_Namf_Location.yaml#/components/schemas/LpHapType' - userPlanePositioningCapability: - $ref: '#/components/schemas/UeUpPositioningCapabilities' + ueUpPosCaps: + type: array + items: + $ref: '#/components/schemas/UeUpPositioningCapabilities' + minItems: 1 reportingInd: allOf: - $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/ReportingInd' - default: POSITIVE_SENSE + 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' + + LocationDataExt: + description: Extended Location Data for UEs + allOf: + - $ref: '#/components/schemas/LocationData' + - $ref: '#/components/schemas/AddLocationDatas' LocationData: description: Information within Determine Location Response. @@ -622,6 +693,17 @@ components: $ref: '#/components/schemas/HighAccuracyGnssMetrics' losNlosMeasureInd: $ref: '#/components/schemas/LosNlosMeasureInd' + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: '#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: '#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: '#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: '#/components/schemas/VelocityEstimate' + GeographicArea: description: Geographic area specified by different shape. @@ -1288,6 +1370,8 @@ components: $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. @@ -1327,6 +1411,12 @@ components: 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 @@ -1384,6 +1474,19 @@ components: $ref: '#/components/schemas/HighAccuracyGnssMetrics' losNlosMeasureInd: $ref: '#/components/schemas/LosNlosMeasureInd' + upLocRepStatAf: + type: integer + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: '#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: '#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: '#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: '#/components/schemas/VelocityEstimate' + UeConnectivityState: description: Indicates the connectivity state of a UE. @@ -1449,10 +1552,10 @@ components: $ref: '#/components/schemas/LocalArea' LocMeasurements: - description: Location Measurements. + description: PRU Location Measurements. type: object properties: - rtsd: + rstd: type: integer HighAccuracyGnssMetrics: @@ -1518,6 +1621,100 @@ components: relatedUEType: $ref: '#/components/schemas/RelatedUEType' + UpConfig: + description: UP Config + type: object + required: + - upNotifyCallBackURI + properties: + upNotifyCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + 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' + targetLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' + + RangeDirection: + description: Represents a range and direction from a point A to a point B. + type: object + properties: + range: + 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: + type: object + properties: + addLocationDatas: + type: array + items: + $ref: '#/components/schemas/LocationData' + minItems: 1 + + AddEventNotifyDatas: + 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 @@ -1692,11 +1889,6 @@ components: type: string format: byte - UeUpPositioningCapabilities: - description: User plane positioning capabilities supported by the UE. - type: string - format: byte - # # ENUMS # @@ -1882,6 +2074,7 @@ components: - NR_MEO - NR_GEO - NR_OTHER_SAT + - EUTRA_CONNECTED_TO_EPC - type: string EventClass: @@ -1906,6 +2099,7 @@ components: - LOCATION_CANCELLATION_EVENT - INTERMEDIATE_EVENT - DIRECT_REPORT_EVENT + - CUMULATIVE_EVENT_REPORT - type: string TerminationCause: @@ -1971,7 +2165,7 @@ components: enum: - ESTABLISHED - RELEASED - - MODIFICATION + - MOVE - type: string RangingSlResult: @@ -1996,3 +2190,21 @@ components: - 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 diff --git a/TS29573_JOSEProtectedMessageForwarding.yaml b/TS29573_JOSEProtectedMessageForwarding.yaml index 3dc57260..0eb42c73 100644 --- a/TS29573_JOSEProtectedMessageForwarding.yaml +++ b/TS29573_JOSEProtectedMessageForwarding.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.3.0-alpha.1' + version: '1.3.0-alpha.2' title: 'JOSE Protected Message Forwarding API' description: | N32-f Message Forwarding Service. @@ -14,7 +14,7 @@ servers: default: https://example.com description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. externalDocs: - description: 3GPP TS 29.573 V18.1.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3 + description: 3GPP TS 29.573 V18.5.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.573/ paths: @@ -27,12 +27,12 @@ paths: parameters: - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string - name: Accept-Encoding in: header - description: Accept-Encoding, described in IETF RFC 7231 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string - name: 3gpp-Sbi-Message-Priority @@ -56,11 +56,11 @@ paths: $ref: '#/components/schemas/N32fReformattedRspMsg' headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string Content-Encoding: - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string 3gpp-Sbi-Message-Priority: @@ -72,7 +72,11 @@ paths: '401': $ref: 'TS29571_CommonData.yaml#/components/responses/401' '403': - $ref: 'TS29571_CommonData.yaml#/components/responses/403' + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsMsgForwarding' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '411': @@ -102,7 +106,7 @@ paths: description: No Content headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string '400': @@ -262,7 +266,7 @@ components: value: $ref: '#/components/schemas/EncodedHttpHeaderValue' HttpPayload: - description: Contains the encoding of JSON payload in the API request / response + description: Contains the encoding of JSON content in the API request / response type: object required: - iePath @@ -318,3 +322,16 @@ components: oneOf: - type: string - $ref: '#/components/schemas/IndexToEncryptedValue' + + ProblemDetailsMsgForwarding: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfoMsgForwarding' + + AdditionInfoMsgForwarding: + description: Problem Details extensions for N32-f message forwarding + properties: + suggestedStatusCode: + type: integer + suggestedProblemDetails: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' diff --git a/TS29573_N32_Handshake.yaml b/TS29573_N32_Handshake.yaml index 9b1898cf..396f232a 100644 --- a/TS29573_N32_Handshake.yaml +++ b/TS29573_N32_Handshake.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: '1.3.0-alpha.4' + version: '1.3.0-alpha.5' title: 'N32 Handshake API' description: | N32-c Handshake Service. @@ -14,7 +14,7 @@ servers: default: https://example.com description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. externalDocs: - description: 3GPP TS 29.573 V18.3.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3 + description: 3GPP TS 29.573 V18.5.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3 url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.573/ paths: @@ -48,6 +48,8 @@ paths: $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' '413': @@ -492,6 +494,11 @@ components: items: $ref: '#/components/schemas/N32fErrorDetail' minItems: 1 + policyMismatchList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/InvalidParam' + minItems: 1 FailedModificationInfo: description: Information on N32-f modifications block that failed to process type: object diff --git a/TS29574_Ndccf_DataManagement.yaml b/TS29574_Ndccf_DataManagement.yaml index f38813da..409174f8 100644 --- a/TS29574_Ndccf_DataManagement.yaml +++ b/TS29574_Ndccf_DataManagement.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: - version: 1.1.0-alpha.4 + version: 1.1.0-alpha.5 title: Ndccf_DataManagement description: | DCCF Data Management Service. @@ -9,7 +9,7 @@ info: All rights reserved. externalDocs: - description: 3GPP TS 29.574 V18.3.0; 5G System; Data Collection Coordination Services; Stage 3. + description: 3GPP TS 29.574 V18.4.0; 5G System; Data Collection Coordination Services; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.574/' # servers: @@ -440,6 +440,14 @@ paths: description: > No Content. The Individual DCCF Data Subscription resource matching the subscriptionId was deleted. + '200': + description: > + The Individual DCCF Data Subscription resource matching the subscriptionId was deleted + and including the stored unsent data events in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/NdccfDataSubscriptionNotification' '307': $ref: 'TS29571_CommonData.yaml#/components/responses/307' '308': @@ -705,6 +713,8 @@ components: $ref: '#/components/schemas/DeletionAlert' termCause: $ref: '#/components/schemas/TermCause' + pendDataNotifCause: + $ref: 'TS29520_Nnwdaf_DataManagement.yaml#/components/schemas/PendingNotificationCause' reUserConsentPurs: type: array items: diff --git a/TS29575_Nadrf_DataManagement.yaml b/TS29575_Nadrf_DataManagement.yaml index 86b20301..c0109014 100644 --- a/TS29575_Nadrf_DataManagement.yaml +++ b/TS29575_Nadrf_DataManagement.yaml @@ -1,13 +1,13 @@ openapi: 3.0.0 info: - version: 1.1.0-alpha.4 + version: 1.1.0-alpha.5 title: Nadrf_DataManagement description: | ADRF Data Management Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.575 V18.3.0; 5G System; Analytics Data Repository Services; Stage 3. + description: 3GPP TS 29.575 V18.4.0; 5G System; Analytics Data Repository Services; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.575/' # servers: diff --git a/TS29575_Nadrf_MLModelManagement.yaml b/TS29575_Nadrf_MLModelManagement.yaml index e55e1170..eb594d70 100644 --- a/TS29575_Nadrf_MLModelManagement.yaml +++ b/TS29575_Nadrf_MLModelManagement.yaml @@ -1,13 +1,13 @@ openapi: 3.0.0 info: - version: 1.0.0-alpha.1 + version: 1.0.0-alpha.2 title: Nadrf_MLModelManagement description: | ADRF ML Model Management Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.575 V18.3.0; 5G System; Analytics Data Repository Services; Stage 3. + description: 3GPP TS 29.575 V18.4.0; 5G System; Analytics Data Repository Services; Stage 3. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.575/' # servers: @@ -139,6 +139,17 @@ paths: schema: type: string responses: + '200': + description: > + Attempted to remove ML model(s) in the Individual ADRF ML Model Store Record resource. + The result is returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MLModelDelResult' + minItems: 1 '204': description: > No Content. The Individual ADRF ML Model Store Record resource matching the @@ -181,8 +192,14 @@ paths: minItems: 1 required: true responses: - '204': - description: No Content. The ADRF ML model matching the provided unique ML model identifier is deleted. + '200': + description: > + The ADRF ML model matching the provided unique ML model identifier + was attempted to be deleted. The result is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelDelResult' '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '401': @@ -227,7 +244,9 @@ components: - oneOf: - required: [nfInstanceId] - required: [nfSetId] - - required: [mlModelIdnfo] + - anyOf: + - required: [mlModelIdnfo] + - required: [mlModels] properties: nfInstanceId: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' @@ -239,6 +258,14 @@ components: $ref: '#/components/schemas/MLModelInfo' minItems: 1 description: List of ML Model Information. + mlModels: + type: array + items: + $ref: '#/components/schemas/MLModel' + minItems: 1 + description: Represents ML Model(s). + modelStoreResult: + $ref: '#/components/schemas/ModelStoreResult' suppFeat: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' # @@ -248,12 +275,106 @@ components: allOf: - required: [modelUniqueId] - required: [mlFileAddr] - - required: [mlStrorageSize] + - required: [mlStorageSize] properties: modelUniqueId: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' - mlModelAddr: + mlFileAddr: $ref: 'TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLModelAddr' - mlStrorageSize: + mlStorageSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + allowConsumerList: + type: array + items: + $ref: '#/components/schemas/AllowedConsumer' + minItems: 1 + description: The allowed consumer list of the ML Model. +# + AllowedConsumer: + description: Represents informatiom of the allowed consumer list of the ML Model. + type: object + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + oneOf: + - required: [nfInstanceId] + - required: [nfSetId] +# + MLModelDelResult: + description: Represents informatiom of the ML Model. + type: object + allOf: + - required: [modelUniqueId] + - required: [DeleteResult] + properties: + modelUniqueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + deleteResult: + $ref: '#/components/schemas/DeleteResult' +# + MLModel: + description: Represents an ML Model. + type: object + allOf: + - required: [modelUniqueId] + - required: [mlModel] + properties: + modelUniqueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + mlModel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Binary' +# + ModelStoreResult: + description: Contains information about ML Model storage result. + type: object + allOf: + - required: [modelUniqueId] + - required: [storeResult] + properties: + modelUniqueId: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + storeResult: + $ref: '#/components/schemas/StoreResult' +# +# ENUMERATIONS DATA TYPES +# + DeleteResult: + anyOf: + - type: string + enum: + - ML_MODEL_DELETED + - ML_MODEL_NOT_FOUND + - ML_MODEL_FOUND_BUT_NOT_DELETED + - 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 store result type. + Possible values are: + - ML_MODEL_DELETED: Indicates that the ML model was deleted in ADRF. + - ML_MODEL_FILE_ADDRESS_NOT_FOUND: Indicates that the ML model was not found in ADRF. + - ML_MODEL_FOUND_BUT_NOT_DELETED: Indicates that the ML model was found in ADRF but not deleted. + # + StoreResult: + anyOf: + - type: string + enum: + - ML_MODEL_FILE_STORED_IN_ADRF + - ML_MODEL_FILE_ADDRESS_NOT_FOUND + - ML_MODEL_FILE_DOWNLOAD_FAILED + - 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 store result type. + Possible values are: + - ML_MODEL_FILE_STORED_IN_ADRF: Indicates that the ML model was successfully stored in ADRF. + - ML_MODEL_FILE_ADDRESS_NOT_FOUND: Indicates that the ML model file address was not found. + - ML_MODEL_FILE_DOWNLOAD_FAILED: Indicates that the download of the ML model file failed. diff --git a/TS29580_Nmbsf_MBSUserDataIngestSession.yaml b/TS29580_Nmbsf_MBSUserDataIngestSession.yaml index 1c060e1a..4e348f11 100644 --- a/TS29580_Nmbsf_MBSUserDataIngestSession.yaml +++ b/TS29580_Nmbsf_MBSUserDataIngestSession.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: nmbsf-mbs-ud-ingest - version: 1.1.0-alpha.4 + version: 1.1.0-alpha.5 description: | API for MBS User Data Ingest Session Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.580 V18.3.0; 5G System; Multicast/Broadcast Service Function Services. + 3GPP TS 29.580 V18.4.0; 5G System; Multicast/Broadcast Service Function Services. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.580/' servers: @@ -1056,10 +1056,10 @@ components: - DATA_INGEST_FAILURE - DELIVERY_STARTED - SESSION_TERMINATED + - SESSION_STARTED + - SESSION_RELEASED - DIST_SESS_ACTIVATED - - DIST_SESS_DEACTIVATED - DIST_SESS_EST_FAILURE - - DIST_SESS_ESTABLISHED - USER_SER_AD - type: string description: > @@ -1072,7 +1072,7 @@ components: Indicates that the MBS User Data Ingest Session is starting. This is an "MBS User Data Ingest Session" level event. - USER_DATA_ING_SESS_STARTED: > - Indicates that the MBS User Data Ingest Session started. This is an "MBS User Data + Indicates that the MBS User Data Ingest Session established. This is an "MBS User Data Ingest Session" level event. - USER_DATA_ING_SESS_TERMINATED: > Indicates that the MBS User Data Ingest Session is terminated. This is an "MBS User Data @@ -1101,16 +1101,15 @@ components: The MBS User Data delivery is started. - SESSION_TERMINATED: > The MBS User Data Ingest Session is terminated. + - SESSION_STARTED: > + The MBS Session is started. + - SESSION_RELEASED: > + The MBS Session is released. - DIST_SESS_ACTIVATED: Indicates that the MBS Distribution Session is activated successfully. - - DIST_SESS_DEACTIVATED: - Indicates that the MBS Distribution Session is deactivated. - DIST_SESS_EST_FAILURE: Indicates that the MBSF failed to successfully establish the MBS Distribution Session at the MBSTF. This is an "MBS Distribution Session" level event. - - DIST_SESS_ESTABLISHED: - Indicates that the MBS Distribution Session established. - This is an "MBS Distribution Session" level event. - USER_SER_AD: Indicates that the MBSF advertises the User Service Announcement information to the MBS Application Provider. diff --git a/TS29581_Nmbstf_DistSession.yaml b/TS29581_Nmbstf_DistSession.yaml index 2b3c5545..89577cff 100644 --- a/TS29581_Nmbstf_DistSession.yaml +++ b/TS29581_Nmbstf_DistSession.yaml @@ -2,14 +2,14 @@ openapi: 3.0.0 info: title: Nmbstf-distsession - version: 1.0.4 + version: 1.1.0-alpha.1 description: | MBSTF Distribution Session Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.581 V17.4.0; 5G System; MBSDistribution Service. + description: 3GPP TS 29.581 V18.3.0; 5G System; MBSDistribution Service. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.581/ servers: @@ -292,7 +292,7 @@ paths: parameters: - name: Content-Encoding in: header - description: Content-Encoding, described in IETF RFC 7231 + description: Content-Encoding, described in IETF RFC 9110 schema: type: string requestBody: @@ -306,7 +306,7 @@ paths: description: Expected response to a successful callback processing headers: Accept-Encoding: - description: Accept-Encoding, described in IETF RFC 7694 + description: Accept-Encoding, described in IETF RFC 9110 schema: type: string '307': @@ -516,8 +516,6 @@ components: dscpMarking: type: string writeOnly: true - mbsSecurityContext: - $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSecurityContext' required: - distSessionId - distSessionState @@ -649,8 +647,6 @@ components: $ref: '#/components/schemas/DistSessionEventType' timeStamp: $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' - mbsSecurityContext: - $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSecurityContext' required: - eventType @@ -757,6 +753,8 @@ components: - SESSION_DEACTIVATED - SESSION_ACTIVATED - SERVICE_MANAGEMENT_FAILURE + - DATA_INGEST_SESSION_ESTABLISHED + - DATA_INGEST_SESSION_TERMINATED - type: string PktIngestMethod: diff --git a/TS29583_PIN_ASRegistration.yaml b/TS29583_PIN_ASRegistration.yaml new file mode 100644 index 00000000..618f8205 --- /dev/null +++ b/TS29583_PIN_ASRegistration.yaml @@ -0,0 +1,329 @@ +openapi: 3.0.0 + +info: + title: PINServer PAS Registration_API + version: 1.0.0-alpha.3 + description: | + API for PAS registration to PIN server. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.583; Application layer support for Personal IoT Network (PINAPP); + Personal IoT Network (PIN) Server Services; Stage 3. + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.583/' + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/pin-as-registration/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.3 of 3GPP TS 29.583. + +paths: + /registrations: + post: + summary: Create a new PAS Registration + operationId: CreatePASRegistration + tags: + - PAS Registrations (Collection) + description: Register a new PAS at the PIN Server. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PASRegistration' + responses: + '201': + description: PAS information is registered successfully at PIN server. + content: + application/json: + schema: + $ref: '#/components/schemas/PASRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /registrations/{registrationId}: + get: + summary: Get an Individual PAS Registration + operationId: GetIndPASReg + tags: + - Individual PAS Registration (Document) + description: Retrieve an Individual PAS registration resource. + parameters: + - name: registrationId + in: path + description: Registration Id. + required: true + schema: + type: string + responses: + '200': + description: OK (The PAS registration information at the PIN Server). + content: + application/json: + schema: + $ref: '#/components/schemas/PASRegistration' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Update an Individual PAS Registration + operationId: UpdateIndPASReg + tags: + - Individual PAS Registration (Document) + description: Fully replace an existing PAS Registration resource. + parameters: + - name: registrationId + in: path + description: PAS Registration Id. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PASRegistration' + responses: + '200': + description: OK (The PAS registration information is updated successfully). + content: + application/json: + schema: + $ref: '#/components/schemas/PASRegistration' + '204': + description: No Content. The PAS registration information is updated successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Modify an Individual PAS Registration + operationId: ModifyIndPASReg + tags: + - Individual PAS Registration (Document) + description: Partially update an existing PAS Registration resource. + parameters: + - name: registrationId + in: path + description: PAS registration Id. + required: true + schema: + type: string + requestBody: + description: Partial update an existing PAS registration resource. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PASRegistrationPatch' + responses: + '200': + description: > + The Individual PAS registration is successfully modified and + the updated registration information is returned in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/PASRegistration' + '204': + description: No Content. The Individual PAS registration is successfully modified. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Delete an Individual PAS Registration + operationId: DeleteIndPASReg + tags: + - Individual PAS Registration (Document) + description: Delete an existing PAS registration at PIN server. + parameters: + - name: registrationId + in: path + description: Registration Id. + required: true + schema: + type: string + responses: + '204': + description: The individual PAS registration is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + PASRegistration: + type: object + description: Represents an PAS registration information. + properties: + conInfo: + $ref: '#/components/schemas/ConnectivityInfo' + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + requestorId: + type: string + description: Indentifies a PAS + passId: + type: string + description: Indentifies a PIN service + required: + - requestorId + - conInfo + - passId + + ConnectivityInfo: + type: object + description: Represents a connection information of PAS. + properties: + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + ipv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + uri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + oneOf: + - required: [uri] + - required: [fqdn] + - required: [ipv4Addr] + - required: [ipv6Addr] + + PASRegistrationPatch: + type: object + description: Represents partial update request of individual PAS registration information. + properties: + conInfo: + $ref: '#/components/schemas/ConnectivityInfo' + expTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' + passId: + type: string + description: Identifies a PIN service provided by PAS. diff --git a/TS29583_PIN_ASServiceContinuity.yaml b/TS29583_PIN_ASServiceContinuity.yaml new file mode 100644 index 00000000..3f2bbf92 --- /dev/null +++ b/TS29583_PIN_ASServiceContinuity.yaml @@ -0,0 +1,400 @@ +openapi: 3.0.0 + +info: + title: PINServer Service Continuity Information_API + description: | + API for PINServer Service Continuity Information Reporting. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: 1.0.0-alpha.2 + +externalDocs: + description: > + 3GPP TS 29.583; Application layer support for Personal IoT Network (PINAPP); + Personal IoT Network (PIN) Server Services; Stage 3. + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.583/' + +security: + - {} + - oAuth2ClientCredentials: [] +servers: + - url: '{apiRoot}/pin-as-servicecontinuity/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.3.1 of 3GPP TS 29.583. + +paths: + /subscriptions: + post: + summary: Creates a new Individual Service Continuity Information Subscriptions resource + operationId: CreateServiceContinuityInfo + tags: + - Service Continuity Information Subscriptions (Collection) + description: Create a Subscription for reporting service continuity information to PAS. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceContinuityInfo' + responses: + '201': + description: > + Created (The individual Service Continuity information subscription resource is created successfully) + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceContinuityInfo' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + ServiceContinuityInfoNotification: + '{request.body#/notificationAddr}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceContinuityInfoNotification' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /subscriptions/{subscriptionId}: + get: + summary: Read an Individual Service Continuity Information Subscriptions resource + operationId: ReadIndServiceContinuityInfo + tags: + - Individual Service Continuity Information Subscription (Document) + description: Retrieve an Individual Service Continuity information subscription information. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + responses: + '200': + description: OK (Successfully get the Service Continuity information subscription). + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceContinuityInfo' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Update an Individual Service Continuity Information Subscriptions resource + operationId: UpdateIndServiceContinuityInfo + tags: + - Individual Service Continuity Information Subscription (Document) + description: Fully replace an existing Individual Service Continuity information Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceContinuityInfo' + responses: + '200': + description: OK (Successfully modified The individual Service Continuity information). + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceContinuityInfo' + '204': + description: No Content. + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Modify an Individual Service Continuity Information Subscriptions resource + operationId: ModifyIndServiceContinuityInfo + tags: + - Individual Service Continuity Information Subscription (Document) + description: Partially update an existing Individual ServiceContinuity information. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + requestBody: + description: Partial update an existing Individual ServiceContinuity information. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/ServiceContinuityInfoPatch' + responses: + '200': + description: > + OK (The Individual ServiceContinuity information Subscription is successfully modified + and the updated subscription information is returned in the response). + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceContinuityInfo' + '204': + description: > + No Content (The individual Service Continuity information subscription was modified + successfully). + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Delete an Individual Service Continuity Information Subscriptions resource + operationId: DeleteIndServiceContinuityInfo + tags: + - Individual Service Continuity Information Subscription (Document) + description: Delete an existing Individual Service Continuity information Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + responses: + '204': + description: The individual subscription is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +# Components + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + ServiceContinuityInfo: + type: object + description: Represents an Individual Service Continuity Information Subscription. + properties: + subsEvent: + $ref: '#/components/schemas/EventType' + notificationAddr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + requestorId: + type: string + description: Identifies a AF requestor. + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + required: + - subsEvent + - notificationAddr + - requestorId + + ServiceContinuityInfoPatch: + type: object + description: Represents the partial update of Individual Service Continuity Information. + properties: + subsEvent: + $ref: '#/components/schemas/EventType' + notificationAddr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + requestorId: + type: string + description: Identifies a AF requestor. + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + + ServiceContinuityInfoNotification: + type: object + description: Represent the service continuity information for notification. + properties: + subsId: + type: string + description: > + Identifies the individual service continuity information subscription for which + the service continuity information notification is delivered. + repInfo: + $ref: '#/components/schemas/ServiceContinuityReportInfo' + + ServiceContinuityReportInfo: + type: object + description: List of notifications that include the information of the service continuity. + properties: + acId: + type: string + description: Identifies an application client identifier. + pegcId: + type: string + description: Identifies a PEGC. + serviceId: + type: string + description: Identifies a PIN service. + sessionId: + type: string + description: Identifies an application session. + targetPineId: + type: string + description: Identifies the PINE. + sessionDes: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + + EventType: + anyOf: + - type: string + enum: + - SERVICE_CONTINUITY_INFO + - 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 service continuity happens in a PIN. + Possible values are: + - SERVICE_CONTINUITY_INFO: Indicates service continuity happens in a PIN. diff --git a/TS29583_PIN_ASServiceSwitch.yaml b/TS29583_PIN_ASServiceSwitch.yaml new file mode 100644 index 00000000..73d5daa1 --- /dev/null +++ b/TS29583_PIN_ASServiceSwitch.yaml @@ -0,0 +1,394 @@ +openapi: 3.0.0 + +info: + title: PINServer Service Switch Information_API + description: | + API for PINServer Service Switch Information Reporting. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: 1.0.0-alpha.2 + +externalDocs: + description: > + 3GPP TS 29.583; Application layer support for Personal IoT Network (PINAPP); + Personal IoT Network (PIN) Server Services; Stage 3. + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.583/' + +security: + - {} + - oAuth2ClientCredentials: [] +servers: + - url: '{apiRoot}/pin-as-serviceswitch/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.2.1 of 3GPP TS 29.583. + +paths: + /subscriptions: + post: + summary: Creates a new Individual Service Switch Information Subscriptions resource + operationId: CreateServiceSwitchInfo + tags: + - Service Switch Information Subscriptions (Collection) + description: Create a Subscription for reporting service switch information to PAS. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSwitchInfo' + responses: + '201': + description: > + Created (The individual Service Switch information subscription resource is created successfully) + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSwitchInfo' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + ServiceSwitchInfoNotification: + '{request.body#/notificationAddr}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSwitchInfoNotification' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /subscriptions/{subscriptionId}: + get: + summary: Read an Individual Service Switch Information Subscriptions resource + operationId: ReadIndServiceSwitchInfo + tags: + - Individual Service Switch Information Subscription (Document) + description: Retrieve an Individual Service Switch information subscription information. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + responses: + '200': + description: OK (Successfully get the Service Switch information subscription). + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSwitchInfo' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Update an Individual Service Switch Information Subscriptions resource + operationId: UpdateIndServiceSwitchInfo + tags: + - Individual Service Switch Information Subscription (Document) + description: Fully replace an existing Individual Service Switch information Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSwitchInfo' + responses: + '200': + description: OK (Successfully modified The individual Service Switch information). + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSwitchInfo' + '204': + description: No Content. + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + patch: + summary: Modify an Individual Service Switch Information Subscriptions resource + operationId: ModifyIndServiceSwitchInfo + tags: + - Individual Service Switch Information Subscription (Document) + description: Partially update an existing Individual ServiceSwitch information. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + requestBody: + description: Partial update an existing Individual ServiceSwitch information. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/ServiceSwitchInfoPatch' + responses: + '200': + description: > + OK (The Individual ServiceSwitch information Subscription is successfully modified + and the updated subscription information is returned in the response). + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSwitchInfo' + '204': + description: > + No Content (The individual Service Switch information subscription was modified + successfully). + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + delete: + summary: Delete an Individual Service Switch Information Subscriptions resource + operationId: DeleteIndServiceSwitchInfo + tags: + - Individual Service Switch Information Subscription (Document) + description: Delete an existing Individual ServiceSwitchinformation Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + responses: + '204': + description: The individual subscription is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +# Components + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + ServiceSwitchInfo: + type: object + description: Represents an Individual Service Switch Information Subscription. + properties: + subsEvent: + $ref: '#/components/schemas/EventType' + notificationAddr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + requestorId: + type: string + description: Identifies a AF requestor. + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + required: + - subsEvent + - notificationAddr + - requestorId + + ServiceSwitchInfoPatch: + type: object + description: Represents the partial update of Individual Service Switch Information. + properties: + subsEvent: + $ref: '#/components/schemas/EventType' + notificationAddr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + requestorId: + type: string + description: Identifies a AF requestor. + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + + ServiceSwitchInfoNotification: + type: object + description: Represent the service switch information for notification. + properties: + subsId: + type: string + description: > + Identifies the individual service switch information subscription for which + the service switch information notification is delivered. + repInfo: + $ref: '#/components/schemas/ServiceSwitchReportInfo' + + ServiceSwitchReportInfo: + type: object + description: List of notifications that include the information of the service switch. + properties: + acId: + type: string + description: Identifies an application client identifier. + sessionId: + type: string + description: Identifies an application session. + targetPineId: + type: string + description: Identifies the PINE that the service is switched to. + sessionDes: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + + EventType: + anyOf: + - type: string + enum: + - SERVICE_SWITCH_INFO + - 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 service switch happens in a PIN. + Possible values are: + - SERVICE_SWITCH_INFO: Indicates service switch happens in a PIN. diff --git a/TS29586_Nslpkmf_Discovery.yaml b/TS29586_Nslpkmf_Discovery.yaml new file mode 100644 index 00000000..6db11f48 --- /dev/null +++ b/TS29586_Nslpkmf_Discovery.yaml @@ -0,0 +1,397 @@ +openapi: 3.0.0 + +info: + title: Nslpkmf_Discovery API + version: '1.0.0-alpha.1' + description: | + Nslpkmf_Discovery Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.586 V0.1.0; 5G System; SideLink Positioning Key Management Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.586/ + +servers: + - url: '{apiRoot}/Nslpkmf-discovery/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - Nslpkmf-discovery + +paths: + /{ueId}/announce-authorize/{userInfoId}: + put: + summary: Obtain the authorization from the SLPKMF for announcing in the PLMN + operationId: ObtainAnnounceAuth + tags: + - Obtain the authorization from the SLPKMF for announcing in the PLMN + security: + - {} + - oAuth2ClientCredentials: + - Nslpkmf-disc + - oAuth2ClientCredentials: + - Nslpkmf-disc + - Nslpkmf-disc:announce-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: userInfoId + in: path + description: User Info Id + required: true + schema: + $ref: '#/components/schemas/UserInfoId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AnnounceAuthData' + required: true + responses: + '201': + description: Successful creation of the resource + content: + application/json: + schema: + $ref: '#/components/schemas/AnnounceAuthData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/Nslpkmf-disc>//{ueId}/announce-authorize/{userInfoId} + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '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 + + /{ueId}/monitor-authorize/{userInfoId}: + put: + summary: Obtain the discovery key from the SLPKMF for monitoring in the PLMN + operationId: ObtainMonitorAuthorize + tags: + - Obtain the discovery key from the SLPKMF for monitoring in the PLMN + security: + - {} + - oAuth2ClientCredentials: + - Nslpkmf-disc + - oAuth2ClientCredentials: + - Nslpkmf-disc + - Nslpkmf-disc:monitor-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: userInfoId + in: path + description: User Info Id + required: true + schema: + $ref: '#/components/schemas/UserInfoId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorAuthReqData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorAuthRespData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/Nslpkmf-disc>//{ueId}/monitor-authorize/{userInfoId} + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '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 + + /{ueId}/discovery-authorize/{userInfoId}: + put: + summary: Obtain the discovery key from the SLPKMF for a discoverer UE + operationId: ObtainDiscAuth + tags: + - Obtain the discovery key for a discoverer UE + security: + - {} + - oAuth2ClientCredentials: + - Nslpkmf-disc + - oAuth2ClientCredentials: + - Nslpkmf-disc + - Nslpkmf-disc:discovery-authorize:modify + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: userInfoId + in: path + description: User Info Id + required: true + schema: + $ref: '#/components/schemas/UserInfoId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoveryAuthReqData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoveryAuthRespData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/Nslpkmf-disc>//{ueId}/discovery-authorize/{userInfoId} + required: true + schema: + type: string + '204': + description: Successful update of the resource. + '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 + + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + Nslpkmf-disc: Access to the Nslpkmf_Discovery API + Nslpkmf-disc:announce-authorize:modify: > + Access to modify the authorization to announce for a UE in the PLMN + Nslpkmf-disc:monitor-authorize:modify: > + Access to modify the authorization for monitoring for an UE in the PLMN + Nslpkmf-disc:discovery-authorize:modify: > + Access to modify the authorization from the SLPKMF for a discoverer UE + in the PLMN to operate Model B restricted discovery + + schemas: + +# COMPLEX TYPES: + + AnnounceAuthData: + type: object + description: Represents Data used to request the authorization to announce for a UE + required: + - rangingSlAppId + - ueRole + properties: + rangingSlAppId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ueRole: + $ref: '#/components/schemas/UeRole' + + MonitorAuthReqData: + type: object + description: Data used to request the discovery key to monitor for a UE + required: + - rangingSlAppId + - ueRole + - ueSecurityCapability + properties: + rangingSlAppId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ueRole: + $ref: '#/components/schemas/UeRole' + ueSecurityCapability: + $ref: '#/components/schemas/UeSecurityCapability' + + MonitorAuthRespData: + type: object + description: Represents the obtained Monitor Discovery Key Data for a UE + required: + - chosenPc5CipheringAlgorithm + - discSecMaterials + properties: + chosenPc5CipheringAlgorithm: + $ref: '#/components/schemas/ChosenPc5CipheringAlgorithm' + discSecMaterials: + $ref: '#/components/schemas/DiscSecMaterials' + + DiscoveryAuthReqData: + type: object + description: Data used to request the discovery key to monitor for a discoverer UE + required: + - rangingSlAppId + - ueRole + - ueSecurityCapability + properties: + rangingSlAppId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ueRole: + $ref: '#/components/schemas/UeRole' + ueSecurityCapability: + $ref: '#/components/schemas/UeSecurityCapability' + + DiscoveryAuthRespData: + type: object + description: Represents the obtained Monitor Discovery Key Data for a discoverer UE + required: + - chosenPc5CipheringAlgorithm + - discSecMaterials + properties: + chosenPc5CipheringAlgorithm: + $ref: '#/components/schemas/ChosenPc5CipheringAlgorithm' + discSecMaterials: + $ref: '#/components/schemas/DiscSecMaterials' + + DiscSecMaterials: + type: object + description: Represents the discovery security materials + properties: + duik: + $ref: '#/components/schemas/Duik' + dusk: + $ref: '#/components/schemas/Dusk' + duck: + $ref: '#/components/schemas/Duck' + + +# SIMPLE TYPES: + UserInfoId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + UeSecurityCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + ChosenPc5CipheringAlgorithm: + description: Contains the chosen PC5 ciphering algorithm. + type: integer + + Duik: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + Duck: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + Dusk: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + + + UeRole: + description: Specifies the different roles of UE for ranging and sidelink positioning service. + anyOf: + - type: string + enum: + - TARGET_UE + - REFERENCE_UE + - LOCATED_UE + - CLIENT_UE + - SERVER_UE + - type: string + + +# ENUMS: diff --git a/TS29586_Nslpkmf_SLPKMFKeyRequest.yaml b/TS29586_Nslpkmf_SLPKMFKeyRequest.yaml new file mode 100644 index 00000000..c4965074 --- /dev/null +++ b/TS29586_Nslpkmf_SLPKMFKeyRequest.yaml @@ -0,0 +1,141 @@ +openapi: 3.0.0 + +info: + title: Nslpkmf_SLPKMFKeyRequest + version: 1.0.0-alpha.1 + description: | + SLPKMF KeyRequest Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.586 V0.1.0; 5G System; SideLink Positioning Key Management Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.586/ + +servers: + - url: '{apiRoot}/nslpkmf-keyrequest/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nslpkmf-keyrequest + +paths: + /ranging-keys/request: + post: + summary: Request Keying Materials for ranging + operationId: UnicastKey + tags: + - Ranging Keys Collection (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnicastKeyReqData' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UnicastKeyRspData' + '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: + nslpkmf-keyrequest: Access to the Nslpkmf_SLPKMFKeyRequest API + + schemas: +# +# Structured Data Types +# + UnicastKeyReqData: + description: Representation of the input to request the keying material. + type: object + properties: + rangingSlAppId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + kslpFreshness1: + $ref: '#/components/schemas/KslpFreshnessParameter1' + slpkId: + $ref: '#/components/schemas/SlpkId' + required: + - rangingSlAppId + - kslpFreshness1 + - slpkId + + + UnicastKeyRspData: + description: Representation of the successfully requested keying material. + type: object + properties: + kslp: + $ref: '#/components/schemas/Kslp' + kslpFreshness2: + $ref: '#/components/schemas/KslpFreshnessParameter2' + required: + - kslp + - kslpFreshness2 + +# +# Simple Data Types +# + SlpkId: + description: Ranging User Key ID + type: string + + Kslp: + description: Key for RANGING AND SIDELINK POSITIONING + type: string + + KslpFreshnessParameter1: + description: KSLP Freshness Parameter 1 + type: string + + KslpFreshnessParameter2: + description: KSLP Freshness Parameter 2 + type: string + + +# +# Enumeration Data Types +# diff --git a/TS29591_Nnef_EventExposure.yaml b/TS29591_Nnef_EventExposure.yaml index 5191ec9a..391bb67e 100644 --- a/TS29591_Nnef_EventExposure.yaml +++ b/TS29591_Nnef_EventExposure.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: Nnef_EventExposure - version: 1.3.0-alpha.3 + version: 1.3.0-alpha.4 description: | NEF Event Exposure Service. © 2023 , 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -10,7 +10,7 @@ info: externalDocs: description: > - 3GPP TS 29.591 V18.2.0; 5G System; Network Exposure Function Southbound Services; Stage 3. + 3GPP TS 29.591 V18.4.0; 5G System; Network Exposure Function Southbound Services; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/ servers: @@ -375,28 +375,64 @@ components: items: $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/MsQoeMetricsCollection' minItems: 1 + deprecated: true + msQoeMetrics: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/QoEMetricsCollection' + minItems: 1 + description: Represents the Media Streaming QoE metrics event notification. msConsumpInfos: type: array items: $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/MsConsumptionCollection' minItems: 1 + deprecated: true + msConsumpReports: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/ConsumptionReportingUnitsCollection' + minItems: 1 + description: Represents the Media Streaming Consumption event notification. msNetAssInvInfos: type: array items: $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/MsNetAssInvocationCollection' minItems: 1 + deprecated: true + msNetAssistInvocation: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/NetworkAssistanceInvocationsCollection' + minItems: 1 + description: > + Represents the Media Streaming Network Assistance Invocations event notification. msDynPlyInvInfos: type: array items: $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/MsDynPolicyInvocationCollection' minItems: 1 + deprecated: true + msDynPlyInvocation: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/DynamicPolicyInvocationsCollection' + minItems: 1 + description: Represents the Media Streaming Dynamic Policy Invocations event notification. msAccActInfos: type: array items: $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/MSAccessActivityCollection' minItems: 1 + deprecated: true + msAccess: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/MediaStreamingAccessesCollection' + minItems: 1 + description: Represents the Media Streaming access event notification. gnssAssistDataInfo: - $ref: '#/components/schemas/GNSSAssistDataInfo' + $ref: '#/components/schemas/GNSSAssistDataInfo' datVolTransTimeInfos: type: array items: @@ -567,11 +603,14 @@ components: description: Represents GNSS Assistance Data related information. type: object properties: + gnssAssistData: + $ref: '#/components/schemas/GNSSAssistData' servArea: $ref: '#/components/schemas/GNSSServArea' sourceInfo: $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicalCoordinates' required: + - gnssAssistData - servArea GNSSServArea: @@ -641,3 +680,9 @@ components: activity. - GNSS_ASSISTANCE_DATA: Indicates that the subscribed/notified event is GNSS Assistance Data Collection. + + GNSSAssistData: + type: string + description: > + Represents GNSS Assistance Data encoded as specified in clause 6.5.2.1 of + 3GPP TS 37.355 [31]. diff --git a/TS29591_Nnef_TrafficInfluenceData.yaml b/TS29591_Nnef_TrafficInfluenceData.yaml index d01bdbb8..d2162cb5 100644 --- a/TS29591_Nnef_TrafficInfluenceData.yaml +++ b/TS29591_Nnef_TrafficInfluenceData.yaml @@ -1,14 +1,14 @@ openapi: 3.0.0 info: title: Nnef_TrafficInfluenceData - version: 1.0.0-alpha.2 + version: 1.0.0-alpha.3 description: | NEF Traffic Influence Data Service. © 2023 , 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > - 3GPP TS 29.591 V18.3.0; 5G System; Network Exposure Function Southbound Services; Stage 3. + 3GPP TS 29.591 V18.4.0; 5G System; Network Exposure Function Southbound Services; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/ servers: - url: '{apiRoot}/nnef-traffic-influence-data/v1' @@ -158,27 +158,27 @@ paths: '204': description: No Content. '307': - $ref: 'TS29122_CommonData.yaml#/components/responses/307' + $ref: 'TS29571_CommonData.yaml#/components/responses/307' '308': - $ref: 'TS29122_CommonData.yaml#/components/responses/308' + $ref: 'TS29571_CommonData.yaml#/components/responses/308' '400': - $ref: 'TS29122_CommonData.yaml#/components/responses/400' + $ref: 'TS29571_CommonData.yaml#/components/responses/400' '401': - $ref: 'TS29122_CommonData.yaml#/components/responses/401' + $ref: 'TS29571_CommonData.yaml#/components/responses/401' '403': - $ref: 'TS29122_CommonData.yaml#/components/responses/403' + $ref: 'TS29571_CommonData.yaml#/components/responses/403' '404': - $ref: 'TS29122_CommonData.yaml#/components/responses/404' + $ref: 'TS29571_CommonData.yaml#/components/responses/404' '406': - $ref: 'TS29122_CommonData.yaml#/components/responses/406' + $ref: 'TS29571_CommonData.yaml#/components/responses/406' '429': - $ref: 'TS29122_CommonData.yaml#/components/responses/429' + $ref: 'TS29571_CommonData.yaml#/components/responses/429' '500': - $ref: 'TS29122_CommonData.yaml#/components/responses/500' + $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': - $ref: 'TS29122_CommonData.yaml#/components/responses/503' + $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: - $ref: 'TS29122_CommonData.yaml#/components/responses/default' + $ref: 'TS29571_CommonData.yaml#/components/responses/default' /subscriptions/{subscriptionId}: get: diff --git a/TS29591_Nnef_UEId.yaml b/TS29591_Nnef_UEId.yaml new file mode 100644 index 00000000..627a8436 --- /dev/null +++ b/TS29591_Nnef_UEId.yaml @@ -0,0 +1,98 @@ +openapi: 3.0.0 +info: + title: Nnef_UEId + version: 1.0.0-alpha.1 + description: | + NEF Traffic Correlation Service. + © 2023 , 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: > + 3GPP TS 29.591 V18.4.0; 5G System; Network Exposure Function Southbound Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/ +servers: + - url: '{apiRoot}/nnef-ueid/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nnef-ueid + +paths: + /fetch: + post: + summary: fetch the Internal UE Identifier for roaming UE(s). + operationId: FetchUEId + tags: + - UE ID (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UeIdReq' + responses: + '200': + description: The requested information was returned successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/UeIdInfo' + '204': + description: No Content (The requested Internal UE Identifier does not exist.) + '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: + nnef-ueid: Access to the UE ID API + + schemas: + UeIdReq: + description: Contains parameters to request to fetch the Internal UE Identifier. + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + required: + - gpsi + + UeIdInfo: + description: Contains the UE ID Information. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + required: + - supi diff --git a/TS29594_Nchf_SpendingLimitControl.yaml b/TS29594_Nchf_SpendingLimitControl.yaml index dda7cf54..546929f0 100644 --- a/TS29594_Nchf_SpendingLimitControl.yaml +++ b/TS29594_Nchf_SpendingLimitControl.yaml @@ -1,25 +1,31 @@ openapi: 3.0.0 + info: - version: 1.3.0-alpha.1 + version: 1.3.0-alpha.2 title: Nchf_SpendingLimitControl description: | Nchf Spending Limit Control Service. - © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. + externalDocs: - description: 3GPP TS 29.594 V18.0.0; 5G System; Spending Limit Control Service. + description: 3GPP TS 29.594 V18.3.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: @@ -149,6 +155,7 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: $ref: 'TS29571_CommonData.yaml#/components/responses/default' + /subscriptions/{subscriptionId}: parameters: - in: path @@ -225,6 +232,8 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + components: securitySchemes: oAuth2ClientCredentials: @@ -234,6 +243,7 @@ components: tokenUrl: '{nrfApiRoot}/oauth2/token' scopes: nchf-spendinglimitcontrol: Access to the Nchf_SpendingLimitControl API + schemas: SpendingLimitContext: description: > @@ -261,6 +271,7 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' notifId: type: string + SpendingLimitStatus: description: > Represents the data structure presenting the statuses of policy counters. @@ -282,6 +293,7 @@ components: $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 @@ -304,6 +316,7 @@ components: required: - policyCounterId - currentStatus + PendingPolicyCounterStatus: description: > Represents the data structure presenting the pending policy counter status. @@ -321,6 +334,7 @@ components: required: - policyCounterStatus - activationTime + PolicyCounterId: type: string description: Identifies a policy counter. @@ -338,10 +352,10 @@ components: $ref: '#/components/schemas/TerminationCause' required: - supi + +# Simple data types and Enumerations + TerminationCause: - description: > - Represents the cause for requesting the termination of the subscription to policy counter - status changes. anyOf: - type: string enum: @@ -350,3 +364,8 @@ components: description: > This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + description: | + Represents the cause for requesting the termination of the subscription to policy counter + status changes. + Possible values are: + - REMOVED_SUBSCRIBER: The subscriber identified by the SUPI has been removed from the CHF. diff --git a/TS29598_Nudsf_DataRepository.yaml b/TS29598_Nudsf_DataRepository.yaml index f33b2505..728154a6 100644 --- a/TS29598_Nudsf_DataRepository.yaml +++ b/TS29598_Nudsf_DataRepository.yaml @@ -1,14 +1,14 @@ openapi: 3.0.0 info: title: Nudsf_DataRepository - version: 1.2.0-alpha.4 + version: 1.2.0-alpha.5 description: | Nudsf Data Repository Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.598 UDSF Services, V18.3.0. + description: 3GPP TS 29.598 UDSF Services, V18.4.0. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.598/' servers: @@ -236,12 +236,12 @@ paths: example: 'UserRecordValue000000001' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string - name: supported-features @@ -313,12 +313,12 @@ paths: example: UserRecordValue000000001 - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 schema: type: string - name: If-Match in: header - description: Record validator for conditional requests, as described in RFC 7232, 3.2 + description: Record validator for conditional requests, as described in RFC 9110, 13.1.2 schema: type: string - name: get-previous @@ -470,7 +470,7 @@ paths: example: UserRecordValue000000001 - name: If-Match in: header - description: Record validator for conditional requests, as described in RFC 7232, 3.2 + description: Record validator for conditional requests, as described in RFC 9110, 13.1.1 schema: type: string - name: get-previous @@ -561,12 +561,12 @@ paths: example: 'UserRecordValue000000001' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string - name: supported-features @@ -649,7 +649,7 @@ paths: example: 'UserRecordValue000000001' - name: If-Match in: header - description: Record validator for conditional requests, as described in RFC 7232, 3.2 + description: Record validator for conditional requests, as described in RFC 9110, 13.1.1 schema: type: string - name: supported-features @@ -877,12 +877,12 @@ paths: example: 'userDefjson01' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string - name: supported-features @@ -968,12 +968,12 @@ paths: default: false - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 schema: type: string - name: If-Match in: header - description: Record validator for conditional requests, as described in RFC 7232, 3.2 + description: Record validator for conditional requests, as described in RFC 9110, 13.1.1 schema: type: string - name: supported-features @@ -1094,7 +1094,7 @@ paths: default: false - name: If-Match in: header - description: Record validator for conditional requests, as described in RFC 7232, 3.2 + description: Record validator for conditional requests, as described in RFC 9110, 13.1.1 schema: type: string - name: supported-features @@ -1256,12 +1256,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string responses: @@ -1351,7 +1351,7 @@ paths: default: false - name: If-Match in: header - description: Record validator for conditional requests, as described in RFC 7232, 3.2 + description: Record validator for conditional requests, as described in RFC 9110, 13.1.1 schema: type: string - name: supported-features @@ -1435,7 +1435,7 @@ paths: example: Subscription01 - name: If-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 13.1.1 schema: type: string - name: supported-features @@ -1550,12 +1550,12 @@ paths: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 schema: type: string - name: If-Match in: header - description: Record validator for conditional requests, as described in RFC 7232, 3.2 + description: Record validator for conditional requests, as described in RFC 9110, 13.1.1 schema: type: string requestBody: @@ -1741,12 +1741,12 @@ paths: $ref: '#/components/schemas/SchemaId' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + 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 7232, 3.3 + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 schema: type: string - name: supported-features @@ -1815,12 +1815,12 @@ paths: $ref: '#/components/schemas/SchemaId' - name: If-None-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 schema: type: string - name: If-Match in: header - description: Validator for conditional requests, as described in RFC 7232, 3.2 + description: Validator for conditional requests, as described in RFC 9110, 13.1.1 schema: type: string - name: get-previous @@ -1944,7 +1944,7 @@ paths: $ref: '#/components/schemas/SchemaId' - name: If-Match in: header - description: Record validator for conditional requests, as described in RFC 7232, 3.2 + description: Record validator for conditional requests, as described in RFC 9110, 13.1.1 schema: type: string - name: get-previous @@ -2413,15 +2413,15 @@ components: headers: Cache-Control: - description: Cache-Control containing max-age, as described in RFC 7234, 5.2 + 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 7232, 2.3 + 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 7232, 2.2 + description: Timestamp for last modification of the resource, as described in RFC 9110, 8.8.2 schema: type: string Location: diff --git a/TS29598_Nudsf_Timer.yaml b/TS29598_Nudsf_Timer.yaml index 478d1b03..5b168ef8 100644 --- a/TS29598_Nudsf_Timer.yaml +++ b/TS29598_Nudsf_Timer.yaml @@ -1,14 +1,14 @@ openapi: 3.0.0 info: title: Nudsf_Timer - version: 1.1.0-alpha.2 + version: 1.1.0-alpha.3 description: | Nudsf Timer Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 29.598 UDSF Services, V18.2.0. + description: 3GPP TS 29.598 UDSF Services, V18.4.0. url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.598/' servers: @@ -542,6 +542,10 @@ components: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' deleteAfter: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + periodicRepetition: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + repetitionCount: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' TimerIdList: description: Represents a list of timer IDs. diff --git a/TS29675_Nucmf_Provisioning.yaml b/TS29675_Nucmf_Provisioning.yaml index 3b3ed59b..a5e649be 100644 --- a/TS29675_Nucmf_Provisioning.yaml +++ b/TS29675_Nucmf_Provisioning.yaml @@ -1,14 +1,14 @@ openapi: 3.0.0 info: title: Nucmf_Provisioning - version: 1.2.0-alpha.2 + version: 1.2.0-alpha.3 description: | UCMF_Provisioning Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > - 3GPP TS 29.675 V18.1.0; User Equipment (UE) radio capability provisioning service; Stage 3. + 3GPP TS 29.675 V18.3.0; User Equipment (UE) radio capability provisioning service; Stage 3. url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.675/ servers: - url: '{apiRoot}/nucmf-provisioning/v1' @@ -254,7 +254,7 @@ paths: '204': description: > No Content. The Individual UE radio capability resource was successfully removed. - The payload body shall be empty. + The content shall be empty. '307': $ref: 'TS29571_CommonData.yaml#/components/responses/307' '308': diff --git a/TS32291_Nchf_ConvergedCharging.yaml b/TS32291_Nchf_ConvergedCharging.yaml index 09fe0fe8..922c173d 100644 --- a/TS32291_Nchf_ConvergedCharging.yaml +++ b/TS32291_Nchf_ConvergedCharging.yaml @@ -1,13 +1,13 @@ openapi: 3.0.0 info: title: Nchf_ConvergedCharging - version: 3.2.0-alpha.3 + version: 3.2.0-alpha.4 description: | ConvergedCharging Service © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: > - 3GPP TS 32.291 V18.3.0: Telecommunication management; Charging management; + 3GPP TS 32.291 V18.4.0: Telecommunication management; Charging management; 5G system, charging service; Stage 3. url: 'http://www.3gpp.org/ftp/Specs/archive/32_series/32.291/' servers: @@ -591,6 +591,8 @@ components: $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: @@ -689,6 +691,8 @@ components: $ref: '#/components/schemas/5GLANTypeService' sNPNInformation: $ref: '#/components/schemas/SNPNInformation' + 5GMulticastService: + $ref: '#/components/schemas/5GMulticastService' required: - pduSessionID - dnnId @@ -742,6 +746,10 @@ components: items: $ref: '#/components/schemas/QosMonitoringReport' minItems: 0 + mBSSessionID: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + mBSDeliveryMethod: + $ref: '#/components/schemas/MbsDeliveryMethod' NSPAContainerInformation: type: object properties: @@ -1065,8 +1073,18 @@ components: 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: @@ -1275,11 +1293,10 @@ components: minItems: 0 managementOperationStatus: $ref: '#/components/schemas/ManagementOperationStatus' -# To be introduced once the reference to 'generic.yaml is resolved -# managementOperationalState: -# $ref: 'genericNrm.yaml#/components/schemas/OperationalState' -# managementAdministrativeState: -# $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' + managementOperationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + managementAdministrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' required: - managementOperation ServiceProfileChargingInformation: @@ -1292,16 +1309,14 @@ components: items: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' minItems: 0 -# To be introduced once the reference to 'nrNrm.yaml is resolved -# sST: -# $ref: 'nrNrm.yaml#/components/schemas/Sst' + sST: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Sst' latency: type: integer availability: type: number -# To be introduced once the reference to sliceNrm.yaml is resolved -# resourceSharingLevel: -# $ref: 'sliceNrm.yaml#/components/schemas/SharingLevel' + resourceSharingLevel: + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/SharingLevel' jitter: type: integer reliability: @@ -1310,11 +1325,10 @@ components: type: integer coverageArea: type: string -# To be introduced once the reference to sliceNrm.yaml is resolved -# uEMobilityLevel: -# $ref: 'sliceNrm.yaml#/components/schemas/MobilityLevel' -# delayToleranceIndicator: -# $ref: 'sliceNrm.yaml#/components/schemas/Support' + uEMobilityLevel: + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/MobilityLevel' + delayToleranceIndicator: + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/Support' dLThptPerSlice: $ref: '#/components/schemas/Throughput' dLThptPerUE: @@ -1329,9 +1343,8 @@ components: type: string supportedAccessTechnology: type: integer -# To be introduced once the reference to sliceNrm.yaml is resolved -# v2XCommunicationModeIndicator: -# $ref: 'sliceNrm.yaml#/components/schemas/Support' + v2XCommunicationModeIndicator: + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/Support' addServiceProfileInfo: type: string Throughput: @@ -2015,7 +2028,7 @@ components: items: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' minItems: 0 - optionalCapability: + optionalCapability : type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' @@ -2136,6 +2149,14 @@ components: type: string description: type: string + 5GMulticastService: + type: object + properties: + mBSSessionIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + minItems: 1 NotificationType: anyOf: - type: string @@ -2181,6 +2202,7 @@ components: anyOf: - type: string enum: + # SMF TriggerType - QUOTA_THRESHOLD - QHT - FINAL @@ -2224,6 +2246,21 @@ components: - REDUNDANT_TRANSMISSION_CHANGE - CGI_SAI_CHANGE - RAI_CHANGE + - JOIN_MULTICAST + - MBS_DELIVERY_METHOD_CHANGE + - LEAVE_MULTICAST + - VSMF_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 - type: string FinalUnitAction: anyOf: @@ -2721,3 +2758,10 @@ components: - OPERATOR_PROVIDED - CONFIGURED - type: string + MbsDeliveryMethod: + anyOf: + - type: string + enum: + - SHARED + - INDIVIDUAL + - type: string