RniAPI.yaml 113 KB
Newer Older
1
openapi: 3.1.0
2
info:
Michel Roy's avatar
Michel Roy committed
3
4
  title: ETSI GS MEC 012 - Radio Network Information API
  description: The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
5
6
7
  contact:
    url: https://forge.etsi.org/rep/mec/gs012-rnis-api
  version: '2.1.1'
8
9
10
  license:
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'
11
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
12
13
14
15

externalDocs:
  description: ETSI GS MEC 012 Radio Network Information API, V2.1.1
  url: http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf
Michel Roy's avatar
Michel Roy committed
16
servers:
17
- url: https://localhost/rni/v2
18
19
20

tags:
- name: rni
21
paths:
22
  /queries/rab_info:
23
    get:
Michel Roy's avatar
Michel Roy committed
24
      tags:
25
      - rni
26
      summary:  'Retrieve information on Radio Access Bearers'
27
      description: Queries information about the Radio Access Bearers
28
29
      operationId: rab_infoGET
      parameters:
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
      - name: app_ins_id
        in: query
        description: Application instance identifier
        style: form
        explode: true
        schema:
          type: string
      - name: cell_id
        in: query
        description: Comma separated list of E-UTRAN Cell Identities
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv4_address
        in: query
        description: Comma separated list of IE IPv4 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv6_address
        in: query
        description: Comma separated list of IE IPv6 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: nated_ip_address
        in: query
        description: Comma separated list of IE NATed IP addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: gtp_teid
        in: query
        description: Comma separated list of GTP TEID addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: erab_id
        in: query
        description: E-RAB identifier
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: qci
        in: query
        description: QoS Class Identifier as defined in ETSI TS 123 401
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: erab_mbr_dl
        in: query
        description: Maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: erab_mbr_ul
        in: query
        description: Maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: erab_gbr_dl
        in: query
        description: Guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: erab_gbr_ul
        in: query
        description: Guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
130
131
132
      responses:
        '200':
          description: Successful response to rab_info request
133
          headers: {}
Michel Roy's avatar
Michel Roy committed
134
          content:
135
            application/json:
Michel Roy's avatar
Michel Roy committed
136
              schema:
Michel Roy's avatar
Michel Roy committed
137
                $ref: '#/components/schemas/RabInfo'
138
        '400':
139
140
141
142
143
144
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
145
        '401':
146
147
148
149
150
151
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
152
        '403':
153
154
155
156
157
158
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
159
        '404':
160
161
162
163
164
165
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
166
        '406':
167
168
169
170
171
172
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
173
        '429':
174
175
176
177
178
179
180
181
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
182
  /queries/plmn_info:
183
    get:
Michel Roy's avatar
Michel Roy committed
184
      tags:
185
      - rni
186
      summary: 'Queries information about the Mobile Network'
187
      description: Queries information about the Mobile Network
188
189
      operationId: plmn_infoGET
      parameters:
190
191
192
193
194
195
196
197
198
199
      - name: app_ins_id
        in: query
        description: Comma separated list of Application instance identifiers
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
200
201
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
202
          description: Successful response to plmn_info request
203
          headers: {}
Michel Roy's avatar
Michel Roy committed
204
          content:
205
            application/json:
Michel Roy's avatar
Michel Roy committed
206
              schema:
207
                type: array
Michel Roy's avatar
Michel Roy committed
208
209
                items:
                  $ref: '#/components/schemas/PlmnInfo'
210
211
                description: ''
                contentMediaType: application/json
212
        '400':
213
214
215
216
217
218
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
219
        '401':
220
221
222
223
224
225
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
226
        '403':
227
228
229
230
231
232
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
233
        '404':
234
235
236
237
238
239
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
240
        '406':
241
242
243
244
245
246
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
247
        '429':
248
249
250
251
252
253
254
255
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
256
  /queries/s1_bearer_info:
257
    get:
Michel Roy's avatar
Michel Roy committed
258
      tags:
259
      - rni
260
      summary: Retrieve S1-U bearer information related to specific UE(s)'
