RniAPI.json 179 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
19
20
21
22
23
      "url": "https://localhost/rni/v2"
    }
  ],
  "tags": [
    {
      "name": "rni"
24
25
26
    }
  ],
  "paths": {
Michel Roy's avatar
Michel Roy committed
27
    "/queries/rab_info": {
28
      "get": {
Michel Roy's avatar
Michel Roy committed
29
        "tags": [
Michel Roy's avatar
Michel Roy committed
30
          "rni"
31
        ],
Michel Roy's avatar
Michel Roy committed
32
33
34
        "summary": "Retrieve information on Radio Access Bearers",
        "description": "Queries information about the Radio Access Bearers",
        "operationId": "rab_infoGET",
35
36
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
37
            "$ref": "#/components/parameters/Query.AppInsId"
38
39
          },
          {
Michel Roy's avatar
Michel Roy committed
40
            "$ref": "#/components/parameters/Query.CellId"
41
42
          },
          {
Michel Roy's avatar
Michel Roy committed
43
            "$ref": "#/components/parameters/Query.UeIpv4Address"
44
45
          },
          {
Michel Roy's avatar
Michel Roy committed
46
            "$ref": "#/components/parameters/Query.UeIpv6Address"
47
48
          },
          {
Michel Roy's avatar
Michel Roy committed
49
            "$ref": "#/components/parameters/Query.NatedIpAddress"
50
51
          },
          {
Michel Roy's avatar
Michel Roy committed
52
            "$ref": "#/components/parameters/Query.GtpTeid"
53
54
          },
          {
Michel Roy's avatar
Michel Roy committed
55
            "$ref": "#/components/parameters/Query.ErabId"
56
57
          },
          {
Michel Roy's avatar
Michel Roy committed
58
            "$ref": "#/components/parameters/Query.Qci"
59
60
          },
          {
Michel Roy's avatar
Michel Roy committed
61
            "$ref": "#/components/parameters/Query.ErabMbrDl"
62
63
          },
          {
Michel Roy's avatar
Michel Roy committed
64
            "$ref": "#/components/parameters/Query.ErabMbrUl"
65
66
          },
          {
Michel Roy's avatar
Michel Roy committed
67
            "$ref": "#/components/parameters/Query.ErabGbrDl"
68
69
          },
          {
Michel Roy's avatar
Michel Roy committed
70
            "$ref": "#/components/parameters/Query.ErabGbrUl"
71
72
73
74
75
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to rab_info request",
Michel Roy's avatar
Michel Roy committed
76
            "content": {
77
              "application/json": {
Michel Roy's avatar
Michel Roy committed
78
79
80
81
82
                "schema": {
                  "type": "object",
                  "properties": {
                    "rabInfo": {
                      "$ref": "#/components/schemas/RabInfo"
83
84
85
86
87
88
89
                    }
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
90
            "$ref": "#/components/responses/400"
91
92
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
93
            "$ref": "#/components/responses/401"
94
95
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
96
            "$ref": "#/components/responses/403"
97
98
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
99
            "$ref": "#/components/responses/404"
100
101
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
102
            "$ref": "#/components/responses/406"
103
104
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
105
            "$ref": "#/components/responses/429"
106
107
          }
        },
Michel Roy's avatar
Michel Roy committed
108
        "x-swagger-router-controller": "queries"
109
110
      }
    },
Michel Roy's avatar
Michel Roy committed
111
    "/queries/plmn_info": {
112
      "get": {
Michel Roy's avatar
Michel Roy committed
113
        "tags": [
Michel Roy's avatar
Michel Roy committed
114
          "rni"
115
        ],
Michel Roy's avatar
Michel Roy committed
116
117
118
        "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",
119
120
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
121
            "$ref": "#/components/parameters/Query.AppInsIdArr"
122
123
124
125
          }
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
126
127
            "description": "Successful response to plmn_info request",
            "content": {
128
              "application/json": {
Michel Roy's avatar
Michel Roy committed
129
130
131
132
133
134
135
136
137
                "schema": {
                  "type": "object",
                  "properties": {
                    "plmnInfo": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/PlmnInfo"
                      }
                    }
138
139
140
141
142
143
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
144
            "$ref": "#/components/responses/400"
145
146
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
147
            "$ref": "#/components/responses/401"
148
149
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
150
            "$ref": "#/components/responses/403"
151
152
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
153
            "$ref": "#/components/responses/404"
154
155
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
156
            "$ref": "#/components/responses/406"
157
158
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
159
            "$ref": "#/components/responses/429"
160
161
          }
        },
Michel Roy's avatar
Michel Roy committed
162
        "x-swagger-router-controller": "queries"
163
164
      }
    },
Michel Roy's avatar
Michel Roy committed
165
    "/queries/s1_bearer_info": {
166
      "get": {
Michel Roy's avatar
Michel Roy committed
167
        "tags": [
Michel Roy's avatar
Michel Roy committed
168
          "rni"
169
        ],
Michel Roy's avatar
Michel Roy committed
170
171
172
        "summary": "Retrieve S1-U bearer information related to specific UE(s)",
        "description": "Queries information about the S1 bearer(s)",
        "operationId": "s1_bearer_infoGET",
173
174
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
175
            "$ref": "#/components/parameters/Query.TempUeId"
176
177
          },
          {
Michel Roy's avatar
Michel Roy committed
178
            "$ref": "#/components/parameters/Query.UeIpv4Address"
179
180
          },
          {
Michel Roy's avatar
Michel Roy committed
181
            "$ref": "#/components/parameters/Query.UeIpv6Address"
182
183
          },
          {
Michel Roy's avatar
Michel Roy committed
184
            "$ref": "#/components/parameters/Query.NatedIpAddress"
185
186
          },
          {
Michel Roy's avatar
Michel Roy committed
187
            "$ref": "#/components/parameters/Query.GtpTeid"
188
189
          },
          {
Michel Roy's avatar
Michel Roy committed
190
            "$ref": "#/components/parameters/Query.CellId"
191
192
          },
          {
Michel Roy's avatar
Michel Roy committed
193
            "$ref": "#/components/parameters/Query.ErabIdArr"
194
195
196
197
198
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to s1_bearer_info request",
Michel Roy's avatar
Michel Roy committed
199
200
201
202
203
204
205
206
207
208
209
210
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "s1BearerInfo"
                  ],
                  "properties": {
                    "s1BearerInfo": {
                      "$ref": "#/components/schemas/S1BearerInfo"
                    }
                  }
211
212
213
214
215
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
216
            "$ref": "#/components/responses/400"
217
218
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
219
            "$ref": "#/components/responses/401"
220
221
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
222
            "$ref": "#/components/responses/403"
223
224
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
225
            "$ref": "#/components/responses/404"
226
227
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
228
            "$ref": "#/components/responses/406"
229
230
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
231
            "$ref": "#/components/responses/429"
232
233
          }
        },
Michel Roy's avatar
Michel Roy committed
234
        "x-swagger-router-controller": "queries"
235
236
      }
    },
