RniAPI.json 168 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
    "contact": {
      "url": "https://forge.etsi.org/rep/mec/gs012-rnis-api"
    },
Michel Roy's avatar
Michel Roy committed
7 8 9
    "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.",
10
    "license": {
ETSI CTI's avatar
ETSI CTI committed
11 12
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
13 14 15
    }
  },
  "externalDocs": {
Michel Roy's avatar
Michel Roy committed
16 17
    "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"
18
  },
Michel Roy's avatar
Michel Roy committed
19
  "servers": [
20
    {
Michel Roy's avatar
Michel Roy committed
21 22 23 24 25 26
      "url": "https://localhost/rni/v2"
    }
  ],
  "tags": [
    {
      "name": "rni"
27 28 29
    }
  ],
  "paths": {
Michel Roy's avatar
Michel Roy committed
30
    "/queries/rab_info": {
31
      "get": {
Michel Roy's avatar
Michel Roy committed
32
        "tags": [
Michel Roy's avatar
Michel Roy committed
33
          "rni"
34
        ],
Michel Roy's avatar
Michel Roy committed
35 36 37
        "summary": "Retrieve information on Radio Access Bearers",
        "description": "Queries information about the Radio Access Bearers",
        "operationId": "rab_infoGET",
38 39
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
40
            "$ref": "#/components/parameters/Query.AppInsId"
41 42
          },
          {
Michel Roy's avatar
Michel Roy committed
43
            "$ref": "#/components/parameters/Query.CellId"
44 45
          },
          {
Michel Roy's avatar
Michel Roy committed
46
            "$ref": "#/components/parameters/Query.UeIpv4Address"
47 48
          },
          {
Michel Roy's avatar
Michel Roy committed
49
            "$ref": "#/components/parameters/Query.UeIpv6Address"
50 51
          },
          {
Michel Roy's avatar
Michel Roy committed
52
            "$ref": "#/components/parameters/Query.NatedIpAddress"
53 54
          },
          {
Michel Roy's avatar
Michel Roy committed
55
            "$ref": "#/components/parameters/Query.GtpTeid"
56 57
          },
          {
Michel Roy's avatar
Michel Roy committed
58
            "$ref": "#/components/parameters/Query.ErabId"
59 60
          },
          {
Michel Roy's avatar
Michel Roy committed
61
            "$ref": "#/components/parameters/Query.Qci"
62 63
          },
          {
Michel Roy's avatar
Michel Roy committed
64
            "$ref": "#/components/parameters/Query.ErabMbrDl"
65 66
          },
          {
Michel Roy's avatar
Michel Roy committed
67
            "$ref": "#/components/parameters/Query.ErabMbrUl"
68 69
          },
          {
Michel Roy's avatar
Michel Roy committed
70
            "$ref": "#/components/parameters/Query.ErabGbrDl"
71 72
          },
          {
Michel Roy's avatar
Michel Roy committed
73
            "$ref": "#/components/parameters/Query.ErabGbrUl"
74 75 76 77 78
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to rab_info request",
Michel Roy's avatar
Michel Roy committed
79
            "content": {
80
              "application/json": {
Michel Roy's avatar
Michel Roy committed
81
                "schema": {
Michel Roy's avatar
Michel Roy committed
82
                  "$ref": "#/components/schemas/RabInfo"
83 84 85 86 87
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
88
            "$ref": "#/components/responses/400"
89 90
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
91
            "$ref": "#/components/responses/401"
92 93
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
94
            "$ref": "#/components/responses/403"
95 96
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
97
            "$ref": "#/components/responses/404"
98 99
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
100
            "$ref": "#/components/responses/406"
101 102
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
103
            "$ref": "#/components/responses/429"
104 105
          }
        },
Michel Roy's avatar
Michel Roy committed
106
        "x-swagger-router-controller": "queries"
107 108
      }
    },
Michel Roy's avatar
Michel Roy committed
109
    "/queries/plmn_info": {
110
      "get": {
Michel Roy's avatar
Michel Roy committed
111
        "tags": [
Michel Roy's avatar
Michel Roy committed
112
          "rni"
113
        ],
Michel Roy's avatar
Michel Roy committed
114 115 116
        "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",
117 118
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
119
            "$ref": "#/components/parameters/Query.AppInsIdArr"
120 121 122 123
          }
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
124 125
            "description": "Successful response to plmn_info request",
            "content": {
126
              "application/json": {
Michel Roy's avatar
Michel Roy committed
127
                "schema": {
Michel Roy's avatar
Michel Roy committed
128 129 130
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PlmnInfo"
131 132 133 134 135 136
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
137
            "$ref": "#/components/responses/400"
138 139
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
140
            "$ref": "#/components/responses/401"
141 142
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
143
            "$ref": "#/components/responses/403"
144 145
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
146
            "$ref": "#/components/responses/404"
147 148
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
149
            "$ref": "#/components/responses/406"
150 151
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
152
            "$ref": "#/components/responses/429"
153 154
          }
        },
Michel Roy's avatar
Michel Roy committed
155
        "x-swagger-router-controller": "queries"
156 157
      }
    },
Michel Roy's avatar
Michel Roy committed
158
    "/queries/s1_bearer_info": {
159
      "get": {
Michel Roy's avatar
Michel Roy committed
160
        "tags": [
Michel Roy's avatar
Michel Roy committed
161
          "rni"
162
        ],
Michel Roy's avatar
Michel Roy committed
163 164 165
        "summary": "Retrieve S1-U bearer information related to specific UE(s)",
        "description": "Queries information about the S1 bearer(s)",
        "operationId": "s1_bearer_infoGET",
166 167
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
168
            "$ref": "#/components/parameters/Query.TempUeId"
169 170
          },
          {
Michel Roy's avatar
Michel Roy committed
171
            "$ref": "#/components/parameters/Query.UeIpv4Address"
172 173
          },
          {
Michel Roy's avatar
Michel Roy committed
174
            "$ref": "#/components/parameters/Query.UeIpv6Address"
175 176
          },
          {
Michel Roy's avatar
Michel Roy committed
177
            "$ref": "#/components/parameters/Query.NatedIpAddress"
178 179
          },
          {
Michel Roy's avatar
Michel Roy committed
180
            "$ref": "#/components/parameters/Query.GtpTeid"
181 182
          },
          {
Michel Roy's avatar
Michel Roy committed
183
            "$ref": "#/components/parameters/Query.CellId"
184 185
          },
          {
Michel Roy's avatar
Michel Roy committed
186
            "$ref": "#/components/parameters/Query.ErabIdArr"
187 188 189 190 191
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to s1_bearer_info request",
Michel Roy's avatar
Michel Roy committed
192 193 194
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
195
                  "$ref": "#/components/schemas/S1BearerInfo"
196 197 198 199 200
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
201
            "$ref": "#/components/responses/400"
202 203
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
204
            "$ref": "#/components/responses/401"
205 206
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
207
            "$ref": "#/components/responses/403"
208 209
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
210
            "$ref": "#/components/responses/404"
211 212
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
213
            "$ref": "#/components/responses/406"
214 215
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
216
            "$ref": "#/components/responses/429"
217 218
          }
        },
Michel Roy's avatar
Michel Roy committed
219
        "x-swagger-router-controller": "queries"
220 221
      }
    },