261
      description: Queries information about the S1 bearer(s)
262
263
      operationId: s1_bearer_infoGET
      parameters:
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
      - name: temp_ue_id
        in: query
        description: Comma separated list of temporary identifiers allocated for the specific UE as defined in   ETSI TS 136 413
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv4_address
        in: query
        description: Comma separated list of IE IPv4 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv6_address
        in: query
        description: Comma separated list of IE IPv6 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: nated_ip_address
        in: query
        description: Comma separated list of IE NATed IP addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: gtp_teid
        in: query
        description: Comma separated list of GTP TEID addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: cell_id
        in: query
        description: Comma separated list of E-UTRAN Cell Identities
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: erab_id
        in: query
        description: Comma separated list of E-RAB identifiers
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            contentEncoding: int32
328
329
330
      responses:
        '200':
          description: Successful response to s1_bearer_info request
331
          headers: {}
Michel Roy's avatar
Michel Roy committed
332
          content:
333
            application/json:
Michel Roy's avatar
Michel Roy committed
334
              schema:
Michel Roy's avatar
Michel Roy committed
335
                $ref: '#/components/schemas/S1BearerInfo'
336
        '400':
337
338
339
340
341
342
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
343
        '401':
344
345
346
347
348
349
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
350
        '403':
351
352
353
354
355
356
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
357
        '404':
358
359
360
361
362
363
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
364
        '406':
365
366
367
368
369
370
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
371
        '429':
372
373
374
375
376
377
378
379
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Michel Roy's avatar
Michel Roy committed
380
  /queries/layer2_meas:
381
    get:
Michel Roy's avatar
Michel Roy committed
382
      tags:
383
      - rni
384
      summary: 'Retrieve information on layer 2 measurements'
385
      description: Queries information about the layer 2 measurements.
Michel Roy's avatar
Michel Roy committed
386
387
      operationId: layer2_meas_infoGET
      parameters:
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
      - name: app_ins_id
        in: query
        description: Application instance identifier
        style: form
        explode: true
        schema:
          type: string
      - name: cell_id
        in: query
        description: Comma separated list of E-UTRAN Cell Identities
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv4_address
        in: query
        description: Comma separated list of IE IPv4 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ue_ipv6_address
        in: query
        description: Comma separated list of IE IPv6 addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: nated_ip_address
        in: query
        description: Comma separated list of IE NATed IP addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: gtp_teid
        in: query
        description: Comma separated list of GTP TEID addresses as defined for the type for AssociateId
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: dl_gbr_prb_usage_cell
        in: query
        description: PRB usage for downlink GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_prb_usage_cell
        in: query
        description: PRB usage for uplink GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_prb_usage_cell
        in: query
        description: PRB usage for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_prb_usage_cell
        in: query
        description: PRB usage for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_total_prb_usage_cell
        in: query
        description: PRB usage for total downlink traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_total_prb_usage_cell
        in: query
        description: PRB usage for total uplink traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: received_dedicated_preambles_cell
        in: query
        description: Received dedicated preambles in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: received_randomly_selected_preambles_low_range_cell
        in: query
        description: Received randomly selected preambles in the low range in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: received_randomly_selected_preambles_high_range_cell
        in: query
        description: Received rendomly selected preambles in the high range in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: number_of_active_ue_dl_gbr_cell
        in: query
        description: Number of active UEs with downlink GBR traffic as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: number_of_active_ue_ul_gbr_cell
        in: query
        description: Number of active UEs with uplink GBR traffic as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: number_of_active_ue_dl_nongbr_cell
        in: query
        description: Number of active UEs with downlink non-GBR traffic as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: number_of_active_ue_ul_nongbr_cell
        in: query
        description: Number of active UEs with uplink non-GBR traffic as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_gbr_pdr_cell
        in: query
        description: Packet discard rate for downlink GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_pdr_cell
        in: query
        description: Packet discard rate for uplink GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_pdr_cell
        in: query
        description: Packet discard rate for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_pdr_cell
        in: query
        description: Packet discard rate for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_gbr_delay_ue
        in: query
        description: Packet delay of downlink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_delay_ue
        in: query
        description: Packet delay of uplink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_delay_ue
        in: query
        description: Packet delay of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_delay_ue
        in: query
        description: Packet delay of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_gbr_pdr_ue
        in: query
        description: Packet discard rate of downlink GBR traffic of a UE in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_pdr_ue
        in: query
        description: Packet discard rate of uplink GBR traffic of a UE in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_pdr_ue
        in: query
        description: Packet discard rate of downlink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_pdr_ue
        in: query
        description: Packet discard rate of uplink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_gbr_throughput_ue
        in: query
        description: Scheduled throughput of downlink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_throughput_ue
        in: query
        description: Scheduled throughput of uplink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_throughput_ue
        in: query
        description: Scheduled throughput of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_throughput_ue
        in: query
        description: Scheduled throughput of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_gbr_data_volume_ue
        in: query
        description: Data volume of downlink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_gbr_data_volume_ue
        in: query
        description: Data volume of uplink GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: dl_nongbr_data_volume_ue
        in: query
        description: Data volume of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: ul_nongbr_data_volume_ue
        in: query
        description: Data volume of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
