RniAPI.yaml 154 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
1
openapi: 3.0.0
2
info:
Michel Roy's avatar
Michel Roy committed
3
4
5
  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.
6
  license:
ETSI CTI's avatar
ETSI CTI committed
7
8
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'
9
externalDocs:
Michel Roy's avatar
Michel Roy committed
10
11
12
13
  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'
servers:
  - url: 'https://{apiRoot}/rni/v2'
14
paths:
15
  /queries/rab_info:
16
    get:
Michel Roy's avatar
Michel Roy committed
17
18
19
20
      tags:
      - ''
      summary: 'Retrieve information on Radio Access Bearers'
      description: 'Queries information about the Radio Access Bearers'
21
22
      operationId: rab_infoGET
      parameters:
Michel Roy's avatar
Michel Roy committed
23
24
25
26
27
28
29
30
31
32
33
34
        - $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.ErabId'
        - $ref: '#/components/parameters/Query.Qci'
        - $ref: '#/components/parameters/Query.ErabMbrDl'
        - $ref: '#/components/parameters/Query.ErabMbrUl'
        - $ref: '#/components/parameters/Query.ErabGbrDl'
        - $ref: '#/components/parameters/Query.ErabGbrUl'
35
36
37
      responses:
        '200':
          description: Successful response to rab_info request
Michel Roy's avatar
Michel Roy committed
38
          content:
39
            application/json:
Michel Roy's avatar
Michel Roy committed
40
41
42
43
44
              schema:
                type: object
                properties:
                  rabInfo:
                    $ref: '#/components/schemas/RabInfo'
45
        '400':
Michel Roy's avatar
Michel Roy committed
46
          $ref: '#/components/responses/400'
47
        '401':
Michel Roy's avatar
Michel Roy committed
48
          $ref: '#/components/responses/401'
49
        '403':
Michel Roy's avatar
Michel Roy committed
50
          $ref: '#/components/responses/403'
51
        '404':
Michel Roy's avatar
Michel Roy committed
52
          $ref: '#/components/responses/404'
53
        '406':
Michel Roy's avatar
Michel Roy committed
54
          $ref: '#/components/responses/406'
55
        '429':
Michel Roy's avatar
Michel Roy committed
56
57
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
58
  /queries/plmn_info:
59
    get:
Michel Roy's avatar
Michel Roy committed
60
61
62
63
      tags:
      - ''
      summary: 'Retrieve information on the underlying Mobile Network that the MEC application is associated to'
      description: 'Queries information about the Mobile Network'
64
65
      operationId: plmn_infoGET
      parameters:
Michel Roy's avatar
Michel Roy committed
66
        - $ref: '#/components/parameters/Query.AppInsIdArr'
67
68
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
69
70
          description: Successful response to plmn_info request
          content:
71
            application/json:
Michel Roy's avatar
Michel Roy committed
72
73
74
75
76
77
78
              schema:
                type: "object"
                properties:
                  plmnInfo:
                    type: "array"
                    items:
                      $ref: '#/components/schemas/PlmnInfo'
79
        '400':
Michel Roy's avatar
Michel Roy committed
80
          $ref: '#/components/responses/400'
81
        '401':
Michel Roy's avatar
Michel Roy committed
82
          $ref: '#/components/responses/401'
83
        '403':
Michel Roy's avatar
Michel Roy committed
84
          $ref: '#/components/responses/403'
85
        '404':
Michel Roy's avatar
Michel Roy committed
86
          $ref: '#/components/responses/404'
87
        '406':
Michel Roy's avatar
Michel Roy committed
88
          $ref: '#/components/responses/406'
89
        '429':
Michel Roy's avatar
Michel Roy committed
90
91
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
92
  /queries/s1_bearer_info:
93
    get:
Michel Roy's avatar
Michel Roy committed
94
95
96
97
      tags:
      - ''
      summary: 'Retrieve S1-U bearer information related to specific UE(s)'
      description: 'Queries information about the S1 bearer(s)'
98
99
      operationId: s1_bearer_infoGET
      parameters:
