RniAPI.json 197 KB
Newer Older
1
{
Michel Roy's avatar
Michel Roy committed
2
  "openapi": "3.0.0",
3
  "info": {
Michel Roy's avatar
Michel Roy committed
4
5
6
    "title": "ETSI GS MEC 012 - Radio Network Information API",
    "version": "2.1.1",
    "description": "The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.",
7
    "license": {
ETSI CTI's avatar
ETSI CTI committed
8
9
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
10
11
12
    }
  },
  "externalDocs": {
Michel Roy's avatar
Michel Roy committed
13
14
    "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"
15
  },
Michel Roy's avatar
Michel Roy committed
16
  "servers": [
17
    {
Michel Roy's avatar
Michel Roy committed
18
      "url": "https://{apiRoot}/rni/v2"
19
20
21
    }
  ],
  "paths": {
Michel Roy's avatar
Michel Roy committed
22
    "/queries/rab_info": {
23
      "get": {
Michel Roy's avatar
Michel Roy committed
24
25
        "tags": [
          ""
26
        ],
Michel Roy's avatar
Michel Roy committed
27
28
29
        "summary": "Retrieve information on Radio Access Bearers",
        "description": "Queries information about the Radio Access Bearers",
        "operationId": "rab_infoGET",
30
31
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
32
            "$ref": "#/components/parameters/Query.AppInsId"
33
34
          },
          {
Michel Roy's avatar
Michel Roy committed
35
            "$ref": "#/components/parameters/Query.CellId"
36
37
          },
          {
Michel Roy's avatar
Michel Roy committed
38
            "$ref": "#/components/parameters/Query.UeIpv4Address"
39
40
          },
          {
Michel Roy's avatar
Michel Roy committed
41
            "$ref": "#/components/parameters/Query.UeIpv6Address"
42
43
          },
          {
Michel Roy's avatar
Michel Roy committed
44
            "$ref": "#/components/parameters/Query.NatedIpAddress"
45
46
          },
          {
Michel Roy's avatar
Michel Roy committed
47
            "$ref": "#/components/parameters/Query.GtpTeid"
48
49
          },
          {
Michel Roy's avatar
Michel Roy committed
50
            "$ref": "#/components/parameters/Query.ErabId"
51
52
          },
          {
Michel Roy's avatar
Michel Roy committed
53
            "$ref": "#/components/parameters/Query.Qci"
54
55
          },
          {
Michel Roy's avatar
Michel Roy committed
56
            "$ref": "#/components/parameters/Query.ErabMbrDl"
57
58
          },
          {
Michel Roy's avatar
Michel Roy committed
59
            "$ref": "#/components/parameters/Query.ErabMbrUl"
60
61
          },
          {
Michel Roy's avatar
Michel Roy committed
62
            "$ref": "#/components/parameters/Query.ErabGbrDl"
63
64
          },
          {
Michel Roy's avatar
Michel Roy committed
65
            "$ref": "#/components/parameters/Query.ErabGbrUl"
66
67
68
69
70
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to rab_info request",
Michel Roy's avatar
Michel Roy committed
71
            "content": {
72
              "application/json": {
Michel Roy's avatar
Michel Roy committed
73
74
75
76
77
                "schema": {
                  "type": "object",
                  "properties": {
                    "rabInfo": {
                      "$ref": "#/components/schemas/RabInfo"
78
79
80
81
82
83
84
                    }
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
85
            "$ref": "#/components/responses/400"
86
87
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
88
            "$ref": "#/components/responses/401"
89
90
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
91
            "$ref": "#/components/responses/403"
92
93
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
94
            "$ref": "#/components/responses/404"
95
96
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
97
            "$ref": "#/components/responses/406"
98
99
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
100
            "$ref": "#/components/responses/429"
101
102
          }
        },
Michel Roy's avatar
Michel Roy committed
103
        "x-swagger-router-controller": "queries"
104
105
      }
    },
Michel Roy's avatar
Michel Roy committed
106
    "/queries/plmn_info": {
107
      "get": {
Michel Roy's avatar
Michel Roy committed
108
109
        "tags": [
          ""
110
        ],
Michel Roy's avatar
Michel Roy committed
111
112
113
        "summary": "Retrieve information on the underlying Mobile Network that the MEC application is associated to",
        "description": "Queries information about the Mobile Network",
        "operationId": "plmn_infoGET",
114
115
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
116
            "$ref": "#/components/parameters/Query.AppInsIdArr"
117
118
119
120
          }
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
121
122
            "description": "Successful response to plmn_info request",
            "content": {
123
              "application/json": {
Michel Roy's avatar
Michel Roy committed
124
125
126
127
128
129
130
131
132
                "schema": {
                  "type": "object",
                  "properties": {
                    "plmnInfo": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/PlmnInfo"
                      }
                    }
133
134
135
136
137
138
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
139
            "$ref": "#/components/responses/400"
140
141
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
142
            "$ref": "#/components/responses/401"
143
144
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
145
            "$ref": "#/components/responses/403"
146
147
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
148
            "$ref": "#/components/responses/404"
149
150
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
151
            "$ref": "#/components/responses/406"
152
153
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
154
            "$ref": "#/components/responses/429"
155
156
          }
        },
Michel Roy's avatar
Michel Roy committed
157
        "x-swagger-router-controller": "queries"
158
159
      }
    },
Michel Roy's avatar
Michel Roy committed
160
    "/queries/s1_bearer_info": {
161
      "get": {
Michel Roy's avatar
Michel Roy committed
162
163
        "tags": [
          ""
164
        ],
Michel Roy's avatar
Michel Roy committed
165
166
167
        "summary": "Retrieve S1-U bearer information related to specific UE(s)",
        "description": "Queries information about the S1 bearer(s)",
        "operationId": "s1_bearer_infoGET",
168
169
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
170
            "$ref": "#/components/parameters/Query.TempUeId"
171
172
          },
          {
Michel Roy's avatar
Michel Roy committed
173
            "$ref": "#/components/parameters/Query.UeIpv4Address"
174
175
          },
          {
Michel Roy's avatar
Michel Roy committed
176
            "$ref": "#/components/parameters/Query.UeIpv6Address"
177
178
          },
          {
Michel Roy's avatar
Michel Roy committed
179
            "$ref": "#/components/parameters/Query.NatedIpAddress"
180
181
          },
          {
Michel Roy's avatar
Michel Roy committed
182
            "$ref": "#/components/parameters/Query.GtpTeid"
183
184
          },
          {
Michel Roy's avatar
Michel Roy committed
185
            "$ref": "#/components/parameters/Query.CellId"
186
187
          },
          {
Michel Roy's avatar
Michel Roy committed
188
            "$ref": "#/components/parameters/Query.ErabIdArr"
189
190
191
192
193
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to s1_bearer_info request",
Michel Roy's avatar
Michel Roy committed
194
195
196
197
198
199
200
201
202
203
204
205
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "s1BearerInfo"
                  ],
                  "properties": {
                    "s1BearerInfo": {
                      "$ref": "#/components/schemas/S1BearerInfo"
                    }
                  }
206
207
208
209
210
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
211
            "$ref": "#/components/responses/400"
212
213
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
214
            "$ref": "#/components/responses/401"
215
216
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
217
            "$ref": "#/components/responses/403"
218
219
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
220
            "$ref": "#/components/responses/404"
221
222
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
223
            "$ref": "#/components/responses/406"
224
225
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
226
            "$ref": "#/components/responses/429"
227
228
          }
        },
Michel Roy's avatar
Michel Roy committed
229
        "x-swagger-router-controller": "queries"
230
231
      }
    },
