-
Notifications
You must be signed in to change notification settings - Fork 263
/
Copy pathTS29575_Nadrf_DataManagement.yaml
927 lines (926 loc) · 34.5 KB
/
TS29575_Nadrf_DataManagement.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
openapi: 3.0.0
info:
version: 1.1.0-alpha.5
title: Nadrf_DataManagement
description: |
ADRF Data Management Service.
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.575 V18.4.0; 5G System; Analytics Data Repository Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.575/'
#
servers:
- url: '{apiRoot}/nadrf-datamanagement/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
#
security:
- oAuth2ClientCredentials:
- nadrf-datamanagement
- {}
#
paths:
/data-store-records:
post:
summary: Creates a new Individual Data Store Record resource.
operationId: CreateADRFDataStoreRecord
tags:
- ADRF Data Store Records (Collection)
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfDataStoreRecord'
required: true
description: ADRF data store record to be stored.
responses:
'201':
description: Successful creation of new Individual ADRF Data Store Record resource.
headers:
Location:
description: >
Contains the URI of the newly created resource, according to the structure
{apiRoot}/nadrf-datamanagement/<apiVersion>/data-store-records/{storeTransId}
required: true
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfDataStoreRecord'
'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:
storageAlertNotification:
'{$request.body#/delNotifUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfAlertNotification'
responses:
'200':
description: The alert receipt is acknowledged and a planned action is provided.
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfAlertNotificationResponse'
'204':
description: The alert receipt 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'
get:
summary: Retrieves existing Individual ADRF Data Store Records.
operationId: GetAdrfDataStoreRecords
tags:
- ADRF Data Store Records (Collection)
security:
- {}
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- nnadrf-datamanagement:storagerequest
parameters:
- name: store-trans-id
description: A storage transaction identifier of a data store record in ADRF.
in: query
required: false
schema:
type: string
- name: fetch-correlation-ids
description: Fetch correlation identifiers received as part of fetch instruction.
in: query
required: false
style: form
explode: false
schema:
type: array
items:
type: string
minItems: 1
- name: data-set-id
description: The data set identifier.
in: query
required: false
schema:
type: string
responses:
'200':
description: Data store records are returned.
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfDataStoreRecord'
'204':
description: No matching ADRF data were found.
'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'
/data-store-records/{storeTransId}:
delete:
summary: Delete an existing Individual ADRF Data Store Record.
operationId: DeleteADRFDataStoreRecord
tags:
- Individual ADRF Data Store Record (Document)
parameters:
- name: storeTransId
in: path
description: String identifying a Data Store Record in ADRF.
required: true
schema:
type: string
responses:
'204':
description: >
No Content. The Individual ADRF Data Store Record resource matching the
storeTransId was deleted.
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/data-retrieval-subscriptions:
post:
summary: Creates a new Individual ADRF Data Retrieval Subscription resource.
operationId: CreateADRFDataRetrievalSubscription
tags:
- ADRF Data Retrieval Subscriptions (Collection)
security:
- {}
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- nnadrf-datamanagement:storagerequest
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfDataRetrievalSubscription'
required: true
description: Individual ADRF Data Retrieval Subscription resource to be created.
responses:
'201':
description: Created a new Individual ADRF Data Retrieval Subscription resource.
headers:
Location:
description: >
Contains the URI of the newly created resource, according to the structure
{apiRoot}/nadrf-datamanagement/<apiVersion>/data-retrieval-subscriptions/{subscriptionId}
required: true
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfDataRetrievalSubscription'
'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:
adrfDataRetrievalNotification:
'{$request.body#/notificationURI}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfDataRetrievalNotification'
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'
/data-retrieval-subscriptions/{subscriptionId}:
delete:
summary: Delete an existing Individual ADRF Data Retrieval Subscription resource.
operationId: DeleteADRFDataRetrievalSubscription
tags:
- Individual ADRF Data Retrieval Subscription (Document)
security:
- {}
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- nnadrf-datamanagement:storagerequest
parameters:
- name: subscriptionId
in: path
description: >
String identifying a data retrieval subscription to the Nadrf_DataManagement
Service.
required: true
schema:
type: string
responses:
'204':
description: >
No Content. The Individual ADRF Data Retrieval Subscription resource matching
the subscriptionId was deleted.
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'502':
$ref: 'TS29571_CommonData.yaml#/components/responses/502'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/request-storage-sub:
post:
summary: Triggers the creation of a new ADRF Storage Subscription.
operationId: CreateADRFStorageSubscription
tags:
- ADRF Storage Subscriptions
security:
- {}
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- nnadrf-datamanagement:storagerequest
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfDataStoreSubscription'
required: true
responses:
'200':
description: >
Successful response with reference used to identify the subscription at the ADRF.
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfDataStoreSubscriptionRef'
'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:
storageSubAlertNotification:
'{$request.body#/delNotifUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfAlertNotification'
responses:
'200':
description: The alert receipt is acknowledged and a planned action is provided.
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfAlertNotificationResponse'
'204':
description: The alert receipt 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'
/request-storage-sub-removal:
post:
summary: Triggers the removal of ADRF storage subscription.
operationId: DeleteADRFStorageSubscription
tags:
- ADRF Storage Subscriptions
security:
- {}
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- nnadrf-datamanagement:storagerequest
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfDataStoreSubscriptionRef'
required: true
responses:
'204':
description: >
No Content. The ADRF Storage Subscription matching the provided reference was deleted.
'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'
/remove-stored-data-analytics:
post:
summary: Remove ADRF data based on data or analytics specification.
operationId: DeleteADRFData
tags:
- ADRF Stored Data
security:
- {}
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- oAuth2ClientCredentials:
- nnadrf-datamanagement
- nnadrf-datamanagement:storagerequest
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NadrfStoredDataSpec'
required: true
responses:
'204':
description: No Content. The ADRF data matching the provided specification is deleted.
'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'
#
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nadrf-datamanagement: Access to the nadrf-datamanagement API
#
schemas:
#
NadrfDataStoreRecord:
description: Represents an Individual ADRF Data Store Record.
type: object
oneOf:
- allOf:
- required: [anaSub]
- required: [anaNotifications]
- allOf:
- required: [dataSub]
- required: [dataNotif]
properties:
dataNotif:
$ref: '#/components/schemas/DataNotification'
anaNotifications:
type: array
items:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscriptionNotification'
minItems: 1
description: List of analytics subscription notifications.
anaSub:
type: array
items:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription'
minItems: 1
description: >
Represents the subscription information of the corresponding analytics notification.
dataSub:
type: array
items:
$ref: '#/components/schemas/DataSubscription'
minItems: 1
description: >
Represents the subscription information of the corresponding data notification.
storeHandl:
$ref: '#/components/schemas/StorageHandlingInfo'
dataSetTag:
$ref: '#/components/schemas/DataSetTag'
dsc:
type: string
description: Data synthesis and compression information.
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
#
NadrfDataStoreSubscription:
description: >
Contains information to be used by the ADRF to create a Data or Analytics subscription.
type: object
allOf:
- oneOf:
- required: [anaSub]
- required: [dataSub]
- oneOf:
- required: [targetNfId]
- required: [targetNfSetId]
properties:
anaSub:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription'
dataSetTag:
$ref: '#/components/schemas/DataSetTag'
dataSub:
$ref: '#/components/schemas/DataSubscription'
targetNfId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
targetNfSetId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
formatInstruct:
$ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/FormattingInstruction'
procInstruct:
$ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/ProcessingInstruction'
multiProcInstructs:
type: array
items:
$ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/ProcessingInstruction'
minItems: 1
description: Processing instructions to be used for sending event notifications.
storeHandl:
$ref: '#/components/schemas/StorageHandlingInfo'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
#
NadrfDataRetrievalSubscription:
description: Represents an Individual ADRF Data Retrieval Subscription.
type: object
required:
- notifCorrId
- notificationURI
- timePeriod
oneOf:
- required: [anaSub]
- required: [dataSub]
- required: [dataSetId]
properties:
anaSub:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription'
dataSetId:
type: string
description: data set identifier of the data or analytics that are subscribed.
dataSub:
$ref: '#/components/schemas/DataSubscription'
notificationURI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
timePeriod:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
notifCorrId:
type: string
description: Notification correlation identifier.
consTrigNotif:
type: boolean
description: >
It indicates that notifications shall be buffered (sending only fetch instructions
to the NF service consumer) until the NF service consumer requests their delivery
using Nadrf_DataManagement Service.
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
#
NadrfDataRetrievalNotification:
description: >
Represents a notification that corresponds with an Individual ADRF Data
Retrieval Subscription.
type: object
required:
- notifCorrId
- timeStamp
oneOf:
- required: [anaNotifications]
- required: [dataNotif]
- required: [fetchInstruct]
properties:
notifCorrId:
type: string
description: Notification correlation identifier.
anaNotifications:
type: array
items:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscriptionNotification'
minItems: 1
description: List of analytics subscription notifications.
dataNotif:
$ref: '#/components/schemas/DataNotification'
fetchInstruct:
$ref: 'TS29576_Nmfaf_3caDataManagement.yaml#/components/schemas/FetchInstruction'#
terminationReq:
type: boolean
description: >
It indicates the termination of the data management subscription that requested by the
ADRF.
dsc:
type: string
description: Data synthesis and compression information.
timeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
#
NadrfDataStoreSubscriptionRef:
description: Contains a reference to a request for a Data or Analytics subscription.
type: object
oneOf:
- required: [transRefId]
- required: [dataSetId]
properties:
transRefId:
type: string
description: Transaction reference identifier.
dataSetId:
type: string
description: data set identifier of data or analytics.
#
NadrfStoredDataSpec:
description: Contains information about Data or Analytics specification.
type: object
required:
- timePeriod
oneOf:
- required: [dataSpec]
- required: [anaSpec]
- required: [dataSetId]
properties:
dataSpec:
$ref: '#/components/schemas/DataSubscription'
anaSpec:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription'
timePeriod:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
dataSetId:
type: string
description: Data set identifier of stored data or analytics records.
#
DataSubscription:
description: Contains a data specification.
type: object
oneOf:
- required: [amfDataSub]
- required: [smfDataSub]
- required: [udmDataSub]
- required: [nefDataSub]
- required: [afDataSub]
- required: [nrfDataSub]
- required: [nsacfDataSub]
- required: [upfDataSub]
- required: [gmlcDataSub]
properties:
amfDataSub:
$ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/AmfEventSubscription'
smfDataSub:
$ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NsmfEventExposure'
udmDataSub:
$ref: 'TS29503_Nudm_EE.yaml#/components/schemas/EeSubscription'
afDataSub:
$ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEventExposureSubsc'
nefDataSub:
$ref: 'TS29591_Nnef_EventExposure.yaml#/components/schemas/NefEventExposureSubsc'
nrfDataSub:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SubscriptionData'
nsacfDataSub:
$ref: 'TS29536_Nnsacf_SliceEventExposure.yaml#/components/schemas/SACEventSubscription'
upfDataSub:
$ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/UpfEventSubscription'
gmlcDataSub:
$ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/InputData'
#
DataNotification:
description: Represents a Data Subscription Notification.
type: object
oneOf:
- required: [amfEventNotifs]
- required: [smfEventNotifs]
- required: [udmEventNotifs]
- required: [nefEventNotifs]
- required: [afEventNotifs]
- required: [nrfEventNotifs]
- required: [nsacfEventNotifs]
- required: [upfEventNotifs]
- required: [gmlcEventNotifs]
properties:
amfEventNotifs:
type: array
items:
$ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/AmfEventNotification'
minItems: 1
description: List of notifications of AMF events.
smfEventNotifs:
type: array
items:
$ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NsmfEventExposureNotification'
minItems: 1
description: List of notifications of SMF events.
udmEventNotifs:
type: array
items:
$ref: 'TS29503_Nudm_EE.yaml#/components/schemas/MonitoringReport'
minItems: 1
description: List of notifications of UDM events.
nefEventNotifs:
type: array
items:
$ref: 'TS29591_Nnef_EventExposure.yaml#/components/schemas/NefEventExposureNotif'
minItems: 1
description: List of notifications of NEF events.
afEventNotifs:
type: array
items:
$ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEventExposureNotif'
minItems: 1
description: List of notifications of AF events.
nrfEventNotifs:
type: array
items:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NotificationData'
minItems: 1
description: List of notifications of NRF events.
nsacfEventNotifs:
type: array
items:
$ref: 'TS29536_Nnsacf_SliceEventExposure.yaml#/components/schemas/SACEventReport'
minItems: 1
description: List of notifications of NSACF events.
upfEventNotifs:
type: array
items:
$ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/NotificationData'
minItems: 1
description: List of notifications of UPF events.
gmlcEventNotifs:
type: array
items:
$ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/EventNotifyData'
minItems: 1
description: List of notifications of GMLC events.
timeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
#
StorageHandlingInfo:
description: Contains storage handling information about data or analytics.
type: object
properties:
lifetime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
delNotifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
delNotifCorrId:
type: string
description: Notification correlation identifier for deletion alerts.
#
NadrfAlertNotification:
description: Contains information about data or analytics that are about to be deleted.
type: object
properties:
alertStorTransId:
type: string
description: >
Storage transaction identifier that can be used to retrieve data or analytics.
delNotifCorrId:
type: string
description: Notification correlation identifier.
required:
- alertStorTransId
- delNotifCorrId
#
NadrfAlertNotificationResponse:
description: >
Contains information about planned actions related to data or analytics
that are about to be deleted.
type: object
properties:
retrievalInd:
type: boolean
description: >
Indicates if the NF service consumer has determined to retrieve the data
or analytics that are about to be deleted.
required:
- retrievalInd
#
DataSetTag:
description: Contains an identifier and a description of associated records.
type: object
required:
- dataSetId
properties:
dataSetId:
type: string
description: Data set identifier of data or analytics records.
dataSetDesc:
type: string
description: Data set description of data or analytics records.
#