Michel Roy's avatar
Michel Roy committed
237
    "/queries/layer2_meas": {
238
      "get": {
Michel Roy's avatar
Michel Roy committed
239
        "tags": [
Michel Roy's avatar
Michel Roy committed
240
          "rni"
Michel Roy's avatar
Michel Roy committed
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
        ],
        "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"
          }
363
364
365
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
366
367
            "description": "Successful response to layer2 measurements info request",
            "content": {
368
              "application/json": {
Michel Roy's avatar
Michel Roy committed
369
370
371
372
373
374
375
376
377
                "schema": {
                  "type": "object",
                  "required": [
                    "l2Meas"
                  ],
                  "properties": {
                    "l2Meas": {
                      "$ref": "#/components/schemas/L2Meas"
                    }
378
379
380
381
382
383
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
384
            "$ref": "#/components/responses/400"
385
386
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
387
            "$ref": "#/components/responses/401"
388
389
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
390
            "$ref": "#/components/responses/403"
391
392
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
393
            "$ref": "#/components/responses/404"
394
395
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
396
397
398
399
            "$ref": "#/components/responses/406"
          },
          "414": {
            "$ref": "#/components/responses/414"
400
401
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
402
            "$ref": "#/components/responses/429"
403
404
          }
        },
Michel Roy's avatar
Michel Roy committed
405
        "x-swagger-router-controller": "queries"
406
407
      }
    },
Michel Roy's avatar
Michel Roy committed
408
    "/subscriptions": {
409
      "get": {
Michel Roy's avatar
Michel Roy committed
410
        "tags": [
Michel Roy's avatar
Michel Roy committed
411
          "rni"
Michel Roy's avatar
Michel Roy committed
412
413
414
415
416
417
418
419
        ],
        "summary": "Retrieve information on subscriptions for notifications",
        "description": "Queries information on subscriptions for notifications",
        "operationId": "subscriptionLinkList_subscriptionsGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.SubscriptionType"
          }
420
421
422
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
423
424
            "description": "Response body contains the list of links to requestors subscriptions.",
            "content": {
425
              "application/json": {
Michel Roy's avatar
Michel Roy committed
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
                "schema": {
                  "type": "object",
                  "required": [
                    "subscriptionLinkList"
                  ],
                  "properties": {
                    "subscriptionLinkList": {
                      "$ref": "#/components/schemas/SubscriptionLinkList"
                    }
                  }
                },
                "example": {
                  "subscriptionLinkList": {
                    "_links": {
                      "self": {
                        "href": "http://meAppServer.example.com/rni/v2/subscriptions"
                      }
                    },
                    "subscription": [
445
                      {
Michel Roy's avatar
Michel Roy committed
446
447
448
449
450
451
452
                        "_links": {
                          "self": {
                            "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
                          }
                        },
                        "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                        "subscriptionType": "CellChangeSubscription"
453
454
455
456
457
458
459
460
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
461
            "$ref": "#/components/responses/400"
462
463
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
464
            "$ref": "#/components/responses/401"
465
466
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
467
            "$ref": "#/components/responses/403"
468
469
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
470
            "$ref": "#/components/responses/404"
471
472
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
473
            "$ref": "#/components/responses/406"
474
475
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
476
            "$ref": "#/components/responses/429"
477
478
          }
        },
Michel Roy's avatar
Michel Roy committed
479
        "x-swagger-router-controller": "subscriptions"
480
481
      },
      "post": {
Michel Roy's avatar
Michel Roy committed
482
        "tags": [
Michel Roy's avatar
Michel Roy committed
483
          "rni"
484
        ],
Michel Roy's avatar
Michel Roy committed
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
        "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": [
                        {
Michel Roy's avatar
Michel Roy committed
539
                          "type": 1,
Michel Roy's avatar
Michel Roy committed
540
541
542
543
544
545
546
547
548
549
550
551
552
                          "value": "10.100.0.1"
                        }
                      ],
                      "ecgi": [
                        {
                          "plmn": {
                            "mnc": "01",
                            "mcc": "001"
                          },
                          "cellId": "ACBDEFA"
                        }
                      ],
                      "hoStatus": [
Michel Roy's avatar
Michel Roy committed
553
554
                        1,
                        2
Michel Roy's avatar
Michel Roy committed
555
556
557
558
559
560
561
562
563
564
                      ]
                    },
                    "expiryDeadline": {
                      "seconds": 1977836800,
                      "nanoseconds": 0
                    }
                  }
                }
              }
            }
565
          }