Michel Roy's avatar
Michel Roy committed
232
    "/queries/layer2_meas": {
233
      "get": {
Michel Roy's avatar
Michel Roy committed
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
        "tags": [
          ""
        ],
        "summary": "Retrieve information on layer 2 measurements",
        "description": "Queries information about the layer 2 measurements.",
        "operationId": "layer2_meas_infoGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.AppInsId"
          },
          {
            "$ref": "#/components/parameters/Query.CellId"
          },
          {
            "$ref": "#/components/parameters/Query.UeIpv4Address"
          },
          {
            "$ref": "#/components/parameters/Query.UeIpv6Address"
          },
          {
            "$ref": "#/components/parameters/Query.NatedIpAddress"
          },
          {
            "$ref": "#/components/parameters/Query.GtpTeid"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.DlTotalPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.UlTotalPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.ReceivedDedicatedPreamblesCell"
          },
          {
            "$ref": "#/components/parameters/Query.ReceivedRandomPreamblesLowRangeCell"
          },
          {
            "$ref": "#/components/parameters/Query.ReceivedRandomPreamblesHighRangeCell"
          },
          {
            "$ref": "#/components/parameters/Query.NumberOfActiveUeDlGbrCell"
          },
          {
            "$ref": "#/components/parameters/Query.NumberOfActiveUeUlGbrCell"
          },
          {
            "$ref": "#/components/parameters/Query.NumberOfActiveUeDlNonGbrCell"
          },
          {
            "$ref": "#/components/parameters/Query.NumberOfActiveUeUlNonGbrCell"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrPdrCell"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrPdrCell"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrPdrCell"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrPdrCell"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrDelayUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrDelayUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrDelayUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrDelayUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrPdrUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrPdrUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrPdrUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrPdrUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrThroughputUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrThroughputUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrThroughputUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrThroughputUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrDataVolumeUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrDataVolumeUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrDataVolumeUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrDataVolumeUe"
          }
358
359
360
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
361
362
            "description": "Successful response to layer2 measurements info request",
            "content": {
363
              "application/json": {
Michel Roy's avatar
Michel Roy committed
364
365
366
367
368
369
370
371
372
                "schema": {
                  "type": "object",
                  "required": [
                    "l2Meas"
                  ],
                  "properties": {
                    "l2Meas": {
                      "$ref": "#/components/schemas/L2Meas"
                    }
373
374
375
376
377
378
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
379
            "$ref": "#/components/responses/400"
380
381
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
382
            "$ref": "#/components/responses/401"
383
384
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
385
            "$ref": "#/components/responses/403"
386
387
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
388
            "$ref": "#/components/responses/404"
389
390
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
391
392
393
394
            "$ref": "#/components/responses/406"
          },
          "414": {
            "$ref": "#/components/responses/414"
395
396
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
397
            "$ref": "#/components/responses/429"
398
399
          }
        },
Michel Roy's avatar
Michel Roy committed
400
        "x-swagger-router-controller": "queries"
401
402
      }
    },
Michel Roy's avatar
Michel Roy committed
403
    "/subscriptions/": {
404
      "get": {
Michel Roy's avatar
Michel Roy committed
405
406
407
408
409
410
411
412
413
414
        "tags": [
          ""
        ],
        "summary": "Retrieve information on subscriptions for notifications",
        "description": "Queries information on subscriptions for notifications",
        "operationId": "subscriptionLinkList_subscriptionsGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.SubscriptionType"
          }
415
416
417
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
418
419
            "description": "Response body contains the list of links to requestors subscriptions.",
            "content": {
420
              "application/json": {
Michel Roy's avatar
Michel Roy committed
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
                "schema": {
                  "type": "object",
                  "required": [
                    "subscriptionLinkList"
                  ],
                  "properties": {
                    "subscriptionLinkList": {
                      "$ref": "#/components/schemas/SubscriptionLinkList"
                    }
                  }
                },
                "example": {
                  "subscriptionLinkList": {
                    "_links": {
                      "self": {
                        "href": "http://meAppServer.example.com/rni/v2/subscriptions"
                      }
                    },
                    "subscription": [
440
                      {
Michel Roy's avatar
Michel Roy committed
441
442
443
444
445
446
447
                        "_links": {
                          "self": {
                            "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
                          }
                        },
                        "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                        "subscriptionType": "CellChangeSubscription"
448
449
450
451
452
453
454
455
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
456
            "$ref": "#/components/responses/400"
457
458
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
459
            "$ref": "#/components/responses/401"
460
461
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
462
            "$ref": "#/components/responses/403"
463
464
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
465
            "$ref": "#/components/responses/404"
466
467
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
468
            "$ref": "#/components/responses/406"
469
470
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
471
            "$ref": "#/components/responses/429"
472
473
          }
        },
Michel Roy's avatar
Michel Roy committed
474
        "x-swagger-router-controller": "subscriptions"
475
476
      },
      "post": {
Michel Roy's avatar
Michel Roy committed
477
478
        "tags": [
          ""
479
        ],
Michel Roy's avatar
Michel Roy committed
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
        "summary": "Create a new subscription",
        "description": "Creates a new subscription to Radio Network Information notifications",
        "operationId": "subscriptionsPOST",
        "requestBody": {
          "description": "Subscription to be created",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "notificationSubscription": {
                    "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"
                      }
                    ],
                    "discriminator": {
                      "propertyName": "subscriptionType"
                    }
                  }
                },
                "example": {
                  "notificationSubscription": {
                    "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
                    }
                  }
                }
              }
            }
560
          }
