-
Notifications
You must be signed in to change notification settings - Fork 255
/
TS29122_PfdManagement.yaml
824 lines (810 loc) · 30.7 KB
/
TS29122_PfdManagement.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
openapi: 3.0.0
info:
title: 3gpp-pfd-management
version: 1.3.0-alpha.3
description: |
API for PFD management.
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.122 V18.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-pfd-management/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
paths:
/{scsAsId}/transactions:
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122.
required: true
schema:
type: string
get:
summary: Read all or queried PFDs for a given SCS/AS.
operationId: FetchAllPFDManagementTransactions
tags:
- PFD Management Transactions
parameters:
- name: external-app-ids
in: query
description: The external application identifier(s) of the requested PFD data.
required: false
schema:
type: array
items:
type: string
minItems: 1
responses:
'200':
description: OK. All or queried transactions related to the request URI are returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PfdManagement'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
post:
summary: Create PFDs for a given SCS/AS and one or more external Application Identifier(s).
operationId: CreatePFDManagementTransaction
tags:
- PFD Management Transactions
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PfdManagement'
description: Create a new transaction for PFD management.
responses:
'201':
description: >
Created. The transaction was created successfully. The SCEF shall return the created
transaction in the response content. PfdReport may be included to provide detailed
failure information for some applications.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdManagement'
headers:
Location:
description: 'Contains the URI of the newly created resource'
required: true
schema:
type: string
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
description: >
The PFDs for all applications were not created successfully. PfdReport is included with
detailed information.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PfdReport'
minItems: 1
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
callbacks:
notificationDestination:
'{request.body#/notificationDestination}':
post:
requestBody: # contents of the callback message
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PfdReport'
minItems: 1
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'
/{scsAsId}/transactions/{transactionId}:
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122.
required: true
schema:
type: string
- name: transactionId
in: path
description: Transaction ID
required: true
schema:
type: string
get:
summary: Read all PFDs for a given SCS/AS and a transaction for one or more external Application Identifier(s).
operationId: FetchIndPFDManagementTransaction
tags:
- Individual PFD Management Transaction
responses:
'200':
description: OK. The transaction information related to the request URI is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdManagement'
'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 PFDs for a given SCS/AS and a transaction for one or more external Application Identifier(s).
operationId: UpdateIndPFDManagementTransaction
tags:
- Individual PFD Management Transaction
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PfdManagement'
description: Change information in PFD management transaction.
responses:
'200':
description: >
OK. The transaction was modified successfully. The SCEF shall return an updated
transaction in the response content.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdManagement'
'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':
description: >
The PFDs for all applications were not updated successfully. PfdReport is included with
detailed information.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PfdReport'
minItems: 1
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
summary: Modify an existing PFD Management Transaction resource.
operationId: ModifyIndPFDManagementTransaction
tags:
- Individual PFD Management Transaction
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/PfdManagementPatch'
responses:
'200':
description: >
OK. The PFD Management Transaction was modified successfully. The SCEF shall return an
updated representation of the resource in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdManagement'
'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':
description: >
The PFDs for all applications were not modified successfully. A set of PFD Report(s) is
included with detailed information.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PfdReport'
minItems: 1
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Delete PFDs for a given SCS/AS and a transaction for one or more external Application Identifier(s).
operationId: DeleteIndPFDManagementTransaction
tags:
- Individual PFD Management Transaction
responses:
'204':
description: >
No Content. The transaction was deleted successfully. The content shall be empty.
'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'
/{scsAsId}/transactions/{transactionId}/applications/{appId}:
parameters:
- name: scsAsId
in: path
description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122.
required: true
schema:
type: string
- name: transactionId
in: path
description: Transaction ID
required: true
schema:
type: string
- name: appId
in: path
description: Identifier of the application
required: true
schema:
type: string
get:
summary: Read PFDs at individual application level.
operationId: FetchIndApplicationPFDManagement
tags:
- Individual Application PFD Management
responses:
'200':
description: OK. The application information related to the request URI is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdData'
'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 PFDs at individual application level.
operationId: UpdateIndApplicationPFDManagement
tags:
- Individual Application PFD Management
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PfdData'
description: Change information in application.
responses:
'200':
description: >
OK. The application resource was modified successfully. The SCEF shall return an updated
application resource in the response content.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdData'
'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':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'409':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'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':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
summary: Update PFDs at individual application level.
operationId: ModifyIndApplicationPFDManagement
tags:
- Individual Application PFD Management
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/PfdData'
description: Change information in PFD management transaction.
responses:
'200':
description: >
OK. The transaction was modified successfully. The SCEF shall return an updated
transaction in the response content.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdData'
'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':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'409':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'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':
description: The PFDs for the application were not updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PfdReport'
application/problem+json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Delete PFDs at individual application level.
operationId: DeleteIndApplicationPFDManagement
tags:
- Individual Application PFD Management
responses:
'204':
description: >
No Content. The application was deleted successfully. The content shall be empty.
'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:
PfdManagement:
description: Represents a PFD management resource for a PFD management request.
type: object
properties:
self:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
pfdDatas:
type: object
additionalProperties:
$ref: '#/components/schemas/PfdData'
minProperties: 1
description: >
Each element uniquely identifies the PFDs for an external application identifier.
Each element is identified in the map via an external application identifier as key.
The response shall include successfully provisioned PFD data of application(s).
pfdReports:
type: object
additionalProperties:
$ref: '#/components/schemas/PfdReport'
minProperties: 1
description: >
Supplied by the SCEF and contains the external application identifiers for which PFD(s)
are not added or modified successfully. The failure reason is also included.
Each element provides the related information for one or more external application
identifier(s) and is identified in the map via the failure identifier as key.
readOnly: true
notificationDestination:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
requestTestNotification:
type: boolean
description: >
Set to true by the SCS/AS to request the SCEF to send a test notification as defined
in clause 5.2.5.3. Set to false or omitted otherwise.
websockNotifConfig:
$ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
required:
- pfdDatas
PfdData:
description: >
Represents a PFD request to add, update or remove PFD(s) for one external application
identifier.
type: object
properties:
externalAppId:
type: string
description: Each element uniquely external application identifier
self:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
pfds:
type: object
additionalProperties:
$ref: '#/components/schemas/Pfd'
description: >
Contains the PFDs of the external application identifier. Each PFD is identified in
the map via a key containing the PFD identifier.
allowedDelay:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm'
cachingTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRo'
required:
- externalAppId
- pfds
Pfd:
description: Represents a PFD for an external Application Identifier.
type: object
properties:
pfdId:
type: string
description: Identifies a PDF of an application identifier.
flowDescriptions:
type: array
items:
type: string
minItems: 1
description: >
Represents a 3-tuple with protocol, server ip and server port for UL/DL application
traffic. The content of the string has the same encoding as the IPFilterRule AVP
value as defined in IETF RFC 6733.
urls:
type: array
items:
type: string
minItems: 1
description: >
Indicates a URL or a regular expression which is used to match the significant parts
of the URL.
domainNames:
type: array
items:
type: string
minItems: 1
description: Indicates an FQDN or a regular expression as a domain name matching criteria.
dnProtocol:
$ref: '#/components/schemas/DomainNameProtocol'
required:
- pfdId
PfdReport:
description: >
Represents a PFD report indicating the external application identifier(s) which PFD(s)
are not added or modified successfully and the corresponding failure cause(s).
type: object
properties:
externalAppIds:
type: array
items:
type: string
minItems: 1
description: >
Identifies the external application identifier(s) which PFD(s) are not added or
modified successfully
failureCode:
$ref: '#/components/schemas/FailureCode'
cachingTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
locationArea:
$ref: '#/components/schemas/UserPlaneLocationArea'
required:
- externalAppIds
- failureCode
UserPlaneLocationArea:
description: >
Represents location area(s) of the user plane functions which are unable to enforce the
provisioned PFD(s) successfully.
type: object
properties:
locationArea:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea'
locationArea5G:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
dnais:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems: 0
description: Identifies a list of DNAI which the user plane functions support.
PfdManagementPatch:
description: >
Represents the parameters to request the modification of a PFD management transaction
resource.
type: object
properties:
pfdDatas:
type: object
additionalProperties:
$ref: '#/components/schemas/PfdData'
minProperties: 1
notificationDestination:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
FailureCode:
anyOf:
- type: string
enum:
- MALFUNCTION
- RESOURCE_LIMITATION
- SHORT_DELAY
- APP_ID_DUPLICATED
- PARTIAL_FAILURE
- OTHER_REASON
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description: |
Represents the failure reason of the PFD management.
Possible values are:
- MALFUNCTION: This value indicates that something functions wrongly in PFD provisioning
or the PFD provisioning does not function at all.
- RESOURCE_LIMITATION: This value indicates there is resource limitation for PFD storage.
- SHORT_DELAY: This value indicates that the allowed delay is too short and PFD(s)
are not stored.
- APP_ID_DUPLICATED: The received external application identifier(s) are already
provisioned.
- PARTIAL_FAILURE: The PFD(s) are not provisioned to all PCEFs/TDFs/SMFs.
- OTHER_REASON: Other reason unspecified.
DomainNameProtocol:
anyOf:
- type: string
enum:
- DNS_QNAME
- TLS_SNI
- TLS_SAN
- TSL_SCN
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
description: |
Represents the type of Domain Name Protocol.
Possible values are:
- DNS_QNAME: Identifies the DNS protocol and the question name in DNS query.
- TLS_SNI: Identifies the Server Name Indication in TLS ClientHello message.
- TLS_SAN: Identifies the Subject Alternative Name in TLS ServerCertificate message.
- TSL_SCN: Identifies the Subject Common Name in TLS ServerCertificate message.