Michel Roy's avatar
Michel Roy committed
566
        },
567
568
        "responses": {
          "201": {
Michel Roy's avatar
Michel Roy committed
569
570
            "description": "Successful subscription",
            "content": {
571
              "application/json": {
Michel Roy's avatar
Michel Roy committed
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
                "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"
                      }
                    }
609
                  },
Michel Roy's avatar
Michel Roy committed
610
611
612
613
614
615
616
617
618
619
620
621
622
                  "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": [
                          {
Michel Roy's avatar
Michel Roy committed
623
                            "type": 1,
Michel Roy's avatar
Michel Roy committed
624
625
626
627
628
629
630
631
632
633
634
635
636
                            "value": "10.100.0.1"
                          }
                        ],
                        "ecgi": [
                          {
                            "plmn": {
                              "mnc": "01",
                              "mcc": "001"
                            },
                            "cellId": "ACBDEFA"
                          }
                        ],
                        "hoStatus": [
Michel Roy's avatar
Michel Roy committed
637
638
                          1,
                          2
Michel Roy's avatar
Michel Roy committed
639
640
641
642
643
644
645
                        ]
                      },
                      "expiryDeadline": {
                        "seconds": 1977836800,
                        "nanoseconds": 0
                      }
                    }
646
647
648
649
650
651
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
652
            "$ref": "#/components/responses/400"
