-
Notifications
You must be signed in to change notification settings - Fork 263
/
Copy pathTS29558_Eees_ACRManagementEvent.yaml
873 lines (838 loc) · 31.9 KB
/
TS29558_Eees_ACRManagementEvent.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
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
openapi: 3.0.0
info:
title: EES ACR Management Event_API
description: |
API for EES ACR Management Event.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: 1.1.0-alpha.6
externalDocs:
description: >
3GPP TS 29.558 V18.5.0 Enabling Edge Applications;
Application Programming Interface (API) specification; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/
security:
- {}
- oAuth2ClientCredentials: []
servers:
- url: '{apiRoot}/eees-acrmgntevent/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558.
paths:
/subscriptions:
post:
summary: Creates a new Individual ACR Management Events Subscription
operationId: CreateACRMngEventSubscr
tags:
- ACR Management Events Subscriptions (Collection)
description: Create an Individual ACR Management Event Subscription resource.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AcrMgntEventsSubscription'
callbacks:
ACRManagementEventsNotification:
'{request.body#/notificationDestination}':
post:
requestBody: # contents of the callback message
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AcrMgntEventsNotification'
responses:
'200':
description: OK (The notification is received successfully)
content:
application/json:
schema:
$ref: '#/components/schemas/EasAckInformation'
'204':
description: No Content (successful notification)
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
UPPathChangeAvailabilityNotif:
'{request.body#/notificationDestination}/report-availability':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityNotif'
responses:
'204':
description: No Content. The notification is successful received.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
responses:
'201':
description: Created (Successful creation)
content:
application/json:
schema:
$ref: '#/components/schemas/AcrMgntEventsSubscription'
headers:
Location:
description: 'Contains the URI of the newly created resource'
required: true
schema:
type: string
'204':
description: >
Successful case. The resource has been successfully created and no
additional content is to be sent in the response message.
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
get:
summary: Read all ACR Management Events Subscriptions
operationId: GetACRMngEventSubscrs
tags:
- ACR Management Events Subscriptions (Collection)
description: Retrieve all the ACR Management Events Subscriptions information.
parameters:
- name: supp-feat
in: query
description: Features supported by the EAS.
required: false
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
responses:
'200':
description: OK (Successful get all of the active subscriptions)
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AcrMgntEventsSubscription'
minItems: 1
description: All the active ACR management events subscriptions
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionId}:
get:
summary: Read an Individual ACR Management Events Subscription
operationId: GetIndACRMngEventSubscr
tags:
- Individual ACR Management Events Subscription (Document)
description: Retrieve an Individual ACR Management Events Subscription.
parameters:
- name: subscriptionId
in: path
description: Subscription Id.
required: true
schema:
type: string
- name: supp-feat
in: query
description: Features supported by the EAS.
required: false
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
responses:
'200':
description: OK (Successful get the active subscription).
content:
application/json:
schema:
$ref: '#/components/schemas/AcrMgntEventsSubscription'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
put:
summary: Update an Individual ACR Management Events Subscription
operationId: UpdateIndACRMngEventSubscr
tags:
- Individual ACR Management Events Subscription (Document)
description: Fully replace an existing Individual ACR Management Events Subscription.
parameters:
- name: subscriptionId
in: path
description: Subscription Id.
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AcrMgntEventsSubscription'
responses:
'200':
description: OK (Successful get the active subscription).
content:
application/json:
schema:
$ref: '#/components/schemas/AcrMgntEventsSubscription'
'204':
description: No Content
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
summary: Modify an Individual ACR Management Events Subscription
operationId: ModifyIndACRMngEventSubscr
tags:
- Individual ACR Management Events Subscription (Document)
parameters:
- name: subscriptionId
in: path
description: Subscription Id.
required: true
schema:
type: string
requestBody:
description: Partial update an existing Individual ACR Management Events Subscription.
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/AcrMgntEventsSubscriptionPatch'
responses:
'200':
description: >
The Individual ACR Management Events Subscription is successfully modified
and the updated subscription information is returned in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/AcrMgntEventsSubscription'
'204':
description: No Content.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Delete an Individual ACR Management Events Subscription
operationId: DeleteIndACRMngEventSubscr
tags:
- Individual ACR Management Events Subscription (Document)
description: Delete an existing Individual ACR Management Events Subscription.
parameters:
- name: subscriptionId
in: path
description: Subscription Id.
required: true
schema:
type: string
responses:
'204':
description: The individual subscription is deleted.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
# Components
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
AcrMgntEventsSubscription:
type: object
description: Represents an Individual ACR Management Events Subscription.
properties:
self:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
easId:
type: string
description: Identifier of an EAS.
eventSubscs:
type: array
items:
$ref: '#/components/schemas/AcrMgntEventSubsc'
minItems: 1
description: The subscribed ACR management events.
evtReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
notificationDestination:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
eventReports:
type: array
items:
$ref: '#/components/schemas/AcrMgntEventReport'
minItems: 1
description: The ACR management event report(s).
availabilityInfo:
$ref: '#/components/schemas/AvailabilityNotif'
failEventReports:
type: array
items:
$ref: '#/components/schemas/FailureAcrMgntEventInfo'
minItems: 1
description: Failure event reports.
requestTestNotification:
type: boolean
description: >
Set to true by the EAS to request the EES to send a test notification.
Set to false or omitted otherwise.
websockNotifConfig:
$ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- easId
- eventSubscs
- notificationDestination
AcrMgntEventSubsc:
type: object
description: Represents an ACR Management Event Subscription.
properties:
event:
$ref: '#/components/schemas/AcrMgntEvent'
eventFilter:
$ref: '#/components/schemas/AcrMgntEventFilter'
evtReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
tgtUeId:
$ref: '#/components/schemas/TargetUeIdentification'
dnaiChgType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType'
easAckInd:
type: boolean
description: >
Identifies whether EAS acknowledgement of UP path change event notifications is to be
expected. Set to "true" if the EAS acknowledgement is expected. Set to "false" if
the EAS acknowledgement is not expected. Default value is "false" if ommited.
This attribute may be provided only if the "event" attribute is set to "UP_PATH_CHG".
easChars:
type: array
items:
$ref: 'TS24558_Eees_EASDiscovery.yaml#/components/schemas/EasCharacteristics'
minItems: 1
description: A list of EAS characteristics.
trafFilterInfo:
$ref: '#/components/schemas/TrafficFilterInfo'
servContPlanInd:
type: boolean
description: >
Represents the service continuity planning indication (i.e., whether or not the EES
shall monitor whether the UE(s) enter the predicted location).
When set to true, it indicates that service continuity planning is required.
When set to false, it indicates that Service continuity planning is not required.
The default value when this attribute is omitted is false.
easAckSvcCont:
type: boolean
description: >
Indicates that the EAS will provide an acknowledgement as a response to the notification
of ACR management notification related to service continuity planning. Set to "true" if
the EAS acknowledgement is expected. Default value is "false". This attribute may be
provided only if the "event" attribute is set to "ACR_MONITORING" and/or
"ACR_FACILITATION".
required:
- event
AcrMgntEventsSubscriptionPatch:
type: object
description: >
Represents a modification request of Individual ACR Management Events Subscription.
properties:
eventSubscs:
type: array
items:
$ref: '#/components/schemas/AcrMgntEventSubsc'
minItems: 1
description: The subscribed ACR management events.
evtReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
notificationDestination:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
AcrMgntEventsNotification:
type: object
description: Represents the ACR management events notification.
properties:
subpId:
type: string
description: >
String identifying the Individual ACR Management Events Subscription
for which the notification is delivered.
eventReports:
type: array
items:
$ref: '#/components/schemas/AcrMgntEventReport'
minItems: 1
description: A list of ACR management event reports.
required:
- subpId
- eventReports
AcrMgntEventReport:
type: object
description: Represents an ACR management event report.
properties:
event:
$ref: '#/components/schemas/AcrMgntEvent'
timeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
upPathChgInfo:
$ref: '#/components/schemas/UpPathChangeInfo'
easEndPoint:
$ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'
actStatus:
$ref: '#/components/schemas/ActStatus'
acrParams:
$ref: '#/components/schemas/ACRParameters'
acId:
type: string
ueId:
$ref: '#/components/schemas/TargetUeIdentification'
selACRScen:
type: array
items:
$ref: '#/components/schemas/SelectedACRScenarios'
minItems: 1
easInBdlInfoList:
type: array
items:
$ref: '#/components/schemas/EasInBundleInfo'
minItems: 1
description: Represents the list of EAS in a bundle related information.
servContPlanInd:
type: boolean
description: >
Represents the service continuity planning indication (i.e., whether or not the EES will
monitor whether the UE(s) enter the predicted location).
When set to true, it indicates that service continuity planning will be performed.
When set to false, it indicates that Service continuity planning will not be performed.
The default value when this attribute is omitted is false.
required:
- event
ACRParameters:
type: object
description: Represents the ACR parameters.
properties:
predictExpTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
FailureAcrMgntEventInfo:
type: object
description: Represents a failure ACR management event.
properties:
event:
$ref: '#/components/schemas/AcrMgntEvent'
failureCode:
$ref: '#/components/schemas/AcrMgntEventFailureCode'
required:
- event
- failureCode
TargetUeIdentification:
description: Identifies the target UE information.
type: object
properties:
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
edgeUeId:
type: string
intGrpId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
extGrpId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId'
ueIpAddr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
oneOf:
- required: [gpsi]
- required: [edgeUeId]
- required: [intGrpId]
- required: [extGrpId]
- required: [ueIpAddr]
AvailabilityNotif:
type: object
description: >
Represents the availability information of user plane path management events monitoring
via the 3GPP 5GC network.
properties:
availabilityStatus:
$ref: '#/components/schemas/AvailabilityStatus'
required:
- availabilityStatus
UpPathChangeInfo:
description: Represents user plane path change information.
type: object
properties:
ueId:
$ref: '#/components/schemas/IndUeIdentification'
dnaiChgType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType'
sourceTrafficRoute:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation'
targetTrafficRoute:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation'
sourceDnai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
targetDnai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
srcUeIpv4Addr:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr'
srcUeIpv6Prefix:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
tgtUeIpv4Addr:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr'
tgtUeIpv6Prefix:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
required:
- ueId
- dnaiChgType
IndUeIdentification:
description: Represents identification information of a UE.
type: object
properties:
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
externalId:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId'
ueIpAddr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
oneOf:
- required: [gpsi]
- required: [externalId]
- required: [ueIpAddr]
TrafficFilterInfo:
description: Represents the Traffic Filter Information.
type: object
properties:
ipFlows:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription'
minItems: 1
description: Contains the flow description for the Uplink and/or Downlink IP flows.
uris:
type: array
items:
type: string
minItems: 1
description: Indicates URI(s) matching criteria.
domainNames:
type: array
items:
type: string
minItems: 1
description: Indicates Domain Name matching criteria.
dnProtocol:
$ref: 'TS29122_PfdManagement.yaml#/components/schemas/DomainNameProtocol'
anyOf:
- required: [ipFlows]
- required: [uris]
- required: [domainNames]
SelectedACRScenarios:
type: object
description: >
Represents the selected ACR scenario(s) applicable for a given combination of AC and UE.
properties:
acrList:
type: array
items:
$ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario'
minItems: 0
acId:
type: string
ueId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
required:
- acrList
- acId
- ueId
EasAckInformation:
type: object
description: Represents the EAS acknowledgement information.
properties:
resCode:
$ref: '#/components/schemas/ResultCode'
required:
- resCode
EasInBundleInfo:
type: object
description: >
Represents EAS in a bundle information.
properties:
easId:
type: string
description: Contains the identifier of the EAS that is within an EAS bundle.
dnais:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems: 1
svcArea:
$ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea'
required:
- easId
#
# ENUMERATIONS DATA TYPES
#
AcrMgntEvent:
anyOf:
- type: string
enum:
- UP_PATH_CHG
- ACR_MONITORING
- ACR_FACILITATION
- ACT_START_STOP
- ACR_SELECTION
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
and is not used to encode content defined in the present version of this API.
description: |
Represents the ACR Management event.
Possible values are:
- UP_PATH_CHG: Indicates that ACR Management Event is the User plane path change event.
- ACR_MONITORING: Indicates that ACR Management Event is the ACR monitoring event.
- ACR_FACILITATION: Indicates that ACR Management Event is the ACR facilitation event.
- ACT_START_STOP: Indicates that ACR Management Event is the ACT start/stop event.
- ACR_SELECTION: Indicates that ACR Management Event is the ACR selection event.
AcrMgntEventFilter:
anyOf:
- type: string
enum:
- INTRA_EDN_MOBILITY
- INTER_EDN_MOBILITY
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
and is not used to encode content defined in the present version of this API.
description: |
Represents the filtering criteria for the ACR Management event.
Possible values are:
- INTRA_EDN_MOBILITY: Indicates that the ACR Management Event filter is intra-EDN mobility.
- INTER_EDN_MOBILITY: Indicates that the ACR Management Event filter is inter-EDN mobility.
ActStatus:
anyOf:
- type: string
enum:
- ACT_START
- ACT_STOP
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
and is not used to encode content defined in the present version of this API.
description: |
Represents the ACT status.
Possible values are:
- ACT_START: Indicates ACT start.
- ACT_STOP: Indicates ACT stop.
AcrMgntEventFailureCode:
anyOf:
- type: string
enum:
- 3GPP_UP_PATH_CHANGE_MON_NOT_AVAILABLE
- OTHER_REASONS
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
and is not used to encode content defined in the present version of this API.
description: |
Represents the failure reason for the ACR Management event.
Possible values are:
- 3GPP_UP_PATH_CHANGE_MON_NOT_AVAILABLE: Indicates that the ACR Management Event
Subscription failed because user plane path management event notifications from the 3GPP
network is NOT available. This value is only applicable for the "UP_PATH_CHG",
"ACR_MONITORING" and "ACR_FACILITATION" events.
- OTHER_REASONS: Indicates that the ACR Management Event Subscription failed for other
reasons. This value is applicable for all events.
AvailabilityStatus:
anyOf:
- type: string
enum:
- AVAILABLE
- NOT_AVAILABLE
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
and is not used to encode content defined in the present version of this API.
description: |
Represents the availability status.
Possible values are:
- AVAILABLE: Indicates availability.
- NOT_AVAILABLE: Indicates unavailability.
ResultCode:
anyOf:
- type: string
enum:
- ACCEPTED
- REJECTED
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
and is not used to encode content defined in the present version of this API.
description: |
Represents the result code of ACT acceptance by EAS.
Possible values are:
- ACCEPTED: Indicates acceptance of the ACT.
- REJECTED: Indicates rejection of the ACT.