Michel Roy's avatar
Michel Roy committed
100
101
102
103
104
105
106
        - $ref: '#/components/parameters/Query.TempUeId'
        - $ref: '#/components/parameters/Query.UeIpv4Address'
        - $ref: '#/components/parameters/Query.UeIpv6Address'
        - $ref: '#/components/parameters/Query.NatedIpAddress'
        - $ref: '#/components/parameters/Query.GtpTeid'
        - $ref: '#/components/parameters/Query.CellId'
        - $ref: '#/components/parameters/Query.ErabIdArr'
107
108
109
      responses:
        '200':
          description: Successful response to s1_bearer_info request
Michel Roy's avatar
Michel Roy committed
110
          content:
111
            application/json:
Michel Roy's avatar
Michel Roy committed
112
113
114
115
116
117
118
              schema:
                type: "object"
                required:
                  - "s1BearerInfo"
                properties:
                  s1BearerInfo:
                    $ref: '#/components/schemas/S1BearerInfo'
119
        '400':
Michel Roy's avatar
Michel Roy committed
120
          $ref: '#/components/responses/400'
121
        '401':
Michel Roy's avatar
Michel Roy committed
122
          $ref: '#/components/responses/401'
123
        '403':
Michel Roy's avatar
Michel Roy committed
124
          $ref: '#/components/responses/403'
125
        '404':
Michel Roy's avatar
Michel Roy committed
126
          $ref: '#/components/responses/404'
127
        '406':
Michel Roy's avatar
Michel Roy committed
128
          $ref: '#/components/responses/406'
129
        '429':
Michel Roy's avatar
Michel Roy committed
130
131
132
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
  /queries/layer2_meas:
133
    get:
Michel Roy's avatar
Michel Roy committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
      tags:
      - ''
      summary: 'Retrieve information on layer 2 measurements'
      description: 'Queries information about the layer 2 measurements.'
      operationId: layer2_meas_infoGET
      parameters:
        - $ref: '#/components/parameters/Query.AppInsId'
        - $ref: '#/components/parameters/Query.CellId'
        - $ref: '#/components/parameters/Query.UeIpv4Address'
        - $ref: '#/components/parameters/Query.UeIpv6Address'
        - $ref: '#/components/parameters/Query.NatedIpAddress'
        - $ref: '#/components/parameters/Query.GtpTeid'
        - $ref: '#/components/parameters/Query.DlGbrPrbUsageCell'
        - $ref: '#/components/parameters/Query.UlGbrPrbUsageCell'
        - $ref: '#/components/parameters/Query.DlNonGbrPrbUsageCell'
        - $ref: '#/components/parameters/Query.UlNonGbrPrbUsageCell'
        - $ref: '#/components/parameters/Query.DlTotalPrbUsageCell'
        - $ref: '#/components/parameters/Query.UlTotalPrbUsageCell'
        - $ref: '#/components/parameters/Query.ReceivedDedicatedPreamblesCell'
        - $ref: '#/components/parameters/Query.ReceivedRandomPreamblesLowRangeCell'
        - $ref: '#/components/parameters/Query.ReceivedRandomPreamblesHighRangeCell'
        - $ref: '#/components/parameters/Query.NumberOfActiveUeDlGbrCell'
        - $ref: '#/components/parameters/Query.NumberOfActiveUeUlGbrCell'
        - $ref: '#/components/parameters/Query.NumberOfActiveUeDlNonGbrCell'
        - $ref: '#/components/parameters/Query.NumberOfActiveUeUlNonGbrCell'
        - $ref: '#/components/parameters/Query.DlGbrPdrCell'
        - $ref: '#/components/parameters/Query.UlGbrPdrCell'
        - $ref: '#/components/parameters/Query.DlNonGbrPdrCell'
        - $ref: '#/components/parameters/Query.UlNonGbrPdrCell'
        - $ref: '#/components/parameters/Query.DlGbrDelayUe'
        - $ref: '#/components/parameters/Query.UlGbrDelayUe'
        - $ref: '#/components/parameters/Query.DlNonGbrDelayUe'
        - $ref: '#/components/parameters/Query.UlNonGbrDelayUe'
        - $ref: '#/components/parameters/Query.DlGbrPdrUe'
        - $ref: '#/components/parameters/Query.UlGbrPdrUe'
        - $ref: '#/components/parameters/Query.DlNonGbrPdrUe'
        - $ref: '#/components/parameters/Query.UlNonGbrPdrUe'
        - $ref: '#/components/parameters/Query.DlGbrThroughputUe'
        - $ref: '#/components/parameters/Query.UlGbrThroughputUe'
        - $ref: '#/components/parameters/Query.DlNonGbrThroughputUe'
        - $ref: '#/components/parameters/Query.UlNonGbrThroughputUe'
        - $ref: '#/components/parameters/Query.DlGbrDataVolumeUe'
        - $ref: '#/components/parameters/Query.UlGbrDataVolumeUe'
        - $ref: '#/components/parameters/Query.DlNonGbrDataVolumeUe'
        - $ref: '#/components/parameters/Query.UlNonGbrDataVolumeUe'