Michel Roy's avatar
Michel Roy committed
561
        },
562
563
        "responses": {
          "201": {
Michel Roy's avatar
Michel Roy committed
564
565
            "description": "Successful subscription",
            "content": {
566
              "application/json": {
Michel Roy's avatar
Michel Roy committed
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
                "schema": {
                  "type": "object",
                  "properties": {
                    "notificationSubscription": {
                      "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"
                        }
                      ],
                      "discriminator": {
                        "propertyName": "subscriptionType"
                      }
                    }
604
                  },
Michel Roy's avatar
Michel Roy committed
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
                  "example": {
                    "notificationSubscription": {
                      "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
                      }
                    }
641
642
643
644
645
646
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
647
            "$ref": "#/components/responses/400"
648
649
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
650
            "$ref": "#/components/responses/401"
651
652
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
653
            "$ref": "#/components/responses/403"
654
655
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
656
            "$ref": "#/components/responses/404"
657
658
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
659
            "$ref": "#/components/responses/406"
660
661
          },
          "415": {
Michel Roy's avatar
Michel Roy committed
662
            "$ref": "#/components/responses/412"
663
664
          },
          "422": {
Michel Roy's avatar
Michel Roy committed
665
            "$ref": "#/components/responses/422"
666
667
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
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
            "$ref": "#/components/responses/429"
          }
        },
        "callbacks": {
          "notification": {
            "{$request.body#/notificationSubscription.callbackReference}": {
              "post": {
                "summary": "Callback POST used to send a notification",
                "description": "Notification from RNIS, content based on subscription type",
                "operationId": "notificationPOST",
                "requestBody": {
                  "description": "Subscription notification",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
                        "type": "object",
                        "properties": {
                          "notification": {
                            "oneOf": [
                              {
                                "$ref": "#/components/schemas/CellChangeNotification"
                              },
                              {
                                "$ref": "#/components/schemas/RabEstNotification"
                              },
                              {
                                "$ref": "#/components/schemas/RabModNotification"
                              },
                              {
                                "$ref": "#/components/schemas/RabRelNotification"
                              },
                              {
                                "$ref": "#/components/schemas/MeasRepUeNotification"
                              },
                              {
                                "$ref": "#/components/schemas/NrMeasRepUeNotification"
                              },
                              {
                                "$ref": "#/components/schemas/MeasTaNotification"
                              },
                              {
                                "$ref": "#/components/schemas/CaReconfNotification"
                              },
                              {
                                "$ref": "#/components/schemas/S1BearerNotification"
                              }
                            ],
                            "discriminator": {
                              "propertyName": "notificationType"
                            }
                          }
                        },
                        "example": {
                          "notification": {
                            "notificationType": "CellChangeNotification",
                            "associateId": [
                              {
                                "type": "1",
                                "value": "10.100.0.1"
                              }
                            ],
                            "hoStatus": "1",
                            "srcEcgi": {
                              "plmn": {
                                "mnc": "01",
                                "mcc": "001"
                              },
                              "cellId": "ACBDEFA"
                            },
                            "tempUeId": {
                              "mmec": 1,
                              "mtmsi": 69967622812
                            },
                            "timeStamp": {
                              "seconds": 1977836800,
                              "nanoseconds": 0
                            },
                            "trgEcgi": {
                              "plmn": {
                                "mnc": "01",
                                "mcc": "001"
                              },
                              "cellId": "FEDCBAA"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
                  }
763
764
765
766
767
                }
              }
            }
          }
        },
Michel Roy's avatar
Michel Roy committed
768
        "x-swagger-router-controller": "subscriptions"
769
770
      }
    },
Michel Roy's avatar
Michel Roy committed
771
    "/subscriptions/{subscriptionId}": {
772
      "get": {
Michel Roy's avatar
Michel Roy committed
773
774
        "tags": [
          ""
775
        ],
Michel Roy's avatar
Michel Roy committed
776
777
778
        "summary": "Retrieve information on current specific subscription",
        "description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "subscriptionsGET",
779
780
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
781
            "$ref": "#/components/parameters/Path.subscrId"
782
783
784
785
          }
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
786
787
            "description": "Subscription information regarding subscription notifications",
            "content": {
788
              "application/json": {
Michel Roy's avatar
Michel Roy committed
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
                "schema": {
                  "type": "object",
                  "required": [
                    "notificationSubscription"
                  ],
                  "properties": {
                    "notificationSubscription": {
                      "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"
                        }
                      ],
                      "discriminator": {
                        "propertyName": "subscriptionType"
                      }
                    }
829
                  },
Michel Roy's avatar
Michel Roy committed
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
                  "example": {
                    "notificationSubscription": {
                      "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
                      }
                    }
866
867
868
869
870
871
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
872
            "$ref": "#/components/responses/400"
873
874
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
875
            "$ref": "#/components/responses/401"
876
877
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
878
            "$ref": "#/components/responses/403"
879
880
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
881
            "$ref": "#/components/responses/404"
882
883
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
884
            "$ref": "#/components/responses/406"
885
886
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
887
            "$ref": "#/components/responses/429"
888
          }
Michel Roy's avatar
Michel Roy committed
889
890
        },
        "x-swagger-router-controller": "subscriptions"
891
892
      },
      "put": {
Michel Roy's avatar
Michel Roy committed
893
894
        "tags": [
          ""
895
        ],
Michel Roy's avatar
Michel Roy committed
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
        "summary": "Modify an existing subscription",
        "description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "subscriptionsPUT",
        "requestBody": {
          "description": "Subscription to be modified",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "notificationSubscription": {
                    "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"
                      }
                    ],
                    "discriminator": {
                      "propertyName": "subscriptionType"
                    }
                  }
                },
                "example": {
                  "notificationSubscription": {
                    "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
                    }
                  }