Michel Roy's avatar
Michel Roy committed
222
    "/queries/layer2_meas": {
223
      "get": {
Michel Roy's avatar
Michel Roy committed
224
        "tags": [
Michel Roy's avatar
Michel Roy committed
225
          "rni"
Michel Roy's avatar
Michel Roy committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
        ],
        "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"
          }
348 349 350
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
351 352
            "description": "Successful response to layer2 measurements info request",
            "content": {
353
              "application/json": {
Michel Roy's avatar
Michel Roy committed
354
                "schema": {
Michel Roy's avatar
Michel Roy committed
355
                  "$ref": "#/components/schemas/L2Meas"
356 357 358 359 360
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
361
            "$ref": "#/components/responses/400"
362 363
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
364
            "$ref": "#/components/responses/401"
365 366
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
367
            "$ref": "#/components/responses/403"
368 369
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
370
            "$ref": "#/components/responses/404"
371 372
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
373 374 375 376
            "$ref": "#/components/responses/406"
          },
          "414": {
            "$ref": "#/components/responses/414"
377 378
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
379
            "$ref": "#/components/responses/429"
380 381
          }
        },
Michel Roy's avatar
Michel Roy committed
382
        "x-swagger-router-controller": "queries"
383 384
      }
    },
Michel Roy's avatar
Michel Roy committed
385
    "/subscriptions": {
386
      "get": {
Michel Roy's avatar
Michel Roy committed
387
        "tags": [
Michel Roy's avatar
Michel Roy committed
388
          "rni"
Michel Roy's avatar
Michel Roy committed
389 390 391 392 393 394 395 396
        ],
        "summary": "Retrieve information on subscriptions for notifications",
        "description": "Queries information on subscriptions for notifications",
        "operationId": "subscriptionLinkList_subscriptionsGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.SubscriptionType"
          }
397 398 399
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
400 401
            "description": "Response body contains the list of links to requestors subscriptions.",
            "content": {
402
              "application/json": {
Michel Roy's avatar
Michel Roy committed
403
                "schema": {
Michel Roy's avatar
Michel Roy committed
404
                  "$ref": "#/components/schemas/SubscriptionLinkList"
Michel Roy's avatar
Michel Roy committed
405 406
                },
                "example": {
Michel Roy's avatar
Michel Roy committed
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
                  "_links": {
                    "self": {
                      "href": "http://meAppServer.example.com/rni/v2/subscriptions"
                    }
                  },
                  "subscription": [
                    {
                      "_links": {
                        "self": {
                          "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
                        }
                      },
                      "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                      "subscriptionType": "CellChangeSubscription"
                    }
                  ]
423 424 425 426 427
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
428
            "$ref": "#/components/responses/400"
429 430
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
431
            "$ref": "#/components/responses/401"
432 433
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
434
            "$ref": "#/components/responses/403"
435 436
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
437
            "$ref": "#/components/responses/404"
438 439
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
440
            "$ref": "#/components/responses/406"
441 442
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
443
            "$ref": "#/components/responses/429"
444 445
          }
        },
Michel Roy's avatar
Michel Roy committed
446
        "x-swagger-router-controller": "subscriptions"
447 448
      },
      "post": {
Michel Roy's avatar
Michel Roy committed
449
        "tags": [
Michel Roy's avatar
Michel Roy committed
450
          "rni"
451
        ],
Michel Roy's avatar
Michel Roy committed
452 453 454 455 456 457 458 459 460
        "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": {
Michel Roy's avatar
Michel Roy committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
                "$ref": "#/components/schemas/InlineSubscription"
              },
              "example": {
                "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"
Michel Roy's avatar
Michel Roy committed
479
                      },
Michel Roy's avatar
Michel Roy committed
480
                      "cellId": "ACBDEFA"
Michel Roy's avatar
Michel Roy committed
481
                    }
Michel Roy's avatar
Michel Roy committed
482 483 484 485 486
                  ],
                  "hoStatus": [
                    1,
                    2
                  ]
