-
Notifications
You must be signed in to change notification settings - Fork 263
/
Copy pathTS29534_Npcf_AMPolicyAuthorization.yaml
767 lines (766 loc) · 28.9 KB
/
TS29534_Npcf_AMPolicyAuthorization.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
openapi: 3.0.0
#
info:
title: Npcf_AMPolicyAuthorization Service API
version: 1.1.0-alpha.2
description: |
PCF Access and Mobility Policy Authorization Service.
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.534 V18.1.0;
5G System; Access and Mobility Policy Authorization Service; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.534/'
#
servers:
- url: '{apiRoot}/npcf-am-policyauthorization/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
#
security:
- {}
- oAuth2ClientCredentials:
- npcf-am-policyauthorization
#
paths:
/app-am-contexts:
post:
summary: Creates a new Individual Application AM Context resource
operationId: PostAppAmContexts
tags:
- Application AM contexts (Collection)
requestBody:
description: Contains the information for the creation the resource.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AppAmContextData'
responses:
'201':
description: Successful creation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/AppAmContextRespData'
headers:
Location:
description: >
Contains the URI of the created individual application AM context resource,
according to the structure
{apiRoot}/npcf-am-policyauthorization/<apiVersion>/app-am-contexts/{appAmContextId}
or the URI of the created AM Policy events subscription subresource,
according to the structure
{apiRoot}/npcf-am-policyauthorization/<apiVersion>/app-am-contexts/{appAmContextId}/events-subscription}
required: true
schema:
type: string
'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'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
callbacks:
terminationRequest:
'{$request.body#/termNotifUri}':
post:
requestBody:
description: Request of the termination of the Individual Application AM Context.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AmTerminationInfo'
responses:
'204':
description: The receipt of the notification is acknowledged.
'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'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
amEventNotification:
'{$request.body#/evSubsc/eventNotifUri}':
post:
requestBody:
description: Notification of an event occurrence in the PCF.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AmEventsNotification'
responses:
'204':
description: The receipt of the notification is acknowledged.
'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'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
#
/app-am-contexts/{appAmContextId}:
get:
summary: "Reads an existing Individual Application AM Context"
operationId: GetAppAmContext
tags:
- Individual Application AM Context (Document)
parameters:
- name: appAmContextId
description: String identifying the resource.
in: path
required: true
schema:
type: string
responses:
'200':
description: A representation of the resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/AppAmContextData'
'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'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
#
patch:
summary: "Modifies an existing Individual Application AM Context"
operationId: ModAppAmContext
tags:
- Individual Application AM Context (Document)
parameters:
- name: appAmContextId
description: String identifying the resource.
in: path
required: true
schema:
type: string
requestBody:
description: Modification of the resource.
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/AppAmContextUpdateData'
responses:
'200':
description: >
Successful modification of the resource and a representation of that resource is
returned. If a subscribed event is matched, the event notification is also included
in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/AppAmContextRespData'
'204':
description: The successful modification.
'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'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
callbacks:
amEventNotification:
'{$request.body#/evSubsc/eventNotifUri}':
post:
requestBody:
description: Notification of an event occurrence in the PCF.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AmEventsNotification'
responses:
'204':
description: The receipt of the notification is acknowledged.
'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'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
#
delete:
summary: Deletes an existing Individual Application AM Context
operationId: DeleteAppAmContext
tags:
- Individual Application AM Context (Document)
parameters:
- name: appAmContextId
description: String identifying the Individual Application AM Context resource.
in: path
required: true
schema:
type: string
responses:
'204':
description: The deletion is confirmed without returning additional data.
'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'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
#
/app-am-contexts/{appAmContextId}/events-subscription:
put:
summary: creates or modifies an AM Policy Events Subscription subresource.
operationId: updateAmEventsSubsc
tags:
- AM Policy Events Subscription (Document)
parameters:
- name: appAmContextId
description: String identifying the AM Policy Events Subscription subresource.
in: path
required: true
schema:
type: string
requestBody:
description: Creation or modification of an AM Policy Events Subscription subresource.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AmEventsSubscData'
responses:
'201':
description: >
The creation of the AM Policy Events Subscription subresource is confirmed and its
representation is returned. If an AM Event is matched, the response also includes the
notification.
content:
application/json:
schema:
$ref: '#/components/schemas/AmEventsSubscRespData'
headers:
Location:
description: >
Contains the URI of the created AM Policy Events Subscription subresource,
according to the structure
{apiRoot}/npcf-am-policyauthorization/<apiVersion>/app-am-contexts/{appAmContextId}/events-subscription}
required: true
schema:
type: string
'200':
description: >
The modification of the AM Policy Events Subscription subresource is confirmed and
its representation is returned. If an AM Event is matched, the response also includes
the notification.
content:
application/json:
schema:
$ref: '#/components/schemas/AmEventsSubscRespData'
'204':
description: >
The modification of the AM Policy Events Subscription subresource is confirmed
without returning additional data.
'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'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
callbacks:
amEventNotification:
'{$request.body#/evSubsc/eventNotifUri}':
post:
requestBody:
description: >
Contains the information for the notification of an event occurrence in the PCF.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AmEventsNotification'
responses:
'204':
description: The receipt of the notification is acknowledged.
'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'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
delete:
summary: deletes the AM Policy Events Subscription subresource
operationId: DeleteAmEventsSubsc
tags:
- AM Policy Events Subscription (Document)
parameters:
- name: appAmContextId
description: String identifying the Individual Application AM Context resource.
in: path
required: true
schema:
type: string
responses:
'204':
description: >
The deletion of the of the AM Policy Events Subscription subresource
is confirmed without returning additional data.
'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'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'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:
npcf-am-policyauthorization: Access to the Npcf_AMPolicyAuthorization API
#
schemas:
#
AppAmContextData:
description: Represents an Individual Application AM Context resource.
type: object
required:
- supi
- termNotifUri
properties:
supi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
termNotifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
evSubsc:
$ref: '#/components/schemas/AmEventsSubscData'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
expiry:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
highThruInd:
type: boolean
description: Indicates whether high throughput is desired for the indicated UE traffic.
covReq:
type: array
description: >
Identifies a list of Tracking Areas per serving network where service is allowed.
items:
$ref: '#/components/schemas/ServiceAreaCoverageInfo'
minItems: 1
asTimeDisParam:
$ref: 'TS29507_Npcf_AMPolicyControl.yaml#/components/schemas/AsTimeDistributionParam'
anyOf:
- anyOf:
- required: [highThruInd]
- required: [covReq]
- required: [asTimeDisParam]
- required: [evSubsc]
#
#
AppAmContextUpdateData:
description: Describes the modifications to an Individual Application AM resource.
type: object
properties:
termNotifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
evSubsc:
$ref: '#/components/schemas/AmEventsSubscDataRm'
expiry:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'
highThruInd:
description: Indicates whether high throughput is desired for the indicated UE traffic.
type: boolean
nullable: true
covReq:
type: array
description: >
Identifies a list of Tracking Areas per serving network where service is allowed.
items:
$ref: '#/components/schemas/ServiceAreaCoverageInfo'
minItems: 1
nullable: true
asTimeDisParam:
$ref: 'TS29507_Npcf_AMPolicyControl.yaml#/components/schemas/AsTimeDistributionParam'
#
AmEventsSubscData:
description: >
It represents the AM Policy Events Subscription subresource and identifies the events
the application subscribes to.
type: object
required:
- eventNotifUri
properties:
eventNotifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
events:
type: array
items:
$ref: '#/components/schemas/AmEventData'
minItems: 1
#
AmEventsNotification:
description: >
Describes the notification about the events occurred within an Individual Application
AM Context resource.
type: object
required:
- repEvents
properties:
appAmContextId:
type: string
description: >
Contains the AM Policy Events Subscription resource identifier related to the event
notification.
repEvents:
type: array
items:
$ref: '#/components/schemas/AmEventNotification'
minItems: 1
#
AmTerminationInfo:
description: >
Includes information related to the termination of the Individual Application AM
Context resource.
type: object
required:
- appAmContextId
- termCause
properties:
appAmContextId:
type: string
description: >
Contains the Individual application AM context resource identifier related to
the termination notification.
termCause:
$ref: '#/components/schemas/AmTerminationCause'
#
AmEventsSubscDataRm:
description: >
This data type is defined in the same way as the AmEventsSubscData but with the OpenAPI
nullable property set to true.
type: object
properties:
eventNotifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
events:
type: array
items:
$ref: '#/components/schemas/AmEventData'
minItems: 1
nullable: true
#
AmEventData:
description: >
This data type contains the event identifier and the related event reporting information.
type: object
required:
- event
properties:
event:
$ref: '#/components/schemas/AmEvent'
immRep:
type: boolean
notifMethod:
$ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NotificationMethod'
maxReportNbr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
monDur:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
repPeriod:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
#
AmEventNotification:
description: Describes the notification of a subscription.
type: object
required:
- event
properties:
event:
$ref: '#/components/schemas/AmEvent'
appliedCov:
$ref: '#/components/schemas/ServiceAreaCoverageInfo'
pduidInfo:
$ref: '#/components/schemas/PduidInformation'
#
PduidInformation:
description: Contains the ProSe Discovery UE ID and its validity timer.
type: object
required:
- expiry
- pduid
properties:
expiry:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
pduid:
$ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/Pduid'
#
ServiceAreaCoverageInfo:
description: It represents a list of Tracking Areas within a serving network.
type: object
required:
- tacList
properties:
tacList:
type: array
description: Indicates a list of Tracking Areas where the service is allowed.
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Tac'
servingNetwork:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
#
# ENUMERATIONS DATA TYPES
#
AmTerminationCause:
description: >
It represents the cause values that the PCF should report when requesting from an NF
service consumer the deletion of an "AF application AM context" resource.
anyOf:
- type: string
enum:
- UE_DEREGISTERED
- UNSPECIFIED
- INSUFFICIENT_RESOURCES
- 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.
#
AmEvent:
anyOf:
- type: string
enum:
- SAC_CH
- PDUID_CH
- 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 PCF notification event to the NF service consumer.
Possible values are:
- SAC_CH: Service Area Coverage Change.
- PDUID_CH: The PDUID assigned to a UE for the UE ProSe Policies changed.
#
#
AppAmContextRespData:
description: It represents a response to a modification or creation request of an Individual Application AM resource. It may contain the notification of the already met events.
anyOf:
- $ref: '#/components/schemas/AppAmContextData'
- $ref: '#/components/schemas/AmEventsNotification'
#
AmEventsSubscRespData:
description: Identifies the events the application subscribes to within an AM Policy Events Subscription subresource data. It may contain the notification of the already met events.
anyOf:
- $ref: '#/components/schemas/AmEventsSubscData'
- $ref: '#/components/schemas/AmEventsNotification'
#