978
979
980
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful subscription to response to subscription notifications",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "notificationSubscription": {
                      "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"
                        }
                      ],
                      "discriminator": {
                        "propertyName": "subscriptionType"
                      }
                    }
                  }
                },
                "example": {
                  "notificationSubscription": {
                    "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
                    }
                  }
1068
1069
1070
1071
                }
              }
            }
          },
Michel Roy's avatar
Michel Roy committed
1072
1073
1074
1075
1076
1077
1078
1079
1080
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
1081
          "404": {
Michel Roy's avatar
Michel Roy committed
1082
            "$ref": "#/components/responses/404"
1083
1084
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
1085
            "$ref": "#/components/responses/406"
1086
1087
          },
          "412": {
Michel Roy's avatar
Michel Roy committed
1088
            "$ref": "#/components/responses/412"
1089
1090
          },
          "422": {
Michel Roy's avatar
Michel Roy committed
1091
            "$ref": "#/components/responses/422"
1092
1093
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
1094
            "$ref": "#/components/responses/429"
1095
          }
Michel Roy's avatar
Michel Roy committed
1096
1097
        },
        "x-swagger-router-controller": "subscriptions"
1098
1099
      },
      "delete": {
Michel Roy's avatar
Michel Roy committed
1100
1101
        "tags": [
          ""
1102
        ],
Michel Roy's avatar
Michel Roy committed
1103
1104
1105
        "summary": "Cancel an existing subscription",
        "description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "subscriptionsDELETE",
1106
1107
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
1108
            "$ref": "#/components/parameters/Path.subscrId"
1109
1110
1111
1112
          }
        ],
        "responses": {
          "204": {
Michel Roy's avatar
Michel Roy committed
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
            "$ref": "#/components/responses/204"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "429": {
            "$ref": "#/components/responses/429"
1126
1127
          }
        },
Michel Roy's avatar
Michel Roy committed
1128
        "x-swagger-router-controller": "subscriptions"
1129
      }