Michel Roy's avatar
Michel Roy committed
487
                },
Michel Roy's avatar
Michel Roy committed
488 489 490
                "expiryDeadline": {
                  "seconds": 1977836800,
                  "nanoseconds": 0
Michel Roy's avatar
Michel Roy committed
491 492 493
                }
              }
            }
494
          }
Michel Roy's avatar
Michel Roy committed
495
        },
496 497
        "responses": {
          "201": {
Michel Roy's avatar
Michel Roy committed
498 499
            "description": "Successful subscription",
            "content": {
500
              "application/json": {
Michel Roy's avatar
Michel Roy committed
501
                "schema": {
Michel Roy's avatar
Michel Roy committed
502 503 504 505 506 507 508 509
                  "$ref": "#/components/schemas/InlineSubscription"
                },
                "example": {
                  "subscriptionType": "CellChangeSubscription",
                  "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                  "_links": {
                    "self": {
                      "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
Michel Roy's avatar
Michel Roy committed
510
                    }
511
                  },
Michel Roy's avatar
Michel Roy committed
512 513 514 515 516 517
                  "filterCriteriaAssocHo": {
                    "appInstanceId": "myApp",
                    "associateId": [
                      {
                        "type": 1,
                        "value": "10.100.0.1"
Michel Roy's avatar
Michel Roy committed
518
                      }
Michel Roy's avatar
Michel Roy committed
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
                    ],
                    "ecgi": [
                      {
                        "plmn": {
                          "mnc": "01",
                          "mcc": "001"
                        },
                        "cellId": "ACBDEFA"
                      }
                    ],
                    "hoStatus": [
                      1,
                      2
                    ]
                  },
                  "expiryDeadline": {
                    "seconds": 1977836800,
                    "nanoseconds": 0
537 538 539 540 541 542
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
543
            "$ref": "#/components/responses/400"
544 545
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
546
            "$ref": "#/components/responses/401"
547 548
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
549
            "$ref": "#/components/responses/403"
550 551
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
552
            "$ref": "#/components/responses/404"
553 554
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
555
            "$ref": "#/components/responses/406"
556 557
          },
          "415": {
Michel Roy's avatar
Michel Roy committed
558
            "$ref": "#/components/responses/412"
559 560
          },
          "422": {
Michel Roy's avatar
Michel Roy committed
561
            "$ref": "#/components/responses/422"
562 563
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
            "$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": {
Michel Roy's avatar
Michel Roy committed
580 581 582 583 584 585 586 587
                        "$ref": "#/components/schemas/InlineNotification"
                      },
                      "example": {
                        "notificationType": "CellChangeNotification",
                        "associateId": [
                          {
                            "type": 1,
                            "value": "10.100.0.1"
Michel Roy's avatar
Michel Roy committed
588
                          }
Michel Roy's avatar
Michel Roy committed
589 590 591 592 593 594 595 596
                        ],
                        "hoStatus": 1,
                        "srcEcgi": {
                          "plmn": {
                            "mnc": "01",
                            "mcc": "001"
                          },
                          "cellId": "ACBDEFA"
Michel Roy's avatar
Michel Roy committed
597
                        },
Michel Roy's avatar
Michel Roy committed
598 599 600 601 602 603 604 605 606 607 608 609 610 611
                        "tempUeId": {
                          "mmec": 1,
                          "mtmsi": 69967622812
                        },
                        "timeStamp": {
                          "seconds": 1977836800,
                          "nanoseconds": 0
                        },
                        "trgEcgi": {
                          "plmn": {
                            "mnc": "01",
                            "mcc": "001"
                          },
                          "cellId": "FEDCBAA"
Michel Roy's avatar
Michel Roy committed
612 613 614 615 616 617 618 619 620
                        }
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
                  }
621 622 623 624 625
                }
              }
            }
          }
        },
Michel Roy's avatar
Michel Roy committed
626
        "x-swagger-router-controller": "subscriptions"
627 628
      }
    },
Michel Roy's avatar
Michel Roy committed
629
    "/subscriptions/{subscriptionId}": {
630
      "get": {
Michel Roy's avatar
Michel Roy committed
631
        "tags": [
Michel Roy's avatar
Michel Roy committed
632
          "rni"
633
        ],
Michel Roy's avatar
Michel Roy committed
634 635 636
        "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",
637 638
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
639
            "$ref": "#/components/parameters/Path.subscrId"
640 641 642 643
          }
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
644 645
            "description": "Subscription information regarding subscription notifications",
            "content": {
646
              "application/json": {
Michel Roy's avatar
Michel Roy committed
647
                "schema": {
Michel Roy's avatar
Michel Roy committed
648 649 650 651 652 653 654 655
                  "$ref": "#/components/schemas/InlineSubscription"
                },
                "example": {
                  "subscriptionType": "CellChangeSubscription",
                  "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                  "_links": {
                    "self": {
                      "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
Michel Roy's avatar
Michel Roy committed
656
                    }
657
                  },
Michel Roy's avatar
Michel Roy committed
658 659 660 661 662 663
                  "filterCriteriaAssocHo": {
                    "appInstanceId": "myApp",
                    "associateId": [
                      {
                        "type": 1,
                        "value": "10.100.0.1"
Michel Roy's avatar
Michel Roy committed
664
                      }
Michel Roy's avatar
Michel Roy committed
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
                    ],
                    "ecgi": [
                      {
                        "plmn": {
                          "mnc": "01",
                          "mcc": "001"
                        },
                        "cellId": "ACBDEFA"
                      }
                    ],
                    "hoStatus": [
                      1,
                      2
                    ]
                  },
                  "expiryDeadline": {
                    "seconds": 1977836800,
                    "nanoseconds": 0
683 684 685 686 687 688
                  }
                }
              }
            }
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
689
            "$ref": "#/components/responses/400"