704
705
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
706
          description: Successful response to layer2 measurements info request
707
          headers: {}
Michel Roy's avatar
Michel Roy committed
708
          content:
709
            application/json:
Michel Roy's avatar
Michel Roy committed
710
              schema:
Michel Roy's avatar
Michel Roy committed
711
                $ref: '#/components/schemas/L2Meas'
712
        '400':
713
714
715
716
717
718
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
719
        '401':
720
721
722
723
724
725
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
726
        '403':
727
728
729
730
731
732
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
733
        '404':
734
735
736
737
738
739
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
740
        '406':
741
742
743
744
745
746
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
747
        '414':
748
749
750
751
752
753
          description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
754
        '429':
755
756
757
758
759
760
761
762
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
Michel Roy's avatar
Michel Roy committed
763
  /subscriptions:
764
    get:
Michel Roy's avatar
Michel Roy committed
765
      tags:
766
      - rni
767
      summary: 'Queries information on subscriptions for notifications'
768
      description: Queries information on subscriptions for notifications
Michel Roy's avatar
Michel Roy committed
769
770
      operationId: subscriptionLinkList_subscriptionsGET
      parameters:
771
772
773
774
775
776
777
      - name: subscription_type
        in: query
        description: 'Filter on a specific subscription type. Permitted values: cell_change, rab_est, rab_mod, rab_rel, meas_rep_ue, nr_meas_rep_ue, timing_advance_ue, ca_reconf, s1_bearer.'
        style: form
        explode: true
        schema:
          type: string
778
779
      responses:
        '200':
780
781
          description: Response body contains the list of links to requestors subscriptions.
          headers: {}
Michel Roy's avatar
Michel Roy committed
782
          content:
783
            application/json:
Michel Roy's avatar
Michel Roy committed
784
              schema:
Michel Roy's avatar
Michel Roy committed
785
                $ref: '#/components/schemas/SubscriptionLinkList'
786
787
788
789
790
791
              
              examples:
               example-ofsub-link-list:
                value:
                  _links:
                   self:
792
                    href: http://meAppServer.example.com/rni/v2/subscriptions
793
794
795
                   subscription:
                   - _links:
                     self:
796
                      href: http://meAppServer.example.com/rni/v2/subscriptions/sub123
797
798
799
                     callbackReference: http://my.callback.com/rni-cell-change/some-id
                     subscriptionType: CellChangeSubscription

800
        '400':
801
802
803
804
805
806
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
807
        '401':
808
809
810
811
812
813
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
814
        '403':
815
816
817
818
819
820
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
821
        '404':
822
823
824
825
826
827
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
828
        '406':
829
830
831
832
833
834
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
835
        '429':
836
837
838
839
840
841
842
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
843
    post:
Michel Roy's avatar
Michel Roy committed
844
      tags:
845
      - rni
846
      summary: 'Creates a new subscription to Radio Network Information notifications'