Michel Roy's avatar
Michel Roy committed
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
    }
  },
  "components": {
    "responses": {
      "204": {
        "description": "No Content"
      },
      "400": {
        "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
        "content": {
          "application/json": {
1141
1142
1143
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1144
1145
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1146
1147
1148
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1149
1150
1151
1152
1153
1154
1155
          }
        }
      },
      "401": {
        "description": "Unauthorized :  used when the client did not submit credentials.",
        "content": {
          "application/json": {
1156
1157
1158
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1159
1160
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1161
1162
1163
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1164
1165
1166
1167
1168
1169
1170
          }
        }
      },
      "403": {
        "description": "Forbidden :  operation is not allowed given the current status of the resource.",
        "content": {
          "application/json": {
1171
1172
            "schema": {
              "type": "object",
1173
              "required": [
Michel Roy's avatar
Michel Roy committed
1174
                "problemDetails"
1175
              ],
1176
              "properties": {
Michel Roy's avatar
Michel Roy committed
1177
1178
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1179
1180
1181
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1182
1183
1184
1185
1186
1187
1188
          }
        }
      },
      "404": {
        "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
        "content": {
          "application/json": {
1189
1190
1191
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1192
1193
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1194
1195
1196
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1197
1198
1199
1200
1201
1202
1203
          }
        }
      },
      "406": {
        "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
        "content": {
          "application/json": {
1204
1205
1206
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1207
1208
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1209
1210
1211
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1212
1213
1214
1215
1216
1217
1218
          }
        }
      },
      "412": {
        "description": "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
        "content": {
          "application/json": {
1219
1220
1221
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1222
1223
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1224
1225
1226
1227
                }
              }
            }
          }
Michel Roy's avatar
Michel Roy committed
1228
        }
1229
      },
Michel Roy's avatar
Michel Roy committed
1230
1231
1232
1233
      "414": {
        "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.",
        "content": {
          "application/json": {
1234
1235
1236
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1237
1238
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1239
1240
1241
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1242
1243
1244
1245
1246
1247
1248
          }
        }
      },
      "415": {
        "description": "Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.",
        "content": {
          "application/json": {
1249
1250
1251
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1252
1253
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1254
1255
1256
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1257
1258
1259
1260
1261
1262
1263
          }
        }
      },
      "422": {
        "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.",
        "content": {
          "application/json": {
1264
1265
1266
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1267
1268
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1269
1270
                }
              }
Michel Roy's avatar
Michel Roy committed
1271
1272
1273
1274
1275
1276
1277
1278
1279
            },
            "example": {
              "application/problem+json": {
                "problemDetails": {
                  "type": "https://meAppServer.example.com/rni/v2/probs/too-many targets",
                  "title": "Too many targets",
                  "status": "422",
                  "detail": "The target area for the request is considered too large",
                  "instance": "/meAppClient.example.com/77777/msgs/abc"
1280
1281
1282
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1283
1284
1285
1286
1287
1288
1289
          }
        }
      },
      "429": {
        "description": "Too Many Requests : used when a rate limiter has triggered.",
        "content": {
          "application/json": {
1290
1291
1292
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1293
1294
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1295
1296
1297
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794