forked from jdegre/5GC_APIs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTS29122_AsSessionWithQoS.yaml
1247 lines (1221 loc) · 48.4 KB
/
TS29122_AsSessionWithQoS.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
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: 3gpp-as-session-with-qos
version: 1.3.0-alpha.4
description: |
API for setting us an AS session with required QoS.
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
security:
- {}
- oAuth2ClientCredentials: []
servers:
- url: '{apiRoot}/3gpp-as-session-with-qos/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
paths:
/{scsAsId}/subscriptions:
get:
summary: Read all or queried active subscriptions for the SCS/AS.
operationId: FetchAllASSessionWithQoSSubscriptions
tags:
- AS Session with Required QoS Subscriptions
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS
required: true
schema:
type: string
- name: ip-addrs
in: query
description: The IP address(es) of the requested UE(s).
required: false
content:
application/json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
minItems: 1
- name: ip-domain
in: query
description: >
The IPv4 address domain identifier. The attribute may only be provided if IPv4 address
is included in the ip-addrs query parameter.
required: false
schema:
type: string
- name: mac-addrs
in: query
description: The MAC address(es) of the requested UE(s).
required: false
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'
minItems: 1
responses:
'200':
description: OK.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AsSessionWithQoSSubscription'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
post:
summary: Creates a new subscription resource.
operationId: CreateASSessionWithQoSSubscription
tags:
- AS Session with Required QoS Subscriptions
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS
required: true
schema:
type: string
requestBody:
description: Request to create a new subscription resource
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AsSessionWithQoSSubscription'
callbacks:
notificationDestination:
'{request.body#/notificationDestination}':
post:
requestBody: # contents of the callback message
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserPlaneNotificationData'
responses:
'204':
description: No Content (successful notification)
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
responses:
'201':
description: Created (Successful creation of subscription)
content:
application/json:
schema:
$ref: '#/components/schemas/AsSessionWithQoSSubscription'
headers:
Location:
description: 'Contains the URI of the newly created resource'
required: true
schema:
type: string
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailsAsSessionWithQos'
headers:
Retry-After:
description: >
Indicates the time the AF has to wait before making a new request. It can be a
non-negative integer (decimal number) indicating the number of seconds the AF
has to wait before making a new request or an HTTP-date after which the AF can
retry a new request.
schema:
type: string
'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'
/{scsAsId}/subscriptions/{subscriptionId}:
get:
summary: Read an active subscriptions for the SCS/AS and the subscription Id.
operationId: FetchIndASSessionWithQoSSubscription
tags:
- Individual AS Session with Required QoS Subscription
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS
required: true
schema:
type: string
- name: subscriptionId
in: path
description: Identifier of the subscription resource
required: true
schema:
type: string
responses:
'200':
description: OK (Successful get the active subscription)
content:
application/json:
schema:
$ref: '#/components/schemas/AsSessionWithQoSSubscription'
'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: Updates/replaces an existing subscription resource.
operationId: UpdateIndASSessionWithQoSSubscription
tags:
- Individual AS Session with Required QoS Subscription
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS
required: true
schema:
type: string
- name: subscriptionId
in: path
description: Identifier of the subscription resource
required: true
schema:
type: string
requestBody:
description: Parameters to update/replace the existing subscription
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AsSessionWithQoSSubscription'
responses:
'200':
description: OK (Successful update of the subscription)
content:
application/json:
schema:
$ref: '#/components/schemas/AsSessionWithQoSSubscription'
'204':
description: No Content (Successful update of the subscription)
'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':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailsAsSessionWithQos'
headers:
Retry-After:
description: >
Indicates the time the AF has to wait before making a new request. It can be a
non-negative integer (decimal number) indicating the number of seconds the AF
has to wait before making a new request or an HTTP-date after which the AF can
retry a new request.
schema:
type: string
'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: Updates/replaces an existing subscription resource.
operationId: ModifyIndASSessionWithQoSSubscription
tags:
- Individual AS Session with Required QoS Subscription
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS
required: true
schema:
type: string
- name: subscriptionId
in: path
description: Identifier of the subscription resource
required: true
schema:
type: string
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/AsSessionWithQoSSubscriptionPatch'
responses:
'200':
description: OK. The subscription was modified successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/AsSessionWithQoSSubscription'
'204':
description: No Content. The subscription was modified successfully.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailsAsSessionWithQos'
headers:
Retry-After:
description: >
Indicates the time the AF has to wait before making a new request. It can be a
non-negative integer (decimal number) indicating the number of seconds the AF
has to wait before making a new request or an HTTP-date after which the AF can
retry a new request.
schema:
type: string
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Deletes an already existing subscription.
operationId: DeleteIndASSessionWithQoSSubscription
tags:
- Individual AS Session with Required QoS Subscription
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS
required: true
schema:
type: string
- name: subscriptionId
in: path
description: Identifier of the subscription resource
required: true
schema:
type: string
responses:
'204':
description: No Content (Successful deletion of the existing subscription)
'200':
description: OK (Successful deletion of the existing subscription)
content:
application/json:
schema:
$ref: '#/components/schemas/UserPlaneNotificationData'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
AsSessionWithQoSSubscription:
description: Represents an individual AS session with required QoS subscription resource.
type: object
properties:
self:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
dnn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
snssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
notificationDestination:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
exterAppId:
type: string
description: Identifies the external Application Identifier.
extGroupId:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
flowInfo:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo'
minItems: 1
description: Describe the data flow which requires QoS.
ethFlowInfo:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'
minItems: 1
description: Identifies Ethernet packet flows.
enEthFlowInfo:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/EthFlowInfo'
minItems: 1
description: >
Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow
idenifer and the corresponding UL and/or DL flows.
listUeAddrs:
type: array
items:
$ref: '#/components/schemas/UeAddInfo'
minItems: 1
description: Identifies the list of UE address.
multiModalId:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MultiModalId'
protoDesc:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ProtoDesc'
qosReference:
type: string
description: Identifies a pre-defined QoS information
altQoSReferences:
type: array
items:
type: string
minItems: 1
description: >
Identifies an ordered list of pre-defined QoS information. The lower the index of the
array for a given entry, the higher the priority.
altQosReqs:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData'
minItems: 1
description: >
Identifies an ordered list of alternative service requirements that include individual
QoS parameter sets. The lower the index of the array for a given entry, the higher the
priority.
disUeNotif:
description: >
Indicates whether the QoS flow parameters signalling to the UE when the SMF is notified
by the NG-RAN of changes in the fulfilled QoS situation is disabled (true) or
not (false). Default value is false. The fulfilled situation is either the QoS profile
or an Alternative QoS Profile.
type: boolean
ueIpv4Addr:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr'
ipDomain:
type: string
ueIpv6Addr:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr'
macAddr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'
usageThreshold:
$ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold'
sponsorInfo:
$ref: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation'
qosMonInfo:
$ref: '#/components/schemas/QosMonitoringInformation'
pdvMon:
$ref: '#/components/schemas/QosMonitoringInformation'
qosDuration:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
qosInactInt:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
directNotifInd:
type: boolean
description: >
Indicates whether the direct event notification is requested (true) or not (false).
Default value is false.
tscQosReq:
$ref: '#/components/schemas/TscQosRequirement'
l4sInfo:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/UplinkDownlinkSupport'
requestTestNotification:
type: boolean
description: >
Set to true by the SCS/AS to request the SCEF to send a test notification as defined
in clause 5.2.5.3. Set to false or omitted otherwise.
websockNotifConfig:
$ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
events:
description: >
Represents the list of user plane event(s) to which the SCS/AS requests to subscribe to.
type: array
items:
$ref: '#/components/schemas/UserPlaneEvent'
minItems: 1
multiModDatFlows:
type: object
additionalProperties:
$ref: '#/components/schemas/AsSessionMediaComponent'
minProperties: 1
description: >
Contains media component data for a single-modal data flow(s).
The key of the map is the medCompN attribute.
pduSetQos:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara'
rTLatencyInd:
type: boolean
description: >
Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of
the service, when it is included and set to "true".
The default value is "false" if omitted. periodInfo:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/PeriodicityInfo'
rttMon:
$ref: '#/components/schemas/QosMonitoringInformation'
qosMonDatRate:
$ref: '#/components/schemas/QosMonitoringInformation'
avrgWndw:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow'
servAuthInfo:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ServAuthInfo'
qosMonConReq:
$ref: '#/components/schemas/QosMonitoringInformation'
listUeConsDtRt:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
minItems: 1
description: >
Identifies the list of UE addresses subject for Consolidated Data Rate monitoring.
required:
- notificationDestination
AsSessionWithQoSSubscriptionPatch:
description: Represents parameters to modify an AS session with specific QoS subscription.
type: object
properties:
exterAppId:
type: string
description: Identifies the external Application Identifier.
flowInfo:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo'
minItems: 1
description: Describe the IP data flow which requires QoS.
ethFlowInfo:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'
minItems: 1
description: Identifies Ethernet packet flows.
enEthFlowInfo:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/EthFlowInfo'
minItems: 1
description: >
Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow
idenifer and the corresponding UL and/or DL flows.
listUeAddrs:
type: array
items:
$ref: '#/components/schemas/UeAddInfo'
minItems: 1
description: Identifies the list of UE address.
qosReference:
type: string
description: Pre-defined QoS reference
altQoSReferences:
type: array
items:
type: string
minItems: 1
description: >
Identifies an ordered list of pre-defined QoS information. The lower the index of the
array for a given entry, the higher the priority.
altQosReqs:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData'
minItems: 1
description: >
Identifies an ordered list of alternative service requirements that include individual
QoS parameter sets. The lower the index of the array for a given entry, the higher the
priority.
disUeNotif:
type: boolean
description: >
Indicates whether the QoS flow parameters signalling to the UE when the SMF is notified
by the NG-RAN of changes in the fulfilled QoS situation is disabled (true) or
not (false). The fulfilled situation is either the QoS profile or an Alternative QoS
Profile.
usageThreshold:
$ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm'
qosMonInfo:
$ref: '#/components/schemas/QosMonitoringInformationRm'
pdvMon:
$ref: '#/components/schemas/QosMonitoringInformationRm'
directNotifInd:
type: boolean
description: >
Indicates whether the direct event notification is requested (true) or not (false).
notificationDestination:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
tscQosReq:
$ref: '#/components/schemas/TscQosRequirementRm'
l4sInfo:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/UplinkDownlinkSupport'
events:
description: >
Represents the updated list of user plane event(s) to which the SCS/AS requests to
subscribe to.
type: array
items:
$ref: '#/components/schemas/UserPlaneEvent'
minItems: 1
multiModDatFlows:
type: object
additionalProperties:
$ref: '#/components/schemas/AsSessionMediaComponentRm'
minProperties: 1
description: >
Contains media component data for a single-modal data flow(s).
The key of the map is the medCompN attribute.
pduSetQos:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm'
rTLatencyInd:
type: boolean
description: >
Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of
the service, when it is included and set to "true".
The default value is "false" if omitted.
protoDesc:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ProtoDesc'
periodInfo:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/PeriodicityInfo'
qosDuration:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'
qosInactInt:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'
rttMon:
$ref: '#/components/schemas/QosMonitoringInformationRm'
qosMonDatRate:
$ref: '#/components/schemas/QosMonitoringInformationRm'
avrgWndw:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm'
qosMonConReq:
$ref: '#/components/schemas/QosMonitoringInformationRm'
listUeConsDtRt:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
minItems: 1
description: >
Identifies the list of UE addresses subject for Consolidated Data Rate monitoring.
QosMonitoringInformation:
description: Represents QoS monitoring information.
type: object
properties:
reqQosMonParams:
type: array
items:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter'
minItems: 1
repFreqs:
type: array
items:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ReportingFrequency'
minItems: 1
repThreshDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
repThreshUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
repThreshRp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
conThreshDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
conThreshUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
waitTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
repPeriod:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
repThreshDatRateDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
repThreshDatRateUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
consDataRateThrDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
consDataRateThrUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
required:
- reqQosMonParams
- repFreqs
QosMonitoringInformationRm:
description: >
Represents the same as the QosMonitoringInformation data type but with
the nullable:true property.
type: object
properties:
reqQosMonParams:
type: array
items:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter'
minItems: 1
repFreqs:
type: array
items:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ReportingFrequency'
minItems: 1
repThreshDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm'
repThreshUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm'
repThreshRp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm'
conThreshDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm'
conThreshUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm'
waitTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'
repPeriod:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'
repThreshDatRateDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'
repThreshDatRateUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'
consDataRateThrDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'
consDataRateThrUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'
QosMonitoringReport:
description: Represents a QoS monitoring report.
type: object
properties:
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
pdmf:
type: boolean
description: Represents the packet delay measurement failure indicator.
ulDataRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
dlDataRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
ulAggrDataRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
dlAggrDataRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
ulConInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
dlConInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
cimf:
type: boolean
description: >
Represents the congestion information measurement failure indicator. When set to "true",
it indicates that a congestion information failure has occurred. Default value is false
if omitted.
UserPlaneNotificationData:
description: Represents the parameters to be conveyed in a user plane event(s) notification.
type: object
properties:
transaction:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
eventReports:
type: array
items:
$ref: '#/components/schemas/UserPlaneEventReport'
minItems: 1
description: Contains the reported event and applicable information
required:
- transaction
- eventReports
UserPlaneEventReport:
description: Represents an event report for user plane.
type: object
properties:
event:
$ref: '#/components/schemas/UserPlaneEvent'
accumulatedUsage:
$ref: 'TS29122_CommonData.yaml#/components/schemas/AccumulatedUsage'
flowIds:
type: array
items:
type: integer
minItems: 1
description: >
Identifies the affected flows that were sent during event subscription. It might be
omitted when the reported event applies to all the flows sent during the subscription.
multiModFlows:
type: array
items:
$ref: '#/components/schemas/MultiModalFlows'
minItems: 1
description: >
Identifies the the flow filters for the single-modal data flows thatwere sent
during event subscription.
It may be omitted when the reported event applies to all the
single-modal data flows sent during the subscription.
appliedQosRef:
type: string
description: >
The currently applied QoS reference. Applicable for event QOS_NOT_GUARANTEED or
SUCCESSFUL_RESOURCES_ALLOCATION.
altQosNotSuppInd:
type: boolean
description: >
When present and set to true it indicates that the Alternative QoS profiles are not
supported by the access network. Applicable for event QOS_NOT_GUARANTEED.
plmnId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
qosMonReports:
type: array
items:
$ref: '#/components/schemas/QosMonitoringReport'
minItems: 1
description: Contains the QoS Monitoring Reporting information
pdvMonReports:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/PdvMonitoringReport'
minItems: 1
description: Contains the PDV Monitoring Reporting information
ratType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
batOffsetInfo:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/BatOffsetInfo'
rttMonReports:
type: array
items:
$ref: '#/components/schemas/QosMonitoringReport'
minItems: 1
description: Contains the round trip delay over two SDFs reporting information
qosMonDatRateReps:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosMonitoringReport'
minItems: 1
description: >
Contains QoS Monitoring for data rate information. It shall be present when the notified
event is "QOS_MONITORING" and data rate measurements are available.
aggrDataRateRpts:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosMonitoringReport'
minItems: 1
description: >
Contains QoS Monitoring for aggregated data rate information. It shall be present when
the notified event is "QOS_MONITORING" and data rate measurements are available.
qosMonConInfoReps:
type: array
items:
$ref: '#/components/schemas/QosMonitoringReport'
minItems: 1
description: >
Contains QoS Monitoring for congestion information. It shall be present when the
notified event is "QOS_MONITORING" and congestion measurements are available.
required:
- event
TscQosRequirement:
description: Represents QoS requirements for time sensitive communication.
type: object
properties:
reqGbrDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
reqGbrUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
reqMbrDl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
reqMbrUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
maxTscBurstSize:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol'
req5Gsdelay:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget'
reqPer:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate'
priority:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscPriorityLevel'
tscaiTimeDom:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
tscaiInputDl:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
tscaiInputUl:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
capBatAdaptation:
type: boolean
description: >
Indicates the capability for AF to adjust the burst sending time, when it is supported
and set to "true". The default value is "false" if omitted.
TscQosRequirementRm:
description: >
Represents the same as the TscQosRequirement data type but with the nullable:true property.
type: object