847
      description: Creates a new subscription to Radio Network Information notifications
Michel Roy's avatar
Michel Roy committed
848
      operationId: subscriptionsPOST
849
      parameters: []
Michel Roy's avatar
Michel Roy committed
850
851
852
853
854
      requestBody:
        description: Subscription to be created
        content:
          application/json:
            schema:
855
856
857
858
859
860
861
862
863
864
865
866
              oneOf:
              - $ref: '#/components/schemas/CellChangeSubscription'
              - $ref: '#/components/schemas/RabEstSubscription'
              - $ref: '#/components/schemas/RabModSubscription'
              - $ref: '#/components/schemas/RabRelSubscription'
              - $ref: '#/components/schemas/MeasRepUeSubscription'
              - $ref: '#/components/schemas/NrMeasRepUeSubscription'
              - $ref: '#/components/schemas/MeasTaSubscription'
              - $ref: '#/components/schemas/CaReconfSubscription'
              - $ref: '#/components/schemas/S1BearerSubscription'
              description: Subscription to be created
              contentMediaType: application/json
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
            examples:
              example-cell-change-subscription:callbacks:
               value:
                 subscriptionType: CellChangeSubscription
                 callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                 filterCriteriaAssocHo:
                   appInstanceId: 'myApp'
                   associateId:
                   - type: 1
                     value: '10.100.0.1'
                   ecgi:
                   - plmn:
                       mnc: '01'
                       mcc: '001'
                     cellId: 'ACBDEFA'
                   hoStatus:
                   - 1
                   - 2
                 expiryDeadline:
                   seconds: 1977836800
                   nanoSeconds: 0
888
        required: true
889
890
      responses:
        '201':
Michel Roy's avatar
Michel Roy committed
891
          description: Successful subscription
892
          headers: {}
Michel Roy's avatar
Michel Roy committed
893
          content:
894
            application/json:
Michel Roy's avatar
Michel Roy committed
895
              schema:
896
897
898
899
900
901
902
903
904
905
906
                oneOf:
                - $ref: '#/components/schemas/CellChangeSubscription'
                - $ref: '#/components/schemas/RabEstSubscription'
                - $ref: '#/components/schemas/RabModSubscription'
                - $ref: '#/components/schemas/RabRelSubscription'
                - $ref: '#/components/schemas/MeasRepUeSubscription'
                - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                - $ref: '#/components/schemas/MeasTaSubscription'
                - $ref: '#/components/schemas/CaReconfSubscription'
                - $ref: '#/components/schemas/S1BearerSubscription'
                contentMediaType: application/json
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
              examples:
                example-call-change-subscription:
                  value:
                   subscriptionType: CellChangeSubscription
                   callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                   _links:
                     self:
                       href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                   filterCriteriaAssocHo:
                      appInstanceId: 'myApp'
                      associateId:
                      - type: 1
                        value: '10.100.0.1'
                      ecgi:
                      - plmn:
                          mnc: '01'
                          mcc: '001'
                        cellId: 'ACBDEFA'
                      hoStatus:
                      - 1
                      - 2
                   expiryDeadline:
                     seconds: 1977836800
                     nanoSeconds: 0


933
        '400':
934
935
936
937
938
939
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
940
        '401':
941
942
943
944
945
946
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
947
        '403':
948
949
950
951
952
953
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
954
        '404':
955
956
957
958
959
960
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
961
        '406':
962
963
964
965
966
967
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
968
        '415':
969
970
971
972
973
974
          description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
975
        '422':
976
977
978
979
980
981
          description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
982
              examples:
983
                application/problem+json:
984
                 value:
985
986
                  type: https://meAppServer.example.com/rni/v2/probs/too-many targets
                  title: Too many targets
987
                  status: 422
988
989
                  detail: The target area for the request is considered too large
                  instance: /meAppClient.example.com/77777/msgs/abc
990
        '429':
991
992
993
994
995
996
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
997
998
999
1000
      
      callbacks: 
        notification:
          '{$request.body#/notificationSubscription.callbackReference}':
For faster browsing, not all history is shown. View entire blame