RniAPI.yaml 150 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
  contact:
    url: https://forge.etsi.org/rep/mec/gs012-rnis-api
Michel Roy's avatar
Michel Roy committed
5
6
7
  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.
8
  license:
ETSI CTI's avatar
ETSI CTI committed
9
10
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'
11
externalDocs:
Michel Roy's avatar
Michel Roy committed
12
13
14
  description: ETSI GS MEC 012 Radio Network Information API, V2.1.1
  url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf'
servers:
Michel Roy's avatar
Michel Roy committed
15
16
17
  - url: 'https://localhost/rni/v2'
tags:
- name: 'rni'
18
paths:
19
  /queries/rab_info:
20
    get:
Michel Roy's avatar
Michel Roy committed
21
      tags:
Michel Roy's avatar
Michel Roy committed
22
      - 'rni'
Michel Roy's avatar
Michel Roy committed
23
24
      summary: 'Retrieve information on Radio Access Bearers'
      description: 'Queries information about the Radio Access Bearers'
25
26
      operationId: rab_infoGET
      parameters:
Michel Roy's avatar
Michel Roy committed
27
28
29
30
31
32
33
34
35
36
37
38
        - $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'
39
40
41
      responses:
        '200':
          description: Successful response to rab_info request
Michel Roy's avatar
Michel Roy committed
42
          content:
43
            application/json:
Michel Roy's avatar
Michel Roy committed
44
45
46
47
48
              schema:
                type: object
                properties:
                  rabInfo:
                    $ref: '#/components/schemas/RabInfo'
49
        '400':
Michel Roy's avatar
Michel Roy committed
50
          $ref: '#/components/responses/400'
51
        '401':
Michel Roy's avatar
Michel Roy committed
52
          $ref: '#/components/responses/401'
53
        '403':
Michel Roy's avatar
Michel Roy committed
54
          $ref: '#/components/responses/403'
55
        '404':
Michel Roy's avatar
Michel Roy committed
56
          $ref: '#/components/responses/404'
57
        '406':
Michel Roy's avatar
Michel Roy committed
58
          $ref: '#/components/responses/406'
59
        '429':
Michel Roy's avatar
Michel Roy committed
60
61
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
62
  /queries/plmn_info:
63
    get:
Michel Roy's avatar
Michel Roy committed
64
      tags:
Michel Roy's avatar
Michel Roy committed
65
      - 'rni'
Michel Roy's avatar
Michel Roy committed
66
67
      summary: 'Retrieve information on the underlying Mobile Network that the MEC application is associated to'
      description: 'Queries information about the Mobile Network'
68
69
      operationId: plmn_infoGET
      parameters:
Michel Roy's avatar
Michel Roy committed
70
        - $ref: '#/components/parameters/Query.AppInsIdArr'
71
72
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
73
74
          description: Successful response to plmn_info request
          content:
75
            application/json:
Michel Roy's avatar
Michel Roy committed
76
77
78
79
80
81
82
              schema:
                type: "object"
                properties:
                  plmnInfo:
                    type: "array"
                    items:
                      $ref: '#/components/schemas/PlmnInfo'
83
        '400':
Michel Roy's avatar
Michel Roy committed
84
          $ref: '#/components/responses/400'
85
        '401':
Michel Roy's avatar
Michel Roy committed
86
          $ref: '#/components/responses/401'
87
        '403':
Michel Roy's avatar
Michel Roy committed
88
          $ref: '#/components/responses/403'
89
        '404':
Michel Roy's avatar
Michel Roy committed
90
          $ref: '#/components/responses/404'
91
        '406':
Michel Roy's avatar
Michel Roy committed
92
          $ref: '#/components/responses/406'
93
        '429':
Michel Roy's avatar
Michel Roy committed
94
95
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
96
  /queries/s1_bearer_info:
97
    get:
Michel Roy's avatar
Michel Roy committed
98
      tags:
Michel Roy's avatar
Michel Roy committed
99
      - 'rni'
Michel Roy's avatar
Michel Roy committed
100
101
      summary: 'Retrieve S1-U bearer information related to specific UE(s)'
      description: 'Queries information about the S1 bearer(s)'
102
103
      operationId: s1_bearer_infoGET
      parameters:
Michel Roy's avatar
Michel Roy committed
104
105
106
107
108
109
110
        - $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'
111
112
113
      responses:
        '200':
          description: Successful response to s1_bearer_info request
Michel Roy's avatar
Michel Roy committed
114
          content:
115
            application/json:
Michel Roy's avatar
Michel Roy committed
116
117
118
119
120
121
122
              schema:
                type: "object"
                required:
                  - "s1BearerInfo"
                properties:
                  s1BearerInfo:
                    $ref: '#/components/schemas/S1BearerInfo'
123
        '400':
Michel Roy's avatar
Michel Roy committed
124
          $ref: '#/components/responses/400'
125
        '401':
Michel Roy's avatar
Michel Roy committed
126
          $ref: '#/components/responses/401'
127
        '403':
Michel Roy's avatar
Michel Roy committed
128
          $ref: '#/components/responses/403'
129
        '404':
Michel Roy's avatar
Michel Roy committed
130
          $ref: '#/components/responses/404'
131
        '406':
Michel Roy's avatar
Michel Roy committed
132
          $ref: '#/components/responses/406'
133
        '429':
Michel Roy's avatar
Michel Roy committed
134
135
136
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
  /queries/layer2_meas:
137
    get:
Michel Roy's avatar
Michel Roy committed
138
      tags:
Michel Roy's avatar
Michel Roy committed
139
      - 'rni'
Michel Roy's avatar
Michel Roy committed
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
179
180
181
182
      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'
183
184
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
185
186
          description: Successful response to layer2 measurements info request
          content:
187
            application/json:
Michel Roy's avatar
Michel Roy committed
188
189
190
191
192
193
194
              schema:
                type: "object"
                required:
                  - "l2Meas"
                properties:
                  l2Meas:
                    $ref: '#/components/schemas/L2Meas'
195
        '400':
Michel Roy's avatar
Michel Roy committed
196
          $ref: '#/components/responses/400'
197
        '401':
Michel Roy's avatar
Michel Roy committed
198
          $ref: '#/components/responses/401'
199
        '403':
Michel Roy's avatar
Michel Roy committed
200
          $ref: '#/components/responses/403'
201
        '404':
Michel Roy's avatar
Michel Roy committed
202
          $ref: '#/components/responses/404'
203
        '406':
Michel Roy's avatar
Michel Roy committed
204
205
206
          $ref: '#/components/responses/406'
        '414':
          $ref: '#/components/responses/414'
207
        '429':
Michel Roy's avatar
Michel Roy committed
208
209
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
Michel Roy's avatar
Michel Roy committed
210
  /subscriptions:
211
    get:
Michel Roy's avatar
Michel Roy committed
212
      tags:
Michel Roy's avatar
Michel Roy committed
213
      - 'rni'
Michel Roy's avatar
Michel Roy committed
214
215
216
217
218
      summary: 'Retrieve information on subscriptions for notifications'
      description: 'Queries information on subscriptions for notifications'
      operationId: subscriptionLinkList_subscriptionsGET
      parameters:
        - $ref: '#/components/parameters/Query.SubscriptionType'
219
220
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
221
222
          description: 'Response body contains the list of links to requestors subscriptions.'
          content:
223
            application/json:
Michel Roy's avatar
Michel Roy committed
224
225
226
227
228
229
230
231
232
233
234
235
              schema:
                type: object
                required:
                  - subscriptionLinkList
                properties:
                  subscriptionLinkList:
                    $ref: '#/components/schemas/SubscriptionLinkList'
              example:
                subscriptionLinkList:
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/rni/v2/subscriptions'
236
                  subscription:
Michel Roy's avatar
Michel Roy committed
237
238
239
240
241
                    - _links:
                        self:
                          href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                      callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                      subscriptionType: CellChangeSubscription
242
        '400':
Michel Roy's avatar
Michel Roy committed
243
          $ref: '#/components/responses/400'
244
        '401':
Michel Roy's avatar
Michel Roy committed
245
          $ref: '#/components/responses/401'
246
        '403':
Michel Roy's avatar
Michel Roy committed
247
          $ref: '#/components/responses/403'
248
        '404':
Michel Roy's avatar
Michel Roy committed
249
          $ref: '#/components/responses/404'
250
        '406':