690 691
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
692
            "$ref": "#/components/responses/401"
693 694
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
695
            "$ref": "#/components/responses/403"
696 697
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
698
            "$ref": "#/components/responses/404"
699 700
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
701
            "$ref": "#/components/responses/406"
702 703
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
704
            "$ref": "#/components/responses/429"
705
          }
Michel Roy's avatar
Michel Roy committed
706 707
        },
        "x-swagger-router-controller": "subscriptions"
708 709
      },
      "put": {
Michel Roy's avatar
Michel Roy committed
710
        "tags": [
Michel Roy's avatar
Michel Roy committed
711
          "rni"
712
        ],
Michel Roy's avatar
Michel Roy committed
713 714 715 716 717 718 719 720 721
        "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": {
Michel Roy's avatar
Michel Roy committed
722 723 724 725 726 727 728 729
                "$ref": "#/components/schemas/InlineSubscription"
              },
              "example": {
                "subscriptionType": "CellChangeSubscription",
                "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                "_links": {
                  "self": {
                    "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
Michel Roy's avatar
Michel Roy committed
730 731
                  }
                },
Michel Roy's avatar
Michel Roy committed
732 733 734 735 736 737
                "filterCriteriaAssocHo": {
                  "appInstanceId": "myApp",
                  "associateId": [
                    {
                      "type": 1,
                      "value": "10.100.0.1"
Michel Roy's avatar
Michel Roy committed
738
                    }
Michel Roy's avatar
Michel Roy committed
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
                  ],
                  "ecgi": [
                    {
                      "plmn": {
                        "mnc": "01",
                        "mcc": "001"
                      },
                      "cellId": "ACBDEFA"
                    }
                  ],
                  "hoStatus": [
                    1,
                    2
                  ]
                },
                "expiryDeadline": {
                  "seconds": 1977836800,
                  "nanoseconds": 0
757 758 759
                }
              }
            }
Michel Roy's avatar
Michel Roy committed
760 761 762 763 764 765 766 767 768 769 770 771 772
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful subscription to response to subscription notifications",
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
773
                  "$ref": "#/components/schemas/InlineSubscription"
Michel Roy's avatar
Michel Roy committed
774 775
                },
                "example": {
Michel Roy's avatar
Michel Roy committed
776 777 778 779 780
                  "subscriptionType": "CellChangeSubscription",
                  "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                  "_links": {
                    "self": {
                      "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
Michel Roy's avatar
Michel Roy committed
781
                    }
Michel Roy's avatar
Michel Roy committed
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
                  },
                  "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
Michel Roy's avatar
Michel Roy committed
808
                  }
809 810 811 812
                }
              }
            }
          },
Michel Roy's avatar
Michel Roy committed
813 814 815 816 817 818 819 820 821
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
822
          "404": {
Michel Roy's avatar
Michel Roy committed
823
            "$ref": "#/components/responses/404"
824 825
          },
          "406": {
Michel Roy's avatar
Michel Roy committed
826
            "$ref": "#/components/responses/406"
827 828
          },
          "412": {
Michel Roy's avatar
Michel Roy committed
829
            "$ref": "#/components/responses/412"
830 831
          },
          "422": {
Michel Roy's avatar
Michel Roy committed
832
            "$ref": "#/components/responses/422"
833 834
          },
          "429": {
Michel Roy's avatar
Michel Roy committed
835
            "$ref": "#/components/responses/429"
836
          }
Michel Roy's avatar
Michel Roy committed
837 838
        },
        "x-swagger-router-controller": "subscriptions"
839 840
      },
      "delete": {
Michel Roy's avatar
Michel Roy committed
841
        "tags": [
Michel Roy's avatar
Michel Roy committed
842
          "rni"
843
        ],
Michel Roy's avatar
Michel Roy committed
844 845 846
        "summary": "Cancel an existing subscription",
        "description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "subscriptionsDELETE",
847 848
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
849
            "$ref": "#/components/parameters/Path.subscrId"
850 851 852 853
          }
        ],
        "responses": {
          "204": {
Michel Roy's avatar
Michel Roy committed
854 855 856 857 858 859 860 861 862 863 864 865 866
            "$ref": "#/components/responses/204"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "429": {
            "$ref": "#/components/responses/429"
867 868
          }
        },
Michel Roy's avatar
Michel Roy committed
869
        "x-swagger-router-controller": "subscriptions"
870
      }