179
180
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
181
182
          description: Successful response to layer2 measurements info request
          content:
183
            application/json:
Michel Roy's avatar
Michel Roy committed
184
185
186
187
188
189
190
              schema:
                type: "object"
                required:
                  - "l2Meas"
                properties:
                  l2Meas:
                    $ref: '#/components/schemas/L2Meas'
191
        '400':
Michel Roy's avatar
Michel Roy committed
192
          $ref: '#/components/responses/400'
193
        '401':
Michel Roy's avatar
Michel Roy committed
194
          $ref: '#/components/responses/401'
195
        '403':
Michel Roy's avatar
Michel Roy committed
196
          $ref: '#/components/responses/403'
197
        '404':
Michel Roy's avatar
Michel Roy committed
198
          $ref: '#/components/responses/404'
199
        '406':
Michel Roy's avatar
Michel Roy committed
200
201
202
          $ref: '#/components/responses/406'
        '414':
          $ref: '#/components/responses/414'
203
        '429':
Michel Roy's avatar
Michel Roy committed
204
205
206
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
  /subscriptions/:
207
    get:
Michel Roy's avatar
Michel Roy committed
208
209
210
211
212
213
214
      tags:
      - ''
      summary: 'Retrieve information on subscriptions for notifications'
      description: 'Queries information on subscriptions for notifications'
      operationId: subscriptionLinkList_subscriptionsGET
      parameters:
        - $ref: '#/components/parameters/Query.SubscriptionType'
215
216
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
217
218
          description: 'Response body contains the list of links to requestors subscriptions.'
          content:
219
            application/json:
Michel Roy's avatar
Michel Roy committed
220
221
222
223
224
225
226
227
228
229
230
231
              schema:
                type: object
                required:
                  - subscriptionLinkList
                properties:
                  subscriptionLinkList:
                    $ref: '#/components/schemas/SubscriptionLinkList'
              example:
                subscriptionLinkList:
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/rni/v2/subscriptions'
232
                  subscription:
Michel Roy's avatar
Michel Roy committed
233
234
235
236
237
                    - _links:
                        self:
                          href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                      callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                      subscriptionType: CellChangeSubscription
238
        '400':
Michel Roy's avatar
Michel Roy committed
239
          $ref: '#/components/responses/400'
240
        '401':
Michel Roy's avatar
Michel Roy committed
241
          $ref: '#/components/responses/401'
242
        '403':
Michel Roy's avatar
Michel Roy committed
243
          $ref: '#/components/responses/403'
244
        '404':
Michel Roy's avatar
Michel Roy committed
245
          $ref: '#/components/responses/404'
246
        '406':
Michel Roy's avatar
Michel Roy committed
247
          $ref: '#/components/responses/406'
248
        '429':
Michel Roy's avatar
Michel Roy committed
249
250
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "subscriptions"
251
    post:
Michel Roy's avatar
Michel Roy committed
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
      tags:
      - ''
      summary: 'Create a new subscription'
      description: 'Creates a new subscription to Radio Network Information notifications'
      operationId: subscriptionsPOST
      requestBody:
        description: Subscription to be created
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notificationSubscription:
                  oneOf:
                    - $ref: '#/components/schemas/CellChangeSubscription'
                    - $ref: '#/components/schemas/RabEstSubscription'
                    - $ref: '#/components/schemas/RabModSubscription'
                    - $ref: '#/components/schemas/RabRelSubscription'
                    - $ref: '#/components/schemas/MeasRepUeSubscription'
                    - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                    - $ref: '#/components/schemas/MeasTaSubscription'
                    - $ref: '#/components/schemas/CaReconfSubscription'
                    - $ref: '#/components/schemas/S1BearerSubscription'
                  discriminator:
                    propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: CellChangeSubscription
                  callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                  filterCriteriaAssocHo:
                    appInstanceId: 'myApp'
                    associateId:
                    - type: '1'
                      value: '10.100.0.1'
                    ecgi:
                    - plmn:
                        mnc: '01'
                        mcc: '001'
                      cellId: 'ACBDEFA'
                    hoStatus:
                    - '1'
                    - '2' 
                  expiryDeadline:
                    seconds: 1977836800
                    nanoseconds: 0
298
299
      responses:
        '201':
Michel Roy's avatar
Michel Roy committed
300
301
          description: Successful subscription
          content:
302
            application/json:
Michel Roy's avatar
Michel Roy committed
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
              schema:
                type: object
                properties:
                  notificationSubscription:
                    oneOf:
                      - $ref: '#/components/schemas/CellChangeSubscription'
                      - $ref: '#/components/schemas/RabEstSubscription'
                      - $ref: '#/components/schemas/RabModSubscription'
                      - $ref: '#/components/schemas/RabRelSubscription'
                      - $ref: '#/components/schemas/MeasRepUeSubscription'
                      - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                      - $ref: '#/components/schemas/MeasTaSubscription'
                      - $ref: '#/components/schemas/CaReconfSubscription'
                      - $ref: '#/components/schemas/S1BearerSubscription'
                    discriminator:
                      propertyName: subscriptionType
                example:
                  notificationSubscription:
                    subscriptionType: CellChangeSubscription
                    callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                    _links:
                      self:
                        href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                    filterCriteriaAssocHo:
                      appInstanceId: 'myApp'
                      associateId:
                      - type: '1'
                        value: '10.100.0.1'
                      ecgi:
                      - plmn:
                          mnc: '01'
                          mcc: '001'
                        cellId: 'ACBDEFA'
                      hoStatus:
                      - '1'
                      - '2'
                    expiryDeadline:
                      seconds: 1977836800
                      nanoseconds: 0
342
        '400':
Michel Roy's avatar
Michel Roy committed
343
          $ref: '#/components/responses/400'
344
        '401':
Michel Roy's avatar
Michel Roy committed
345
          $ref: '#/components/responses/401'
346
        '403':
Michel Roy's avatar
Michel Roy committed
347
          $ref: '#/components/responses/403'
348
        '404':
Michel Roy's avatar
Michel Roy committed
349
          $ref: '#/components/responses/404'
350
        '406':
Michel Roy's avatar
Michel Roy committed
351
          $ref: '#/components/responses/406'
352
        '415':
Michel Roy's avatar
Michel Roy committed
353
          $ref: '#/components/responses/412'
354
        '422':
Michel Roy's avatar
Michel Roy committed
355
          $ref: '#/components/responses/422'
356
        '429':