Michel Roy's avatar
Michel Roy committed
251
          $ref: '#/components/responses/406'
252
        '429':
Michel Roy's avatar
Michel Roy committed
253
254
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "subscriptions"
255
    post:
Michel Roy's avatar
Michel Roy committed
256
      tags:
Michel Roy's avatar
Michel Roy committed
257
      - 'rni'
Michel Roy's avatar
Michel Roy committed
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
      summary: 'Create a new subscription'
      description: 'Creates a new subscription to Radio Network Information notifications'
      operationId: subscriptionsPOST
      requestBody:
        description: Subscription to be created
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notificationSubscription:
                  oneOf:
                    - $ref: '#/components/schemas/CellChangeSubscription'
                    - $ref: '#/components/schemas/RabEstSubscription'
                    - $ref: '#/components/schemas/RabModSubscription'
                    - $ref: '#/components/schemas/RabRelSubscription'
                    - $ref: '#/components/schemas/MeasRepUeSubscription'
                    - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                    - $ref: '#/components/schemas/MeasTaSubscription'
                    - $ref: '#/components/schemas/CaReconfSubscription'
                    - $ref: '#/components/schemas/S1BearerSubscription'
                  discriminator:
                    propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: CellChangeSubscription
                  callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                  filterCriteriaAssocHo:
                    appInstanceId: 'myApp'
                    associateId:
Michel Roy's avatar
Michel Roy committed
289
                    - type: 1
Michel Roy's avatar
Michel Roy committed
290
291
292
293
294
295
296
                      value: '10.100.0.1'
                    ecgi:
                    - plmn:
                        mnc: '01'
                        mcc: '001'
                      cellId: 'ACBDEFA'
                    hoStatus:
Michel Roy's avatar
Michel Roy committed
297
298
                    - 1
                    - 2
Michel Roy's avatar
Michel Roy committed
299
300
301
                  expiryDeadline:
                    seconds: 1977836800
                    nanoseconds: 0
302
303
      responses:
        '201':
Michel Roy's avatar
Michel Roy committed
304
305
          description: Successful subscription
          content:
306
            application/json:
Michel Roy's avatar
Michel Roy committed
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
              schema:
                type: object
                properties:
                  notificationSubscription:
                    oneOf:
                      - $ref: '#/components/schemas/CellChangeSubscription'
                      - $ref: '#/components/schemas/RabEstSubscription'
                      - $ref: '#/components/schemas/RabModSubscription'
                      - $ref: '#/components/schemas/RabRelSubscription'
                      - $ref: '#/components/schemas/MeasRepUeSubscription'
                      - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                      - $ref: '#/components/schemas/MeasTaSubscription'
                      - $ref: '#/components/schemas/CaReconfSubscription'
                      - $ref: '#/components/schemas/S1BearerSubscription'
                    discriminator:
                      propertyName: subscriptionType
                example:
                  notificationSubscription:
                    subscriptionType: CellChangeSubscription
                    callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                    _links:
                      self:
                        href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                    filterCriteriaAssocHo:
                      appInstanceId: 'myApp'
                      associateId:
Michel Roy's avatar
Michel Roy committed
333
                      - type: 1
Michel Roy's avatar
Michel Roy committed
334
335
336
337
338
339
340
                        value: '10.100.0.1'
                      ecgi:
                      - plmn:
                          mnc: '01'
                          mcc: '001'
                        cellId: 'ACBDEFA'
                      hoStatus:
Michel Roy's avatar
Michel Roy committed
341
342
                      - 1
                      - 2
Michel Roy's avatar
Michel Roy committed
343
344
345
                    expiryDeadline:
                      seconds: 1977836800
                      nanoseconds: 0
346
        '400':
Michel Roy's avatar
Michel Roy committed
347
          $ref: '#/components/responses/400'
348
        '401':
Michel Roy's avatar
Michel Roy committed
349
          $ref: '#/components/responses/401'
350
        '403':
Michel Roy's avatar
Michel Roy committed
351
          $ref: '#/components/responses/403'
352
        '404':
Michel Roy's avatar
Michel Roy committed
353
          $ref: '#/components/responses/404'
354
        '406':
Michel Roy's avatar
Michel Roy committed
355
          $ref: '#/components/responses/406'