653
654
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
655
            "$ref": "#/components/responses/401"
656
657
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
658
            "$ref": "#/components/responses/403"
659
660
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
661
            "$ref": "#/components/responses/404"
662
663
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
664
            "$ref": "#/components/responses/406"
665
666
          },
          "415": {
Michel Roy's avatar
Michel Roy committed
667
            "$ref": "#/components/responses/412"
668
669
          },
          "422": {
Michel Roy's avatar
Michel Roy committed
670
            "$ref": "#/components/responses/422"
671
672
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
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
            "$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": [
                              {
Michel Roy's avatar
Michel Roy committed
731
                                "type": 1,
Michel Roy's avatar
Michel Roy committed
732
733
734
                                "value": "10.100.0.1"
                              }
                            ],
Michel Roy's avatar
Michel Roy committed
735
                            "hoStatus": 1,
Michel Roy's avatar
Michel Roy committed
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
                            "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"
                  }
768
769
770
771
772
                }
              }
            }
          }
        },
Michel Roy's avatar
Michel Roy committed
773
        "x-swagger-router-controller": "subscriptions"
774
775
      }
    },
Michel Roy's avatar
Michel Roy committed
776
    "/subscriptions/{subscriptionId}": {
777
      "get": {
Michel Roy's avatar
Michel Roy committed
778
        "tags": [
Michel Roy's avatar
Michel Roy committed
779
          "rni"
780
        ],
Michel Roy's avatar
Michel Roy committed
781
782
783
        "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",
784
785
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
786
            "$ref": "#/components/parameters/Path.subscrId"
787
788
789
790
          }
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
791
792
            "description": "Subscription information regarding subscription notifications",
            "content": {
793
              "application/json": {
Michel Roy's avatar
Michel Roy committed
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
                "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"
                      }
                    }
834
                  },
Michel Roy's avatar
Michel Roy committed
835
836
837
838
839
840
841
842
843
844
845
846
847
                  "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": [
                          {
Michel Roy's avatar
Michel Roy committed
848
                            "type": 1,
Michel Roy's avatar
Michel Roy committed
849
850
851
852
853
854
855
856
857
858
859
860
861
                            "value": "10.100.0.1"
                          }
                        ],
                        "ecgi": [
                          {
                            "plmn": {
                              "mnc": "01",
                              "mcc": "001"
                            },
                            "cellId": "ACBDEFA"
                          }
                        ],
                        "hoStatus": [
Michel Roy's avatar
Michel Roy committed
862
863
                          1,
                          2
Michel Roy's avatar
Michel Roy committed
864
865
866
867
868
869
870
                        ]
                      },
                      "expiryDeadline": {
                        "seconds": 1977836800,
                        "nanoseconds": 0
                      }
                    }
