├── .gitignore ├── README.md ├── apis ├── TS29122_AsSessionWithQoS.yaml ├── TS29122_ChargeableParty.yaml ├── TS29122_CommonData.yaml ├── TS29122_CpProvisioning.yaml ├── TS29122_DeviceTriggering.yaml ├── TS29122_ECRControl.yaml ├── TS29122_GMDviaMBMSbyMB2.yaml ├── TS29122_GMDviaMBMSbyxMB.yaml ├── TS29122_MonitoringEvent.yaml ├── TS29122_MsisdnLessMoSms.yaml ├── TS29122_NIDD.yaml ├── TS29122_NpConfiguration.yaml ├── TS29122_PfdManagement.yaml ├── TS29122_RacsParameterProvisioning.yaml ├── TS29122_ReportingNetworkStatus.yaml ├── TS29122_ResourceManagementOfBdt.yaml ├── TS29502_Nsmf_PDUSession.yaml ├── TS29503_Nudm_EE.yaml ├── TS29503_Nudm_MT.yaml ├── TS29503_Nudm_NIDDAU.yaml ├── TS29503_Nudm_PP.yaml ├── TS29503_Nudm_RSDS.yaml ├── TS29503_Nudm_SDM.yaml ├── TS29503_Nudm_SSAU.yaml ├── TS29503_Nudm_UEAU.yaml ├── TS29503_Nudm_UECM.yaml ├── TS29503_Nudm_UEID.yaml ├── TS29504_Nudr_DR.yaml ├── TS29504_Nudr_GroupIDmap.yaml ├── TS29505_Subscription_Data.yaml ├── TS29507_Npcf_AMPolicyControl.yaml ├── TS29508_Nsmf_EventExposure.yaml ├── TS29509_Nausf_SoRProtection.yaml ├── TS29509_Nausf_UEAuthentication.yaml ├── TS29509_Nausf_UPUProtection.yaml ├── TS29510_Nnrf_AccessToken.yaml ├── TS29510_Nnrf_Bootstrapping.yaml ├── TS29510_Nnrf_NFDiscovery.yaml ├── TS29510_Nnrf_NFManagement.yaml ├── TS29512_Npcf_SMPolicyControl.yaml ├── TS29514_Npcf_PolicyAuthorization.yaml ├── TS29518_Namf_Communication.yaml ├── TS29518_Namf_EventExposure.yaml ├── TS29518_Namf_Location.yaml ├── TS29518_Namf_MBSBroadcast.yaml ├── TS29518_Namf_MBSCommunication.yaml ├── TS29518_Namf_MT.yaml ├── TS29519_Application_Data.yaml ├── TS29519_Exposure_Data.yaml ├── TS29519_Policy_Data.yaml ├── TS29520_Nnwdaf_AnalyticsInfo.yaml ├── TS29520_Nnwdaf_DataManagement.yaml ├── TS29520_Nnwdaf_EventsSubscription.yaml ├── TS29520_Nnwdaf_MLModelProvision.yaml ├── TS29521_Nbsf_Management.yaml ├── TS29523_Npcf_EventExposure.yaml ├── TS29525_Npcf_UEPolicyControl.yaml ├── TS29551_Nnef_PFDmanagement.yaml ├── TS29554_Npcf_BDTPolicyControl.yaml ├── TS29571_CommonData.yaml ├── TS29594_Nchf_SpendingLimitControl.yaml ├── TS32291_Nchf_ConvergedCharging.yaml └── TS32291_Nchf_OfflineOnlyCharging.yaml ├── documentation ├── GSMA │ └── VoLTE Service Description and Implementation Guidelines.pdf ├── TS 23.167 - IP Multimedia Subsystem (IMS) emergency sessions │ └── Rel-17 │ │ └── ts_123167v170200p.pdf ├── TS 23.179 - LTE - Functional architecture and information flows to support mission critical communication services - Stage 2 │ └── Rel-13 │ │ └── ts_123179v130500p.pdf ├── TS 23.203 - Policy and charging control architecture │ └── Rel-17 │ │ └── ts_123203v170200p.pdf ├── TS 23.228 - IP Multimedia Subsystem (IMS) - Stage 2 │ └── Rel-17 │ │ └── ts_123228v170300p.pdf ├── TS 23.380 - IMS Restoration Procedures │ └── Rel-17 │ │ └── ts_123380v170100p.pdf ├── TS 23.401 - General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access │ └── Rel-17 │ │ └── ts_123401v170800p.pdf ├── TS 23.501 - System Architecture for the 5G System │ └── Rel-17 │ │ └── ts_123501v170900p.pdf ├── TS 23.502 - Procedures for the 5G System (5GS) │ └── Rel-17 │ │ └── ts_123502v170900p.pdf ├── TS 23.503 - Policy and Charging Control Framework for the 5G System │ └── Rel-17 │ │ └── ts_123503v170900p.pdf ├── TS 29.122 - T8 reference point for Northbound APIs │ └── Rel-17 │ │ └── ts_129122v171000p.pdf ├── TS 29.211 - Rx Interface and Rx-Gx signalling flows │ └── Rel-6 │ │ └── ts_129211v060400p.pdf ├── TS 29.212 - Policy and Charging Control (PCC); Reference points │ └── Rel-17 │ │ └── ts_129212v170300p.pdf ├── TS 29.213 - Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping │ └── Rel-17 │ │ └── ts_129213v170200p.pdf ├── TS 29.214 - Policy and charging control over Rx reference point │ └── Rel-17 │ │ └── ts_129214v170500p.pdf ├── TS 29.219 - Policy and charging control - Spending limit reporting over Sy reference point │ └── Rel-17 │ │ └── ts_129219v170000p.pdf ├── TS 29.244 - Interface between the Control Plane and the User Plane nodes │ └── Rel-17 │ │ └── ts_129244v170900p.pdf ├── TS 29.501 - Principles and Guidelines for Services Definition │ └── Rel-17 │ │ └── ts_129501v170700p.pdf ├── TS 29.502 - Session Management Services │ └── Rel-17 │ │ └── ts_129502v170900p.pdf ├── TS 29.503 - Unified Data Management Services │ └── Rel-17 │ │ └── ts_129503v171100p.pdf ├── TS 29.504 - Unified Data Repository Services │ └── Rel-17 │ │ └── ts_129504v171100p.pdf ├── TS 29.505 - 5G System; Usage of the Unified Data Repository services for Subscription Data; Stage 3 │ └── Rel-17 │ │ └── ts_129505v171000p.pdf ├── TS 29.507 - Access and Mobility Policy Control Service │ └── Rel-17 │ │ └── ts_129507v170900p.pdf ├── TS 29.508 - Session Management Event Exposure Service │ └── Rel-17 │ │ └── ts_129508v171000p.pdf ├── TS 29.509 - Authentication Server Services │ └── Rel-17 │ │ └── ts_129509v170900p.pdf ├── TS 29.510 - Network Function Repository Services │ └── Rel-17 │ │ └── ts_129510v171000p.pdf ├── TS 29.512 - Session Management Policy Control Service │ └── Rel-17 │ │ └── ts_129512v171100p.pdf ├── TS 29.513 - Policy and Charging Control signalling flows and QoS parameter mapping │ └── Rel-17 │ │ └── ts_129513v171100p.pdf ├── TS 29.514 - Policy Authorization Service │ └── Rel-17 │ │ └── ts_129514v170900p.pdf ├── TS 29.518 - 5G System; Access and Mobility Management Services; Stage 3 │ └── Rel-17 │ │ └── ts_129518v171000p.pdf ├── TS 29.519 - Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure │ └── Rel-17 │ │ └── ts_129519v171000p.pdf ├── TS 29.520 - Network Data Analytics Services │ └── Rel-17 │ │ └── ts_129520v171100p.pdf ├── TS 29.521 - Binding Support Management Service │ └── Rel-17 │ │ └── ts_129521v170900p.pdf ├── TS 29.523 - Policy Control Event Exposure Service │ └── Rel-17 │ │ └── ts_129523v170800p.pdf ├── TS 29.525 - UE Policy Control Service │ └── Rel-17 │ │ └── ts_129525v170900p.pdf ├── TS 29.551 - 5G System; Packet Flow Description Management Service; Stage 3 │ └── Rel-17 │ │ └── ts_129551v170800p.pdf ├── TS 29.554 - Background Data Transfer Policy Control Service │ └── Rel-17 │ │ └── ts_129554v170400p.pdf ├── TS 29.571 - Common Data Types for Service Based Interfaces │ └── Rel-17 │ │ └── ts_129571v170900p.pdf ├── TS 29.594 - Spending Limit Control Service │ └── Rel-17 │ │ └── ts_129594v170500p.pdf ├── TS 32.240 - Charging architecture and principles │ └── Rel-17 │ │ └── ts_132240v171000p.pdf ├── TS 32.251 - Telecommunication management;Charging management;Packet Switched (PS) domain charging │ └── Rel-17 │ │ └── ts_132251v170000p.pdf ├── TS 32.255 - Telecommunication management; Charging management; 5G data connectivity domain charging; Stage 2 │ └── Rel-17 │ │ └── ts_132255v171000p.pdf ├── TS 32.260 - IP Multimedia Subsystem (IMS) charging │ └── Rel-17 │ │ └── ts_132260v170500p.pdf ├── TS 32.270 - Multimedia Messaging Service (MMS) charging │ └── Rel-17 │ │ └── ts_132270v170000p.pdf ├── TS 32.274 - Short Message Service (SMS) charging │ └── Rel-17 │ │ └── ts_132274v170200p.pdf ├── TS 32.276 - Voice Call Service (VCS) charging │ └── Rel-17 │ │ └── ts_132276v170000p.pdf ├── TS 32.290 - Services, operations and procedures of charging using Service Based Interface (SBI) │ └── Rel-17 │ │ └── ts_132290v170700p.pdf ├── TS 32.291 - 5G system, charging service; Stage 3 │ └── Rel-17 │ │ └── ts_132291v170700p.pdf ├── TS 32.296 - Online Charging System (OCS) - Applications and interfaces │ └── Rel-17 │ │ └── ts_132296v170000p.pdf ├── TS 32.299 - Diameter charging applications │ └── Rel-17 │ │ └── ts_132299v170000p.pdf ├── TS 33.501 - Security architecture and procedures for 5G System │ └── Rel-17 │ │ └── ts_133501v171000p.pdf └── images │ ├── 5G System architecture.png │ ├── PCF Interfaces.png │ └── diagrams.drawio └── scripts ├── configuration.json ├── getDocumentation.py ├── requirements.txt └── templates └── README.j2 /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /apis/TS29122_ECRControl.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | info: 3 | title: 3gpp-ecr-control 4 | version: 1.2.0 5 | description: | 6 | API for enhanced converage restriction control. 7 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 8 | All rights reserved. 9 | externalDocs: 10 | description: 3GPP TS 29.122 V17.6.0 T8 reference point for Northbound APIs 11 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' 12 | security: 13 | - {} 14 | - oAuth2ClientCredentials: [] 15 | servers: 16 | - url: '{apiRoot}/3gpp-ecr-control/v1' 17 | variables: 18 | apiRoot: 19 | default: https://example.com 20 | description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. 21 | paths: 22 | /query: 23 | post: 24 | summary: Query the status of enhanced converage restriction for a UE. 25 | requestBody: 26 | required: true 27 | content: 28 | application/json: 29 | schema: 30 | $ref: '#/components/schemas/ECRControl' 31 | responses: 32 | '200': 33 | description: The requested information was returned successfully. 34 | content: 35 | application/json: 36 | schema: 37 | $ref: '#/components/schemas/ECRData' 38 | '307': 39 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/307' 40 | '308': 41 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/308' 42 | '400': 43 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/400' 44 | '401': 45 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/401' 46 | '403': 47 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/403' 48 | '404': 49 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/404' 50 | '411': 51 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/411' 52 | '413': 53 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/413' 54 | '415': 55 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/415' 56 | '429': 57 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/429' 58 | '500': 59 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/500' 60 | '503': 61 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/503' 62 | default: 63 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/default' 64 | 65 | /configure: 66 | post: 67 | summary: Configure the enhanced converage restriction for a UE. 68 | requestBody: 69 | required: true 70 | content: 71 | application/json: 72 | schema: 73 | $ref: '#/components/schemas/ECRControl' 74 | responses: 75 | '200': 76 | description: The Enhanced Coverage Restriction setting was configured successfully.. 77 | content: 78 | application/json: 79 | schema: 80 | $ref: '#/components/schemas/ECRData' 81 | '307': 82 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/307' 83 | '308': 84 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/308' 85 | '400': 86 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/400' 87 | '401': 88 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/401' 89 | '403': 90 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/403' 91 | '404': 92 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/404' 93 | '411': 94 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/411' 95 | '413': 96 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/413' 97 | '415': 98 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/415' 99 | '429': 100 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/429' 101 | '500': 102 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/500' 103 | '503': 104 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/503' 105 | default: 106 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/default' 107 | components: 108 | securitySchemes: 109 | oAuth2ClientCredentials: 110 | type: oauth2 111 | flows: 112 | clientCredentials: 113 | tokenUrl: '{tokenUrl}' 114 | scopes: {} 115 | schemas: 116 | ECRControl: 117 | description: Represents the parameters to request Enhanced Coverage Restriction control. 118 | type: object 119 | properties: 120 | supportedFeatures: 121 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 122 | mtcProviderId: 123 | type: string 124 | description: Identifies the MTC Service Provider and/or MTC Application. 125 | scsAsId: 126 | type: string 127 | description: Identifier of the SCS/AS. 128 | externalId: 129 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/ExternalId' 130 | msisdn: 131 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/Msisdn' 132 | ecrDataWbs: 133 | type: array 134 | items: 135 | $ref: '#/components/schemas/PlmnEcRestrictionDataWb' 136 | minItems: 0 137 | restrictedPlmnIds: 138 | type: array 139 | items: 140 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/PlmnId' 141 | minItems: 0 142 | description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be restricted. This attribute shall not be present for the query custom operation. 143 | allowedPlmnIds: 144 | type: array 145 | items: 146 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/PlmnId' 147 | minItems: 0 148 | description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be allowed. This attribute shall not be present for the query custom operation. 149 | required: 150 | - supportedFeatures 151 | oneOf: 152 | - required: [externalId] 153 | - required: [msisdn] 154 | not: 155 | required: [restrictedPlmnIds, allowedPlmnIds] 156 | ECRData: 157 | description: Represents the current visited PLMN (if any) and the current settings of enhanced coverage restriction. 158 | type: object 159 | properties: 160 | supportedFeatures: 161 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 162 | visitedPlmnId: 163 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/PlmnId' 164 | ecrDataWbs: 165 | type: array 166 | items: 167 | $ref: '#/components/schemas/PlmnEcRestrictionDataWb' 168 | minItems: 0 169 | restrictedPlmnIds: 170 | type: array 171 | items: 172 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/PlmnId' 173 | minItems: 0 174 | description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be restricted. 175 | allowedPlmnIds: 176 | type: array 177 | items: 178 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/PlmnId' 179 | minItems: 0 180 | description: Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be allowed. 181 | required: 182 | - supportedFeatures 183 | not: 184 | required: [restrictedPlmnIds, allowedPlmnIds] 185 | PlmnEcRestrictionDataWb: 186 | description: Indicates whether enhanced coverage mode is restricted or not for a PLMN ID. 187 | type: object 188 | properties: 189 | plmnId: 190 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/PlmnId' 191 | plmnEcrDataWb: 192 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29503_Nudm_SDM.yaml#/components/schemas/EcRestrictionDataWb' 193 | required: 194 | - plmnId 195 | -------------------------------------------------------------------------------- /apis/TS29122_MsisdnLessMoSms.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | info: 3 | title: 3gpp-msisdn-less-mo-sms 4 | version: 1.2.0 5 | description: | 6 | API for MSISDN-less Mobile Originated SMS. 7 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 8 | All rights reserved. 9 | externalDocs: 10 | description: 3GPP TS 29.122 V17.6.0 T8 reference point for Northbound APIs 11 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' 12 | security: 13 | - {} 14 | - oAuth2ClientCredentials: [] 15 | servers: 16 | - url: '{apiRoot}' 17 | variables: 18 | apiRoot: 19 | default: https://example.com 20 | description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. 21 | paths: 22 | /: 23 | post: 24 | summary: Deliver a received MSIDN-less MO SMS from the SCEF to the SCS/AS. 25 | operationId: DeliverMSISDNlessMOSMSNotification 26 | tags: 27 | - MSISDN-less MO SMS Notification 28 | requestBody: 29 | required: true 30 | content: 31 | application/json: 32 | schema: 33 | $ref: '#/components/schemas/MsisdnLessMoSmsNotification' 34 | responses: 35 | '200': 36 | description: Success 37 | content: 38 | application/json: 39 | schema: 40 | $ref: '#/components/schemas/MsisdnLessMoSmsNotificationReply' 41 | '307': 42 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/307' 43 | '308': 44 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/308' 45 | '400': 46 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/400' 47 | '401': 48 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/401' 49 | '403': 50 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/403' 51 | '404': 52 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/404' 53 | '411': 54 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/411' 55 | '413': 56 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/413' 57 | '415': 58 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/415' 59 | '429': 60 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/429' 61 | '500': 62 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/500' 63 | '503': 64 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/503' 65 | default: 66 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/responses/default' 67 | 68 | components: 69 | securitySchemes: 70 | oAuth2ClientCredentials: 71 | type: oauth2 72 | flows: 73 | clientCredentials: 74 | tokenUrl: '{tokenUrl}' 75 | scopes: {} 76 | schemas: 77 | MsisdnLessMoSmsNotification: 78 | description: Represents a MSISDN-less MO SMS notification. 79 | type: object 80 | properties: 81 | supportedFeatures: 82 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 83 | sms: 84 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/Bytes' 85 | externalId: 86 | type: string 87 | description: External identifier has the form username@realm. 88 | applicationPort: 89 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/Port' 90 | required: 91 | - supportedFeatures 92 | - sms 93 | - externalId 94 | - applicationPort 95 | MsisdnLessMoSmsNotificationReply: 96 | description: Represents a reply to a MSISDN-less MO SMS notification. 97 | type: object 98 | properties: 99 | supportedFeatures: 100 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 101 | required: 102 | - supportedFeatures 103 | -------------------------------------------------------------------------------- /apis/TS29503_Nudm_MT.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | info: 3 | version: '1.1.0' 4 | title: 'Nudm_MT' 5 | description: | 6 | UDM MT Service. 7 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 8 | All rights reserved. 9 | 10 | externalDocs: 11 | description: 3GPP TS 29.503 Unified Data Management Services, version 17.7.0 12 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' 13 | 14 | servers: 15 | - url: '{apiRoot}/nudm-mt/v1' 16 | variables: 17 | apiRoot: 18 | default: https://example.com 19 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. 20 | 21 | security: 22 | - oAuth2ClientCredentials: 23 | - nudm-mt 24 | - {} 25 | 26 | paths: 27 | /{supi}: 28 | get: 29 | summary: Query Information for the UE 30 | operationId: QueryUeInfo 31 | tags: 32 | - Query UE Info 33 | parameters: 34 | - name: supi 35 | in: path 36 | description: Identifier of the UE 37 | required: true 38 | schema: 39 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 40 | - name: fields 41 | in: query 42 | description: attributes to be retrieved 43 | required: true 44 | schema: 45 | type: array 46 | items: 47 | type: string 48 | minItems: 1 49 | style: form 50 | explode: false 51 | - name: supported-features 52 | in: query 53 | description: Supported Features 54 | schema: 55 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 56 | responses: 57 | '200': 58 | description: Expected response to a valid request 59 | content: 60 | application/json: 61 | schema: 62 | $ref: '#/components/schemas/UeInfo' 63 | '400': 64 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 65 | '404': 66 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 67 | '500': 68 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 69 | '501': 70 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/501' 71 | '503': 72 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 73 | default: 74 | description: Unexpected error 75 | /{supi}/loc-info/provide-loc-info: 76 | post: 77 | summary: Provides the UE's 5GS location information 78 | operationId: ProvideLocationInfo 79 | tags: 80 | - Provide UE Location 81 | parameters: 82 | - name: supi 83 | in: path 84 | description: Identifier of the UE 85 | required: true 86 | schema: 87 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 88 | requestBody: 89 | content: 90 | application/json: 91 | schema: 92 | $ref: '#/components/schemas/LocationInfoRequest' 93 | required: true 94 | responses: 95 | '200': 96 | description: Expected response to a valid request 97 | content: 98 | application/json: 99 | schema: 100 | $ref: '#/components/schemas/LocationInfoResult' 101 | '400': 102 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 103 | '404': 104 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 105 | '500': 106 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 107 | '501': 108 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/501' 109 | '503': 110 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 111 | default: 112 | description: Unexpected error 113 | 114 | 115 | components: 116 | securitySchemes: 117 | oAuth2ClientCredentials: 118 | type: oauth2 119 | flows: 120 | clientCredentials: 121 | tokenUrl: '{nrfApiRoot}/oauth2/token' 122 | scopes: 123 | nudm-mt: Access to the nudm-mt API 124 | 125 | 126 | schemas: 127 | 128 | # COMPLEX TYPES: 129 | 130 | UeInfo: 131 | description: Represents UE information. 132 | type: object 133 | properties: 134 | tadsInfo: 135 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29518_Namf_MT.yaml#/components/schemas/UeContextInfo' 136 | userState: 137 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29518_Namf_EventExposure.yaml#/components/schemas/5GsUserState' 138 | 5gSrvccInfo: 139 | $ref: '#/components/schemas/5GSrvccInfo' 140 | 141 | 5GSrvccInfo: 142 | description: Represents 5G SRVCC information for a UE. 143 | type: object 144 | required: 145 | - ue5GSrvccCapability 146 | properties: 147 | ue5GSrvccCapability: 148 | type: boolean 149 | stnSr: 150 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/StnSr' 151 | cMsisdn: 152 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/CMsisdn' 153 | 154 | LocationInfoRequest: 155 | description: Represents information to be sent in a location information request. It contains the requested information, i.e. current location, local time zone, RAT type, or serving node identity only. 156 | type: object 157 | properties: 158 | req5gsLoc: 159 | type: boolean 160 | default: false 161 | reqCurrentLoc: 162 | type: boolean 163 | default: false 164 | reqRatType: 165 | type: boolean 166 | default: false 167 | reqTimeZone: 168 | type: boolean 169 | default: false 170 | reqServingNode: 171 | type: boolean 172 | default: false 173 | supportedFeatures: 174 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 175 | 176 | LocationInfoResult: 177 | description: Represents the requested location information. 178 | type: object 179 | properties: 180 | vPlmnId: 181 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PlmnId' 182 | amfInstanceId: 183 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 184 | smsfInstanceId: 185 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 186 | ncgi: 187 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Ncgi' 188 | ecgi: 189 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Ecgi' 190 | tai: 191 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Tai' 192 | currentLoc: 193 | type: boolean 194 | geoInfo: 195 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' 196 | locationAge: 197 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' 198 | ratType: 199 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/RatType' 200 | timezone: 201 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/TimeZone' 202 | supportedFeatures: 203 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 204 | 205 | # SIMPLE TYPES: 206 | 207 | 208 | # ENUMS: 209 | 210 | -------------------------------------------------------------------------------- /apis/TS29503_Nudm_NIDDAU.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | 3 | info: 4 | version: '1.1.1' 5 | title: 'Nudm_NIDDAU' 6 | description: | 7 | Nudm NIDD Authorization Service. 8 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 9 | All rights reserved. 10 | 11 | externalDocs: 12 | description: 3GPP TS 29.503 Unified Data Management Services, version 17.8.0 13 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' 14 | 15 | servers: 16 | - url: '{apiRoot}/nudm-niddau/v1' 17 | variables: 18 | apiRoot: 19 | default: https://example.com 20 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. 21 | 22 | security: 23 | - oAuth2ClientCredentials: 24 | - nudm-niddau 25 | - {} 26 | 27 | paths: 28 | /{ueIdentity}/authorize: 29 | post: 30 | summary: Authorize the NIDD configuration request. 31 | operationId: AuthorizeNiddData 32 | tags: 33 | - Authorize the NIDD configuration request 34 | parameters: 35 | - name: ueIdentity 36 | in: path 37 | description: Represents the scope of the UE for which the NIDD configuration are authorized. Contains the GPSI of the user or the external group ID. 38 | required: true 39 | schema: 40 | type: string 41 | pattern: '^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^@]+|extgroupid-[^@]+@[^@]+)$' 42 | requestBody: 43 | content: 44 | application/json: 45 | schema: 46 | $ref: '#/components/schemas/AuthorizationInfo' 47 | required: true 48 | responses: 49 | '200': 50 | description: Expected response to a valid request 51 | content: 52 | application/json: 53 | schema: 54 | $ref: '#/components/schemas/AuthorizationData' 55 | '400': 56 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 57 | '403': 58 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 59 | '404': 60 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 61 | '500': 62 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 63 | '501': 64 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/501' 65 | '503': 66 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 67 | default: 68 | description: Unexpected error 69 | callbacks: 70 | niddAuthUpdateNotification: 71 | '{request.body#/authUpdateCallbackUri}': 72 | post: 73 | requestBody: 74 | required: true 75 | content: 76 | application/json: 77 | schema: 78 | $ref: '#/components/schemas/NiddAuthUpdateNotification' 79 | responses: 80 | '204': 81 | description: Expected response to a valid request 82 | 83 | 84 | components: 85 | securitySchemes: 86 | oAuth2ClientCredentials: 87 | type: oauth2 88 | flows: 89 | clientCredentials: 90 | tokenUrl: '{nrfApiRoot}/oauth2/token' 91 | scopes: 92 | nudm-niddau: Access to the nudm-niddau API 93 | 94 | schemas: 95 | 96 | # COMPLEX TYPES: 97 | # 98 | AuthorizationData: 99 | description: Represents NIDD authorization data. 100 | type: object 101 | required: 102 | - authorizationData 103 | properties: 104 | authorizationData: 105 | type: array 106 | items: 107 | $ref: '#/components/schemas/UserIdentifier' 108 | minItems: 1 109 | uniqueItems: true 110 | validityTime: 111 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/DateTime' 112 | 113 | UserIdentifier: 114 | description: Represents the user identifier. 115 | type: object 116 | required: 117 | - supi 118 | properties: 119 | supi: 120 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 121 | gpsi: 122 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Gpsi' 123 | validityTime: 124 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/DateTime' 125 | 126 | NiddAuthUpdateInfo: 127 | description: Represents NIDD authorization update information. 128 | type: object 129 | required: 130 | - authorizationData 131 | properties: 132 | authorizationData: 133 | $ref: '#/components/schemas/AuthorizationData' 134 | invalidityInd: 135 | type: boolean 136 | snssai: 137 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Snssai' 138 | dnn: 139 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Dnn' 140 | niddCause: 141 | $ref: '#/components/schemas/NiddCause' 142 | 143 | NiddAuthUpdateNotification: 144 | description: Represents a NIDD authorization update notification. 145 | type: object 146 | required: 147 | - niddAuthUpdateInfoList 148 | properties: 149 | niddAuthUpdateInfoList: 150 | type: array 151 | items: 152 | $ref: '#/components/schemas/NiddAuthUpdateInfo' 153 | minItems: 1 154 | 155 | AuthorizationInfo: 156 | description: Represents NIDD authorization information. 157 | type: object 158 | required: 159 | - snssai 160 | - dnn 161 | - mtcProviderInformation 162 | - authUpdateCallbackUri 163 | properties: 164 | snssai: 165 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Snssai' 166 | dnn: 167 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Dnn' 168 | mtcProviderInformation: 169 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' 170 | authUpdateCallbackUri: 171 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Uri' 172 | afId: 173 | type: string 174 | nefId: 175 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefId' 176 | validityTime: 177 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/DateTime' 178 | contextInfo: 179 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo' 180 | 181 | 182 | # SIMPLE TYPES: 183 | 184 | 185 | 186 | # ENUMS: 187 | 188 | NiddCause: 189 | anyOf: 190 | - type: string 191 | enum: 192 | - SUBSCRIPTION_WITHDRAWAL 193 | - DNN_REMOVED 194 | - type: string 195 | 196 | -------------------------------------------------------------------------------- /apis/TS29503_Nudm_RSDS.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | info: 3 | version: '1.1.0' 4 | title: 'Nudm_ReportSMDeliveryStatus' 5 | description: | 6 | UDM Report SM Delivery Status Service. 7 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 8 | All rights reserved. 9 | 10 | externalDocs: 11 | description: 3GPP TS 29.503 Unified Data Management Services, version 17.8.0 12 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' 13 | 14 | servers: 15 | - url: '{apiRoot}/nudm-rsds/v1' 16 | variables: 17 | apiRoot: 18 | default: https://example.com 19 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. 20 | 21 | security: 22 | - oAuth2ClientCredentials: 23 | - nudm-rsds 24 | - {} 25 | 26 | paths: 27 | /{ueIdentity}/sm-delivery-status: 28 | post: 29 | summary: Report the SM Delivery Status 30 | operationId: ReportSMDeliveryStatus 31 | tags: 32 | - Report SM Delivery Status 33 | parameters: 34 | - name: ueIdentity 35 | in: path 36 | description: Represents the scope of the UE for which the Service Specific Parameters are authorized. Contains the GPSI of the user or the external group ID. 37 | required: true 38 | schema: 39 | type: string 40 | pattern: '^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^@]+|extgroupid-[^@]+@[^@]+)$' 41 | requestBody: 42 | content: 43 | application/json: 44 | schema: 45 | $ref: '#/components/schemas/SmDeliveryStatus' 46 | required: true 47 | responses: 48 | '204': 49 | description: Successful response 50 | '400': 51 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 52 | '404': 53 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 54 | '500': 55 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 56 | '503': 57 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 58 | default: 59 | description: Unexpected error 60 | 61 | 62 | components: 63 | securitySchemes: 64 | oAuth2ClientCredentials: 65 | type: oauth2 66 | flows: 67 | clientCredentials: 68 | tokenUrl: '{nrfApiRoot}/oauth2/token' 69 | scopes: 70 | nudm-rsds: Access to the nudm-rsds API 71 | 72 | 73 | schemas: 74 | 75 | # COMPLEX TYPES: 76 | 77 | SmDeliveryStatus: 78 | description: Represents SM Delivery Status. 79 | type: object 80 | required: 81 | - gpsi 82 | - smStatusReport 83 | properties: 84 | gpsi: 85 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Gpsi' 86 | smStatusReport: 87 | type: string 88 | 89 | 90 | # SIMPLE TYPES: 91 | 92 | 93 | # ENUMS: 94 | 95 | -------------------------------------------------------------------------------- /apis/TS29503_Nudm_SSAU.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | 3 | info: 4 | version: '1.0.2' 5 | title: 'Nudm_SSAU' 6 | description: | 7 | Nudm Service Specific Authorization Service. 8 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 9 | All rights reserved. 10 | 11 | externalDocs: 12 | description: 3GPP TS 29.503 Unified Data Management Services, version 17.9.0 13 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' 14 | 15 | servers: 16 | - url: '{apiRoot}/nudm-ssau/v1' 17 | variables: 18 | apiRoot: 19 | default: https://example.com 20 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. 21 | 22 | security: 23 | - oAuth2ClientCredentials: 24 | - nudm-ssau 25 | - {} 26 | 27 | paths: 28 | /{ueIdentity}/{serviceType}/authorize: 29 | post: 30 | summary: Authorization for the Service specific parameters in the request. 31 | operationId: ServiceSpecificAuthorization 32 | tags: 33 | - Service specific authorization request 34 | parameters: 35 | - name: ueIdentity 36 | in: path 37 | description: Represents the scope of the UE for which the Service Specific Parameters are authorized. Contains the GPSI of the user or the external group ID. 38 | required: true 39 | schema: 40 | type: string 41 | pattern: '^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^@]+|extgroupid-[^@]+@[^@]+)$' 42 | - name: serviceType 43 | in: path 44 | description: Represents the specific service for which the Service Specific Parameters are authorized. 45 | required: true 46 | schema: 47 | $ref: '#/components/schemas/ServiceType' 48 | requestBody: 49 | content: 50 | application/json: 51 | schema: 52 | $ref: '#/components/schemas/ServiceSpecificAuthorizationInfo' 53 | required: true 54 | responses: 55 | '200': 56 | description: Expected response to a valid request 57 | content: 58 | application/json: 59 | schema: 60 | $ref: '#/components/schemas/ServiceSpecificAuthorizationData' 61 | '400': 62 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 63 | '403': 64 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 65 | '404': 66 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 67 | '500': 68 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 69 | '501': 70 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/501' 71 | '503': 72 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 73 | default: 74 | description: Unexpected error 75 | callbacks: 76 | authUpdateNotification: 77 | '{request.body#/authUpdateCallbackUri}': 78 | post: 79 | requestBody: 80 | required: true 81 | content: 82 | application/json: 83 | schema: 84 | $ref: '#/components/schemas/AuthUpdateNotification' 85 | responses: 86 | '204': 87 | description: Expected response to a valid request 88 | 89 | /{ueIdentity}/{serviceType}/remove: 90 | post: 91 | summary: Remove the authorization of specific service's configuration. 92 | operationId: ServiceSpecificAuthorizationRemoval 93 | tags: 94 | - Service specific authorization remove 95 | parameters: 96 | - name: ueIdentity 97 | in: path 98 | description: Represents the scope of the UE for which the Service Specific configuration authorization to be removed. Contains the GPSI of the user or the external group ID. 99 | required: true 100 | schema: 101 | type: string 102 | pattern: '^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^@]+|extgroupid-[^@]+@[^@]+)$' 103 | - name: serviceType 104 | in: path 105 | description: Represents the specific service for which the Service Specific configuration authorization to be removed. 106 | required: true 107 | schema: 108 | $ref: '#/components/schemas/ServiceType' 109 | requestBody: 110 | content: 111 | application/json: 112 | schema: 113 | $ref: '#/components/schemas/ServiceSpecificAuthorizationRemoveData' 114 | required: true 115 | responses: 116 | '204': 117 | description: Successful response 118 | '400': 119 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 120 | '401': 121 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 122 | '403': 123 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 124 | '404': 125 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 126 | '411': 127 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 128 | '413': 129 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 130 | '415': 131 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 132 | '429': 133 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 134 | '500': 135 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 136 | '501': 137 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/501' 138 | '502': 139 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/502' 140 | '503': 141 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 142 | default: 143 | description: Unexpected error 144 | 145 | 146 | components: 147 | securitySchemes: 148 | oAuth2ClientCredentials: 149 | type: oauth2 150 | flows: 151 | clientCredentials: 152 | tokenUrl: '{nrfApiRoot}/oauth2/token' 153 | scopes: 154 | nudm-ssau: Access to the nudm-ssau API 155 | 156 | schemas: 157 | 158 | # COMPLEX TYPES: 159 | # 160 | AuthUpdateNotification: 161 | description: Represents an authorization update notification. 162 | type: object 163 | required: 164 | - serviceType 165 | - authUpdateInfoList 166 | properties: 167 | serviceType: 168 | $ref: '#/components/schemas/ServiceType' 169 | snssai: 170 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Snssai' 171 | dnn: 172 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Dnn' 173 | authUpdateInfoList: 174 | type: array 175 | items: 176 | $ref: '#/components/schemas/AuthUpdateInfo' 177 | minItems: 1 178 | mtcProviderInformation: 179 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' 180 | afId: 181 | type: string 182 | 183 | AuthUpdateInfo: 184 | description: Represents authorization update information. 185 | type: object 186 | required: 187 | - authorizationData 188 | properties: 189 | authorizationData: 190 | $ref: '#/components/schemas/ServiceSpecificAuthorizationData' 191 | invalidityInd: 192 | type: boolean 193 | invalidCause: 194 | $ref: '#/components/schemas/InvalidCause' 195 | 196 | 197 | ServiceSpecificAuthorizationInfo: 198 | description: Authorization information for a specific service 199 | type: object 200 | properties: 201 | snssai: 202 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Snssai' 203 | dnn: 204 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Dnn' 205 | mtcProviderInformation: 206 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' 207 | authUpdateCallbackUri: 208 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Uri' 209 | afId: 210 | type: string 211 | nefId: 212 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefId' 213 | 214 | ServiceSpecificAuthorizationData: 215 | description: Authorization Response for a specific service. 216 | type: object 217 | properties: 218 | authorizationUeId: 219 | $ref: '#/components/schemas/AuthorizationUeId' 220 | extGroupId: 221 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' 222 | intGroupId: 223 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/GroupId' 224 | authId: 225 | type: string 226 | 227 | AuthorizationUeId: 228 | description: UE Id of the Authorization Data. 229 | type: object 230 | required: 231 | - supi 232 | properties: 233 | supi: 234 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 235 | gpsi: 236 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Gpsi' 237 | 238 | ServiceSpecificAuthorizationRemoveData: 239 | description: Information for Authorization removal of a specific service. 240 | type: object 241 | required: 242 | - authId 243 | properties: 244 | authId: 245 | type: string 246 | 247 | 248 | 249 | # SIMPLE TYPES: 250 | 251 | 252 | 253 | # ENUMS: 254 | 255 | ServiceType: 256 | anyOf: 257 | - type: string 258 | enum: 259 | - AF_GUIDANCE_FOR_URSP 260 | - type: string 261 | description: > 262 | This string provides forward-compatibility with future 263 | extensions to the enumeration but is not used to encode 264 | content defined in the present version of this API. 265 | description: > 266 | Possible values are 267 | - AF_GUIDANCE_FOR_URSP 268 | 269 | InvalidCause: 270 | anyOf: 271 | - type: string 272 | enum: 273 | - SUBSRIPTION_WITHDRAWAL 274 | - DNN_REMOVED 275 | - SLICE_REMOVED 276 | - AUTHORIZATION_REVOKED 277 | - type: string 278 | description: > 279 | This string provides forward-compatibility with future 280 | extensions to the enumeration but is not used to encode 281 | content defined in the present version of this API. 282 | description: > 283 | Possible values are 284 | - SUBSRIPTION_WITHDRAWAL 285 | - DNN_REMOVED 286 | - SLICE_REMOVED 287 | - AUTHORIZATION_REVOKED 288 | 289 | -------------------------------------------------------------------------------- /apis/TS29503_Nudm_UEID.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | info: 3 | version: '1.0.0' 4 | title: 'Nudm_UEIdentifier' 5 | description: | 6 | UDM UE Identifier Service. 7 | © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 8 | All rights reserved. 9 | 10 | externalDocs: 11 | description: 3GPP TS 29.503 Unified Data Management Services, version 17.10.0 12 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' 13 | 14 | servers: 15 | - url: '{apiRoot}/nudm-ueid/v1' 16 | variables: 17 | apiRoot: 18 | default: https://example.com 19 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. 20 | 21 | security: 22 | - oAuth2ClientCredentials: 23 | - nudm-ueid 24 | - {} 25 | 26 | paths: 27 | /deconceal: 28 | post: 29 | summary: Deconceal the SUCI to the SUPI 30 | operationId: Deconceal 31 | tags: 32 | - Deconceal 33 | requestBody: 34 | content: 35 | application/json: 36 | schema: 37 | $ref: '#/components/schemas/DeconcealReqData' 38 | required: true 39 | responses: 40 | '200': 41 | description: Successful response 42 | content: 43 | application/json: 44 | schema: 45 | $ref: '#/components/schemas/DeconcealRspData' 46 | '400': 47 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 48 | '403': 49 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 50 | '404': 51 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 52 | '500': 53 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 54 | '501': 55 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/501' 56 | '503': 57 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 58 | default: 59 | description: Unexpected error 60 | 61 | 62 | components: 63 | securitySchemes: 64 | oAuth2ClientCredentials: 65 | type: oauth2 66 | flows: 67 | clientCredentials: 68 | tokenUrl: '{nrfApiRoot}/oauth2/token' 69 | scopes: 70 | nudm-ueid: Access to the nudm-ueid API 71 | 72 | 73 | schemas: 74 | 75 | # COMPLEX TYPES: 76 | 77 | DeconcealReqData: 78 | description: Deconceal Request Data 79 | type: object 80 | required: 81 | - suci 82 | properties: 83 | suci: 84 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29509_Nausf_UEAuthentication.yaml#/components/schemas/Suci' 85 | 86 | DeconcealRspData: 87 | description: Deconceal Response Data 88 | type: object 89 | required: 90 | - supi 91 | properties: 92 | supi: 93 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 94 | 95 | # SIMPLE TYPES: 96 | 97 | 98 | # ENUMS: 99 | -------------------------------------------------------------------------------- /apis/TS29504_Nudr_GroupIDmap.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | 3 | info: 4 | version: 1.1.0 5 | title: 'Nudr_GroupIDmap' 6 | description: | 7 | Unified Data Repository Service for NF-Group ID retrieval. 8 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 9 | All rights reserved. 10 | 11 | externalDocs: 12 | description: 3GPP TS 29.504 V17.7.0; 5G System; Unified Data Repository Services; Stage 3 13 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.504/' 14 | 15 | servers: 16 | - description: API root 17 | url: '{apiRoot}/nudr-group-id-map/v1' 18 | variables: 19 | apiRoot: 20 | default: https://example.com 21 | 22 | security: 23 | - {} 24 | - oAuth2ClientCredentials: 25 | - nudr-group-id-map 26 | 27 | paths: 28 | /nf-group-ids: 29 | get: 30 | summary: Retrieves NF-Group IDs for provided Subscriber and NF types 31 | operationId: GetNfGroupIDs 32 | tags: 33 | - NF Group IDs (Document) 34 | parameters: 35 | - name: nf-type 36 | in: query 37 | description: Type of NF 38 | required: true 39 | style: form 40 | explode: false 41 | schema: 42 | type: array 43 | items: 44 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' 45 | minItems: 1 46 | - name: subscriberId 47 | # The name of this query parameter is left not following the naming convention as defined in 3GPP TS 29.501 due to backward compatibility consideration. 48 | in: query 49 | description: Identifier of the subscriber 50 | required: true 51 | schema: 52 | $ref: '#/components/schemas/SubscriberId' 53 | responses: 54 | '200': 55 | description: Expected response to a valid request 56 | content: 57 | application/json: 58 | schema: 59 | $ref: '#/components/schemas/NfGroupIdMapResult' 60 | '404': 61 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 62 | default: 63 | description: Unexpected error 64 | 65 | 66 | components: 67 | securitySchemes: 68 | oAuth2ClientCredentials: 69 | type: oauth2 70 | flows: 71 | clientCredentials: 72 | tokenUrl: '{nrfApiRoot}/oauth2/token' 73 | scopes: 74 | nudr-group-id-map: Access to the Nudr_GroupIDmap API 75 | 76 | 77 | 78 | schemas: 79 | 80 | # COMPLEX TYPES: 81 | 82 | NfGroupIdMapResult: 83 | description: Contains the NFGroupIds for the requested NF types. The NFType is the key of the map. 84 | type: object 85 | additionalProperties: 86 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfGroupId' 87 | minProperties: 1 88 | 89 | # SIMPLE TYPES: 90 | 91 | SubscriberId: 92 | description: Represents the Subscription Identifier SUPI or GPSI or IMPI or IMPU. 93 | type: string 94 | pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|impi-.+|impu-.+|.+)$' 95 | 96 | # ENUMS: 97 | -------------------------------------------------------------------------------- /apis/TS29509_Nausf_SoRProtection.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | 3 | info: 4 | version: 1.2.0 5 | title: Nausf_SoRProtection Service 6 | description: | 7 | AUSF SoR Protection Service. 8 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 9 | All rights reserved. 10 | 11 | externalDocs: 12 | description: 3GPP TS 29.509 V17.6.0; 5G System; Authentication Server Services 13 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.509' 14 | 15 | servers: 16 | - url: '{apiRoot}/nausf-sorprotection/v1' 17 | variables: 18 | apiRoot: 19 | default: https://example.com 20 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. 21 | 22 | security: 23 | - {} 24 | - oAuth2ClientCredentials: 25 | - nausf-sorprotection 26 | 27 | paths: 28 | /{supi}/ue-sor: 29 | post: 30 | parameters: 31 | - name: supi 32 | in: path 33 | description: Identifier of the UE 34 | required: true 35 | schema: 36 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 37 | requestBody: 38 | content: 39 | application/json: 40 | schema: 41 | $ref: '#/components/schemas/SorInfo' 42 | required: true 43 | responses: 44 | '200': 45 | description: SorSecurityInfo 46 | content: 47 | application/json: 48 | schema: 49 | $ref: '#/components/schemas/SorSecurityInfo' 50 | '307': 51 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 52 | '308': 53 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 54 | '503': 55 | description: Service Unavailable 56 | content: 57 | application/problem+json: 58 | schema: 59 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/ProblemDetails' 60 | 61 | components: 62 | securitySchemes: 63 | oAuth2ClientCredentials: 64 | type: oauth2 65 | flows: 66 | clientCredentials: 67 | tokenUrl: '{nrfApiRoot}/oauth2/token' 68 | scopes: 69 | nausf-sorprotection: Access to the Nausf_SoRProtection API 70 | schemas: 71 | 72 | # 73 | # COMPLEX TYPES: 74 | # 75 | 76 | SorInfo: 77 | description: Contains the Steering Information. 78 | type: object 79 | properties: 80 | steeringContainer: 81 | $ref: '#/components/schemas/SteeringContainer' 82 | ackInd: 83 | $ref: '#/components/schemas/AckInd' 84 | sorHeader: 85 | $ref: '#/components/schemas/SorHeader' 86 | sorTransparentInfo: 87 | $ref: '#/components/schemas/SorTransparentInfo' 88 | supportedFeatures: 89 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 90 | required: 91 | - ackInd 92 | 93 | SorSecurityInfo: 94 | description: Contains the material generated for securing of SoR. It contains at least the SoR-MAC-IAUSF and CounterSoR. 95 | type: object 96 | properties: 97 | sorMacIausf: 98 | $ref: '#/components/schemas/SorMac' 99 | counterSor: 100 | $ref: '#/components/schemas/CounterSor' 101 | sorXmacIue: 102 | $ref: '#/components/schemas/SorMac' 103 | required: 104 | - sorMacIausf 105 | - counterSor 106 | 107 | SteeringContainer: 108 | description: Contains the information sent to UE. 109 | oneOf: 110 | - type: array 111 | items: 112 | $ref: '#/components/schemas/SteeringInfo' 113 | minItems: 1 114 | - $ref: '#/components/schemas/SecuredPacket' 115 | 116 | SteeringInfo: 117 | description: Contains a combination of one PLMN identity and zero or more access technologies. 118 | type: object 119 | properties: 120 | plmnId: 121 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PlmnId' 122 | accessTechList: 123 | type: array 124 | items: 125 | $ref: '#/components/schemas/AccessTech' 126 | minItems: 1 127 | required: 128 | - plmnId 129 | 130 | # 131 | # SIMPLE TYPES: 132 | # 133 | 134 | SorMac: 135 | description: MAC value for protecting SOR procedure (SoR-MAC-IAUSF and SoR-XMAC-IUE). 136 | type: string 137 | pattern: '^[A-Fa-f0-9]{32}$' 138 | 139 | CounterSor: 140 | description: CounterSoR. 141 | type: string 142 | pattern: '^[A-Fa-f0-9]{4}$' 143 | 144 | AckInd: 145 | description: Contains indication whether the acknowledgement from UE is needed. 146 | type: boolean 147 | 148 | SecuredPacket: 149 | description: Contains a secure packet. 150 | type: string 151 | format: byte 152 | 153 | SorHeader: 154 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Bytes' 155 | 156 | SorTransparentInfo: 157 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Bytes' 158 | 159 | # 160 | # ENUMS: 161 | 162 | AccessTech: 163 | description: Represents the access technology 164 | anyOf: 165 | - type: string 166 | enum: 167 | - NR 168 | - EUTRAN_IN_WBS1_MODE_AND_NBS1_MODE 169 | - EUTRAN_IN_NBS1_MODE_ONLY 170 | - EUTRAN_IN_WBS1_MODE_ONLY 171 | - UTRAN 172 | - GSM_AND_ECGSM_IoT 173 | - GSM_WITHOUT_ECGSM_IoT 174 | - ECGSM_IoT_ONLY 175 | - CDMA_1xRTT 176 | - CDMA_HRPD 177 | - GSM_COMPACT 178 | - type: string 179 | 180 | -------------------------------------------------------------------------------- /apis/TS29509_Nausf_UPUProtection.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | info: 3 | version: 1.2.0 4 | title: Nausf_UPUProtection Service 5 | description: | 6 | AUSF UPU Protection Service. 7 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 8 | All rights reserved. 9 | 10 | externalDocs: 11 | description: 3GPP TS 29.509 V17.6.0; 5G System; Authentication Server Services 12 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.509' 13 | 14 | servers: 15 | - url: '{apiRoot}/nausf-upuprotection/v1' 16 | variables: 17 | apiRoot: 18 | default: https://example.com 19 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. 20 | 21 | security: 22 | - {} 23 | - oAuth2ClientCredentials: 24 | - nausf-upuprotection 25 | 26 | paths: 27 | /{supi}/ue-upu: 28 | post: 29 | parameters: 30 | - name: supi 31 | in: path 32 | description: Identifier of the UE 33 | required: true 34 | schema: 35 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 36 | requestBody: 37 | content: 38 | application/json: 39 | schema: 40 | $ref: '#/components/schemas/UpuInfo' 41 | required: true 42 | responses: 43 | '200': 44 | description: UpuSecurityInfo 45 | content: 46 | application/json: 47 | schema: 48 | $ref: '#/components/schemas/UpuSecurityInfo' 49 | '503': 50 | description: Service Unavailable 51 | content: 52 | application/problem+json: 53 | schema: 54 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/ProblemDetails' 55 | '307': 56 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 57 | '308': 58 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 59 | 60 | components: 61 | securitySchemes: 62 | oAuth2ClientCredentials: 63 | type: oauth2 64 | flows: 65 | clientCredentials: 66 | tokenUrl: '{nrfApiRoot}/oauth2/token' 67 | scopes: 68 | nausf-upuprotection: Access to the Nausf_UPUProtection API 69 | 70 | schemas: 71 | 72 | # 73 | # COMPLEX TYPES: 74 | # 75 | 76 | UpuInfo: 77 | description: Contains the UE parameters update Information. 78 | type: object 79 | properties: 80 | upuDataList: 81 | type: array 82 | items: 83 | $ref: '#/components/schemas/UpuData' 84 | minItems: 1 85 | upuHeader: 86 | $ref: '#/components/schemas/UpuHeader' 87 | upuAckInd: 88 | $ref: '#/components/schemas/UpuAckInd' 89 | supportedFeatures: 90 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 91 | upuTransparentInfo: 92 | $ref: '#/components/schemas/UpuTransparentInfo' 93 | required: 94 | - upuDataList 95 | - upuAckInd 96 | 97 | UpuSecurityInfo: 98 | description: Contains the material generated for securing of UPU. It contains at least the UPU-MAC-IAUSF and CounterUPU. 99 | type: object 100 | properties: 101 | upuMacIausf: 102 | $ref: '#/components/schemas/UpuMac' 103 | counterUpu: 104 | $ref: '#/components/schemas/CounterUpu' 105 | upuXmacIue: 106 | $ref: '#/components/schemas/UpuMac' 107 | required: 108 | - upuMacIausf 109 | - counterUpu 110 | 111 | UpuData: 112 | description: Contains UE parameters update data set (e.g., the updated Routing ID Data or the Default configured NSSAI). 113 | type: object 114 | properties: 115 | secPacket: 116 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29509_Nausf_SoRProtection.yaml#/components/schemas/SecuredPacket' 117 | defaultConfNssai: 118 | type: array 119 | items: 120 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Snssai' 121 | minItems: 1 122 | routingId: 123 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29544_Nspaf_SecuredPacket.yaml#/components/schemas/RoutingId' 124 | 125 | # 126 | # SIMPLE TYPES: 127 | # 128 | 129 | UpuMac: 130 | description: MAC value for protecting UPU procedure (UPU-MAC-IAUSF and UPU-MAC-IUE). 131 | type: string 132 | pattern: '^[A-Fa-f0-9]{32}$' 133 | 134 | CounterUpu: 135 | description: CounterUPU. 136 | type: string 137 | pattern: '^[A-Fa-f0-9]{4}$' 138 | 139 | UpuAckInd: 140 | description: Contains the indication of whether the acknowledgement from UE is needed. 141 | type: boolean 142 | 143 | UpuHeader: 144 | description: Contains the "UPU Header" IE as specified in clause 9.11.3.53A of 3GPP TS 24.501 (octet 4), encoded as 2 hexadecimal characters. 145 | type: string 146 | pattern: '^[A-Fa-f0-9]{2}$' 147 | 148 | UpuTransparentInfo: 149 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Bytes' 150 | 151 | -------------------------------------------------------------------------------- /apis/TS29510_Nnrf_AccessToken.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | 3 | info: 4 | version: '1.2.1' 5 | title: 'NRF OAuth2' 6 | description: | 7 | NRF OAuth2 Authorization. 8 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 9 | All rights reserved. 10 | 11 | externalDocs: 12 | description: 3GPP TS 29.510 V17.7.0; 5G System; Network Function Repository Services; Stage 3 13 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' 14 | 15 | paths: 16 | /oauth2/token: 17 | post: 18 | summary: Access Token Request 19 | operationId: AccessTokenRequest 20 | tags: 21 | - Access Token Request 22 | parameters: 23 | - name: Content-Encoding 24 | in: header 25 | description: Content-Encoding, described in IETF RFC 7231 26 | schema: 27 | type: string 28 | - name: Accept-Encoding 29 | in: header 30 | description: Accept-Encoding, described in IETF RFC 7231 31 | schema: 32 | type: string 33 | requestBody: 34 | content: 35 | application/x-www-form-urlencoded: 36 | schema: 37 | $ref: '#/components/schemas/AccessTokenReq' 38 | encoding: 39 | requesterPlmn: 40 | contentType: application/json 41 | requesterPlmnList: 42 | contentType: application/json 43 | requesterSnssaiList: 44 | contentType: application/json 45 | requesterSnpnList: 46 | contentType: application/json 47 | targetPlmn: 48 | contentType: application/json 49 | targetSnpn: 50 | contentType: application/json 51 | targetSnssaiList: 52 | contentType: application/json 53 | targetNsiList: 54 | style: form 55 | explode: true 56 | required: true 57 | responses: 58 | '200': 59 | description: Successful Access Token Request 60 | content: 61 | application/json: 62 | schema: 63 | $ref: '#/components/schemas/AccessTokenRsp' 64 | headers: 65 | Cache-Control: 66 | $ref: '#/components/headers/cache-control' 67 | Pragma: 68 | $ref: '#/components/headers/pragma' 69 | Accept-Encoding: 70 | description: Accept-Encoding, described in IETF RFC 7694 71 | schema: 72 | type: string 73 | Content-Encoding: 74 | description: Content-Encoding, described in IETF RFC 7231 75 | schema: 76 | type: string 77 | '307': 78 | description: Temporary Redirect 79 | content: 80 | application/json: 81 | schema: 82 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/RedirectResponse' 83 | headers: 84 | Location: 85 | description: The URI pointing to the resource located on the redirect target NRF 86 | required: true 87 | schema: 88 | type: string 89 | '308': 90 | description: Permanent Redirect 91 | content: 92 | application/json: 93 | schema: 94 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/RedirectResponse' 95 | headers: 96 | Location: 97 | description: The URI pointing to the resource located on the redirect target NRF 98 | required: true 99 | schema: 100 | type: string 101 | '400': 102 | description: Error in the Access Token Request 103 | content: 104 | application/json: 105 | schema: 106 | $ref: '#/components/schemas/AccessTokenErr' 107 | application/problem+json: # error originated by an SCP or SEPP 108 | schema: 109 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/ProblemDetails' 110 | headers: 111 | Cache-Control: 112 | $ref: '#/components/headers/cache-control' 113 | Pragma: 114 | $ref: '#/components/headers/pragma' 115 | '401': 116 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 117 | '403': 118 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 119 | '404': 120 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 121 | '411': 122 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 123 | '413': 124 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 125 | '415': 126 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 127 | '429': 128 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 129 | '500': 130 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 131 | '501': 132 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/501' 133 | '503': 134 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 135 | default: 136 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 137 | 138 | components: 139 | headers: 140 | cache-control: 141 | required: true 142 | schema: 143 | type: string 144 | enum: 145 | - no-store 146 | pragma: 147 | required: true 148 | schema: 149 | type: string 150 | enum: 151 | - no-cache 152 | 153 | schemas: 154 | AccessTokenReq: 155 | description: Contains information related to the access token request 156 | type: object 157 | required: 158 | - grant_type 159 | - nfInstanceId 160 | - scope 161 | properties: 162 | grant_type: 163 | type: string 164 | enum: 165 | - client_credentials 166 | nfInstanceId: 167 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 168 | nfType: 169 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' 170 | targetNfType: 171 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' 172 | scope: 173 | type: string 174 | pattern: '^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$' 175 | targetNfInstanceId: 176 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 177 | requesterPlmn: 178 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PlmnId' 179 | requesterPlmnList: 180 | type: array 181 | items: 182 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PlmnId' 183 | minItems: 2 184 | requesterSnssaiList: 185 | type: array 186 | items: 187 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Snssai' 188 | minItems: 1 189 | requesterFqdn: 190 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Fqdn' 191 | requesterSnpnList: 192 | type: array 193 | items: 194 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' 195 | minItems: 1 196 | targetPlmn: 197 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PlmnId' 198 | targetSnpn: 199 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' 200 | targetSnssaiList: 201 | type: array 202 | items: 203 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Snssai' 204 | minItems: 1 205 | targetNsiList: 206 | type: array 207 | items: 208 | type: string 209 | minItems: 1 210 | targetNfSetId: 211 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfSetId' 212 | targetNfServiceSetId: 213 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' 214 | hnrfAccessTokenUri: 215 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Uri' 216 | sourceNfInstanceId: 217 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 218 | 219 | AccessTokenRsp: 220 | description: Contains information related to the access token response 221 | type: object 222 | required: 223 | - access_token 224 | - token_type 225 | properties: 226 | access_token: 227 | type: string 228 | description: > 229 | JWS Compact Serialized representation of JWS signed JSON object (AccessTokenClaims) 230 | token_type: 231 | type: string 232 | enum: 233 | - Bearer 234 | expires_in: 235 | type: integer 236 | scope: 237 | type: string 238 | pattern: '^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$' 239 | 240 | AccessTokenClaims: 241 | description: The claims data structure for the access token 242 | type: object 243 | required: 244 | - iss 245 | - sub 246 | - aud 247 | - scope 248 | - exp 249 | properties: 250 | iss: 251 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 252 | sub: 253 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 254 | aud: 255 | anyOf: 256 | - $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' 257 | - type: array 258 | items: 259 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 260 | minItems: 1 261 | scope: 262 | type: string 263 | pattern: '^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$' 264 | exp: 265 | type: integer 266 | consumerPlmnId: 267 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PlmnId' 268 | consumerSnpnId: 269 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' 270 | producerPlmnId: 271 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PlmnId' 272 | producerSnpnId: 273 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' 274 | producerSnssaiList: 275 | type: array 276 | items: 277 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Snssai' 278 | minItems: 1 279 | producerNsiList: 280 | type: array 281 | items: 282 | type: string 283 | minItems: 1 284 | producerNfSetId: 285 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfSetId' 286 | producerNfServiceSetId: 287 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' 288 | sourceNfInstanceId: 289 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 290 | 291 | AccessTokenErr: 292 | description: Error returned in the access token response message 293 | type: object 294 | required: 295 | - error 296 | properties: 297 | error: 298 | type: string 299 | enum: 300 | - invalid_request 301 | - invalid_client 302 | - invalid_grant 303 | - unauthorized_client 304 | - unsupported_grant_type 305 | - invalid_scope 306 | error_description: 307 | type: string 308 | error_uri: 309 | type: string 310 | -------------------------------------------------------------------------------- /apis/TS29510_Nnrf_Bootstrapping.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | 3 | info: 4 | version: '1.1.0' 5 | title: 'NRF Bootstrapping' 6 | description: | 7 | NRF Bootstrapping. 8 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 9 | All rights reserved. 10 | 11 | externalDocs: 12 | description: 3GPP TS 29.510 V17.6.0; 5G System; Network Function Repository Services; Stage 3 13 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' 14 | 15 | paths: 16 | /bootstrapping: 17 | get: 18 | summary: Bootstrapping Info Request 19 | operationId: BootstrappingInfoRequest 20 | tags: 21 | - Bootstrapping Request 22 | parameters: 23 | - name: If-None-Match 24 | in: header 25 | description: Validator for conditional requests, as described in IETF RFC 7232, 3.2 26 | schema: 27 | type: string 28 | responses: 29 | '200': 30 | description: Successful Bootstrapping Request 31 | content: 32 | application/3gppHal+json: 33 | schema: 34 | $ref: '#/components/schemas/BootstrappingInfo' 35 | headers: 36 | Cache-Control: 37 | description: Cache-Control containing max-age, described in IETF RFC 7234, 5.2 38 | schema: 39 | type: string 40 | ETag: 41 | description: Entity Tag containing a strong validator, described in IETF RFC 7232, 2.3 42 | schema: 43 | type: string 44 | '307': 45 | description: Temporary Redirect 46 | content: 47 | application/json: 48 | schema: 49 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/RedirectResponse' 50 | headers: 51 | Location: 52 | description: The URI pointing to the resource located on the redirect target NRF 53 | required: true 54 | schema: 55 | type: string 56 | '308': 57 | description: Permanent Redirect 58 | content: 59 | application/json: 60 | schema: 61 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/RedirectResponse' 62 | headers: 63 | Location: 64 | description: The URI pointing to the resource located on the redirect target NRF 65 | required: true 66 | schema: 67 | type: string 68 | '400': 69 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 70 | '500': 71 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 72 | default: 73 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 74 | 75 | components: 76 | schemas: 77 | BootstrappingInfo: 78 | description: Information returned by NRF in the bootstrapping response message 79 | type: object 80 | required: 81 | - _links 82 | properties: 83 | status: 84 | $ref: '#/components/schemas/Status' 85 | _links: 86 | type: object 87 | description: > 88 | Map of link objects where the keys are the link relations defined in 89 | 3GPP TS 29.510 clause 6.4.6.3.3 90 | additionalProperties: 91 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' 92 | minProperties: 1 93 | nrfFeatures: 94 | type: object 95 | description: > 96 | Map of features supported by the NRF, where the keys are the NRF services 97 | as defined in 3GPP TS 29.510 clause 6.1.6.3.11 98 | additionalProperties: 99 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 100 | minProperties: 1 101 | oauth2Required: 102 | type: object 103 | description: > 104 | Map indicating whether the NRF requires Oauth2-based authorization for accessing 105 | its services. The key of the map shall be the name of an NRF service, 106 | e.g. "nnrf-nfm" or "nnrf-disc" 107 | additionalProperties: 108 | type: boolean 109 | minProperties: 1 110 | nrfSetId: 111 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfSetId' 112 | nrfInstanceId: 113 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 114 | 115 | Status: 116 | description: Overal status of the NRF 117 | anyOf: 118 | - type: string 119 | enum: 120 | - OPERATIVE 121 | - NON_OPERATIVE 122 | - type: string 123 | -------------------------------------------------------------------------------- /apis/TS29518_Namf_MBSCommunication.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | 3 | info: 4 | version: 1.0.1 5 | title: Namf_MBSCommunication 6 | description: | 7 | AMF Communication Service for MBS. 8 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 9 | All rights reserved. 10 | 11 | externalDocs: 12 | description: 3GPP TS 29.518 V17.8.0; 5G System; Access and Mobility Management Services 13 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' 14 | 15 | servers: 16 | - url: '{apiRoot}/namf-mbs-comm/v1' 17 | variables: 18 | apiRoot: 19 | default: https://example.com 20 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 21 | 22 | security: 23 | - {} 24 | - oAuth2ClientCredentials: 25 | - namf-mbs-comm 26 | 27 | paths: 28 | /n2-messages/transfer: 29 | post: 30 | summary: Namf_MBSCommunication N2 Message Transfer service Operation 31 | tags: 32 | - N2Messages Handler (custom operation) 33 | operationId: N2MessageTransfer 34 | requestBody: 35 | content: 36 | multipart/related: # message with binary body part(s) 37 | schema: 38 | type: object 39 | properties: # Request parts 40 | jsonData: 41 | $ref: '#/components/schemas/MbsN2MessageTransferReqData' 42 | binaryDataN2Information: 43 | type: string 44 | format: binary 45 | encoding: 46 | jsonData: 47 | contentType: application/json 48 | binaryDataN2Information: 49 | contentType: application/vnd.3gpp.ngap 50 | headers: 51 | Content-Id: 52 | schema: 53 | type: string 54 | required: true 55 | responses: 56 | '200': 57 | description: MBS N2 Message Transfer successfully initiated 58 | content: 59 | application/json: 60 | schema: 61 | $ref: '#/components/schemas/MbsN2MessageTransferRspData' 62 | '307': 63 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 64 | '308': 65 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 66 | '400': 67 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 68 | '403': 69 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 70 | '404': 71 | description: Not Found 72 | content: 73 | application/problem+json: 74 | schema: 75 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/ProblemDetails' 76 | '411': 77 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 78 | '413': 79 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 80 | '415': 81 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 82 | '429': 83 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 84 | '500': 85 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 86 | '503': 87 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 88 | default: 89 | description: Unexpected error 90 | 91 | components: 92 | securitySchemes: 93 | oAuth2ClientCredentials: 94 | type: oauth2 95 | flows: 96 | clientCredentials: 97 | tokenUrl: '{nrfApiRoot}/oauth2/token' 98 | scopes: 99 | namf-mbs-comm: Access to the Namf_MBSCommunication API 100 | 101 | schemas: 102 | 103 | # 104 | # STRUCTURED DATA TYPES 105 | # 106 | 107 | MbsN2MessageTransferReqData: 108 | description: Data within MBS N2 Message Transfer Request 109 | type: object 110 | properties: 111 | mbsSessionId: 112 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/MbsSessionId' 113 | areaSessionId: 114 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/AreaSessionId' 115 | n2MbsSmInfo: 116 | $ref: '#/components/schemas/N2MbsSmInfo' 117 | supportedFeatures: 118 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 119 | required: 120 | - mbsSessionId 121 | - n2MbsSmInfo 122 | 123 | 124 | 125 | MbsN2MessageTransferRspData: 126 | description: Data within MBS N2 Message Transfer Response 127 | type: object 128 | properties: 129 | result: 130 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29518_Namf_Communication.yaml#/components/schemas/N2InformationTransferResult' 131 | supportedFeatures: 132 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 133 | required: 134 | - result 135 | 136 | 137 | 138 | 139 | N2MbsSmInfo: 140 | description: N2 MBS Session Management information 141 | type: object 142 | properties: 143 | ngapIeType: 144 | $ref: '#/components/schemas/MbsNgapIeType' 145 | ngapData: 146 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' 147 | required: 148 | - ngapIeType 149 | - ngapData 150 | 151 | # 152 | # SIMPLE DATA TYPES 153 | # 154 | 155 | 156 | # 157 | # ENUMERATIONS 158 | # 159 | 160 | MbsNgapIeType: 161 | description: NGAP Information Element Type 162 | anyOf: 163 | - type: string 164 | enum: 165 | - MBS_SES_ACT_REQ 166 | - MBS_SES_DEACT_REQ 167 | - MBS_SES_UPD_REQ 168 | - type: string 169 | -------------------------------------------------------------------------------- /apis/TS29518_Namf_MT.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | 3 | info: 4 | version: 1.2.2 5 | title: Namf_MT 6 | description: | 7 | AMF Mobile Terminated Service. 8 | © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 9 | All rights reserved. 10 | 11 | security: 12 | - {} 13 | - oAuth2ClientCredentials: 14 | - namf-mt 15 | 16 | externalDocs: 17 | description: 3GPP TS 29.518 V17.9.0; 5G System; Access and Mobility Management Services 18 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/' 19 | 20 | servers: 21 | - url: '{apiRoot}/namf-mt/v1' 22 | variables: 23 | apiRoot: 24 | default: https://example.com 25 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 26 | 27 | paths: 28 | '/ue-contexts/{ueContextId}': 29 | get: 30 | summary: Namf_MT Provide Domain Selection Info service Operation 31 | tags: 32 | - ueContext (Document) 33 | operationId: Provide Domain Selection Info 34 | parameters: 35 | - name: ueContextId 36 | in: path 37 | description: UE Context Identifier 38 | required: true 39 | schema: 40 | type: string 41 | pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|.+)$' 42 | - name: info-class 43 | in: query 44 | description: UE Context Information Class 45 | schema: 46 | $ref: '#/components/schemas/UeContextInfoClass' 47 | - name: supported-features 48 | in: query 49 | description: Supported Features 50 | schema: 51 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 52 | - name: old-guami 53 | in: query 54 | description: Old GUAMI 55 | content: 56 | application/json: 57 | schema: 58 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Guami' 59 | responses: 60 | '200': 61 | description: Requested UE Context Information returned 62 | content: 63 | application/json: 64 | schema: 65 | $ref: '#/components/schemas/UeContextInfo' 66 | '307': 67 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 68 | '308': 69 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 70 | '400': 71 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 72 | '403': 73 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 74 | '404': 75 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 76 | '409': 77 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/409' 78 | '414': 79 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/414' 80 | '429': 81 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 82 | '500': 83 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 84 | '503': 85 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 86 | default: 87 | description: Unexpected error 88 | /ue-contexts/{ueContextId}/ue-reachind: 89 | put: 90 | summary: Namf_MT EnableUEReachability service Operation 91 | tags: 92 | - ueReachInd (Document) 93 | operationId: EnableUeReachability 94 | parameters: 95 | - name: ueContextId 96 | in: path 97 | description: UE Context Identifier 98 | required: true 99 | schema: 100 | type: string 101 | requestBody: 102 | content: 103 | application/json: 104 | schema: 105 | $ref: '#/components/schemas/EnableUeReachabilityReqData' 106 | required: true 107 | responses: 108 | '200': 109 | description: UE has become reachable as desired 110 | content: 111 | application/json: 112 | schema: 113 | $ref: '#/components/schemas/EnableUeReachabilityRspData' 114 | '307': 115 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 116 | '308': 117 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 118 | '400': 119 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 120 | '403': 121 | description: Forbidden 122 | content: 123 | application/problem+json: 124 | schema: 125 | $ref: '#/components/schemas/ProblemDetailsEnableUeReachability' 126 | '404': 127 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 128 | '409': 129 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/409' 130 | '411': 131 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 132 | '413': 133 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 134 | '415': 135 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 136 | '429': 137 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 138 | '500': 139 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 140 | '503': 141 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 142 | '504': 143 | description: Gateway Timeout 144 | content: 145 | application/problem+json: 146 | schema: 147 | $ref: '#/components/schemas/ProblemDetailsEnableUeReachability' 148 | default: 149 | description: Unexpected error 150 | 151 | /ue-contexts/enable-group-reachability: 152 | post: 153 | summary: Namf_MT EnableGroupReachability service Operation 154 | tags: 155 | - ueContexts (collection) 156 | operationId: EnableGroupReachability 157 | requestBody: 158 | description: list of UEs requested to be made reachable for the related TMGI 159 | content: 160 | application/json: 161 | schema: 162 | $ref: '#/components/schemas/EnableGroupReachabilityReqData' 163 | required: true 164 | responses: 165 | '200': 166 | description: Successful response. 167 | content: 168 | application/json: 169 | schema: 170 | $ref: '#/components/schemas/EnableGroupReachabilityRspData' 171 | '307': 172 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 173 | '308': 174 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 175 | '400': 176 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 177 | '403': 178 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 179 | '404': 180 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 181 | '411': 182 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 183 | '413': 184 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 185 | '415': 186 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 187 | '429': 188 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 189 | '500': 190 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 191 | '503': 192 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 193 | '504': 194 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/504' 195 | default: 196 | description: Unexpected error 197 | callbacks: 198 | reachabilityNotification: 199 | '{request.body#/reachabilityNotifyUri}': 200 | post: 201 | requestBody: 202 | required: true 203 | content: 204 | application/json: 205 | schema: 206 | $ref: '#/components/schemas/ReachabilityNotificationData' 207 | responses: 208 | '204': 209 | description: UE reachability notification response 210 | '307': 211 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 212 | '308': 213 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 214 | '400': 215 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 216 | '403': 217 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 218 | '404': 219 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 220 | '411': 221 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 222 | '413': 223 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 224 | '415': 225 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 226 | '429': 227 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 228 | '500': 229 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 230 | '503': 231 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 232 | default: 233 | description: Unexpected error 234 | 235 | components: 236 | securitySchemes: 237 | oAuth2ClientCredentials: 238 | type: oauth2 239 | flows: 240 | clientCredentials: 241 | tokenUrl: '{nrfApiRoot}/oauth2/token' 242 | scopes: 243 | namf-mt: Access to the Namf_MT API 244 | schemas: 245 | EnableUeReachabilityReqData: 246 | description: Data within the Enable UE Reachability Request 247 | type: object 248 | properties: 249 | reachability: 250 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability' 251 | supportedFeatures: 252 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 253 | oldGuami: 254 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Guami' 255 | extBufSupport: 256 | type: boolean 257 | default: false 258 | required: 259 | - reachability 260 | EnableUeReachabilityRspData: 261 | description: Data within the Enable UE Reachability Response 262 | type: object 263 | properties: 264 | reachability: 265 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability' 266 | supportedFeatures: 267 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 268 | required: 269 | - reachability 270 | UeContextInfo: 271 | description: UE Context Information 272 | type: object 273 | properties: 274 | supportVoPS: 275 | type: boolean 276 | supportVoPSn3gpp: 277 | type: boolean 278 | lastActTime: 279 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/DateTime' 280 | accessType: 281 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/AccessType' 282 | ratType: 283 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/RatType' 284 | supportedFeatures: 285 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 286 | ProblemDetailsEnableUeReachability: 287 | description: Enable UE Reachability Error Detail 288 | allOf: 289 | - $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/ProblemDetails' 290 | - $ref: '#/components/schemas/AdditionInfoEnableUeReachability' 291 | AdditionInfoEnableUeReachability: 292 | description: Additional information to be returned in EnableUeReachability error response 293 | type: object 294 | properties: 295 | maxWaitingTime: 296 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/DurationSec' 297 | EnableGroupReachabilityReqData: 298 | description: Data within the Enable Group Reachability Request 299 | type: object 300 | properties: 301 | ueInfoList: 302 | type: array 303 | items: 304 | $ref: '#/components/schemas/UeInfo' 305 | minItems: 1 306 | tmgi: 307 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Tmgi' 308 | reachabilityNotifyUri: 309 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Uri' 310 | mbsServiceAreaInfoList: 311 | type: array 312 | items: 313 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' 314 | minItems: 1 315 | arp: 316 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Arp' 317 | 5qi: 318 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/5Qi' 319 | supportedFeatures: 320 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 321 | required: 322 | - ueInfoList 323 | - tmgi 324 | EnableGroupReachabilityRspData: 325 | description: Data within the Enable Group Reachability Response 326 | type: object 327 | properties: 328 | ueConnectedList: 329 | type: array 330 | items: 331 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 332 | minItems: 1 333 | supportedFeatures: 334 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 335 | 336 | UeInfo: 337 | description: list of UEs requested to be made reachable for the MBS Session 338 | type: object 339 | properties: 340 | ueList: 341 | type: array 342 | items: 343 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 344 | minItems: 1 345 | pduSessionId: 346 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/PduSessionId' 347 | required: 348 | - ueList 349 | 350 | ReachabilityNotificationData: 351 | description: Data within the UE Reachability Info Notify 352 | type: object 353 | properties: 354 | reachableUeList: 355 | type: array 356 | items: 357 | $ref: '#/components/schemas/ReachableUeInfo' 358 | minItems: 1 359 | unreachableUeList: 360 | type: array 361 | items: 362 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 363 | minItems: 1 364 | ReachableUeInfo: 365 | description: Contains the reachable UE Information 366 | type: object 367 | properties: 368 | ueList: 369 | type: array 370 | items: 371 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 372 | minItems: 1 373 | userLocation: 374 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/UserLocation' 375 | required: 376 | - ueList 377 | 378 | UeContextInfoClass: 379 | description: Indicates the UE Context information class 380 | anyOf: 381 | - type: string 382 | enum: 383 | - TADS 384 | - type: string 385 | -------------------------------------------------------------------------------- /apis/TS29520_Nnwdaf_DataManagement.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | info: 3 | title: Nnwdaf_DataManagement 4 | version: 1.0.2 5 | description: | 6 | Nnwdaf_DataManagement API Service. 7 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 8 | All rights reserved. 9 | externalDocs: 10 | description: 3GPP TS 29.520 V17.9.0; 5G System; Network Data Analytics Services. 11 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/' 12 | servers: 13 | - url: '{apiRoot}/nnwdaf-datamanagement/v1' 14 | variables: 15 | apiRoot: 16 | default: https://example.com 17 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 18 | security: 19 | - {} 20 | - oAuth2ClientCredentials: 21 | - nnwdaf-datamanagement 22 | paths: 23 | /subscriptions: 24 | post: 25 | summary: subscribe to notifications 26 | operationId: CreateIndividualSubcription 27 | tags: 28 | - Subscriptions (Collection) 29 | requestBody: 30 | required: true 31 | content: 32 | application/json: 33 | schema: 34 | $ref: '#/components/schemas/NnwdafDataManagementSubsc' 35 | responses: 36 | '201': 37 | description: Success 38 | content: 39 | application/json: 40 | schema: 41 | $ref: '#/components/schemas/NnwdafDataManagementSubsc' 42 | headers: 43 | Location: 44 | description: > 45 | Contains the URI of the newly created resource, according to the structure 46 | {apiRoot}/nnwdaf-datamanagement//subscriptions/{subId}. 47 | required: true 48 | schema: 49 | type: string 50 | '400': 51 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 52 | '401': 53 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 54 | '403': 55 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 56 | '404': 57 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 58 | '411': 59 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 60 | '413': 61 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 62 | '415': 63 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 64 | '429': 65 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 66 | '500': 67 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 68 | '503': 69 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 70 | default: 71 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 72 | callbacks: 73 | myNotification: 74 | '{$request.body#/notificURI}': 75 | post: 76 | requestBody: 77 | required: true 78 | content: 79 | application/json: 80 | schema: 81 | $ref: '#/components/schemas/NnwdafDataManagementNotif' 82 | responses: 83 | '204': 84 | description: No Content, Notification was succesfull 85 | '307': 86 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 87 | '308': 88 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 89 | '400': 90 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 91 | '401': 92 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 93 | '403': 94 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 95 | '404': 96 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 97 | '411': 98 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 99 | '413': 100 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 101 | '415': 102 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 103 | '429': 104 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 105 | '500': 106 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 107 | '503': 108 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 109 | default: 110 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 111 | callbacks: 112 | Fetch: 113 | '{request.body#/fetchInstruct/fetchUri}': 114 | post: 115 | requestBody: 116 | required: true 117 | content: 118 | application/json: 119 | schema: 120 | type: array 121 | items: 122 | type: string 123 | minItems: 1 124 | description: Indicate the fetch correlation identifier. 125 | responses: 126 | '200': 127 | description: Expected response to a valid request 128 | content: 129 | application/json: 130 | schema: 131 | $ref: '#/components/schemas/NnwdafDataManagementNotif' 132 | '307': 133 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 134 | '308': 135 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 136 | '400': 137 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 138 | '401': 139 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 140 | '403': 141 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 142 | '404': 143 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 144 | '406': 145 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/406' 146 | '411': 147 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 148 | '413': 149 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 150 | '415': 151 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 152 | '429': 153 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 154 | '500': 155 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 156 | '503': 157 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 158 | default: 159 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 160 | /subscriptions/{subscriptionId}: 161 | put: 162 | summary: Update an existing Individual NWDAF Data Subscription. 163 | operationId: UpdateNWDAFDataSubscription 164 | tags: 165 | - Individual NWDAF Data Management Subscription (Document) 166 | requestBody: 167 | required: true 168 | content: 169 | application/json: 170 | schema: 171 | $ref: '#/components/schemas/NnwdafDataManagementSubsc' 172 | parameters: 173 | - name: subscriptionId 174 | in: path 175 | description: Event Subscription ID 176 | required: true 177 | schema: 178 | type: string 179 | responses: 180 | '200': 181 | description: OK. Resource was succesfully modified and representation is returned 182 | content: 183 | application/json: 184 | schema: 185 | $ref: '#/components/schemas/NnwdafDataManagementSubsc' 186 | '204': 187 | description: No Content. Resource was succesfully modified 188 | '307': 189 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 190 | '308': 191 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 192 | '400': 193 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 194 | '401': 195 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 196 | '403': 197 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 198 | '404': 199 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 200 | '411': 201 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 202 | '413': 203 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 204 | '415': 205 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 206 | '429': 207 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 208 | '500': 209 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 210 | '503': 211 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 212 | default: 213 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 214 | delete: 215 | summary: unsubscribe from notifications 216 | operationId: DeleteNWDAFDataSubscription 217 | tags: 218 | - Individual NWDAF Data Management Subscription (Document) 219 | parameters: 220 | - name: subscriptionId 221 | in: path 222 | description: Event Subscription ID 223 | required: true 224 | schema: 225 | type: string 226 | responses: 227 | '204': 228 | description: No Content. Resource was succesfully deleted 229 | '307': 230 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 231 | '308': 232 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 233 | '400': 234 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 235 | '401': 236 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 237 | '403': 238 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 239 | '404': 240 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 241 | '429': 242 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 243 | '500': 244 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 245 | '503': 246 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 247 | default: 248 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 249 | components: 250 | securitySchemes: 251 | oAuth2ClientCredentials: 252 | type: oauth2 253 | flows: 254 | clientCredentials: 255 | tokenUrl: '{nrfApiRoot}/oauth2/token' 256 | scopes: 257 | nnwdaf-datamanagement: Access to the Nnwdaf_DataManagement API 258 | schemas: 259 | NnwdafDataManagementSubsc: 260 | description: Represents an Individual NWDAF Data Management Subscription resource. 261 | type: object 262 | properties: 263 | adrfId: 264 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 265 | adrfSetId: 266 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfSetId' 267 | anaSub: 268 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' 269 | dataCollectPurposes: 270 | type: array 271 | items: 272 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29574_Ndccf_DataManagement.yaml#/components/schemas/DataCollectionPurpose' 273 | minItems: 1 274 | description: > 275 | The purposes of data collection. This attribute may only be provided if user consent 276 | is reqiured depending on local policy and regulations and the consumer has 277 | not checked user consent. 278 | dataSub: 279 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSubscription' 280 | formatInstruct: 281 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29574_Ndccf_DataManagement.yaml#/components/schemas/FormattingInstruction' 282 | notifCorrId: 283 | type: string 284 | notificURI: 285 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Uri' 286 | procInstruct: 287 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29574_Ndccf_DataManagement.yaml#/components/schemas/ProcessingInstruction' 288 | suppFeat: 289 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 290 | targetNfId: 291 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 292 | targetNfSetId: 293 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/NfSetId' 294 | timePeriod: 295 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/TimeWindow' 296 | required: 297 | - notifCorrId 298 | - notificURI 299 | oneOf: 300 | - required: [anaSub] 301 | - required: [dataSub] 302 | NnwdafDataManagementNotif: 303 | description: Represents an Individual Notification. 304 | type: object 305 | properties: 306 | dataNotification: 307 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataNotification' 308 | dataReports: 309 | type: array 310 | items: 311 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29574_Ndccf_DataManagement.yaml#/components/schemas/NotifSummaryReport' 312 | minItems: 1 313 | description: List of summary reports of processed notifications. 314 | notifCorrId: 315 | type: string 316 | description: Notification correlation identifier. 317 | terminationReq: 318 | type: string 319 | description: > 320 | It indicates that the termination of the data management subscription 321 | is requested by the NWDAF. 322 | fetchInstruct: 323 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29576_Nmfaf_3caDataManagement.yaml#/components/schemas/FetchInstruction' 324 | notifTimestamp: 325 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/DateTime' 326 | required: 327 | - notifCorrId 328 | - notifTimestamp 329 | oneOf: 330 | - required: [dataNotification] 331 | - required: [dataReports] 332 | - required: [fetchInstruct] 333 | 334 | -------------------------------------------------------------------------------- /apis/TS29520_Nnwdaf_MLModelProvision.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | info: 3 | title: Nnwdaf_MLModelProvision 4 | version: 1.0.0 5 | description: | 6 | Nnwdaf_MLModelProvision API Service. 7 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 8 | All rights reserved. 9 | externalDocs: 10 | description: 3GPP TS 29.520 V17.7.0; 5G System; Network Data Analytics Services. 11 | url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ 12 | servers: 13 | - url: '{apiRoot}/nnwdaf-mlmodelprovision/v1' 14 | variables: 15 | apiRoot: 16 | default: https://example.com 17 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 18 | security: 19 | - {} 20 | - oAuth2ClientCredentials: 21 | - nnwdaf-mlmodelprovision 22 | paths: 23 | /subscriptions: 24 | post: 25 | summary: Create a new Individual NWDAF ML Model Provision Subscription resource. 26 | operationId: CreateNWDAFMLModelProvisionSubcription 27 | tags: 28 | - Subscriptions (Collection) 29 | requestBody: 30 | required: true 31 | content: 32 | application/json: 33 | schema: 34 | $ref: '#/components/schemas/NwdafMLModelProvSubsc' 35 | responses: 36 | '201': 37 | description: Create a new Individual NWDAF ML Model Provision Subscription resource. 38 | content: 39 | application/json: 40 | schema: 41 | $ref: '#/components/schemas/NwdafMLModelProvSubsc' 42 | headers: 43 | Location: 44 | description: > 45 | Contains the URI of the newly created resource, according to the structure 46 | {apiRoot}/nnwdaf-mlmodelprovision/v1/subscriptions/{subscriptionId}. 47 | required: true 48 | schema: 49 | type: string 50 | '400': 51 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 52 | '401': 53 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 54 | '403': 55 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 56 | '404': 57 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 58 | '411': 59 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 60 | '413': 61 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 62 | '415': 63 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 64 | '429': 65 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 66 | '500': 67 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 68 | '503': 69 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 70 | default: 71 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 72 | callbacks: 73 | myNotification: 74 | '{$request.body#/notifUri}': 75 | post: 76 | requestBody: 77 | required: true 78 | content: 79 | application/json: 80 | schema: 81 | type: array 82 | items: 83 | $ref: '#/components/schemas/NwdafMLModelProvNotif' 84 | minItems: 1 85 | responses: 86 | '204': 87 | description: No Content, Notification was succesfull 88 | '307': 89 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 90 | '308': 91 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 92 | '400': 93 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 94 | '401': 95 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 96 | '403': 97 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 98 | '404': 99 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 100 | '411': 101 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 102 | '413': 103 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 104 | '415': 105 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 106 | '429': 107 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 108 | '500': 109 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 110 | '503': 111 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 112 | default: 113 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 114 | /subscriptions/{subscriptionId}: 115 | put: 116 | summary: update an existing Individual NWDAF ML Model Provision Subscription 117 | operationId: UpdateNWDAFMLModelProvisionSubcription 118 | tags: 119 | - Individual NWDAF ML Model Provision Subscription (Document) 120 | requestBody: 121 | required: true 122 | content: 123 | application/json: 124 | schema: 125 | $ref: '#/components/schemas/NwdafMLModelProvSubsc' 126 | parameters: 127 | - name: subscriptionId 128 | in: path 129 | description: String identifying a subscription to the Nnwdaf_MLModelProvision Service. 130 | required: true 131 | schema: 132 | type: string 133 | responses: 134 | '200': 135 | description: > 136 | The Individual NWDAF ML Model Provision Subscription resource was modified successfully 137 | and a representation of that resource is returned. 138 | content: 139 | application/json: 140 | schema: 141 | $ref: '#/components/schemas/NwdafMLModelProvSubsc' 142 | '204': 143 | description: > 144 | The Individual NWDAF ML Model Provision Subscription resource was modified successfully. 145 | '307': 146 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 147 | '308': 148 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 149 | '400': 150 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 151 | '401': 152 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 153 | '403': 154 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 155 | '404': 156 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 157 | '411': 158 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 159 | '413': 160 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 161 | '415': 162 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 163 | '429': 164 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 165 | '500': 166 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 167 | '503': 168 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 169 | default: 170 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 171 | delete: 172 | summary: Delete an existing Individual NWDAF ML Model Provision Subscription. 173 | operationId: DeleteNWDAFMLModelProvisionSubcription 174 | tags: 175 | - Individual NWDAF ML Model Provision Subscription (Document) 176 | parameters: 177 | - name: subscriptionId 178 | in: path 179 | description: String identifying a subscription to the Nnwdaf_MLModelProvision Service. 180 | required: true 181 | schema: 182 | type: string 183 | responses: 184 | '204': 185 | description: > 186 | No Content. The Individual NWDAF ML Model Provision Subscription matching the 187 | subscriptionId was deleted. 188 | '307': 189 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 190 | '308': 191 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 192 | '400': 193 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 194 | '401': 195 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 196 | '403': 197 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 198 | '404': 199 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 200 | '429': 201 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 202 | '500': 203 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 204 | '503': 205 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 206 | default: 207 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 208 | components: 209 | securitySchemes: 210 | oAuth2ClientCredentials: 211 | type: oauth2 212 | flows: 213 | clientCredentials: 214 | tokenUrl: '{nrfApiRoot}/oauth2/token' 215 | scopes: 216 | nnwdaf-mlmodelprovision: Access to the Nnwdaf_MLModelProvision API 217 | schemas: 218 | NwdafMLModelProvSubsc: 219 | description: Represents NWDAF Event Subscription resources. 220 | type: object 221 | properties: 222 | mLEventSubscs: 223 | type: array 224 | items: 225 | $ref: '#/components/schemas/MLEventSubscription' 226 | minItems: 1 227 | description: Subscribed events 228 | notifUri: 229 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Uri' 230 | mLEventNotifs: 231 | type: array 232 | items: 233 | $ref: '#/components/schemas/MLEventNotif' 234 | minItems: 1 235 | suppFeats: 236 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 237 | notifCorreId: 238 | type: string 239 | eventReq: 240 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' 241 | failEventReports: 242 | type: array 243 | items: 244 | $ref: '#/components/schemas/FailureEventInfoForMLModel' 245 | minItems: 1 246 | required: 247 | - mLEventSubscs 248 | - notifUri 249 | MLEventSubscription: 250 | description: Represents a subscription to a single event. 251 | type: object 252 | properties: 253 | mLEvent: 254 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' 255 | mLEventFilter: 256 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventFilter' 257 | tgtUe: 258 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TargetUeInformation' 259 | mLTargetPeriod: 260 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/TimeWindow' 261 | expiryTime: 262 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/DateTime' 263 | required: 264 | - mLEvent 265 | - mLEventFilter 266 | NwdafMLModelProvNotif: 267 | description: Represents notifications on events that occurred. 268 | type: object 269 | properties: 270 | eventNotifs: 271 | type: array 272 | items: 273 | $ref: '#/components/schemas/MLEventNotif' 274 | minItems: 1 275 | description: Notifications about Individual Events. 276 | subscriptionId: 277 | type: string 278 | description: String identifying a subscription to the Nnwdaf_MLModelProvision Service. 279 | required: 280 | - eventNotifs 281 | - subscriptionId 282 | MLEventNotif: 283 | description: Represents a notification related to a single event that occurred. 284 | type: object 285 | properties: 286 | event: 287 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' 288 | notifCorreId: 289 | type: string 290 | mLFileAddr: 291 | $ref: '#/components/schemas/MLModelAddr' 292 | validityPeriod: 293 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29122_CommonData.yaml#/components/schemas/TimeWindow' 294 | spatialValidity: 295 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' 296 | required: 297 | - event 298 | - mLFileAddr 299 | FailureEventInfoForMLModel: 300 | description: > 301 | Represents the event(s) that the subscription is not successful including the failure 302 | reason(s). 303 | type: object 304 | properties: 305 | event: 306 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' 307 | failureCode: 308 | $ref: '#/components/schemas/FailureCode' 309 | required: 310 | - event 311 | - failureCode 312 | 313 | MLModelAddr: 314 | description: Addresses of ML model files. 315 | type: object 316 | properties: 317 | mLModelUrl: 318 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Uri' 319 | mlFileFqdn: 320 | type: string 321 | description: The FQDN of the ML Model file. 322 | oneOf: 323 | - required: [mLModelUrl] 324 | - required: [mlFileFqdn] 325 | 326 | # 327 | # ENUMERATIONS DATA TYPES 328 | # 329 | FailureCode: 330 | anyOf: 331 | - type: string 332 | enum: 333 | - UNAVAILABLE_ML_MODEL 334 | - type: string 335 | description: > 336 | This string provides forward-compatibility with future extensions to the enumeration but 337 | is not used to encode content defined in the present version of this API. 338 | description: > 339 | Possible values are 340 | - UNAVAILABLE_ML_MODEL: Indicates the requested ML model for the event is unavailable. 341 | -------------------------------------------------------------------------------- /apis/TS29594_Nchf_SpendingLimitControl.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | info: 3 | version: 1.2.0 4 | title: Nchf_SpendingLimitControl 5 | description: | 6 | Nchf Spending Limit Control Service. 7 | © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). 8 | All rights reserved. 9 | externalDocs: 10 | description: 3GPP TS 29.594 V17.4.0; 5G System; Spending Limit Control Service. 11 | url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.594/' 12 | servers: 13 | - url: '{apiRoot}/nchf-spendinglimitcontrol/v1' 14 | variables: 15 | apiRoot: 16 | default: https://example.com 17 | description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 18 | security: 19 | - {} 20 | - oAuth2ClientCredentials: 21 | - nchf-spendinglimitcontrol 22 | paths: 23 | /subscriptions: 24 | post: 25 | requestBody: 26 | required: true 27 | content: 28 | application/json: 29 | schema: 30 | $ref: '#/components/schemas/SpendingLimitContext' 31 | responses: 32 | '201': 33 | description: Success 34 | content: 35 | application/json: 36 | schema: 37 | $ref: '#/components/schemas/SpendingLimitStatus' 38 | headers: 39 | Location: 40 | description: > 41 | Contains the URI of the created individual spending limit resource, 42 | according to the structure 43 | {apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId} 44 | required: true 45 | schema: 46 | type: string 47 | '400': 48 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 49 | '401': 50 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 51 | '403': 52 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 53 | '404': 54 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 55 | '411': 56 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 57 | '413': 58 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 59 | '415': 60 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 61 | '429': 62 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 63 | '500': 64 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 65 | '503': 66 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 67 | default: 68 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 69 | callbacks: 70 | statusNotification: 71 | '{$request.body#/notifUri}/notify': 72 | post: 73 | requestBody: 74 | required: true 75 | content: 76 | application/json: 77 | schema: 78 | $ref: '#/components/schemas/SpendingLimitStatus' 79 | responses: 80 | '204': 81 | description: No Content, Notification was succesfull 82 | '307': 83 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 84 | '308': 85 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 86 | '400': 87 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 88 | '401': 89 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 90 | '403': 91 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 92 | '404': 93 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 94 | '411': 95 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 96 | '413': 97 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 98 | '415': 99 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 100 | '429': 101 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 102 | '500': 103 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 104 | '503': 105 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 106 | default: 107 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 108 | subscriptionTermination: 109 | '{$request.body#/notifUri}/terminate': 110 | post: 111 | requestBody: 112 | required: true 113 | content: 114 | application/json: 115 | schema: 116 | $ref: '#/components/schemas/SubscriptionTerminationInfo' 117 | responses: 118 | '204': 119 | description: No Content, Notification was succesfull 120 | '307': 121 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 122 | '308': 123 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 124 | '400': 125 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 126 | '401': 127 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 128 | '403': 129 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 130 | '404': 131 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 132 | '411': 133 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 134 | '413': 135 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 136 | '415': 137 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 138 | '429': 139 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 140 | '500': 141 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 142 | '503': 143 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 144 | default: 145 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 146 | /subscriptions/{subscriptionId}: 147 | parameters: 148 | - in: path 149 | name: subscriptionId 150 | description: Identifies an individual spending limit retrieval subscription. 151 | required: true 152 | schema: 153 | type: string 154 | put: 155 | requestBody: 156 | required: true 157 | content: 158 | application/json: 159 | schema: 160 | $ref: '#/components/schemas/SpendingLimitContext' 161 | responses: 162 | '200': 163 | description: OK. Resource was succesfully modified and representation is returned 164 | content: 165 | application/json: 166 | schema: 167 | $ref: '#/components/schemas/SpendingLimitStatus' 168 | '307': 169 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 170 | '308': 171 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 172 | '400': 173 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 174 | '401': 175 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 176 | '403': 177 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 178 | '404': 179 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 180 | '411': 181 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/411' 182 | '413': 183 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/413' 184 | '415': 185 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/415' 186 | '429': 187 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 188 | '500': 189 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 190 | '503': 191 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 192 | default: 193 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 194 | delete: 195 | responses: 196 | '204': 197 | description: No Content. Resource was succesfully deleted 198 | '307': 199 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/307' 200 | '308': 201 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/308' 202 | '400': 203 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/400' 204 | '401': 205 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/401' 206 | '403': 207 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/403' 208 | '404': 209 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/404' 210 | '429': 211 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/429' 212 | '500': 213 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/500' 214 | '503': 215 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/503' 216 | default: 217 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/responses/default' 218 | components: 219 | securitySchemes: 220 | oAuth2ClientCredentials: 221 | type: oauth2 222 | flows: 223 | clientCredentials: 224 | tokenUrl: '{nrfApiRoot}/oauth2/token' 225 | scopes: 226 | nchf-spendinglimitcontrol: Access to the Nchf_SpendingLimitControl API 227 | schemas: 228 | SpendingLimitContext: 229 | description: > 230 | Represents the subscription data structure required for an individual CHF spending limit 231 | subscription. 232 | type: object 233 | properties: 234 | supi: 235 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 236 | gpsi: 237 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Gpsi' 238 | policyCounterIds: 239 | type: array 240 | items: 241 | $ref: '#/components/schemas/PolicyCounterId' 242 | minItems: 1 243 | description: > 244 | This is a list of policy counter identifier(s), which identifies policy counters 245 | maintained per subscriber within the CHF. 246 | notifUri: 247 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Uri' 248 | expiry: 249 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/DateTime' 250 | supportedFeatures: 251 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 252 | notifId: 253 | type: string 254 | SpendingLimitStatus: 255 | description: > 256 | Represents the data structure presenting the statuses of policy counters. 257 | type: object 258 | properties: 259 | supi: 260 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 261 | notifId: 262 | type: string 263 | statusInfos: 264 | type: object 265 | additionalProperties: 266 | $ref: '#/components/schemas/PolicyCounterInfo' 267 | minProperties: 1 268 | description: > 269 | Status of the requested policy counters. The key of the map is the attribute 270 | "policyCounterId". 271 | expiry: 272 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/DateTime' 273 | supportedFeatures: 274 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' 275 | PolicyCounterInfo: 276 | description: Represents the data structure presenting the policy counter status. 277 | type: object 278 | properties: 279 | policyCounterId: 280 | $ref: '#/components/schemas/PolicyCounterId' 281 | currentStatus: 282 | type: string 283 | description: > 284 | Identifies the policy counter status applicable for a specific policy counter identified 285 | by the policyCounterId. The values (e.g. valid, invalid or any other status) are not 286 | specified. The interpretation and actions related to the defined values are out of scope 287 | of 3GPP. 288 | penPolCounterStatuses: 289 | type: array 290 | items: 291 | $ref: '#/components/schemas/PendingPolicyCounterStatus' 292 | minItems: 1 293 | description: Provides the pending policy counter status. 294 | required: 295 | - policyCounterId 296 | - currentStatus 297 | PendingPolicyCounterStatus: 298 | description: > 299 | Represents the data structure presenting the pending policy counter status. 300 | type: object 301 | properties: 302 | policyCounterStatus: 303 | type: string 304 | description: > 305 | Identifies the policy counter status applicable for a specific policy counter identified 306 | by the policyCounterId. The values (e.g. valid, invalid or any other status) are not 307 | specified. The interpretation and actions related to the defined values are out of scope 308 | of 3GPP. 309 | activationTime: 310 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/DateTime' 311 | required: 312 | - policyCounterStatus 313 | - activationTime 314 | PolicyCounterId: 315 | type: string 316 | description: Identifies a policy counter. 317 | SubscriptionTerminationInfo: 318 | description: > 319 | Represents the data structure presenting the indication of the termination of the 320 | subscription. 321 | type: object 322 | properties: 323 | supi: 324 | $ref: 'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS29571_CommonData.yaml#/components/schemas/Supi' 325 | notifId: 326 | type: string 327 | termCause: 328 | $ref: '#/components/schemas/TerminationCause' 329 | required: 330 | - supi 331 | TerminationCause: 332 | description: > 333 | Represents the cause for requesting the termination of the subscription to policy counter 334 | status changes. 335 | anyOf: 336 | - type: string 337 | enum: 338 | - REMOVED_SUBSCRIBER 339 | - type: string -------------------------------------------------------------------------------- /documentation/GSMA/VoLTE Service Description and Implementation Guidelines.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/GSMA/VoLTE Service Description and Implementation Guidelines.pdf -------------------------------------------------------------------------------- /documentation/TS 23.167 - IP Multimedia Subsystem (IMS) emergency sessions/Rel-17/ts_123167v170200p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 23.167 - IP Multimedia Subsystem (IMS) emergency sessions/Rel-17/ts_123167v170200p.pdf -------------------------------------------------------------------------------- /documentation/TS 23.179 - LTE - Functional architecture and information flows to support mission critical communication services - Stage 2/Rel-13/ts_123179v130500p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 23.179 - LTE - Functional architecture and information flows to support mission critical communication services - Stage 2/Rel-13/ts_123179v130500p.pdf -------------------------------------------------------------------------------- /documentation/TS 23.203 - Policy and charging control architecture/Rel-17/ts_123203v170200p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 23.203 - Policy and charging control architecture/Rel-17/ts_123203v170200p.pdf -------------------------------------------------------------------------------- /documentation/TS 23.228 - IP Multimedia Subsystem (IMS) - Stage 2/Rel-17/ts_123228v170300p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 23.228 - IP Multimedia Subsystem (IMS) - Stage 2/Rel-17/ts_123228v170300p.pdf -------------------------------------------------------------------------------- /documentation/TS 23.380 - IMS Restoration Procedures/Rel-17/ts_123380v170100p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 23.380 - IMS Restoration Procedures/Rel-17/ts_123380v170100p.pdf -------------------------------------------------------------------------------- /documentation/TS 23.401 - General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access/Rel-17/ts_123401v170800p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 23.401 - General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access/Rel-17/ts_123401v170800p.pdf -------------------------------------------------------------------------------- /documentation/TS 23.501 - System Architecture for the 5G System/Rel-17/ts_123501v170900p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 23.501 - System Architecture for the 5G System/Rel-17/ts_123501v170900p.pdf -------------------------------------------------------------------------------- /documentation/TS 23.502 - Procedures for the 5G System (5GS)/Rel-17/ts_123502v170900p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 23.502 - Procedures for the 5G System (5GS)/Rel-17/ts_123502v170900p.pdf -------------------------------------------------------------------------------- /documentation/TS 23.503 - Policy and Charging Control Framework for the 5G System/Rel-17/ts_123503v170900p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 23.503 - Policy and Charging Control Framework for the 5G System/Rel-17/ts_123503v170900p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.122 - T8 reference point for Northbound APIs/Rel-17/ts_129122v171000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.122 - T8 reference point for Northbound APIs/Rel-17/ts_129122v171000p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.211 - Rx Interface and Rx-Gx signalling flows/Rel-6/ts_129211v060400p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.211 - Rx Interface and Rx-Gx signalling flows/Rel-6/ts_129211v060400p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.212 - Policy and Charging Control (PCC); Reference points/Rel-17/ts_129212v170300p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.212 - Policy and Charging Control (PCC); Reference points/Rel-17/ts_129212v170300p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.213 - Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping/Rel-17/ts_129213v170200p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.213 - Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping/Rel-17/ts_129213v170200p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.214 - Policy and charging control over Rx reference point/Rel-17/ts_129214v170500p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.214 - Policy and charging control over Rx reference point/Rel-17/ts_129214v170500p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.219 - Policy and charging control - Spending limit reporting over Sy reference point/Rel-17/ts_129219v170000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.219 - Policy and charging control - Spending limit reporting over Sy reference point/Rel-17/ts_129219v170000p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.244 - Interface between the Control Plane and the User Plane nodes/Rel-17/ts_129244v170900p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.244 - Interface between the Control Plane and the User Plane nodes/Rel-17/ts_129244v170900p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.501 - Principles and Guidelines for Services Definition/Rel-17/ts_129501v170700p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.501 - Principles and Guidelines for Services Definition/Rel-17/ts_129501v170700p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.502 - Session Management Services/Rel-17/ts_129502v170900p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.502 - Session Management Services/Rel-17/ts_129502v170900p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.503 - Unified Data Management Services/Rel-17/ts_129503v171100p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.503 - Unified Data Management Services/Rel-17/ts_129503v171100p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.504 - Unified Data Repository Services/Rel-17/ts_129504v171100p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.504 - Unified Data Repository Services/Rel-17/ts_129504v171100p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.505 - 5G System; Usage of the Unified Data Repository services for Subscription Data; Stage 3/Rel-17/ts_129505v171000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.505 - 5G System; Usage of the Unified Data Repository services for Subscription Data; Stage 3/Rel-17/ts_129505v171000p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.507 - Access and Mobility Policy Control Service/Rel-17/ts_129507v170900p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.507 - Access and Mobility Policy Control Service/Rel-17/ts_129507v170900p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.508 - Session Management Event Exposure Service/Rel-17/ts_129508v171000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.508 - Session Management Event Exposure Service/Rel-17/ts_129508v171000p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.509 - Authentication Server Services/Rel-17/ts_129509v170900p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.509 - Authentication Server Services/Rel-17/ts_129509v170900p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.510 - Network Function Repository Services/Rel-17/ts_129510v171000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.510 - Network Function Repository Services/Rel-17/ts_129510v171000p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.512 - Session Management Policy Control Service/Rel-17/ts_129512v171100p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.512 - Session Management Policy Control Service/Rel-17/ts_129512v171100p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.513 - Policy and Charging Control signalling flows and QoS parameter mapping/Rel-17/ts_129513v171100p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.513 - Policy and Charging Control signalling flows and QoS parameter mapping/Rel-17/ts_129513v171100p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.514 - Policy Authorization Service/Rel-17/ts_129514v170900p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.514 - Policy Authorization Service/Rel-17/ts_129514v170900p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.518 - 5G System; Access and Mobility Management Services; Stage 3/Rel-17/ts_129518v171000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.518 - 5G System; Access and Mobility Management Services; Stage 3/Rel-17/ts_129518v171000p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.519 - Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure/Rel-17/ts_129519v171000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.519 - Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure/Rel-17/ts_129519v171000p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.520 - Network Data Analytics Services/Rel-17/ts_129520v171100p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.520 - Network Data Analytics Services/Rel-17/ts_129520v171100p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.521 - Binding Support Management Service/Rel-17/ts_129521v170900p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.521 - Binding Support Management Service/Rel-17/ts_129521v170900p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.523 - Policy Control Event Exposure Service/Rel-17/ts_129523v170800p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.523 - Policy Control Event Exposure Service/Rel-17/ts_129523v170800p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.525 - UE Policy Control Service/Rel-17/ts_129525v170900p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.525 - UE Policy Control Service/Rel-17/ts_129525v170900p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.551 - 5G System; Packet Flow Description Management Service; Stage 3/Rel-17/ts_129551v170800p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.551 - 5G System; Packet Flow Description Management Service; Stage 3/Rel-17/ts_129551v170800p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.554 - Background Data Transfer Policy Control Service/Rel-17/ts_129554v170400p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.554 - Background Data Transfer Policy Control Service/Rel-17/ts_129554v170400p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.571 - Common Data Types for Service Based Interfaces/Rel-17/ts_129571v170900p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.571 - Common Data Types for Service Based Interfaces/Rel-17/ts_129571v170900p.pdf -------------------------------------------------------------------------------- /documentation/TS 29.594 - Spending Limit Control Service/Rel-17/ts_129594v170500p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 29.594 - Spending Limit Control Service/Rel-17/ts_129594v170500p.pdf -------------------------------------------------------------------------------- /documentation/TS 32.240 - Charging architecture and principles/Rel-17/ts_132240v171000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 32.240 - Charging architecture and principles/Rel-17/ts_132240v171000p.pdf -------------------------------------------------------------------------------- /documentation/TS 32.251 - Telecommunication management;Charging management;Packet Switched (PS) domain charging/Rel-17/ts_132251v170000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 32.251 - Telecommunication management;Charging management;Packet Switched (PS) domain charging/Rel-17/ts_132251v170000p.pdf -------------------------------------------------------------------------------- /documentation/TS 32.255 - Telecommunication management; Charging management; 5G data connectivity domain charging; Stage 2/Rel-17/ts_132255v171000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 32.255 - Telecommunication management; Charging management; 5G data connectivity domain charging; Stage 2/Rel-17/ts_132255v171000p.pdf -------------------------------------------------------------------------------- /documentation/TS 32.260 - IP Multimedia Subsystem (IMS) charging/Rel-17/ts_132260v170500p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 32.260 - IP Multimedia Subsystem (IMS) charging/Rel-17/ts_132260v170500p.pdf -------------------------------------------------------------------------------- /documentation/TS 32.270 - Multimedia Messaging Service (MMS) charging/Rel-17/ts_132270v170000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 32.270 - Multimedia Messaging Service (MMS) charging/Rel-17/ts_132270v170000p.pdf -------------------------------------------------------------------------------- /documentation/TS 32.274 - Short Message Service (SMS) charging/Rel-17/ts_132274v170200p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 32.274 - Short Message Service (SMS) charging/Rel-17/ts_132274v170200p.pdf -------------------------------------------------------------------------------- /documentation/TS 32.276 - Voice Call Service (VCS) charging/Rel-17/ts_132276v170000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 32.276 - Voice Call Service (VCS) charging/Rel-17/ts_132276v170000p.pdf -------------------------------------------------------------------------------- /documentation/TS 32.290 - Services, operations and procedures of charging using Service Based Interface (SBI)/Rel-17/ts_132290v170700p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 32.290 - Services, operations and procedures of charging using Service Based Interface (SBI)/Rel-17/ts_132290v170700p.pdf -------------------------------------------------------------------------------- /documentation/TS 32.291 - 5G system, charging service; Stage 3/Rel-17/ts_132291v170700p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 32.291 - 5G system, charging service; Stage 3/Rel-17/ts_132291v170700p.pdf -------------------------------------------------------------------------------- /documentation/TS 32.296 - Online Charging System (OCS) - Applications and interfaces/Rel-17/ts_132296v170000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 32.296 - Online Charging System (OCS) - Applications and interfaces/Rel-17/ts_132296v170000p.pdf -------------------------------------------------------------------------------- /documentation/TS 32.299 - Diameter charging applications/Rel-17/ts_132299v170000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 32.299 - Diameter charging applications/Rel-17/ts_132299v170000p.pdf -------------------------------------------------------------------------------- /documentation/TS 33.501 - Security architecture and procedures for 5G System/Rel-17/ts_133501v171000p.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/TS 33.501 - Security architecture and procedures for 5G System/Rel-17/ts_133501v171000p.pdf -------------------------------------------------------------------------------- /documentation/images/5G System architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/images/5G System architecture.png -------------------------------------------------------------------------------- /documentation/images/PCF Interfaces.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/522cf6ca41ed827c32893bb6d9177e56bf9af12f/documentation/images/PCF Interfaces.png -------------------------------------------------------------------------------- /documentation/images/diagrams.drawio: -------------------------------------------------------------------------------- 1 | 3Zvfb5swEMf/mkjbQyfA/AiPbZK2mlRWLYq2PnrgBjQCEZAm6V8/KAaMTRtCE7jlKfgwxnz9yfnuSEZostrdRXjtPoQO8UeK5OxGaDpSFEXSlfQjs+xziywjallGnkNtlWHuvRJqlKh14zkkrnVMwtBPvHXdaIdBQOykZsNRFG7r3Z5Dv37XNV4SwTC3sS9af3lO4ubWsSZV9nviLd3izrJEz6xw0ZkaYhc74ZYxodkITaIwTPKj1W5C/Ey9Qpf8utt3zpYTi0iQtLlg6v24Mp+M74H/114o5itZBvEVHeUF+xv6wNZ8fksnnOwLFaJwEzgkG0gaoZut6yVkvsZ2dnabLnxqc5OVn7bk9FCcWHEXEiVkx5joRO9IuCJJtE+70LMq1YxSM6bNLbMC1OQy4hdXYbrmy3LcSpb0gCpzhEqKqNJseJFkHZZKSFTp5/AqlRoAUUkVVHqcDK+SKsFSSRNUWkwfBldJU2CppAsqXQ+Pkg7MeRuCSJP74VUygDnvsYjSAkAgoHB+qWwPpZMp6vQwvEy8+x5cpiJ8Z3SaA9BJB6eTGIALIpHAuc4ymbQVhAFpKQpxaomNKAnzyFrDIxe2iPg48V7q6VCTDvQOj6GXzqQKUuuClzFrMUIcbiKb0IvY7IUbZ6weGCjB0ZIkwkBvq1I+9ScWSswBFrPBeZY5npEyNM9iEvDl59dra3ClEDilxERg8Ti8h9TA6SSmAtPhcTLAySQGcBbexM/H7SZk5yW/MxG/abT1RCXNjqc7trGnjXfVzF374ZgTyE5lcKGB0XGn4otXve9UYohq4RVoEExQIKj8ApodSRAG6pmEwiexJMSwSSjCRSgoaJxTkDuiwBdFekehodAfxEdvD0E6CwaGrPnEnqtweGsd5CF/6o94AIXD+MAitt4iOKxkfq85Nw1iMmMFBDwMCigY+NJUZxpMbhzUMwwN722CCDwMCBQMSDmVa+ALJn3TIKal1toGT4MKioaDgV9rGnis+Pzx3DSIybe1cVbQadBA0aDpp6IBcQNpPdMgvm+0MHjXoIOCQT9ZDDl0RiG+V7VsFzwNBigaxqeKIQfPKMSiU0cSZJYDBot3SCjLE2xxoixVnLw8gVpiVrwuAsIZF1SqfFDZuozBVb3H/VJWTJv1OcXSfdLjSKA4M/9PzBDHGeIDlLacyeaBgc4NWkO5rKtDO3Jr67ne2tahwSrRX4o/U0TM0EXum2pbhwarrHMpnDWU+NSLdGetOYP1nknmkjn1VBtn+cPAvkhrKB/qXUnr5tFkYB4NVjFK5VyRyruitqRph3zjuUlrKE2anX2a0tGpGaxXkz9kLQNgTmdG/D/hdlYZbt4M6YnsF0iejf2e2IRVNtd4L8hXu8+83aak4D3TbZ11iI+YL/1KVKTnI7bkPm1W/wbMu1d/qkSzfw==5Zxdc6JIFIZ/jVW7F7MFNCBeGhPNXEilxrJm52qLgY4yg+BCO+r++m1ig9iHXZAg3ZKr0Edo4O3H8wVxgCabwyx2tut55OFgoCneYYAeB5qmKaZG/6SW48miqohZVrHvMdvZsPD/wcyoMOvO93BysSOJooD420ujG4UhdsmFzYnjaH+522sUXJ5166wwMCxcJ4DWr75H1ierZShn+zP2V+vszKrCPtk42c7MkKwdL9oXTOhpgCZxFJHT1uYwwUGqXqbLc6J8fVgmK//4t/rjr9f9j+VM+3SabHrNIfktxDgk7U7N1vKXE+yYXvZiMWX3S46ZiHG0Cz2cTqQM0MN+7RO82Dpu+umeckNta7IJ6Eilm2xKHBN84Nag4gbUXFXKI442mMRHehybRWfrwEi02HBfWFVmWhcWNDvKYRyt8nnPWtENJtcV0iEo3ZOkyqmmXNLpULovkkqXCyOJdAaQ7mUiqXS6Ipd0JpBu+TiXUzpDk0u6IZBuLCl0pmRRwgLKTZ4llW4oWZQYQeiWsuYmGufr8rEo8bL0u6jeXFLx+EAhXjwViLeQVTxTOvFgTQGUw6E3Tms7OgqjEJcphT1Q1zXTqaCDUaJDZotx4BD/1+U5y8RhZ3iJfHo15xT7chXyjDubIYl2sYvZQcUqjZvH0ismIk68wgRM9LZU+V2/Y/VgWbN8kpN8lSMfaaLJh3XNb19+H9tyyoekkw/WNssXSb2uIZ14sLp5lBS8oXTawfLGdnbJ63VhCx988meq7B8GG31jOqfbj4fi4MgG7wp19NLegkpVCi0qJA65xGTYMCTyjb/OQyKs4Wxn0wM6VEUkHjq/rKOGfICJuuYDFqp20gs+hGbUusH5D7UhH3xLqGs+svBW5CNMrg4vIb2KAiHp8FvxszMjb6OWIDlp8393J5IRq2Jla4cYjjWVj1W3RgQ2HOwQ94QQJJIQvjHXGJERNw/qmBDYVbHDuCeE6CIJQVpbToTvAXWNSMkT6a3bE0QMoalIVQZRGxGeNb6mvTUiJU/ed96mH4iYIhExzLYQQdxERseIwC6c7fTEiQxFEmK2lqyKrmdgq9F21z1BxBKJiNVWsiq8noEd1YZ4qEU4Cqz8Bx55G6XYRMlbKoLaKHpN9lShlRKXvep89lq73cJ1962O0Svp1mYr9U7fpNwjfMpdwIc4+hCf9dSlTx1VTHRr/EqawU1935WhUcoWcm3fJ/RZRE98X3bZRfjQBw68Rl34hDag+gJfSQ9b/8CerzZ8Yt9b44pJva3Am7/U2RV+GsTPbIpfM9+n3qXvE9o20zmnpfNOqy5+RpUXvTV+sLM60MyAqvXwnW6s0o3p/PM0M9KT5PZ8xzjf0z9gj842j777FF1N+RwSHO+j+Kcfruhwugtd4kch4FuKF7z4l+P0bG0KTI1KmOKbFO39q15Jx6ppXtSD0IRqJ+VCn7oYVaVcXd8wrCoub+0bSt4vpGpMry4My3JsCUgS1jTgupyoaebMP98Dr5reGhDYswLBYzyrGTuMGZ1p7Lo4SejGzCF47xyljxloWB0zyl4KBo/H2gsaJZ2cjxw0rPsIGpxP0LWmCSXvXDp+hJK5oAJ+D/ZMzi+voRgXWuX/vizsBwZgL2KcOZSP+OXNhK5+V09oQL+DLy8dnn/x5bT7+Ydz0NO/5Vpbc6IwFP41PtKBJFx8bL20s2s7trbTdl92qKRKF8VBVNxfv7AkAieMF1Yxzj5pDiHAl+87J+ckDdyaRLeBPRvf+w71Gkh1ogZuNxBCqoHin8SyTi2ahpllFLgOs2WGgfubMqPKrAvXofNCx9D3vdCdFY1Dfzqlw7Bgs4PAXxW7ffpe8akze0QFw2Boe6L11XXCcWq1dDWz31F3NOZP1lR2ZWLzzswwH9uOv8qZcKeBW4Hvh+m/SdSiXoIexyUia2s9GAyXbx+PvZmitF6Mn0o6WPeQWzafENBpWHnoz1a3/+no727v16PzdfP17JpLBadDL21vwfDqt7rsc8M1xzDwF1OHJuOoDXyzGrshHczsYXJ1FdMmto3DiRe3tPjvni/LPmpJg5BGualiL39L/QkNg3XcZcNFNg+ciQZrr7Jpxdw2zk0pYTabMWm0GTpDK/7DADsAPGQJ6D0gLKBHp851QuS4NfWntIhWDFKwfkuQvdJ58z1/rR0x2NPWmrciN0xvMy3WTG5T1CvV1JkhuzVp5O/s08CNMaABsx02Z3N/EQzpblaFdjCi4ZZ+xEw7UqegYZECuSnWS2aY2wLq2aG7LCq/bNrZE/q+G3/vhmEGKjJMMQBz0g9nd+WlBgbSLDAQAgOlyAgD/WXh5rP/gZhNkZikbl7qOVqqWxl5ZPZxNuykHyZS0U83i6whekX6GWAgbNZLP6yK9OO2+vjXRAZwjLp1MY7RkoqZpnokx2hgwMyaiYkEYl5LutrBIBYRcbFj1bnWweJK8UGvW9KE4IuVNOeeJJImIEZoMEbsK2kM1joCBU+taSIQc3AvqagJAVhZ51a1LqraPI6q1R2qPgzjS1vLEagKFVWTF9FAxNRqlpeY417LKi8knbxK8jDt0KhZIaHKaTLBKxdqr9Qm2hVuk9apg6a1r6ylUjUGYtQgc/YOmk3AVATcw4lVzd+7QEw+eYc6fq3g9rMosGs5l6fz1faa1bHpR/aln1x5GAYODlfNwyD/6o4qhPv2jH+tO0mjigFC+bkzMSImsQ+8Ev0faJfsvSKUSrpCTa5qcc8EhQGs1izdkkIA53pt9CushTQ56SdXQmLAFQf0+HuX8LQdA52af2K+/9J+kjN0wC3Ls4eOknQfGxW1e2AV7zCMd1fI5ZIXTD013aomL7gJpNUtL1OkyGtb1io5LKidXWAlJwI6kmKnG3Jhx5WYd+x9SbGDvMMlZ1FOBZ4a0W6HPK4HypP93Pqwb6a9niJit5T2IA9fQm05x1MrdmIu+oCqnpa4vHyqZP9qG8MkibdwNWsBcuxdXgfZFOLbdMcPt2PXQffej94sjL6R7/35vTK7LePek6SyhXWQOgNGKXZiHeRmICl2wOWdGzkxDajo7qru5J/raFiJs9tGLUmcHSwdNSs6Ow2Wjo62VR83s3PQaffsODnu/AE= -------------------------------------------------------------------------------- /scripts/configuration.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "id": "TS 23.167", 4 | "name": "IP Multimedia Subsystem (IMS) emergency sessions" 5 | }, 6 | { 7 | "id": "TS 23.179", 8 | "name": "LTE - Functional architecture and information flows to support mission critical communication services - Stage 2" 9 | }, 10 | { 11 | "id": "TS 23.203", 12 | "name": "Policy and charging control architecture" 13 | }, 14 | { 15 | "id": "TS 23.228", 16 | "name": "IP Multimedia Subsystem (IMS) - Stage 2" 17 | }, 18 | { 19 | "id": "TS 23.380", 20 | "name": "IMS Restoration Procedures" 21 | }, 22 | { 23 | "id": "TS 23.401", 24 | "name": "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access" 25 | }, 26 | { 27 | "id": "TS 23.501", 28 | "name": "System Architecture for the 5G System" 29 | }, 30 | { 31 | "id": "TS 23.502", 32 | "name": "Procedures for the 5G System (5GS)" 33 | }, 34 | { 35 | "id": "TS 23.503", 36 | "name": "Policy and Charging Control Framework for the 5G System" 37 | }, 38 | { 39 | "id": "TS 29.122", 40 | "name": "T8 reference point for Northbound APIs" 41 | }, 42 | { 43 | "id": "TS 29.211", 44 | "name": "Rx Interface and Rx-Gx signalling flows" 45 | }, 46 | { 47 | "id": "TS 29.212", 48 | "name": "Policy and Charging Control (PCC); Reference points" 49 | }, 50 | { 51 | "id": "TS 29.213", 52 | "name": "Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping" 53 | }, 54 | { 55 | "id": "TS 29.214", 56 | "name": "Policy and charging control over Rx reference point" 57 | }, 58 | { 59 | "id": "TS 29.219", 60 | "name": "Policy and charging control - Spending limit reporting over Sy reference point" 61 | }, 62 | { 63 | "id": "TS 29.244", 64 | "name": "Interface between the Control Plane and the User Plane nodes" 65 | }, 66 | 67 | { 68 | "id": "TS 29.501", 69 | "name": "Principles and Guidelines for Services Definition" 70 | }, 71 | { 72 | "id": "TS 29.502", 73 | "name": "Session Management Services" 74 | }, 75 | { 76 | "id": "TS 29.503", 77 | "name": "Unified Data Management Services" 78 | }, 79 | { 80 | "id": "TS 29.505", 81 | "name": "5G System; Usage of the Unified Data Repository services for Subscription Data; Stage 3" 82 | }, 83 | { 84 | "id": "TS 29.504", 85 | "name": "Unified Data Repository Services" 86 | }, 87 | { 88 | "id": "TS 29.507", 89 | "name": "Access and Mobility Policy Control Service" 90 | }, 91 | { 92 | "id": "TS 29.508", 93 | "name": "Session Management Event Exposure Service" 94 | }, 95 | { 96 | "id": "TS 29.509", 97 | "name": "Authentication Server Services" 98 | }, 99 | { 100 | "id": "TS 29.510", 101 | "name": "Network Function Repository Services" 102 | }, 103 | { 104 | "id": "TS 29.512", 105 | "name": "Session Management Policy Control Service" 106 | }, 107 | { 108 | "id": "TS 29.513", 109 | "name": "Policy and Charging Control signalling flows and QoS parameter mapping" 110 | }, 111 | { 112 | "id": "TS 29.514", 113 | "name": "Policy Authorization Service" 114 | }, 115 | { 116 | "id": "TS 29.518", 117 | "name": "5G System; Access and Mobility Management Services; Stage 3" 118 | }, 119 | { 120 | "id": "TS 29.519", 121 | "name": "Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure" 122 | }, 123 | { 124 | "id": "TS 29.520", 125 | "name": "Network Data Analytics Services" 126 | }, 127 | { 128 | "id": "TS 29.521", 129 | "name": "Binding Support Management Service" 130 | }, 131 | { 132 | "id": "TS 29.523", 133 | "name": "Policy Control Event Exposure Service" 134 | }, 135 | { 136 | "id": "TS 29.525", 137 | "name": "UE Policy Control Service" 138 | }, 139 | { 140 | "id": "TS 29.551", 141 | "name": "5G System; Packet Flow Description Management Service; Stage 3" 142 | }, 143 | { 144 | "id": "TS 29.554", 145 | "name": "Background Data Transfer Policy Control Service" 146 | }, 147 | { 148 | "id": "TS 29.571", 149 | "name": "Common Data Types for Service Based Interfaces" 150 | }, 151 | { 152 | "id": "TS 29.594", 153 | "name": "Spending Limit Control Service" 154 | }, 155 | 156 | { 157 | "id": "TS 32.240", 158 | "name": "Charging architecture and principles" 159 | }, 160 | { 161 | "id": "TS 32.251", 162 | "name": "Telecommunication management;Charging management;Packet Switched (PS) domain charging" 163 | }, 164 | { 165 | "id": "TS 32.255", 166 | "name": "Telecommunication management; Charging management; 5G data connectivity domain charging; Stage 2" 167 | }, 168 | { 169 | "id": "TS 32.260", 170 | "name": "IP Multimedia Subsystem (IMS) charging" 171 | }, 172 | { 173 | "id": "TS 32.270", 174 | "name": "Multimedia Messaging Service (MMS) charging" 175 | }, 176 | { 177 | "id": "TS 32.274", 178 | "name": "Short Message Service (SMS) charging" 179 | }, 180 | { 181 | "id": "TS 32.276", 182 | "name": "Voice Call Service (VCS) charging" 183 | }, 184 | { 185 | "id": "TS 32.290", 186 | "name": "Services, operations and procedures of charging using Service Based Interface (SBI)" 187 | }, 188 | { 189 | "id": "TS 32.291", 190 | "name": "5G system, charging service; Stage 3" 191 | }, 192 | { 193 | "id": "TS 32.296", 194 | "name": "Online Charging System (OCS) - Applications and interfaces" 195 | }, 196 | { 197 | "id": "TS 32.299", 198 | "name": "Diameter charging applications" 199 | }, 200 | { 201 | "id": "TS 33.501", 202 | "name": "Security architecture and procedures for 5G System" 203 | } 204 | ] 205 | -------------------------------------------------------------------------------- /scripts/getDocumentation.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import json 4 | import os 5 | import shutil 6 | import re 7 | import urllib.request 8 | import zipfile, io 9 | from jinja2 import Environment, FileSystemLoader 10 | 11 | templates = FileSystemLoader('./templates') 12 | env = Environment(loader=templates) 13 | 14 | with open('configuration.json') as json_data_file: 15 | configuration = json.load(json_data_file) 16 | 17 | api_urls = {} 18 | release_documents = {} 19 | 20 | def getURLAsJSON(url): 21 | req = urllib.request.Request(url) 22 | try: 23 | with urllib.request.urlopen(req) as response: 24 | the_page = response.read() 25 | encoding = response.info().get_content_charset('utf-8') 26 | return json.loads(the_page.decode(encoding)) 27 | except Exception as e: 28 | pass 29 | 30 | return None 31 | 32 | def getURLAsString(url): 33 | req = urllib.request.Request(url) 34 | try: 35 | with urllib.request.urlopen(req) as response: 36 | the_page = response.read() 37 | encoding = response.info().get_content_charset('utf-8') 38 | return str(the_page.decode(encoding)) 39 | except Exception as e: 40 | pass 41 | 42 | return None 43 | 44 | def getURL(url): 45 | req = urllib.request.Request(url) 46 | try: 47 | with urllib.request.urlopen(req) as response: 48 | return response.read() 49 | except Exception as e: 50 | print(e) 51 | pass 52 | 53 | return None 54 | 55 | def getAPIURL(api): 56 | return "https://editor.swagger.io/?url=https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/" + api +".yaml" 57 | 58 | def getDigit(val): 59 | if val.isdigit(): return int(val) 60 | else: return (ord(val) - 87) 61 | 62 | def getAPI(getOpenAPI, regrularExpression): 63 | print("getAPI:" + str(getOpenAPI)) 64 | urlAPI = re.findall(regrularExpression, str(getURLAsString(getOpenAPI))) 65 | for url in urlAPI: 66 | getOpenAPIFile = getOpenAPI + url + ".yaml" 67 | if os.path.exists("../apis/" + url + ".yaml"): continue 68 | 69 | open("../apis/" + url + ".yaml", 'wb').write(getURLAsString(getOpenAPIFile)) 70 | 71 | api_urls[url] = getAPIURL(url) 72 | print("getAPI Done") 73 | 74 | def getAPIFromGithub(): 75 | print("getAPIFromGithub starting") 76 | fileList = getURLAsJSON("https://api.github.com/repos/jdegre/5GC_APIs/git/trees/Rel-17?recursive=1") 77 | 78 | for entry in fileList["tree"]: 79 | filename = entry["path"] 80 | if not filename.endswith(".yaml"): continue 81 | urlfile = 'https://raw.githubusercontent.com/jdegre/5GC_APIs/master/' + filename 82 | 83 | open("../apis/" + filename, 'wb').write(getURL(urlfile)) 84 | 85 | api_urls[filename.replace(".yaml", "")] = getAPIURL(filename.replace(".yaml", "")) 86 | print("getAPIFromGithub end") 87 | 88 | baseGitURL = "https://github.com/emanuelfreitas/3gpp-documentation/raw/master/documentation/" 89 | 90 | shutil.rmtree("../apis") 91 | os.makedirs("../apis") 92 | 93 | for doc in configuration: 94 | directoryName = doc["id"] + " - " + doc["name"] 95 | print(directoryName) 96 | 97 | m = re.search('TS (\d+)\.(\d+)', doc["id"]) 98 | serie = m.group(1) 99 | docId = m.group(2) 100 | 101 | m = re.search('(\d)(\d)(\d)', docId) 102 | docgroup = m.group(1) 103 | 104 | lastRelease = 0 105 | releaseDoc = None 106 | 107 | releasesList = list(range(6, 18)) 108 | releasesList.sort(reverse=True) 109 | 110 | for relase in releasesList: 111 | if lastRelease > 0: continue 112 | 113 | directory = "../documentation/" + directoryName + "/Rel-" + str(relase) 114 | if not os.path.exists(directory): 115 | os.makedirs(directory) 116 | 117 | filesInDir = os.listdir(directory) 118 | 119 | getSeriesURL = "https://www.etsi.org/deliver/etsi_ts/1" +str(serie) + str(docgroup) + "00_1" +str(serie) + str(docgroup) + "99/1" +str(serie) + str(docId) +"/" 120 | idArray = re.findall(r"etsi_ts\/1" +str(serie) + str(docgroup) + "00_1" +str(serie) + str(docgroup) + "99\/1" +str(serie) + str(docId) + "\/"+ str(relase).zfill(2) + "\.([\w+|\.]+)\/", str(getURLAsString(getSeriesURL))) 121 | 122 | if(len(idArray) == 0): 123 | os.rmdir(directory) 124 | continue 125 | idArray.sort() 126 | id = idArray[len(idArray)-1] 127 | 128 | getSeriesURL = "https://www.etsi.org/deliver/etsi_ts/1" +str(serie) + str(docgroup) + "00_1" +str(serie) + str(docgroup) + "99/1" +str(serie) + str(docId) +"/" + str(relase).zfill(2) + "." + str(id) + "/" 129 | pdfFile = re.findall(r"\/(\w+).pdf", getURLAsString(getSeriesURL)) 130 | zipFile = re.findall(r"\/(\w+).zip", getURLAsString(getSeriesURL)) 131 | if(len(pdfFile) == 0): 132 | os.rmdir(directory) 133 | continue 134 | pdf = pdfFile[0] 135 | if(len(zipFile) > 0): 136 | zipF = zipFile[0] 137 | zipURL = getSeriesURL + "/" + str(zipF) + ".zip" 138 | resp = urllib.request.urlopen(zipURL) 139 | myzip = zipfile.ZipFile(io.BytesIO(resp.read())) 140 | for line in myzip.namelist(): 141 | if line.startswith('TS') and line.endswith('yaml'): 142 | myzip.extract(line, '../apis') 143 | filedata = None 144 | with open('../apis/'+str(line), 'r') as file : 145 | print("going to replace") 146 | filedata = file.read() 147 | filedata = filedata.replace('$ref: \'TS', '$ref: \'https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/apis/TS') 148 | with open('../apis/'+str(line), 'w') as file: 149 | file.write(filedata) 150 | 151 | api_urls[line.replace(".yaml", "")] = getAPIURL(line.replace(".yaml", "")) 152 | 153 | if str(pdf)+".pdf" in filesInDir: 154 | filesInDir.remove(str(pdf)+".pdf") 155 | else: 156 | getSeriesURL = getSeriesURL + "/" + str(pdf) + ".pdf" 157 | the_page = None 158 | with urllib.request.urlopen(getSeriesURL) as response: 159 | the_page = response.read() 160 | with open(directory + '/' + str(pdf) + '.pdf', 'wb') as f: 161 | f.write(the_page) 162 | for f in filesInDir: 163 | print("GOING TO REMOVE: " + directory + "/" + f) 164 | os.remove(directory + "/" + f) 165 | 166 | lastRelease = relase 167 | releaseDoc = directoryName + "/Rel-" + str(relase) + '/' + str(pdf) + '.pdf' 168 | 169 | if lastRelease != 0: 170 | release_documents[doc["id"]] = baseGitURL + releaseDoc.replace(" ", "%20") 171 | 172 | 173 | ##getAPIFromGithub() 174 | 175 | readme_template = env.get_template('README.j2') 176 | output = readme_template.render(release_documents=release_documents,api_urls=api_urls) 177 | 178 | f = open("../README.md", "w") 179 | f.write(output) 180 | f.close -------------------------------------------------------------------------------- /scripts/requirements.txt: -------------------------------------------------------------------------------- 1 | requests 2 | jinja2 3 | svn -------------------------------------------------------------------------------- /scripts/templates/README.j2: -------------------------------------------------------------------------------- 1 | # 3GPP Documentation 2 | 3 | ## Table of contents 4 | * [5G Core Network](#5GCoreNetwork) 5 | * [Architecture](#5GArchitecture) 6 | * [Reference Points](#5GReferencePoints) 7 | * [Services](#5GServices) 8 | * [Network Functions and entities](#5GNetworkFunctions) 9 | * [AMF (Access and Mobility Management Function)](#AMF) 10 | * [AUSF (Authentication Server Function)](#AUSF) 11 | * [BSF (Binding Support Function)](#BSF) 12 | * [CHF (Charging Function)](#CHF) 13 | * [NEF (Network Exposure Function)](#NEF) 14 | * [NRF (NF Repository Function)](#NRF) 15 | * [NWDAF (Network Data Analytics Function)](#NDAF) 16 | * [PCF (Policy Control Function)](#PCF) 17 | * [SMF (Session Management Function)](#SMF) 18 | * [UDR (Unified Data Repository)](#UDR) 19 | * [Policy and Charging Control](#PCC) 20 | * [OCS (Online Charging System)](#OCS) 21 | * [PCRF (Policy and Charging Rule Function)](#PCRF) 22 | 23 | ## 5G Core Network 24 | * [TS 23.501 - System Architecture for the 5G System]({{ release_documents['TS 23.501'] }}) 25 | * [TS 23.502 - Procedures for the 5G System (5GS)]({{ release_documents['TS 23.502'] }}) 26 | * [TS 23.503 - Policy and Charging Control Framework for the 5G System]({{ release_documents['TS 23.503'] }}) 27 | * [TS 29.501 - Principles and Guidelines for Services Definition]({{ release_documents['TS 29.501'] }}) 28 | * [TS 29.571 - Common Data Types for Service Based Interfaces]({{ release_documents['TS 29.571'] }}) 29 | * [TS 33.501 - Security architecture and procedures for 5G System]({{ release_documents['TS 33.501'] }}) 30 | 31 | ###### Common APIs 32 | * [TS 29.571 Common Data Types]({{api_urls['TS29571_CommonData']}}) 33 | * [TS 29.122 Common Data Types]({{api_urls['TS29122_CommonData']}}) 34 | 35 | ### Architecture 36 | #### 5G System architecture 37 | ![5G System architecture](https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/documentation/images/5G%20System%20architecture.png "5G System architecture") 38 | 39 | #### PCF/CHF Interfaces 40 | ![PCF Interfaces](https://raw.githubusercontent.com/emanuelfreitas/3gpp-documentation/master/documentation/images/PCF%20Interfaces.png "PCF Interfaces") 41 | 42 | ### Reference points 43 | | Interface | Description | 44 | |:---------:|:------------| 45 | | N1 | Reference point between the UE and the AMF | 46 | | N2 | Reference point between the (R)AN and the AMF | 47 | | N3 | Reference point between the (R)AN and the UPF | 48 | | N4 | Reference point between the SMF and the UPF | 49 | | **N5** | Reference point between the PCF and an AF | 50 | | N6 | Reference point between the UPF and a Data Network | 51 | | **N7** | Reference point between the SMF and the PCF | 52 | | N8 | Reference point between the UDM and the AMF | 53 | | N9 | Reference point between two UPFs | 54 | | N10 | Reference point between the UDM and the SMF | 55 | | N11 | Reference point between the AMF and the SMF | 56 | | N12 | Reference point between AMF and AUSF | 57 | | N13 | Reference point between the UDM and Authentication Server function the AUSF | 58 | | N14 | Reference point between two AMFs | 59 | | **N15** | Reference point between the PCF and the AMF in the case of non-roaming scenario, PCF in the visited network and AMF in the case of roaming scenario | 60 | | N16 | Reference point between two SMFs (in roaming case between SMF in the visited network and the SMF in the home network) | 61 | | N17 | Reference point between AMF and 5G-EIR | 62 | | N18 | Reference point between any NF and UDSF | 63 | | N22 | Reference point between AMF and NSSF | 64 | | **N23** | Reference point between PCF and NWDAF | 65 | | **N24** | Reference point between the PCF in the visited network and the PCF in the home network | 66 | | N27 | Reference point between NRF in the visited network and the NRF in the home network | 67 | | **N28** | Reference point between PCF and OCS | 68 | | N31 | Reference point between the NSSF in the visited network and the NSSF in the home network | 69 | | N32 | Reference point between SEPP in the visited network and the SEPP in the home network | 70 | | N33 | Reference point between NEF and AF | 71 | | N34 | Reference point between NSSF and NWDAF | 72 | | N35 | Reference point between UDM and UDR | 73 | | **N36** | Reference point between PCF and UDR | 74 | | N37 | Reference point between NEF and UDR | 75 | | **N40** | Reference point between SMF and the CHF | 76 | | N50 | Reference point between AMF and the CBCF | 77 | 78 | ### Services 79 | | Producer | Consumer | Service | Standard | API | 80 | |:--------:|:--------:|:--------|:--------:|:----| 81 | | [PCF](#PCF) | AF | Npcf_PolicyAuthorization | [TS 29.514]({{ release_documents['TS 29.514'] }}) | [PCF Policy Authorization Service]({{ api_urls['TS29514_Npcf_PolicyAuthorization'] }}) | 82 | | | SMF | Npcf_SMPolicyControl | [TS 29.512]({{ release_documents['TS 29.512'] }}) | [Session Management Policy Control Service]({{ api_urls['TS29512_Npcf_SMPolicyControl'] }}) | 83 | | | AMF | Npcf_AMPolicyControl | [TS 29.507]({{ release_documents['TS 29.507'] }}) | [Access and Mobility Policy Control Service]({{ api_urls['TS29507_Npcf_AMPolicyControl'] }}) | 84 | | | NEF | Npcf_EventExposure | [TS 29.523]({{ release_documents['TS 29.523'] }}) | [PCF Event Exposure Service]({{ api_urls['TS29523_Npcf_EventExposure'] }}) | 85 | | | | Npcf_BDTPolicyControl | [TS 29.554]({{ release_documents['TS 29.554'] }}) | [PCF BDT Policy Control Service]({{ api_urls['TS29554_Npcf_BDTPolicyControl'] }}) | 86 | | [NWDAF](#NWDAF) | PCF | Nnwdaf_EventsSubscription | [TS 29.520]({{ release_documents['TS 29.520'] }}) | [Nnwdaf_EventsSubscription Service API]({{ api_urls['TS29520_Nnwdaf_EventsSubscription'] }}) | 87 | | | | Nnwdaf_AnalyticsInfo | [TS 29.520]({{ release_documents['TS 29.520'] }}) | [Nnwdaf_AnalyticsInfo Service API]({{ api_urls['TS29520_Nnwdaf_AnalyticsInfo'] }}) | 88 | | [CHF](#CHF) | PCF | Nchf_SpendingLimitControl | [TS 29.594]({{ release_documents['TS 29.594'] }}) | [Spending Limit Control]({{ api_urls['TS29594_Nchf_SpendingLimitControl'] }}) | 89 | | | NF | Nchf_ConvergedCharging | [TS 32.291]({{ release_documents['TS 32.291'] }}) | [Converged Charging]({{ api_urls['TS32291_Nchf_ConvergedCharging'] }}) | 90 | | | NF | Nchf_OfflineOnlyCharging | [TS 32.291]({{ release_documents['TS 32.291'] }}) | [Offline Only Charging]({{ api_urls['TS32291_Nchf_OfflineOnlyCharging'] }}) | 91 | | [UDR](#UDR) | PCF | Nudr_DataRepository | [TS 29.504]({{ release_documents['TS 29.504'] }}) | [Unified Data Repository Service]({{ api_urls['TS29504_Nudr_DR'] }}) | 92 | | [BSF](#BSF) | PCF, NEF, AF | Nbsf_Management | [TS 29.521]({{ release_documents['TS 29.521'] }}) | [Binding Support Management Service API]({{ api_urls['TS29521_Nbsf_Management'] }}) | 93 | | [NRF](#NRF) | ALL NF | Nnrf_NFManagement | [TS 29.510]({{ release_documents['TS 29.510'] }}) | [NRF NFManagement Service]({{ api_urls['TS29510_Nnrf_NFManagement'] }}) | 94 | | | | Nnrf_NFDiscovery | [TS 29.510]({{ release_documents['TS 29.510'] }}) | [NRF NFDiscovery Service]({{ api_urls['TS29510_Nnrf_NFDiscovery'] }}) | 95 | | | | Nnrf_AccessToken | [TS 29.510]({{ release_documents['TS 29.510'] }}) | [NRF OAuth2 Authorization]({{ api_urls['TS29510_Nnrf_AccessToken'] }}) | 96 | 97 | ### Network Functions and entities 98 | 99 | #### AMF (Access and Mobility Management Function) 100 | 101 | ###### APIs 102 | * [Communication]({{api_urls['TS29518_Namf_Communication']}}) 103 | * [Event Exposure]({{api_urls['TS29518_Namf_EventExposure']}}) 104 | * [Location]({{api_urls['TS29518_Namf_Location']}}) 105 | * [MT]({{api_urls['TS29518_Namf_MT']}}) 106 | 107 | #### AUSF (Authentication Server Function) 108 | * [TS 29.509 - Authentication Server Services]({{ release_documents['TS 29.509'] }}) 109 | ###### APIs 110 | * [UE Authentication]({{api_urls['TS29509_Nausf_UEAuthentication']}}) 111 | * [SoR Protection]({{api_urls['TS29509_Nausf_SoRProtection']}}) 112 | 113 | #### BSF (Binding Support Function) 114 | * [TS 29.521 - Binding Support Management Service]({{ release_documents['TS 29.521'] }}) 115 | 116 | #### CHF (Charging Function) 117 | * [TS 29.594 - Spending Limit Control Service]({{ release_documents['TS 29.594'] }}) 118 | * [TS 32.240 - Telecommunication management; Charging management; Charging architecture and principles]({{ release_documents['TS 32.240'] }}) 119 | * [TS 32.255 - Telecommunication management; Charging management; 5G data connectivity domain charging; Stage 2]({{ release_documents['TS 32.255'] }}) 120 | * [TS 32.290 - Telecommunication management; Charging management; 5G system; Services, operations and procedures of charging using Service Based Interface (SBI)]({{ release_documents['TS 32.290'] }}) 121 | * [TS 32.291 - 5G system, charging service; Stage 3]({{ release_documents['TS 32.291'] }}) 122 | 123 | #### NEF (Network Exposure Function) 124 | * [TS 29.551 - 5G System; Packet Flow Description Management Service; Stage 3]({{ release_documents['TS 29.551'] }}) 125 | 126 | ###### APIs 127 | * [Packet Flow Description (PFD) Management]({{api_urls['TS29551_Nnef_PFDmanagement']}}) 128 | 129 | #### NRF (NF Repository Function) 130 | * [TS 29.510 - Network Function Repository Services]({{ release_documents['TS 29.510'] }}) 131 | 132 | #### NWDAF (Network Data Analytics Function) 133 | * [TS 29.520 - Network Data Analytics Services]({{ release_documents['TS 29.520'] }}) 134 | 135 | #### PCF (Policy Control Function) 136 | * [TS 29.244 - Interface between the Control Plane and the User Plane nodes]({{ release_documents['TS 29.244'] }}) 137 | * [TS 29.507 - Access and Mobility Policy Control Service]({{ release_documents['TS 29.507'] }}) 138 | * [TS 29.512 - Session Management Policy Control Service]({{ release_documents['TS 29.512'] }}) 139 | * [TS 29.513 - Policy and Charging Control signalling flows and QoS parameter mapping]({{ release_documents['TS 29.513'] }}) 140 | * [TS 29.514 - Policy Authorization Service]({{ release_documents['TS 29.514'] }}) 141 | * [TS 29.523 - Policy Control Event Exposure Service]({{ release_documents['TS 29.523'] }}) 142 | * [TS 29.525 - UE Policy Control Service]({{ release_documents['TS 29.525'] }}) 143 | * [TS 29.554 - Background Data Transfer Policy Control Service]({{ release_documents['TS 29.554'] }}) 144 | * [TS 29.594 - Spending Limit Control Service]({{ release_documents['TS 29.594'] }}) 145 | 146 | #### SMF (Session Management Function) 147 | * [TS 29.502 - Session Management Services]({{ release_documents['TS 29.502'] }}) 148 | * [TS 29.508 - Session Management Event Exposure Service]({{ release_documents['TS 29.508'] }}) 149 | ###### APIs 150 | * [PDU Session]({{api_urls['TS29502_Nsmf_PDUSession']}}) 151 | * [Event Exposure]({{api_urls['TS29508_Nsmf_EventExposure']}}) 152 | 153 | #### UDR (Unified Data Repository) 154 | * [TS 29.504 - Unified Data Repository Services]({{ release_documents['TS 29.504'] }}) 155 | * [TS 29.519 - Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure]({{ release_documents['TS 29.519'] }}) 156 | ###### APIs 157 | * Data Repository 158 | * [Subscription Data]({{api_urls['TS29505_Subscription_Data']}}) 159 | * [Policy Data]({{api_urls['TS29519_Policy_Data']}}) 160 | * [Exposure Data]({{api_urls['TS29519_Exposure_Data']}}) 161 | * [Application Data]({{api_urls['TS29519_Application_Data']}}) 162 | 163 | ## Policy and Charging Control 164 | * [RFC 6733 - Diameter Base Protocol](https://tools.ietf.org/pdf/rfc6733.pdf) 165 | * [RFC 8506 - Diameter Credit-Control Application](https://tools.ietf.org/pdf/rfc8506.pdf) 166 | * [TS 23.167 - IP Multimedia Subsystem (IMS) emergency sessions]({{ release_documents['TS 23.167'] }}) 167 | * [TS 23.179 - Functional architecture and information flows to support mission critical communication services]({{ release_documents['TS 23.179'] }}) 168 | * [TS 23.203 - Policy and charging control architecture]({{ release_documents['TS 23.203'] }}) 169 | * [TS 23.228 - IP Multimedia Subsystem (IMS) - Stage 2]({{ release_documents['TS 23.228'] }}) 170 | * [TS 23.401 - General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access]({{ release_documents['TS 23.401'] }}) 171 | 172 | * [VoLTE Service Description and Implementation Guidelines](https://github.com/emanuelfreitas/3gpp-documentation/raw/master/documentation/GSMA/VoLTE%20Service%20Description%20and%20Implementation%20Guidelines.pdf) 173 | 174 | #### OCS (Online Charging System) 175 | * [TS 29.219 - Policy and charging control: Spending limit reporting over Sy reference point]({{ release_documents['TS 29.219'] }}) 176 | * [TS 32.240 - Telecommunication management; Charging management; Charging architecture and principles]({{ release_documents['TS 32.240'] }}) 177 | * [TS 32.251 - Telecommunication management;Charging management;Packet Switched (PS) domain charging]({{ release_documents['TS 32.251'] }}) 178 | * [TS 32.260 - IP Multimedia Subsystem (IMS) charging]({{ release_documents['TS 32.260'] }}) 179 | * [TS 32.270 - Multimedia Messaging Service (MMS) charging]({{ release_documents['TS 32.270'] }}) 180 | * [TS 32.274 - Short Message Service (SMS) charging]({{ release_documents['TS 32.274'] }}) 181 | * [TS 32.276 - Voice Call Service (VCS) charging]({{ release_documents['TS 32.276'] }}) 182 | * [TS 32.296 - Telecommunication management; Charging management; Online Charging System (OCS): Applications and interfaces]({{ release_documents['TS 32.296'] }}) 183 | * [TS 32.299 - Diameter charging applications]({{ release_documents['TS 32.299'] }}) 184 | 185 | | Interface | Standard | 186 | |------------|----------| 187 | | Sy | [TS 29.219 - Policy and charging control: Spending limit reporting over Sy reference point]({{ release_documents['TS 29.219'] }}) | 188 | | Ro - Gy | [TS 32.251 - Telecommunication management;Charging management;Packet Switched (PS) domain charging]({{ release_documents['TS 32.251'] }}) | 189 | | Ro / Rf | [TS 32.299 - Diameter charging applications]({{ release_documents['TS 32.299'] }}) | 190 | 191 | #### PCRF (Policy and Charging Rule Function) 192 | * [TS 29.211 - Rx Interface and Rx-Gx signalling flows]({{ release_documents['TS 29.211'] }}) 193 | * [TS 29.213 - Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping]({{ release_documents['TS 29.213'] }}) 194 | * [TS 23.380 - IMS Restoration Procedures]({{ release_documents['TS 23.380'] }}) 195 | 196 | | Interface | Standard | 197 | |------------|----------| 198 | | Gx | [TS 29.212 - Policy and Charging Control (PCC); Reference points]({{ release_documents['TS 29.212'] }}) | 199 | | Rx | [TS 29.214 - Policy and charging control over Rx reference point]({{ release_documents['TS 29.214'] }}) | 200 | | Sy | [TS 29.219 - Policy and charging control: Spending limit reporting over Sy reference point]({{ release_documents['TS 29.219'] }}) | --------------------------------------------------------------------------------