356
        '415':
Michel Roy's avatar
Michel Roy committed
357
          $ref: '#/components/responses/412'
358
        '422':
Michel Roy's avatar
Michel Roy committed
359
          $ref: '#/components/responses/422'
360
        '429':
Michel Roy's avatar
Michel Roy committed
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
          $ref: '#/components/responses/429'
      callbacks:
        notification:
          '{$request.body#/notificationSubscription.callbackReference}':
            post:
              summary: 'Callback POST used to send a notification'
              description: 'Notification from RNIS, content based on subscription type'
              operationId: notificationPOST
              requestBody:
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      properties:
                        notification:
                          oneOf:
                            - $ref: '#/components/schemas/CellChangeNotification'
                            - $ref: '#/components/schemas/RabEstNotification'
                            - $ref: '#/components/schemas/RabModNotification'
                            - $ref: '#/components/schemas/RabRelNotification'
                            - $ref: '#/components/schemas/MeasRepUeNotification'
                            - $ref: '#/components/schemas/NrMeasRepUeNotification'
                            - $ref: '#/components/schemas/MeasTaNotification'
                            - $ref: '#/components/schemas/CaReconfNotification'
                            - $ref: '#/components/schemas/S1BearerNotification'
                          discriminator:
                            propertyName: notificationType
                      example:
                        notification:
                          notificationType: CellChangeNotification
                          associateId:
Michel Roy's avatar
Michel Roy committed
394
                          - type: 1
Michel Roy's avatar
Michel Roy committed
395
                            value: '10.100.0.1'
Michel Roy's avatar
Michel Roy committed
396
                          hoStatus: 1
Michel Roy's avatar
Michel Roy committed
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
                          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}':
418
    get:
Michel Roy's avatar
Michel Roy committed
419
      tags:
Michel Roy's avatar
Michel Roy committed
420
      - 'rni'
Michel Roy's avatar
Michel Roy committed
421
422
423
      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
424
      parameters:
Michel Roy's avatar
Michel Roy committed
425
        - $ref: '#/components/parameters/Path.subscrId'
426
427
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
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
          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:
Michel Roy's avatar
Michel Roy committed
459
                      - type: 1
Michel Roy's avatar
Michel Roy committed
460
461
462
463
464
465
466
                        value: '10.100.0.1'
                      ecgi:
                      - plmn:
                          mnc: '01'
                          mcc: '001'
                        cellId: 'ACBDEFA'
                      hoStatus:
Michel Roy's avatar
Michel Roy committed
467
468
                      - 1
                      - 2
Michel Roy's avatar
Michel Roy committed
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
                    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:
Michel Roy's avatar
Michel Roy committed
487
      - 'rni'
Michel Roy's avatar
Michel Roy committed
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
      summary: 'Modify an existing subscription'
      description: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsPUT
      requestBody:
        description: Subscription to be modified
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notificationSubscription:
                  oneOf:
                      - $ref: '#/components/schemas/CellChangeSubscription'
                      - $ref: '#/components/schemas/RabEstSubscription'
                      - $ref: '#/components/schemas/RabModSubscription'
                      - $ref: '#/components/schemas/RabRelSubscription'
                      - $ref: '#/components/schemas/MeasRepUeSubscription'
                      - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                      - $ref: '#/components/schemas/MeasTaSubscription'
                      - $ref: '#/components/schemas/CaReconfSubscription'
                      - $ref: '#/components/schemas/S1BearerSubscription'
                  discriminator:
                    propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: CellChangeSubscription
                  callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                  filterCriteriaAssocHo:
                    appInstanceId: 'myApp'
                    associateId:
Michel Roy's avatar
Michel Roy committed
522
                    - type: 1
Michel Roy's avatar
Michel Roy committed
523
524
525
526
527
528
529
                      value: '10.100.0.1'
                    ecgi:
                    - plmn:
                        mnc: '01'
                        mcc: '001'
                      cellId: 'ACBDEFA'
                    hoStatus:
Michel Roy's avatar
Michel Roy committed
530
531
                    - 1
                    - 2
Michel Roy's avatar
Michel Roy committed
532
533
534
535
536
537
538
539
540
                  expiryDeadline:
                    seconds: 1977836800
                    nanoseconds: 0
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '200':
          description: Successful subscription to response to subscription notifications
          content:
541
            application/json:
Michel Roy's avatar
Michel Roy committed
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
              schema:
                type: object
                properties:
                  notificationSubscription:
                    oneOf:
                      - $ref: '#/components/schemas/CellChangeSubscription'
                      - $ref: '#/components/schemas/RabEstSubscription'
                      - $ref: '#/components/schemas/RabModSubscription'
                      - $ref: '#/components/schemas/RabRelSubscription'
                      - $ref: '#/components/schemas/MeasRepUeSubscription'
                      - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                      - $ref: '#/components/schemas/MeasTaSubscription'
                      - $ref: '#/components/schemas/CaReconfSubscription'
                      - $ref: '#/components/schemas/S1BearerSubscription'
                    discriminator:
                      propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: CellChangeSubscription
                  callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                  filterCriteriaAssocHo:
                    appInstanceId: 'myApp'
                    associateId:
Michel Roy's avatar
Michel Roy committed
568
                    - type: 1
Michel Roy's avatar
Michel Roy committed
569
570
571
572
573
574
575
                      value: '10.100.0.1'
                    ecgi:
                    - plmn:
                        mnc: '01'
                        mcc: '001'
                      cellId: 'ACBDEFA'
                    hoStatus:
Michel Roy's avatar
Michel Roy committed
576
577
                    - 1
                    - 2
Michel Roy's avatar
Michel Roy committed
578
579
580
                  expiryDeadline:
                    seconds: 1977836800
                    nanoseconds: 0
581
        '400':
Michel Roy's avatar
Michel Roy committed
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
          $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:
Michel Roy's avatar
Michel Roy committed
600
      - 'rni'
Michel Roy's avatar
Michel Roy committed
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
      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:
626
627
628
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
629
630
631
632
633
634
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    401:
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/json:
635
636
637
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
638
639
640
641
642
643
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    403:
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/json:
644
645
          schema:
            type: object
646
            required:
Michel Roy's avatar
Michel Roy committed
647
              - problemDetails
648
            properties:
Michel Roy's avatar
Michel Roy committed
649
650
651
652
653
654
              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:
655
656
657
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
658
659
660
661
662
663
              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:
664
665
666
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
667
668
669
670
671
672
673
              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:
674
675
676
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
677
678
679
680
681
682
683
              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:
684
685
686
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
687
688
689
690
691
692
              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:
693
694
695
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
696
697
698
699
700
701
702
703
704
              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:
705
706
707
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
708
709
710
711
712
713
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
          example:
            application/problem+json:
              problemDetails:
                type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
714
                title: Too many targets
715
716
                status: '422'
                detail: The target area for the request is considered too large
Michel Roy's avatar
Michel Roy committed
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
                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:
762
763
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
764
765
766
767
768
769
770
771
          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:
772
773
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
774
775
776
777
778
779
780
781
          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:
782
783
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
784
785
786
787
788
789
790
791
          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:
792
793
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
794
795
796
797
798
799
800
801
          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:
802
803
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
804
805
806
807
808
809
810
811
812
          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
813
        format: int32
Michel Roy's avatar
Michel Roy committed
814
815
816
817
818
819
820
821
      x-exportParamName: ErabId
      x-optionalDataType: Int32
    Query.ErabIdArr:
      name: erab_id
      in: query
      description: 'Comma separated list of E-RAB identifiers'
      required: false
      schema:
822
823
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
824
          type: integer
Michel Roy's avatar
Michel Roy committed
825
          format: int32
Michel Roy's avatar
Michel Roy committed
826
827
828
829
830
831
832
      x-exportParamName: ErabIdArr
    Query.Qci:
      name: qci
      in: query
      description: 'QoS Class Identifier as defined in ETSI TS 123 401'
      required: false
      schema:
833
        type: integer
Michel Roy's avatar
Michel Roy committed
834
        format: int32
Michel Roy's avatar
Michel Roy committed
835
836
837
838
839
840
841
842
      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:
843
        type: integer
Michel Roy's avatar
Michel Roy committed
844
        format: int32
Michel Roy's avatar
Michel Roy committed
845
846
847
848
849
850
851
852
853
      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
854
        format: int32