871
872
873
874
875
876
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
877
            "$ref": "#/components/responses/400"
878
879
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
880
            "$ref": "#/components/responses/401"
881
882
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
883
            "$ref": "#/components/responses/403"
884
885
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
886
            "$ref": "#/components/responses/404"
887
888
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
889
            "$ref": "#/components/responses/406"
890
891
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
892
            "$ref": "#/components/responses/429"
893
          }
Michel Roy's avatar
Michel Roy committed
894
895
        },
        "x-swagger-router-controller": "subscriptions"
896
897
      },
      "put": {
Michel Roy's avatar
Michel Roy committed
898
        "tags": [
Michel Roy's avatar
Michel Roy committed
899
          "rni"
900
        ],
Michel Roy's avatar
Michel Roy committed
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
        "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": [
                        {
Michel Roy's avatar
Michel Roy committed
960
                          "type": 1,
Michel Roy's avatar
Michel Roy committed
961
962
963
964
965
966
967
968
969
970
971
972
973
                          "value": "10.100.0.1"
                        }
                      ],
                      "ecgi": [
                        {
                          "plmn": {
                            "mnc": "01",
                            "mcc": "001"
                          },
                          "cellId": "ACBDEFA"
                        }
                      ],
                      "hoStatus": [
Michel Roy's avatar
Michel Roy committed
974
975
                        1,
                        2
Michel Roy's avatar
Michel Roy committed
976
977
978
979
980
981
982
                      ]
                    },
                    "expiryDeadline": {
                      "seconds": 1977836800,
                      "nanoseconds": 0
                    }
                  }
983
984
985
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
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
          }
        },
        "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": [
                        {
Michel Roy's avatar
Michel Roy committed
1050
                          "type": 1,
Michel Roy's avatar
Michel Roy committed
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
                          "value": "10.100.0.1"
                        }
                      ],
                      "ecgi": [
                        {
                          "plmn": {
                            "mnc": "01",
                            "mcc": "001"
                          },
                          "cellId": "ACBDEFA"
                        }
                      ],
                      "hoStatus": [
Michel Roy's avatar
Michel Roy committed
1064
1065
                        1,
                        2
Michel Roy's avatar
Michel Roy committed
1066
1067
1068
1069
1070
1071
1072
                      ]
                    },
                    "expiryDeadline": {
                      "seconds": 1977836800,
                      "nanoseconds": 0
                    }
                  }
1073
1074
1075
1076
                }
              }
            }
          },
Michel Roy's avatar
Michel Roy committed
1077
1078
1079
1080
1081
1082
1083
1084
1085
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
1086
          "404": {
Michel Roy's avatar
Michel Roy committed
1087
            "$ref": "#/components/responses/404"
1088
1089
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
1090
            "$ref": "#/components/responses/406"
1091
1092
          },
          "412": {
Michel Roy's avatar
Michel Roy committed
1093
            "$ref": "#/components/responses/412"
1094
1095
          },
          "422": {
Michel Roy's avatar
Michel Roy committed
1096
            "$ref": "#/components/responses/422"
1097
1098
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
1099
            "$ref": "#/components/responses/429"
1100
          }
Michel Roy's avatar
Michel Roy committed
1101
1102
        },
        "x-swagger-router-controller": "subscriptions"
1103
1104
      },
      "delete": {
Michel Roy's avatar
Michel Roy committed
1105
        "tags": [
Michel Roy's avatar
Michel Roy committed
1106
          "rni"
1107
        ],
Michel Roy's avatar
Michel Roy committed
1108
1109
1110
        "summary": "Cancel an existing subscription",
        "description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "subscriptionsDELETE",
1111
1112
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
1113
            "$ref": "#/components/parameters/Path.subscrId"
1114
1115
1116
1117
          }
        ],
        "responses": {
          "204": {
Michel Roy's avatar
Michel Roy committed
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
            "$ref": "#/components/responses/204"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "429": {
            "$ref": "#/components/responses/429"
1131
1132
          }
        },
Michel Roy's avatar
Michel Roy committed
1133
        "x-swagger-router-controller": "subscriptions"
1134
      }
