forked from jdegre/5GC_APIs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTS29508_Nsmf_EventExposure.yaml
589 lines (589 loc) · 22.3 KB
/
TS29508_Nsmf_EventExposure.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
openapi: 3.0.0
info:
version: 1.2.0-alpha.3
title: Nsmf_EventExposure
description: |
Session Management Event Exposure Service.
© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.508 V17.4.0; 5G System; Session Management Event Exposure Service.
url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.508/
servers:
- url: '{apiRoot}/nsmf_event-exposure/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501
security:
- {}
- oAuth2ClientCredentials:
- nsmf-event-exposure
paths:
/subscriptions:
post:
operationId: CreateIndividualSubcription
summary: Create an individual subscription for event notifications from the SMF
tags:
- Subscriptions (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NsmfEventExposure'
responses:
'201':
description: Created.
headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}'
required: true
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/NsmfEventExposure'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
callbacks:
myNotification:
'{$request.body#/notifUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NsmfEventExposureNotification'
responses:
'204':
description: No Content, Notification was successful.
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
callbacks:
afAcknowledgement:
'{request.body#/ackUri}':
post:
requestBody: # contents of the callback message
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AckOfNotify'
responses:
'204':
description: No Content (successful acknowledgement)
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/subscriptions/{subId}:
get:
operationId: GetIndividualSubcription
summary: Read an individual subscription for event notifications from the SMF
tags:
- IndividualSubscription (Document)
parameters:
- name: subId
in: path
description: Event Subscription ID
required: true
schema:
type: string
responses:
'200':
description: OK. Resource representation is returned
content:
application/json:
schema:
$ref: '#/components/schemas/NsmfEventExposure'
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
put:
operationId: ReplaceIndividualSubcription
summary: Replace an individual subscription for event notifications from the SMF
tags:
- IndividualSubscription (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NsmfEventExposure'
parameters:
- name: subId
in: path
description: Event Subscription ID
required: true
schema:
type: string
responses:
'200':
description: OK. Resource was successfully modified and representation is returned
content:
application/json:
schema:
$ref: '#/components/schemas/NsmfEventExposure'
'204':
description: No Content. Resource was successfully modified
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
delete:
operationId: DeleteIndividualSubcription
summary: Delete an individual subscription for event notifications from the SMF
tags:
- IndividualSubscription (Document)
parameters:
- name: subId
in: path
description: Event Subscription ID
required: true
schema:
type: string
responses:
'204':
description: No Content. Resource was successfully deleted
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nsmf-event-exposure: Access to the Nsmf_EventExposure API
schemas:
NsmfEventExposure:
description: Represents an Individual SMF Notification Subscription resource. The serviveName property corresponds to the serviceName in the main body of the specification.
type: object
properties:
supi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
anyUeInd:
type: boolean
description: Any UE indication. This IE shall be present if the event subscription is applicable to any UE. Default value "false" is used, if not present.
groupId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
pduSeId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
dnn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
snssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
subId:
$ref: '#/components/schemas/SubId'
notifId:
type: string
description: Notification Correlation ID assigned by the NF service consumer.
notifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
altNotifIpv4Addrs:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
description: Alternate or backup IPv4 address(es) where to send Notifications.
minItems: 1
altNotifIpv6Addrs:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
description: Alternate or backup IPv6 address(es) where to send Notifications.
minItems: 1
altNotifFqdns:
type: array
items:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Fqdn'
minItems: 1
description: Alternate or backup FQDN(s) where to send Notifications.
eventSubs:
type: array
items:
$ref: '#/components/schemas/EventSubscription'
minItems: 1
description: Subscribed events
ImmeRep:
type: boolean
notifMethod:
$ref: '#/components/schemas/NotificationMethod'
maxReportNbr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
expiry:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
repPeriod:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
guami:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Guami'
serviveName:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
sampRatio:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio'
partitionCriteria:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PartitioningCriteria'
minItems: 1
description: Criteria for partitioning the UEs before applying the sampling ratio.
grpRepTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
notifFlag:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag'
required:
- notifId
- notifUri
- eventSubs
NsmfEventExposureNotification:
description: Represents notifications on events that occurred.
type: object
properties:
notifId:
type: string
description: Notification correlation ID
eventNotifs:
type: array
items:
$ref: '#/components/schemas/EventNotification'
minItems: 1
description: Notifications about Individual Events
ackUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
required:
- notifId
- eventNotifs
EventSubscription:
description: Represents a subscription to a single event.
type: object
properties:
event:
$ref: '#/components/schemas/SmfEvent'
dnaiChgType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType'
dddTraDescriptors:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor'
minItems: 1
dddStati:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus'
minItems: 1
appIds:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId'
minItems: 1
required:
- event
EventNotification:
description: Represents a notification related to a single event that occurred.
type: object
properties:
event:
$ref: '#/components/schemas/SmfEvent'
timeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
supi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
sourceDnai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
targetDnai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
dnaiChgType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType'
sourceUeIpv4Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
sourceUeIpv6Prefix:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
targetUeIpv4Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
targetUeIpv6Prefix:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
sourceTraRouting:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation'
targetTraRouting:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation'
ueMac:
$ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'
adIpv4Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
adIpv6Prefix:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
reIpv4Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
reIpv6Prefix:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
plmnId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
accType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType'
pduSeId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
ratType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
dddStatus:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus'
dddTraDescriptor:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor'
maxWaitTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
commFailure:
$ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CommunicationFailure'
ipv4Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ipv6Prefixes:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
minItems: 1
ipv6Addrs:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
minItems: 1
pduSessType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType'
qfi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi'
appId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId'
ethfDescs:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'
minItems: 1
maxItems: 2
fDescs:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription'
minItems: 1
maxItems: 2
dnn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
snssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
ulDelays:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
minItems: 1
dlDelays:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
minItems: 1
rtDelays:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
minItems: 1
required:
- event
- timeStamp
SubId:
type: string
format: SubId
description: Identifies an Individual SMF Notification Subscription. To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501. In an OpenAPI schema, the format shall be designated as "SubId".
AckOfNotify:
description: Represents an acknowledgement information of an event notification.
type: object
properties:
notifId:
type: string
ackResult:
$ref: 'TS29522_TrafficInfluence.yaml#/components/schemas/AfResultInfo'
supi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
required:
- notifId
- ackResult
SmfEvent:
anyOf:
- type: string
enum:
- AC_TY_CH
- UP_PATH_CH
- PDU_SES_REL
- PLMN_CH
- UE_IP_CH
- RAT_TY_CH
- DDDS
- COMM_FAIL
- PDU_SES_EST
- QFI_ALLOC
- QOS_MON
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description: >
Possible values are
- AC_TY_CH: Access Type Change
- UP_PATH_CH: UP Path Change
- PDU_SES_REL: PDU Session Release
- PLMN_CH: PLMN Change
- UE_IP_CH: UE IP address change
- RAT_TY_CH: RAT Type Change
- DDDS: Downlink data delivery status
- COMM_FAIL: Communication Failure
- PDU_SES_EST: PDU Session Establishment
- QFI_ALLOC: QFI allocation
- QOS_MON: QoS Monitoring
NotificationMethod:
anyOf:
- type: string
enum:
- PERIODIC
- ONE_TIME
- ON_EVENT_DETECTION
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description: >
Possible values are
- PERIODIC
- ONE_TIME
- ON_EVENT_DETECTION