Michel Roy's avatar
Michel Roy committed
855
856
857
858
859
860
861
862
863
      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
864
        format: int32
Michel Roy's avatar
Michel Roy committed
865
866
867
868
869
870
871
872
873
      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
874
        format: int32
Michel Roy's avatar
Michel Roy committed
875
876
877
878
879
880
881
882
      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:
883
884
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
885
886
887
888
889
890
891
892
          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:
893
        type: integer
Michel Roy's avatar
Michel Roy committed
894
895
896
897
898
899
900
      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:
901
        type: integer
Michel Roy's avatar
Michel Roy committed
902
903
904
905
906
907
908
      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:
909
        type: integer
Michel Roy's avatar
Michel Roy committed
910
911
912
913
914
915
916
      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:
917
        type: integer
Michel Roy's avatar
Michel Roy committed
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
      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
1154
      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
1155
1156
1157
1158
1159
1160
1161
1162
      required: false
      schema:
        type: string
      x-exportParamName: SubscriptionType
  schemas:
    AssociateId:
      properties:
        type:
Michel Roy's avatar
Michel Roy committed
1163
          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
1164
          enum:
Michel Roy's avatar
Michel Roy committed
1165
1166
1167
1168
1169
1170
          - 0
          - 1
          - 2
          - 3
          - 4
          type: integer
Michel Roy's avatar
Michel Roy committed
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
          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:
Michel Roy's avatar
Michel Roy committed
1181
          description: 0 to N identifiers to associate the event for a specific UE or flow.
Michel Roy's avatar
Michel Roy committed
1182
1183
1184
1185
1186
1187
1188
          items:
            $ref: '#/components/schemas/AssociateId'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: AssociateId
        carrierAggregationMeasInfo:
Michel Roy's avatar
Michel Roy committed
1189
          description: This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation up to M.
Michel Roy's avatar
Michel Roy committed
1190
1191
1192
1193
          items:
            type: object
            properties:
              cellIdNei:
Michel Roy's avatar
Michel Roy committed
1194
1195
1196
1197
                # 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
                $ref: '#/components/schemas/CellId'
Michel Roy's avatar
Michel Roy committed
1198
              cellIdSrv:
Michel Roy's avatar
Michel Roy committed
1199
1200
1201
1202
                # description': E-UTRAN Cell Identity of a Carrier Aggregation serving cell.
                # x-etsi-mec-cardinality': '1'
                # x-etsi-mec-origin-type': CellId
                $ref: '#/components/schemas/CellId'
Michel Roy's avatar
Michel Roy committed
1203
              rsrpNei:
Michel Roy's avatar
Michel Roy committed
1204
1205
                description: "Reference Signal Received Power as defined in ETSI TS\_136 214 [i.5]."
                format: int32
Michel Roy's avatar
Michel Roy committed
1206
1207
1208
1209
                type: integer
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
              rsrpSrv:
Michel Roy's avatar
Michel Roy committed
1210
1211
                description: "Reference Signal Received Power as defined in ETSI TS\_136 214 [i.5]."
                format: int32
Michel Roy's avatar
Michel Roy committed
1212
1213
1214
1215
                type: integer
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
              rsrqNei:
Michel Roy's avatar
Michel Roy committed
1216
1217
                description: Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
                format: int32
Michel Roy's avatar
Michel Roy committed
1218
1219
1220
1221
                type: integer
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
              rsrqSrv:
Michel Roy's avatar
Michel Roy committed
1222
1223
                description: Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
                format: int32
Michel Roy's avatar
Michel Roy committed
1224
1225
1226
                type: integer
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
1227
          minItems: 0
Michel Roy's avatar
Michel Roy committed
1228
1229
1230
1231
1232
1233
1234
          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
1235
1236
1237
1238
          # description': E-UTRAN Cell Global Identifier.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Ecgi
          $ref: '#/components/schemas/Ecgi'
Michel Roy's avatar
Michel Roy committed
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
        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
1250
1251
1252
1253
1254
                # description': E-UTRAN Cell Global Identifier.
                # x-etsi-mec-cardinality': '1'
                # x-etsi-mec-origin-type': Ecgi
                $ref: '#/components/schemas/Ecgi'
          minItems: 0