Michel Roy's avatar
Michel Roy committed
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
          $ref: '#/components/responses/429'
      callbacks:
        notification:
          '{$request.body#/notificationSubscription.callbackReference}':
            post:
              summary: 'Callback POST used to send a notification'
              description: 'Notification from RNIS, content based on subscription type'
              operationId: notificationPOST
              requestBody:
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      properties:
                        notification:
                          oneOf:
                            - $ref: '#/components/schemas/CellChangeNotification'
                            - $ref: '#/components/schemas/RabEstNotification'
                            - $ref: '#/components/schemas/RabModNotification'
                            - $ref: '#/components/schemas/RabRelNotification'
                            - $ref: '#/components/schemas/MeasRepUeNotification'
                            - $ref: '#/components/schemas/NrMeasRepUeNotification'
                            - $ref: '#/components/schemas/MeasTaNotification'
                            - $ref: '#/components/schemas/CaReconfNotification'
                            - $ref: '#/components/schemas/S1BearerNotification'
                          discriminator:
                            propertyName: notificationType
                      example:
                        notification:
                          notificationType: CellChangeNotification
                          associateId:
                          - type: '1'
                            value: '10.100.0.1'
                          hoStatus: '1'
                          srcEcgi:
                            plmn:
                              mnc: '01'
                              mcc: '001'
                            cellId: 'ACBDEFA'
                          tempUeId:
                            mmec: 1
                            mtmsi: 001011231231234
                          timeStamp:
                            seconds: 1977836800
                            nanoseconds: 0
                          trgEcgi:
                            plmn:
                              mnc: '01'
                              mcc: '001'
                            cellId: 'FEDCBAA'
              responses:
                '204':
                  $ref: '#/components/responses/204'
      x-swagger-router-controller: "subscriptions"
  '/subscriptions/{subscriptionId}':
414
    get:
Michel Roy's avatar
Michel Roy committed
415
416
417
418
419
      tags:
      - ''
      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
420
      parameters:
Michel Roy's avatar
Michel Roy committed
421
        - $ref: '#/components/parameters/Path.subscrId'
422
423
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
          description: Subscription information regarding subscription notifications
          content:
            application/json:
              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
                example:
                  notificationSubscription:
                    subscriptionType: CellChangeSubscription
                    callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                    _links:
                      self:
                        href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                    filterCriteriaAssocHo:
                      appInstanceId: 'myApp'
                      associateId:
                      - type: '1'
                        value: '10.100.0.1'
                      ecgi:
                      - plmn:
                          mnc: '01'
                          mcc: '001'
                        cellId: 'ACBDEFA'
                      hoStatus:
                      - '1'
                      - '2'
                    expiryDeadline:
                      seconds: 1977836800
                      nanoseconds: 0
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "subscriptions"
    put:
      tags:
      - ''
      summary: 'Modify an existing subscription'
      description: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsPUT
      requestBody:
        description: Subscription to be modified
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notificationSubscription:
                  oneOf:
                      - $ref: '#/components/schemas/CellChangeSubscription'
                      - $ref: '#/components/schemas/RabEstSubscription'
                      - $ref: '#/components/schemas/RabModSubscription'
                      - $ref: '#/components/schemas/RabRelSubscription'
                      - $ref: '#/components/schemas/MeasRepUeSubscription'
                      - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                      - $ref: '#/components/schemas/MeasTaSubscription'
                      - $ref: '#/components/schemas/CaReconfSubscription'
                      - $ref: '#/components/schemas/S1BearerSubscription'
                  discriminator:
                    propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: CellChangeSubscription
                  callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                  filterCriteriaAssocHo:
                    appInstanceId: 'myApp'
                    associateId:
                    - type: '1'
                      value: '10.100.0.1'
                    ecgi:
                    - plmn:
                        mnc: '01'
                        mcc: '001'
                      cellId: 'ACBDEFA'
                    hoStatus:
                    - '1'
                    - '2'
                  expiryDeadline:
                    seconds: 1977836800
                    nanoseconds: 0
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '200':
          description: Successful subscription to response to subscription notifications
          content:
537
            application/json:
Michel Roy's avatar
Michel Roy committed
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
              schema:
                type: object
                properties:
                  notificationSubscription:
                    oneOf:
                      - $ref: '#/components/schemas/CellChangeSubscription'
                      - $ref: '#/components/schemas/RabEstSubscription'
                      - $ref: '#/components/schemas/RabModSubscription'
                      - $ref: '#/components/schemas/RabRelSubscription'
                      - $ref: '#/components/schemas/MeasRepUeSubscription'
                      - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                      - $ref: '#/components/schemas/MeasTaSubscription'
                      - $ref: '#/components/schemas/CaReconfSubscription'
                      - $ref: '#/components/schemas/S1BearerSubscription'
                    discriminator:
                      propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: CellChangeSubscription
                  callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                  filterCriteriaAssocHo:
                    appInstanceId: 'myApp'
                    associateId:
                    - type: '1'
                      value: '10.100.0.1'
                    ecgi:
                    - plmn:
                        mnc: '01'
                        mcc: '001'
                      cellId: 'ACBDEFA'
                    hoStatus:
                    - '1'
                    - '2'
                  expiryDeadline:
                    seconds: 1977836800
                    nanoseconds: 0
577
        '400':
Michel Roy's avatar
Michel Roy committed
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '412':
          $ref: '#/components/responses/412'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "subscriptions"
    delete:
      tags:
      - ''
      summary: 'Cancel an existing subscription'
      description: 'Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsDELETE
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '204':
          $ref: '#/components/responses/204'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "subscriptions"
components:
  responses:
    204:
      description: No Content
    400:
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/json:
622
623
624
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
625
626
627
628
629
630
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    401:
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/json:
631
632
633
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
634
635
636
637
638
639
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    403:
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/json:
640
641
          schema:
            type: object
642
            required:
Michel Roy's avatar
Michel Roy committed
643
              - problemDetails
644
            properties:
Michel Roy's avatar
Michel Roy committed
645
646
647
648
649
650
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    404:
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/json:
651
652
653
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
654
655
656
657
658
659
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    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:
660
661
662
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
663
664
665
666
667
668
669
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    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:
670
671
672
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
673
674
675
676
677
678
679
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    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:
680
681
682
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
683
684
685
686
687
688
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    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:
689
690
691
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
692
693
694
695
696
697
698
699
700
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    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:
701
702
703
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
704
705
706
707
708
709
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
          example:
            application/problem+json:
              problemDetails:
                type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
710
                title: Too many targets
711
712
                status: '422'
                detail: The target area for the request is considered too large
Michel Roy's avatar
Michel Roy committed
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
                instance: /meAppClient.example.com/77777/msgs/abc
    429:
      description: 'Too Many Requests : used when a rate limiter has triggered.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
  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:
758
759
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
760
761
762
763
764
765
766
767
          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:
768
769
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
770
771
772
773
774
775
776
777
          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:
778
779
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
780
781
782
783
784
785
786
787
          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:
788
789
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
790
791
792
793
794
795
796
797
          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:
798
799
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
          type: string
      x-exportParamName: GtpTeid
    Query.ErabId:
      name: erab_id
      in: query
      description: E-RAB identifier
      required: false
      schema:
        type: integer
        format: uint32
      x-exportParamName: ErabId
      x-optionalDataType: Int32
    Query.ErabIdArr:
      name: erab_id
      in: query
      description: 'Comma separated list of E-RAB identifiers'
      required: false
      schema:
818
819
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
820
821
822
823
824
825
826
827
828
          type: integer
          format: uint32
      x-exportParamName: ErabIdArr
    Query.Qci:
      name: qci
      in: query
      description: 'QoS Class Identifier as defined in ETSI TS 123 401'
      required: false
      schema:
829
830
        type: integer
        format: uint32
Michel Roy's avatar
Michel Roy committed
831
832
833
834
835
836
837
838
      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:
839
840
        type: integer
        format: uint32
Michel Roy's avatar
Michel Roy committed
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
      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
        format: uint32
      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
        format: uint32
      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
        format: uint32
      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:
879
880
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
881
882
883
884
885
886
887
888
          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:
889
        type: integer
Michel Roy's avatar
Michel Roy committed
890
891
892
893
894
895
896
      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:
897
        type: integer
Michel Roy's avatar
Michel Roy committed
898
899
900
901
902
903
904
      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:
905
        type: integer
Michel Roy's avatar
Michel Roy committed
906
907
908
909
910
911
912
      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:
913
        type: integer
Michel Roy's avatar
Michel Roy committed
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
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
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
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
      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
      description: 'Subscription type filter'
      required: false
      schema:
        type: string
      x-exportParamName: SubscriptionType
  schemas:
    AssociateId:
      properties:
        type:
          description: 'Numeric value (0-255) corresponding to specified type of identifier
            as following:

            0 = reserved.

            1= UE_IPv4_ADDRESS.

            2 = UE_IPV6_ADDRESS.

            3 = NATED_IP_ADDRESS.

            4 = GTP_TEID.'
          enum:
          - 0 = reserved
          - 1 = UE_IPv4_ADDRESS
          - 2 = UE_IPV6_ADDRESS
          - 3 = NATED_IP_ADDRESS
          - 4 = GTP_TEID
          type: string
          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
        carrierAggregationMeasInfo:
          description: This parameter can be repeated to contain information of
            all the carriers assign for Carrier Aggregation up to M.
          items:
            type: object
            properties:
              cellIdNei:
                allOf:
                - $ref: '#/components/schemas/CellId'
                description: E-UTRAN Cell Identity of the best neighbouring cell associated with the Carrier Aggregation serving cell.
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: CellId
              cellIdSrv:
                allOf:
                - $ref: '#/components/schemas/CellId'
                description: E-UTRAN Cell Identity of a Carrier Aggregation serving cell.
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: CellId
              rsrpNei:
                type: integer
                format: uint32
                description: "Reference Signal Received Power as defined in ETSI TS\_\
                  136 214 [i.5]."
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
              rsrpSrv:
                type: integer
                format: uint32
                description: "Reference Signal Received Power as defined in ETSI TS\_\
                  136 214 [i.5]."
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
              rsrqNei:
                type: integer
                format: uint32
                description: Reference Signal Received Quality as defined in ETSI
                  TS 136 214 [i.5].
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
              rsrqSrv:
                type: integer
                format: uint32
                description: Reference Signal Received Quality as defined in ETSI
                  TS 136 214 [i.5].
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
          required:
          - cellIdSrv
          - cellIdNei
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..M
          x-etsi-mec-origin-type: Structure (inlined)
        ecgi:
          allOf:
          - $ref: '#/components/schemas/Ecgi'
          description: E-UTRAN Cell Global Identifier.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Ecgi
        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:
                allOf:
                - $ref: '#/components/schemas/Ecgi'
                description: E-UTRAN Cell Global Identifier.
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: Ecgi
          required:
          - ecgi
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Structure (inlined)
        secondaryCellRemove:
          description: ''
          items:
            type: object
            properties:
              ecgi:
                allOf:
                - $ref: '#/components/schemas/Ecgi'
                description: E-UTRAN Cell Global Identifier.
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: Ecgi
          required:
          - ecgi
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Structure (inlined)
        timeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
      required:
      - notificationType
      - ecgi
      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:
              allOf:
              - $ref: '#/components/schemas/LinkType'
              description: Self referring URI. The URI shall be unique within the RNI API as it acts as an ID for the subscription.
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: LinkType
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        callbackReference:
          description: URI selected by the service consumer to receive notifications
            on the subscribed RNIS information. This shall be included both in the
            request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
        filterCriteriaAssoc:
          description: List of filtering criteria for the subscription. Any filtering
            criteria from below, which is included in the request, shall also be included
            in the response.
          properties:
            appInstanceId:
              description: Unique identifier for the MEC application instance.
              type: string
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            associateId:
              description: 0 to N identifiers to associate the information 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
            ecgi:
              description: E-UTRAN Cell Global Identifier.
              items:
                $ref: '#/components/schemas/Ecgi'
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: Ecgi
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        subscriptionType:
          description: Shall be set to "CaReconfSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
1373
      - callbackReference