Michel Roy's avatar
Michel Roy committed
871 872 873 874 875 876 877 878 879 880
    }
  },
  "components": {
    "responses": {
      "204": {
        "description": "No Content"
      },
      "400": {
        "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
        "content": {
Michel Roy's avatar
Michel Roy committed
881
          "application/problem+json": {
882
            "schema": {
Michel Roy's avatar
Michel Roy committed
883
              "$ref": "#/components/schemas/ProblemDetails"
884
            }
Michel Roy's avatar
Michel Roy committed
885 886 887 888 889 890
          }
        }
      },
      "401": {
        "description": "Unauthorized :  used when the client did not submit credentials.",
        "content": {
Michel Roy's avatar
Michel Roy committed
891
          "application/problem+json": {
892
            "schema": {
Michel Roy's avatar
Michel Roy committed
893
              "$ref": "#/components/schemas/ProblemDetails"
894
            }
Michel Roy's avatar
Michel Roy committed
895 896 897 898 899 900
          }
        }
      },
      "403": {
        "description": "Forbidden :  operation is not allowed given the current status of the resource.",
        "content": {
Michel Roy's avatar
Michel Roy committed
901
          "application/problem+json": {
902
            "schema": {
Michel Roy's avatar
Michel Roy committed
903
              "$ref": "#/components/schemas/ProblemDetails"
904
            }
Michel Roy's avatar
Michel Roy committed
905 906 907 908 909 910
          }
        }
      },
      "404": {
        "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
        "content": {
Michel Roy's avatar
Michel Roy committed
911
          "application/problem+json": {
912
            "schema": {
Michel Roy's avatar
Michel Roy committed
913
              "$ref": "#/components/schemas/ProblemDetails"
914
            }
Michel Roy's avatar
Michel Roy committed
915 916 917 918 919 920
          }
        }
      },
      "406": {
        "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
        "content": {
Michel Roy's avatar
Michel Roy committed
921
          "application/problem+json": {
922
            "schema": {
Michel Roy's avatar
Michel Roy committed
923
              "$ref": "#/components/schemas/ProblemDetails"
924
            }
Michel Roy's avatar
Michel Roy committed
925 926 927 928 929 930
          }
        }
      },
      "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": {
Michel Roy's avatar
Michel Roy committed
931
          "application/problem+json": {
932
            "schema": {
Michel Roy's avatar
Michel Roy committed
933
              "$ref": "#/components/schemas/ProblemDetails"
934 935
            }
          }
Michel Roy's avatar
Michel Roy committed
936
        }
937
      },
Michel Roy's avatar
Michel Roy committed
938 939 940
      "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": {
Michel Roy's avatar
Michel Roy committed
941
          "application/problem+json": {
942
            "schema": {
Michel Roy's avatar
Michel Roy committed
943
              "$ref": "#/components/schemas/ProblemDetails"
944
            }
Michel Roy's avatar
Michel Roy committed
945 946 947 948 949 950
          }
        }
      },
      "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": {
Michel Roy's avatar
Michel Roy committed
951
          "application/problem+json": {
952
            "schema": {
Michel Roy's avatar
Michel Roy committed
953
              "$ref": "#/components/schemas/ProblemDetails"
954
            }
Michel Roy's avatar
Michel Roy committed
955 956 957 958 959 960
          }
        }
      },
      "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": {
Michel Roy's avatar
Michel Roy committed
961
          "application/problem+json": {
962
            "schema": {
Michel Roy's avatar
Michel Roy committed
963
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
964 965 966
            },
            "example": {
              "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
967 968 969 970 971
                "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"
972 973
              }
            }
Michel Roy's avatar
Michel Roy committed
974 975 976 977 978 979
          }
        }
      },
      "429": {
        "description": "Too Many Requests : used when a rate limiter has triggered.",
        "content": {
Michel Roy's avatar
Michel Roy committed
980
          "application/problem+json": {
981
            "schema": {
Michel Roy's avatar
Michel Roy committed
982
              "$ref": "#/components/schemas/ProblemDetails"
983
            }
Michel Roy's avatar
Michel Roy committed
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
          }
        }
      }
    },
    "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": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "x-exportParamName": "CellId"
      },
      "Query.UeIpv4Address": {
        "name": "ue_ipv4_address",
        "in": "query",
        "description": "Comma separated list of IE IPv4 addresses as defined for the type for AssociateId",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "x-exportParamName": "UeIpv4Address"
      },
      "Query.UeIpv6Address": {
        "name": "ue_ipv6_address",
        "in": "query",
        "description": "Comma separated list of IE IPv6 addresses as defined for the type for AssociateId",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "x-exportParamName": "UeIpv6Address"
      },
      "Query.NatedIpAddress": {
        "name": "nated_ip_address",
        "in": "query",
        "description": "Comma separated list of IE NATed IP addresses as defined for the type for AssociateId",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "x-exportParamName": "NatedIpAddress"
      },
      "Query.GtpTeid": {
        "name": "gtp_teid",
        "in": "query",
        "description": "Comma separated list of GTP TEID addresses as defined for the type for AssociateId",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "x-exportParamName": "GtpTeid"
      },
      "Query.ErabId": {
        "name": "erab_id",
        "in": "query",
        "description": "E-RAB identifier",
        "required": false,
        "schema": {
          "type": "integer",
Michel Roy's avatar
Michel Roy committed
1096
          "format": "int32"
Michel Roy's avatar
Michel Roy committed
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
        },
        "x-exportParamName": "ErabId",
        "x-optionalDataType": "Int32"
      },
      "Query.ErabIdArr": {
        "name": "erab_id",
        "in": "query",
        "description": "Comma separated list of E-RAB identifiers",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
1110
            "format": "int32"
Michel Roy's avatar
Michel Roy committed
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
          }
        },
        "x-exportParamName": "ErabIdArr"
      },
      "Query.Qci": {
        "name": "qci",
        "in": "query",
        "description": "QoS Class Identifier as defined in ETSI TS 123 401",
        "required": false,
        "schema": {
          "type": "integer",
Michel Roy's avatar
Michel Roy committed
1122
          "format": "int32"
Michel Roy's avatar
Michel Roy committed
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
        },
        "x-exportParamName": "Qci",
        "x-optionalDataType": "Int32"
      },
      "Query.ErabMbrDl": {
        "name": "erab_mbr_dl",
        "in": "query",
        "description": "Maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401",
        "required": false,
        "schema": {
          "type": "integer",
Michel Roy's avatar
Michel Roy committed
1134
          "format": "int32"
Michel Roy's avatar
Michel Roy committed
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
        },
        "x-exportParamName": "ErabMbrDl",
        "x-optionalDataType": "Int32"
      },
      "Query.ErabMbrUl": {
        "name": "erab_mbr_ul",
        "in": "query",
        "description": "Maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401",
        "required": false,
        "schema": {
          "type": "integer",
Michel Roy's avatar
Michel Roy committed
1146
          "format": "int32"
Michel Roy's avatar
Michel Roy committed
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
        },
        "x-exportParamName": "ErabMbrUl",
        "x-optionalDataType": "Int32"
      },
      "Query.ErabGbrDl": {
        "name": "erab_gbr_dl",
        "in": "query",
        "description": "Guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401",
        "required": false,
        "schema": {
          "type": "integer",
Michel Roy's avatar
Michel Roy committed
1158
          "format": "int32"
Michel Roy's avatar
Michel Roy committed
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
        },
        "x-exportParamName": "ErabGbrDl",
        "x-optionalDataType": "Int32"
      },
      "Query.ErabGbrUl": {
        "name": "erab_gbr_ul",
        "in": "query",
        "description": "Guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401",
        "required": false,
        "schema": {
          "type": "integer",
Michel Roy's avatar
Michel Roy committed
1170
          "format": "int32"
Michel Roy's avatar
Michel Roy committed
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
        },
        "x-exportParamName": "ErabGbrUl",
        "x-optionalDataType": "Int32"
      },
      "Query.TempUeId": {
        "name": "temp_ue_id",
        "in": "query",
        "description": "Comma separated list of temporary identifiers allocated for the specific UE as defined in   ETSI TS 136 413",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "x-exportParamName": "TempUeId"
      },
      "Query.DlGbrPrbUsageCell": {
        "name": "dl_gbr_prb_usage_cell",
        "in": "query",
        "description": "PRB usage for downlink GBR traffic in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlGbrPrbUsageCell"
      },
      "Query.UlGbrPrbUsageCell": {
        "name": "ul_gbr_prb_usage_cell",
        "in": "query",
        "description": "PRB usage for uplink GBR traffic in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlGbrPrbUsageCell"
      },
      "Query.DlNonGbrPrbUsageCell": {
        "name": "dl_nongbr_prb_usage_cell",
        "in": "query",
        "description": "PRB usage for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlNonGbrPrbUsageCell"
      },
      "Query.UlNonGbrPrbUsageCell": {
        "name": "ul_nongbr_prb_usage_cell",
        "in": "query",
        "description": "PRB usage for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlNonGbrPrbUsageCell"
      },
      "Query.DlTotalPrbUsageCell": {
        "name": "dl_total_prb_usage_cell",
        "in": "query",
        "description": "PRB usage for total downlink traffic in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlTotalPrbUsageCell"
      },
      "Query.UlTotalPrbUsageCell": {
        "name": "ul_total_prb_usage_cell",
        "in": "query",
        "description": "PRB usage for total uplink traffic in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlTotalPrbUsageCell"
      },
      "Query.ReceivedDedicatedPreamblesCell": {
        "name": "received_dedicated_preambles_cell",
        "in": "query",
        "description": "Received dedicated preambles in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "ReceivedDedicatedPreamblesCell"
      },
      "Query.ReceivedRandomPreamblesLowRangeCell": {
        "name": "received_randomly_selected_preambles_low_range_cell",
        "in": "query",
        "description": "Received randomly selected preambles in the low range in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "ReceivedRandomPreamblesLowRangeCell"
      },
      "Query.ReceivedRandomPreamblesHighRangeCell": {
        "name": "received_randomly_selected_preambles_high_range_cell",
        "in": "query",
        "description": "Received rendomly selected preambles in the high range in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "ReceivedRandomPreamblesHighRangeCell"
      },
      "Query.NumberOfActiveUeDlGbrCell": {
        "name": "number_of_active_ue_dl_gbr_cell",
        "in": "query",
        "description": "Number of active UEs with downlink GBR traffic as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "NumberOfActiveUeDlGbrCell"
      },
      "Query.NumberOfActiveUeUlGbrCell": {
        "name": "number_of_active_ue_ul_gbr_cell",
        "in": "query",
        "description": "Number of active UEs with uplink GBR traffic as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "NumberOfActiveUeUlGbrCell"
      },
      "Query.NumberOfActiveUeDlNonGbrCell": {
        "name": "number_of_active_ue_dl_nongbr_cell",
        "in": "query",
        "description": "Number of active UEs with downlink non-GBR traffic as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "NumberOfActiveUeDlNonGbrCell"
      },
      "Query.NumberOfActiveUeUlNonGbrCell": {
        "name": "number_of_active_ue_ul_nongbr_cell",
        "in": "query",
        "description": "Number of active UEs with uplink non-GBR traffic as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "NumberOfActiveUeUlNonGbrCell"
      },
      "Query.DlGbrPdrCell": {
        "name": "dl_gbr_pdr_cell",
        "in": "query",
        "description": "Packet discard rate for downlink GBR traffic in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlGbrPdrCell"
      },
      "Query.UlGbrPdrCell": {
        "name": "ul_gbr_pdr_cell",
        "in": "query",
        "description": "Packet discard rate for uplink GBR traffic in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlGbrPdrCell"
      },
      "Query.DlNonGbrPdrCell": {
        "name": "dl_nongbr_pdr_cell",
        "in": "query",
        "description": "Packet discard rate for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlNonGbrPdrCell"
      },
      "Query.UlNonGbrPdrCell": {
        "name": "ul_nongbr_pdr_cell",
        "in": "query",
        "description": "Packet discard rate for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlNonGbrPdrCell"
      },
      "Query.DlGbrDelayUe": {
        "name": "dl_gbr_delay_ue",
        "in": "query",
        "description": "Packet delay of downlink GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlGbrDelayUe"
      },
      "Query.UlGbrDelayUe": {
        "name": "ul_gbr_delay_ue",
        "in": "query",
        "description": "Packet delay of uplink GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlGbrDelayUe"
      },
      "Query.DlNonGbrDelayUe": {
        "name": "dl_nongbr_delay_ue",
        "in": "query",
        "description": "Packet delay of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlNonGbrDelayUe"
      },
      "Query.UlNonGbrDelayUe": {
        "name": "ul_nongbr_delay_ue",
        "in": "query",
        "description": "Packet delay of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlNonGbrDelayUe"
      },
      "Query.DlGbrPdrUe": {
        "name": "dl_gbr_pdr_ue",
        "in": "query",
        "description": "Packet discard rate of downlink GBR traffic of a UE in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlGbrPdrUe"
      },
      "Query.UlGbrPdrUe": {
        "name": "ul_gbr_pdr_ue",
        "in": "query",
        "description": "Packet discard rate of uplink GBR traffic of a UE in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlGbrPdrUe"
      },
      "Query.DlNonGbrPdrUe": {
        "name": "dl_nongbr_pdr_ue",
        "in": "query",
        "description": "Packet discard rate of downlink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlNonGbrPdrUe"
      },
      "Query.UlNonGbrPdrUe": {
        "name": "ul_nongbr_pdr_ue",
        "in": "query",
        "description": "Packet discard rate of uplink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlNonGbrPdrUe"
      },
      "Query.DlGbrThroughputUe": {
        "name": "dl_gbr_throughput_ue",
        "in": "query",
        "description": "Scheduled throughput of downlink GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlGbrThroughputUe"
      },
      "Query.UlGbrThroughputUe": {
        "name": "ul_gbr_throughput_ue",
        "in": "query",
        "description": "Scheduled throughput of uplink GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlGbrThroughputUe"
      },
      "Query.DlNonGbrThroughputUe": {
        "name": "dl_nongbr_throughput_ue",
        "in": "query",
        "description": "Scheduled throughput of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlNonGbrThroughputUe"
      },
      "Query.UlNonGbrThroughputUe": {
        "name": "ul_nongbr_throughput_ue",
        "in": "query",
        "description": "Scheduled throughput of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlNonGbrThroughputUe"
      },
      "Query.DlGbrDataVolumeUe": {
        "name": "dl_gbr_data_volume_ue",
        "in": "query",
        "description": "Data volume of downlink GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlGbrDataVolumeUe"
      },
      "Query.UlGbrDataVolumeUe": {
        "name": "ul_gbr_data_volume_ue",
        "in": "query",
        "description": "Data volume of uplink GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlGbrDataVolumeUe"
      },
      "Query.DlNonGbrDataVolumeUe": {
        "name": "dl_nongbr_data_volume_ue",
        "in": "query",
        "description": "Data volume of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "DlNonGbrDataVolumeUe"
      },
      "Query.UlNonGbrDataVolumeUe": {
        "name": "ul_nongbr_data_volume_ue",
        "in": "query",
        "description": "Data volume of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "x-exportParamName": "UlNonGbrDataVolumeUe"
      },
      "Query.SubscriptionType": {
        "name": "subscription_type",
        "in": "query",
Michel Roy's avatar
Michel Roy committed
1521
        "description": "Filter on a specific subscription type. Permitted values: cell_change, rab_est, rab_mod, rab_rel, meas_rep_ue, nr_meas_rep_ue, timing_advance_ue, ca_reconf, s1_bearer.",
Michel Roy's avatar
Michel Roy committed
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532
        "required": false,
        "schema": {
          "type": "string"
        },
        "x-exportParamName": "SubscriptionType"
      }
    },
    "schemas": {
      "AssociateId": {
        "properties": {
          "type": {
Michel Roy's avatar
Michel Roy committed
1533
            "description": "Numeric value (0-255) corresponding to specified type of identifier as following: <p>0 = reserved. <p>1 = UE_IPv4_ADDRESS. <p>2 = UE_IPV6_ADDRESS. <p>3 = NATED_IP_ADDRESS. <p>4 = GTP_TEID.",
Michel Roy's avatar
Michel Roy committed
1534
            "enum": [
Michel Roy's avatar
Michel Roy committed
1535 1536 1537 1538 1539
              0,
              1,
              2,
              3,
              4
Michel Roy's avatar
Michel Roy committed
1540
            ],
Michel Roy's avatar
Michel Roy committed
1541
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Enum"
          },
          "value": {
            "description": "Value for the identifier.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          }
        }
      },
      "CaReconfNotification": {
        "properties": {
          "associateId": {
            "description": "0 to N identifiers to associate the event for a specific UE or flow.",
            "items": {
              "$ref": "#/components/schemas/AssociateId"
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "AssociateId"
1564
          },
Michel Roy's avatar
Michel Roy committed
1565 1566 1567
          "carrierAggregationMeasInfo": {
            "description": "This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation up to M.",
            "items": {
1568 1569
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1570
                "cellIdNei": {
Michel Roy's avatar
Michel Roy committed
1571
                  "$ref": "#/components/schemas/CellId"
Michel Roy's avatar
Michel Roy committed
1572 1573
                },
                "cellIdSrv": {
Michel Roy's avatar
Michel Roy committed
1574
                  "$ref": "#/components/schemas/CellId"
Michel Roy's avatar
Michel Roy committed
1575 1576 1577
                },
                "rsrpNei": {
                  "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].",
Michel Roy's avatar
Michel Roy committed
1578
                  "format": "uint32",
Michel Roy's avatar
Michel Roy committed
1579
                  "type": "integer",
Michel Roy's avatar
Michel Roy committed
1580 1581 1582 1583 1584
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "Uint32"
                },
                "rsrpSrv": {
                  "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].",
Michel Roy's avatar
Michel Roy committed
1585
                  "format": "uint32",
Michel Roy's avatar
Michel Roy committed
1586
                  "type": "integer",
Michel Roy's avatar
Michel Roy committed
1587 1588 1589 1590 1591
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "Uint32"
                },
                "rsrqNei": {
                  "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].",
Michel Roy's avatar
Michel Roy committed
1592
                  "format": "uint32",
Michel Roy's avatar
Michel Roy committed
1593
                  "type": "integer",
Michel Roy's avatar
Michel Roy committed
1594 1595 1596 1597 1598
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "Uint32"
                },
                "rsrqSrv": {
                  "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].",
Michel Roy's avatar
Michel Roy committed
1599
                  "format": "uint32",
Michel Roy's avatar
Michel Roy committed
1600
                  "type": "integer",
Michel Roy's avatar
Michel Roy committed
1601 1602
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "Uint32"
1603 1604 1605
                }
              }
            },
Michel Roy's avatar
Michel Roy committed
1606
            "minItems": 0,
Michel Roy's avatar
Michel Roy committed
1607 1608 1609 1610 1611 1612 1613 1614 1615
            "required": [
              "cellIdSrv",
              "cellIdNei"
            ],
            "type": "array",
            "x-etsi-mec-cardinality": "0..M",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },
          "ecgi": {
Michel Roy's avatar
Michel Roy committed
1616
            "$ref": "#/components/schemas/Ecgi"
Michel Roy's avatar
Michel Roy committed
1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
          },
          "notificationType": {
            "description": "Shall be set to \"CaReConfNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "secondaryCellAdd": {
            "description": "",
            "items": {
              "type": "object",
              "properties": {
                "ecgi": {
Michel Roy's avatar
Michel Roy committed
1630
                  "$ref": "#/components/schemas/Ecgi"
1631 1632
                }
              }
Michel Roy's avatar
Michel Roy committed
1633
            },
Michel Roy's avatar
Michel Roy committed
1634
            "minItems": 0,
Michel Roy's avatar
Michel Roy committed
1635 1636 1637 1638 1639 1640
            "required": [
              "ecgi"
            ],
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "Structure (inlined)"
1641
          },
Michel Roy's avatar
Michel Roy committed
1642 1643 1644
          "secondaryCellRemove": {
            "description": "",
            "items": {
1645 1646
              "type": "object",
              "properties": {
Michel Roy's avatar
Michel Roy committed
1647
                "ecgi": {
Michel Roy's avatar
Michel Roy committed
1648
                  "$ref": "#/components/schemas/Ecgi"
1649 1650
                }
              }
Michel Roy's avatar
Michel Roy committed
1651
            },
Michel Roy's avatar
Michel Roy committed
1652
            "minItems": 0,
Michel Roy's avatar
Michel Roy committed
1653 1654 1655 1656 1657 1658 1659 1660
            "required": [
              "ecgi"
            ],
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },
          "timeStamp": {
Michel Roy's avatar
Michel Roy committed
1661
            "$ref": "#/components/schemas/TimeStamp"
1662 1663
          }
        },
Michel Roy's avatar
Michel Roy committed
1664 1665 1666
        "required": [
          "notificationType",
          "ecgi"
1667
        ],
Michel Roy's avatar
Michel Roy committed
1668 1669 1670 1671 1672 1673 1674 1675 1676
        "type": "object",
        "x-etsi-ref": "6.4.8"
      },
      "CaReconfSubscription": {
        "properties": {
          "_links": {
            "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
            "properties": {
              "self": {
Michel Roy's avatar