Michel Roy's avatar
Michel Roy committed
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
          required:
          - ecgi
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Structure (inlined)
        secondaryCellRemove:
          description: ''
          items:
            type: object
            properties:
              ecgi:
Michel Roy's avatar
Michel Roy committed
1266
1267
1268
1269
1270
                # description': E-UTRAN Cell Global Identifier.
                # x-etsi-mec-cardinality': '1'
                # x-etsi-mec-origin-type': Ecgi
                $ref: '#/components/schemas/Ecgi'
          minItems: 0
Michel Roy's avatar
Michel Roy committed
1271
1272
1273
1274
1275
1276
          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
1277
1278
1279
1280
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
1281
1282
1283
1284
1285
1286
1287
1288
      required:
      - notificationType
      - ecgi
      type: object
      x-etsi-ref: 6.4.8
    CaReconfSubscription:
      properties:
        _links:
Michel Roy's avatar
Michel Roy committed
1289
          description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
Michel Roy's avatar
Michel Roy committed
1290
1291
          properties:
            self:
Michel Roy's avatar
Michel Roy committed
1292
1293
1294
1295
              # 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
              $ref: '#/components/schemas/LinkType'
Michel Roy's avatar
Michel Roy committed
1296
1297
1298
1299
1300
1301
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        callbackReference:
Michel Roy's avatar
Michel Roy committed
1302
          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.
Michel Roy's avatar
Michel Roy committed
1303
1304
1305
1306
1307
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
Michel Roy's avatar
Michel Roy committed
1308
1309
1310
1311
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
1312
        filterCriteriaAssoc:
Michel Roy's avatar
Michel Roy committed
1313
          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.
Michel Roy's avatar
Michel Roy committed
1314
1315
1316
1317
1318
1319
1320
          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:
Michel Roy's avatar
Michel Roy committed
1321
              description: 0 to N identifiers to associate the information for a specific UE or flow.
Michel Roy's avatar
Michel Roy committed
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
              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
1346
      - callbackReference
Michel Roy's avatar
Michel Roy committed
1347
1348
1349
1350
1351
1352
      - filterCriteriaAssoc
      type: object
      x-etsi-ref: 6.3.8
    CellChangeNotification:
      properties:
        associateId:
Michel Roy's avatar
Michel Roy committed
1353
          description: 0 to N identifiers to associate the event for a specific UE or flow.
Michel Roy's avatar
Michel Roy committed
1354
1355
1356
1357
1358
1359
1360
          items:
            $ref: '#/components/schemas/AssociateId'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: AssociateId
        hoStatus:
Michel Roy's avatar
Michel Roy committed
1361
1362
1363
1364
1365
1366
          description: 'Indicate the status of the UE handover procedure. Values are defined as following:
            <p>1 = IN_PREPARATION.
            <p>2 = IN_EXECUTION.
            <p>3 = COMPLETED.
            <p>4 = REJECTED.
            <p>5 = CANCELLED.'
Michel Roy's avatar
Michel Roy committed
1367
          enum:
Michel Roy's avatar
Michel Roy committed
1368
1369
1370
1371
1372
1373
          - 1
          - 2
          - 3
          - 4
          - 5
          type: integer
Michel Roy's avatar
Michel Roy committed
1374
1375
1376
1377
1378
1379
1380
1381
          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:
Michel Roy's avatar
Michel Roy committed
1382
1383
1384
1385
          # description': E-UTRAN Cell Global Identifier of the source cell.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Ecgi
          $ref: '#/components/schemas/Ecgi'
Michel Roy's avatar
Michel Roy committed
1386
        tempUeId:
Michel Roy's avatar
Michel Roy committed
1387
          description: The temporary identifier allocated for the specific UE as defined below.
Michel Roy's avatar
Michel Roy committed
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
          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:
Michel Roy's avatar
Michel Roy committed
1406
1407
1408
1409
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
1410
1411
        trgEcgi:
          description: 'E-UTRAN Cell Global Identifier of the target cell.
Michel Roy's avatar
Michel Roy committed
1412
1413

            NOTE: Cardinality N is valid only in case of statuses IN_PREPARATION, REJECTED and CANCELLED.'
Michel Roy's avatar
Michel Roy committed
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
          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:
Michel Roy's avatar
Michel Roy committed
1430
          description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.