Michel Roy's avatar
Michel Roy committed
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
    }
  },
  "components": {
    "responses": {
      "204": {
        "description": "No Content"
      },
      "400": {
        "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
        "content": {
          "application/json": {
1146
1147
1148
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1149
1150
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1151
1152
1153
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1154
1155
1156
1157
1158
1159
1160
          }
        }
      },
      "401": {
        "description": "Unauthorized :  used when the client did not submit credentials.",
        "content": {
          "application/json": {
1161
1162
1163
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1164
1165
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1166
1167
1168
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1169
1170
1171
1172
1173
1174
1175
          }
        }
      },
      "403": {
        "description": "Forbidden :  operation is not allowed given the current status of the resource.",
        "content": {
          "application/json": {
1176
1177
            "schema": {
              "type": "object",
1178
              "required": [
Michel Roy's avatar
Michel Roy committed
1179
                "problemDetails"
1180
              ],
1181
              "properties": {
Michel Roy's avatar
Michel Roy committed
1182
1183
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1184
1185
1186
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1187
1188
1189
1190
1191
1192
1193
          }
        }
      },
      "404": {
        "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
        "content": {
          "application/json": {
1194
1195
1196
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1197
1198
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1199
1200
1201
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1202
1203
1204
1205
1206
1207
1208
          }
        }
      },
      "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": {
1209
1210
1211
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1212
1213
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1214
1215
1216
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1217
1218
1219
1220
1221
1222
1223
          }
        }
      },
      "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": {
1224
1225
1226
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1227
1228
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1229
1230
1231
1232
                }
              }
            }
          }
Michel Roy's avatar
Michel Roy committed
1233
        }
1234
      },
Michel Roy's avatar
Michel Roy committed
1235
1236
1237
1238
      "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": {
1239
1240
1241
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1242
1243
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1244
1245
1246
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1247
1248
1249
1250
1251
1252
1253
          }
        }
      },
      "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": {
1254
1255
1256
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1257
1258
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1259
1260
1261
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1262
1263
1264
1265
1266
1267
1268
          }
        }
      },
      "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": {
1269
1270
1271
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1272
1273
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1274
1275
                }
              }
Michel Roy's avatar
Michel Roy committed
1276
1277
1278
1279
1280
1281
1282
1283
1284
            },
            "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"
1285
1286
1287
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
1288
1289
1290
1291
1292
1293
1294
          }
        }
      },
      "429": {
        "description": "Too Many Requests : used when a rate limiter has triggered.",
        "content": {
          "application/json": {
1295
1296
1297
            "schema": {
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1298
1299
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
1300
1301
1302
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
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
          }
        }
      }
    },
    "parameters": {
      "Path.subscrId": {
        "name": "subscriptionId",
        "in": "path",
        "description": "Subscription Id, specifically the \"Self-referring URI\" returned in the subscription request",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uri"
        },
        "x-exportParamName": "SubscriptionId"
      },
      "Query.AppInsId": {
        "name": "app_ins_id",
        "in": "query",
        "description": "Application instance identifier",
        "required": false,
        "schema": {
          "type": "string"
        },
        "x-exportParamName": "AppInsId",
        "x-optionalDataType": "String"
      },
      "Query.AppInsIdArr": {
        "name": "app_ins_id",
        "in": "query",
        "description": "Comma separated list of Application instance identifiers",
        "required": true,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "x-exportParamName": "AppInsIdArr"
      },
      "Query.CellId": {
        "name": "cell_id",
        "in": "query",
        "description": "Comma separated list of E-UTRAN Cell Identities",
        "required":