Michel Roy's avatar
Michel Roy committed
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
      - filterCriteriaAssoc
      type: object
      x-etsi-ref: 6.3.8
    CellChangeNotification:
      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
        hoStatus:
          description: 'Indicate the status of the UE handover procedure. Values are
            defined as following:

            1 = IN_PREPARATION.

            2 = IN_EXECUTION.

            3 = COMPLETED.

            4 = REJECTED.

            5 = CANCELLED.'
          enum:
          - 1 = IN_PREPARATION
          - 2 = IN_EXECUTION
          - 3 = COMPLETED
          - 4 = REJECTED
          - 5 = CANCELLED
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum
        notificationType:
          description: Shall be set to "CellChangeNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        srcEcgi:
          allOf:
          - $ref: '#/components/schemas/Ecgi'
          description: E-UTRAN Cell Global Identifier of the source cell.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Ecgi
        tempUeId:
          description: The temporary identifier allocated for the specific UE as defined
            below.
          properties:
            mmec:
              description: MMEC as defined in ETSI TS 136 413 [i.3].
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            mtmsi:
              description: M-TMSI as defined in ETSI TS 136 413 [i.3].
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
          required:
          - mmec
          - mtmsi
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        timeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
        trgEcgi:
          description: 'E-UTRAN Cell Global Identifier of the target cell.
            NOTE: Cardinality N is valid only in case of statuses IN_PREPARATION,
            REJECTED and CANCELLED.'
          items:
            $ref: '#/components/schemas/Ecgi'
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Ecgi
      required:
      - notificationType
      - srcEcgi
      - trgEcgi
      - hoStatus
      type: object
      x-etsi-ref: 6.4.2
    CellChangeSubscription:
      properties:
        _links:
          description: Hyperlink related to the resource. This shall be only included
            in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/LinkType'
              description: Self referring URI. The URI shall be unique within the RNI API as it acts as an ID for the subscription.
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: LinkType
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        callbackReference:
          description: URI selected by the service consumer to receive notifications
            on the subscribed RNIS information. This shall be included both in the
            request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
        filterCriteriaAssocHo:
          description: List of filtering criteria for the subscription. Any filtering
            criteria from below, which is included in the request, shall also be included
            in the response.
          properties:
            appInstanceId:
              description: Unique identifier for the MEC application instance.
              type: string
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            associateId:
              description: 0 to N identifiers to associate the information 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
            ecgi:
              description: E-UTRAN Cell Global Identifier.
              items:
                $ref: '#/components/schemas/Ecgi'
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: Ecgi
            hoStatus:
              description: 'In case hoStatus is not included in the subscription request,
                the default value 3 = COMPLETED shall be used and included in the
                response:

                1 = IN_PREPARATION.

                2 = IN_EXECUTION.

                3 = COMPLETED.

                4 = REJECTED.

                5 = CANCELLED.'
              items:
                $ref: '#/components/schemas/Enum'
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: Enum
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        subscriptionType:
          description: Shall be set to "CellChangeSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
1552
      - callbackReference
Michel Roy's avatar
Michel Roy committed
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
      - filterCriteriaAssocHo
      type: object
      x-etsi-ref: 6.3.2
    CellId:
      description: String representing the E-UTRAN Cell Identity. Encoded as a bit
        string (size (28)) as defined in ETSI TS 136 413 [i.3].
      type: string
    Ecgi:
      properties:
        cellId:
          allOf:
          - $ref: '#/components/schemas/CellId'
          description: E-UTRAN Cell Global Identifier.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: CellId
        plmn:
          allOf:
          - $ref: '#/components/schemas/Plmn'
          description: Public Land Mobile Network Identity.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Plmn
      required:
      - plmn
      - cellId
      type: object
      x-etsi-ref: 6.5.6
    Enum:
      type: integer
    ExpiryNotification:
      properties:
        _links:
          description: List of hyperlinks related to the resource.
          properties:
            self:
              description: Self referring URI. This shall be included in the response
                from the RNIS. The URI shall be unique within the RNI API as it acts
                as an ID for the subscription.
              format: uri
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: URI
          required:
          - self
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        expiryDeadline:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: TimeStamp
        timeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
      required:
1612
      - _links
Michel Roy's avatar
Michel Roy committed
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306