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": {
admin_forge's avatar
admin_forge 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
          }
        },
        "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"
                        },
For faster browsing, not all history is shown. View entire blame