RniAPI.yaml 144 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
              schema:
Michel Roy's avatar
Michel Roy committed
45
                $ref: '#/components/schemas/RabInfo'
46
        '400':
Michel Roy's avatar
Michel Roy committed
47
          $ref: '#/components/responses/400'
48
        '401':
Michel Roy's avatar
Michel Roy committed
49
          $ref: '#/components/responses/401'
50
        '403':
Michel Roy's avatar
Michel Roy committed
51
          $ref: '#/components/responses/403'
52
        '404':
Michel Roy's avatar
Michel Roy committed
53
          $ref: '#/components/responses/404'
54
        '406':
Michel Roy's avatar
Michel Roy committed
55
          $ref: '#/components/responses/406'
56
        '429':
Michel Roy's avatar
Michel Roy committed
57
58
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
59
  /queries/plmn_info:
60
    get:
Michel Roy's avatar
Michel Roy committed
61
      tags:
Michel Roy's avatar
Michel Roy committed
62
      - 'rni'
Michel Roy's avatar
Michel Roy committed
63
64
      summary: 'Retrieve information on the underlying Mobile Network that the MEC application is associated to'
      description: 'Queries information about the Mobile Network'
65
66
      operationId: plmn_infoGET
      parameters:
Michel Roy's avatar
Michel Roy committed
67
        - $ref: '#/components/parameters/Query.AppInsIdArr'
68
69
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
70
71
          description: Successful response to plmn_info request
          content:
72
            application/json:
Michel Roy's avatar
Michel Roy committed
73
              schema:
Michel Roy's avatar
Michel Roy committed
74
75
76
                type: "array"
                items:
                  $ref: '#/components/schemas/PlmnInfo'
77
        '400':
Michel Roy's avatar
Michel Roy committed
78
          $ref: '#/components/responses/400'
79
        '401':
Michel Roy's avatar
Michel Roy committed
80
          $ref: '#/components/responses/401'
81
        '403':
Michel Roy's avatar
Michel Roy committed
82
          $ref: '#/components/responses/403'
83
        '404':
Michel Roy's avatar
Michel Roy committed
84
          $ref: '#/components/responses/404'
85
        '406':
Michel Roy's avatar
Michel Roy committed
86
          $ref: '#/components/responses/406'
87
        '429':
Michel Roy's avatar
Michel Roy committed
88
89
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
90
  /queries/s1_bearer_info:
91
    get:
Michel Roy's avatar
Michel Roy committed
92
      tags:
Michel Roy's avatar
Michel Roy committed
93
      - 'rni'
Michel Roy's avatar
Michel Roy committed
94
95
      summary: 'Retrieve S1-U bearer information related to specific UE(s)'
      description: 'Queries information about the S1 bearer(s)'
96
97
      operationId: s1_bearer_infoGET
      parameters:
Michel Roy's avatar
Michel Roy committed
98
99
100
101
102
103
104
        - $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'
105
106
107
      responses:
        '200':
          description: Successful response to s1_bearer_info request
Michel Roy's avatar
Michel Roy committed
108
          content:
109
            application/json:
Michel Roy's avatar
Michel Roy committed
110
              schema:
Michel Roy's avatar
Michel Roy committed
111
                $ref: '#/components/schemas/S1BearerInfo'
112
        '400':
Michel Roy's avatar
Michel Roy committed
113
          $ref: '#/components/responses/400'
114
        '401':
Michel Roy's avatar
Michel Roy committed
115
          $ref: '#/components/responses/401'
116
        '403':
Michel Roy's avatar
Michel Roy committed
117
          $ref: '#/components/responses/403'
118
        '404':
Michel Roy's avatar
Michel Roy committed
119
          $ref: '#/components/responses/404'
120
        '406':
Michel Roy's avatar
Michel Roy committed
121
          $ref: '#/components/responses/406'
122
        '429':
Michel Roy's avatar
Michel Roy committed
123
124
125
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
  /queries/layer2_meas:
126
    get:
Michel Roy's avatar
Michel Roy committed
127
      tags:
Michel Roy's avatar
Michel Roy committed
128
      - 'rni'
Michel Roy's avatar
Michel Roy committed
129
130
131
132
133
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
      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'
172
173
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
174
175
          description: Successful response to layer2 measurements info request
          content:
176
            application/json:
Michel Roy's avatar
Michel Roy committed
177
              schema:
Michel Roy's avatar
Michel Roy committed
178
                $ref: '#/components/schemas/L2Meas'
179
        '400':
Michel Roy's avatar
Michel Roy committed
180
          $ref: '#/components/responses/400'
181
        '401':
Michel Roy's avatar
Michel Roy committed
182
          $ref: '#/components/responses/401'
183
        '403':
Michel Roy's avatar
Michel Roy committed
184
          $ref: '#/components/responses/403'
185
        '404':
Michel Roy's avatar
Michel Roy committed
186
          $ref: '#/components/responses/404'
187
        '406':
Michel Roy's avatar
Michel Roy committed
188
189
190
          $ref: '#/components/responses/406'
        '414':
          $ref: '#/components/responses/414'
191
        '429':
Michel Roy's avatar
Michel Roy committed
192
193
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
Michel Roy's avatar
Michel Roy committed
194
  /subscriptions:
195
    get:
Michel Roy's avatar
Michel Roy committed
196
      tags:
Michel Roy's avatar
Michel Roy committed
197
      - 'rni'
Michel Roy's avatar
Michel Roy committed
198
199
200
201
202
      summary: 'Retrieve information on subscriptions for notifications'
      description: 'Queries information on subscriptions for notifications'
      operationId: subscriptionLinkList_subscriptionsGET
      parameters:
        - $ref: '#/components/parameters/Query.SubscriptionType'
203
204
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
205
206
          description: 'Response body contains the list of links to requestors subscriptions.'
          content:
207
            application/json:
Michel Roy's avatar
Michel Roy committed
208
              schema:
Michel Roy's avatar
Michel Roy committed
209
                $ref: '#/components/schemas/SubscriptionLinkList'
Michel Roy's avatar
Michel Roy committed
210
              example:
Michel Roy's avatar
Michel Roy committed
211
212
213
214
215
216
217
218
219
                _links:
                  self:
                    href: 'http://meAppServer.example.com/rni/v2/subscriptions'
                subscription:
                  - _links:
                      self:
                        href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                    callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                    subscriptionType: CellChangeSubscription
220
        '400':
Michel Roy's avatar
Michel Roy committed
221
          $ref: '#/components/responses/400'
222
        '401':
Michel Roy's avatar
Michel Roy committed
223
          $ref: '#/components/responses/401'
224
        '403':
Michel Roy's avatar
Michel Roy committed
225
          $ref: '#/components/responses/403'
226
        '404':
Michel Roy's avatar
Michel Roy committed
227
          $ref: '#/components/responses/404'
228
        '406':
Michel Roy's avatar
Michel Roy committed
229
          $ref: '#/components/responses/406'
230
        '429':
Michel Roy's avatar
Michel Roy committed
231
232
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "subscriptions"
233
    post:
Michel Roy's avatar
Michel Roy committed
234
      tags:
Michel Roy's avatar
Michel Roy committed
235
      - 'rni'
Michel Roy's avatar
Michel Roy committed
236
237
238
239
240
241
242
243
244
      summary: 'Create a new subscription'
      description: 'Creates a new subscription to Radio Network Information notifications'
      operationId: subscriptionsPOST
      requestBody:
        description: Subscription to be created
        required: true
        content:
          application/json:
            schema:
Michel Roy's avatar
Michel Roy committed
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
              $ref: '#/components/schemas/InlineSubscription'
            example:
              subscriptionType: CellChangeSubscription
              callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
              filterCriteriaAssocHo:
                appInstanceId: 'myApp'
                associateId:
                - type: 1
                  value: '10.100.0.1'
                ecgi:
                - plmn:
                    mnc: '01'
                    mcc: '001'
                  cellId: 'ACBDEFA'
                hoStatus:
                - 1
                - 2
              expiryDeadline:
                seconds: 1977836800
                nanoseconds: 0
265
266
      responses:
        '201':
Michel Roy's avatar
Michel Roy committed
267
268
          description: Successful subscription
          content:
269
            application/json:
Michel Roy's avatar
Michel Roy committed
270
              schema:
Michel Roy's avatar
Michel Roy committed
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
                $ref: '#/components/schemas/InlineSubscription'
              example:
                subscriptionType: CellChangeSubscription
                callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                _links:
                  self:
                    href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                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
294
        '400':
Michel Roy's avatar
Michel Roy committed
295
          $ref: '#/components/responses/400'
296
        '401':
Michel Roy's avatar
Michel Roy committed
297
          $ref: '#/components/responses/401'
298
        '403':
Michel Roy's avatar
Michel Roy committed
299
          $ref: '#/components/responses/403'
300
        '404':
Michel Roy's avatar
Michel Roy committed
301
          $ref: '#/components/responses/404'
302
        '406':
Michel Roy's avatar
Michel Roy committed
303
          $ref: '#/components/responses/406'
304
        '415':
Michel Roy's avatar
Michel Roy committed
305
          $ref: '#/components/responses/412'
306
        '422':
Michel Roy's avatar
Michel Roy committed
307
          $ref: '#/components/responses/422'
308
        '429':
Michel Roy's avatar
Michel Roy committed
309
310
311
312
313
314
315
316
317
318
319
320
321
322
          $ref: '#/components/responses/429'
      callbacks:
        notification:
          '{$request.body#/notificationSubscription.callbackReference}':
            post:
              summary: 'Callback POST used to send a notification'
              description: 'Notification from RNIS, content based on subscription type'
              operationId: notificationPOST
              requestBody:
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
Michel Roy's avatar
Michel Roy committed
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
                      $ref: '#/components/schemas/InlineNotification'
                    example:
                      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'
Michel Roy's avatar
Michel Roy committed
346
347
348
349
350
              responses:
                '204':
                  $ref: '#/components/responses/204'
      x-swagger-router-controller: "subscriptions"
  '/subscriptions/{subscriptionId}':
351
    get:
Michel Roy's avatar
Michel Roy committed
352
      tags:
Michel Roy's avatar
Michel Roy committed
353
      - 'rni'
Michel Roy's avatar
Michel Roy committed
354
355
356
      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
357
      parameters:
Michel Roy's avatar
Michel Roy committed
358
        - $ref: '#/components/parameters/Path.subscrId'
359
360
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
361
362
363
364
          description: Subscription information regarding subscription notifications
          content:
            application/json:
              schema:
Michel Roy's avatar
Michel Roy committed
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
                $ref: '#/components/schemas/InlineSubscription'
              example:
                subscriptionType: CellChangeSubscription
                callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                _links:
                  self:
                    href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                filterCriteriaAssocHo:
                  appInstanceId: 'myApp'
                  associateId:
                  - type: 1
                    value: '10.100.0.1'
                  ecgi:
                  - plmn:
                      mnc: '01'
                      mcc: '001'
                    cellId: 'ACBDEFA'
                  hoStatus:
                  - 1
                  - 2
                expiryDeadline:
                  seconds: 1977836800
                  nanoseconds: 0
Michel Roy's avatar
Michel Roy committed
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
        '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
403
      - 'rni'
Michel Roy's avatar
Michel Roy committed
404
405
406
407
408
409
410
411
412
      summary: 'Modify an existing subscription'
      description: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsPUT
      requestBody:
        description: Subscription to be modified
        required: true
        content:
          application/json:
            schema:
Michel Roy's avatar
Michel Roy committed
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
              $ref: '#/components/schemas/InlineSubscription'
            example:
              subscriptionType: CellChangeSubscription
              callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
              _links:
                self:
                  href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
              filterCriteriaAssocHo:
                appInstanceId: 'myApp'
                associateId:
                - type: 1
                  value: '10.100.0.1'
                ecgi:
                - plmn:
                    mnc: '01'
                    mcc: '001'
                  cellId: 'ACBDEFA'
                hoStatus:
                - 1
                - 2
              expiryDeadline:
                seconds: 1977836800
                nanoseconds: 0
Michel Roy's avatar
Michel Roy committed
436
437
438
439
440
441
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '200':
          description: Successful subscription to response to subscription notifications
          content:
442
            application/json:
Michel Roy's avatar
Michel Roy committed
443
              schema:
Michel Roy's avatar
Michel Roy committed
444
                $ref: '#/components/schemas/InlineSubscription'
Michel Roy's avatar
Michel Roy committed
445
              example:
Michel Roy's avatar
Michel Roy committed
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
                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
467
        '400':
Michel Roy's avatar
Michel Roy committed
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
          $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
486
      - 'rni'
Michel Roy's avatar
Michel Roy committed
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
      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:
Michel Roy's avatar
Michel Roy committed
511
        application/problem+json:
512
          schema:
Michel Roy's avatar
Michel Roy committed
513
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
514
515
516
    401:
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
Michel Roy's avatar
Michel Roy committed
517
        application/problem+json:
518
          schema:
Michel Roy's avatar
Michel Roy committed
519
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
520
521
522
    403:
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
Michel Roy's avatar
Michel Roy committed
523
        application/problem+json:
524
          schema:
Michel Roy's avatar
Michel Roy committed
525
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
526
527
528
    404:
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
Michel Roy's avatar
Michel Roy committed
529
        application/problem+json:
530
          schema:
Michel Roy's avatar
Michel Roy committed
531
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
532
533
534
    406:
      description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
      content:
Michel Roy's avatar
Michel Roy committed
535
        application/problem+json:
536
          schema:
Michel Roy's avatar
Michel Roy committed
537
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
538
539
540
541
    412:
      description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when
        using ETags to avoid write conflicts when using PUT'
      content:
Michel Roy's avatar
Michel Roy committed
542
        application/problem+json:
543
          schema:
Michel Roy's avatar
Michel Roy committed
544
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
545
546
547
548
    414:
      description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is
        longer than the server is willing or able to process.'
      content:
Michel Roy's avatar
Michel Roy committed
549
        application/problem+json:
550
          schema:
Michel Roy's avatar
Michel Roy committed
551
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
552
553
554
    415:
      description: 'Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.'
      content:
Michel Roy's avatar
Michel Roy committed
555
        application/problem+json:
556
          schema:
Michel Roy's avatar
Michel Roy committed
557
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
558
559
560
561
562
563
    422:
      description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the
        syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an
        JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This
        error condition can also occur if the capabilities required by the request are not supported.'
      content:
Michel Roy's avatar
Michel Roy committed
564
        application/problem+json:
565
          schema:
Michel Roy's avatar
Michel Roy committed
566
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
567
568
          example:
            application/problem+json:
Michel Roy's avatar
Michel Roy committed
569
570
571
572
573
              type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
              title: Too many targets
              status: '422'
              detail: The target area for the request is considered too large
              instance: /meAppClient.example.com/77777/msgs/abc
Michel Roy's avatar
Michel Roy committed
574
575
576
    429:
      description: 'Too Many Requests : used when a rate limiter has triggered.'
      content:
Michel Roy's avatar
Michel Roy committed
577
        application/problem+json:
Michel Roy's avatar
Michel Roy committed
578
          schema:
Michel Roy's avatar
Michel Roy committed
579
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
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
  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:
615
616
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
617
618
619
620
621
622
623
624
          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:
625
626
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
627
628
629
630
631
632
633
634
          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:
635
636
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
637
638
639
640
641
642
643
644
          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:
645
646
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
647
648
649
650
651
652
653
654
          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:
655
656
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
657
658
659
660
661
662
663
664
665
          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
666
        format: int32
Michel Roy's avatar
Michel Roy committed
667
668
669
670
671
672
673
674
      x-exportParamName: ErabId
      x-optionalDataType: Int32
    Query.ErabIdArr:
      name: erab_id
      in: query
      description: 'Comma separated list of E-RAB identifiers'
      required: false
      schema:
675
676
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
677
          type: integer
Michel Roy's avatar
Michel Roy committed
678
          format: int32
Michel Roy's avatar
Michel Roy committed
679
680
681
682
683
684
685
      x-exportParamName: ErabIdArr
    Query.Qci:
      name: qci
      in: query
      description: 'QoS Class Identifier as defined in ETSI TS 123 401'
      required: false
      schema:
686
        type: integer
Michel Roy's avatar
Michel Roy committed
687
        format: int32
Michel Roy's avatar
Michel Roy committed
688
689
690
691
692
693
694
695
      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:
696
        type: integer
Michel Roy's avatar
Michel Roy committed
697
        format: int32
Michel Roy's avatar
Michel Roy committed
698
699
700
701
702
703
704
705
706
      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
707
        format: int32
Michel Roy's avatar
Michel Roy committed
708
709
710
711
712
713
714
715
716
      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
717
        format: int32
Michel Roy's avatar
Michel Roy committed
718
719
720
721
722
723
724
725
726
      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
727
        format: int32
Michel Roy's avatar
Michel Roy committed
728
729
730
731
732
733
734
735
      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:
736
737
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
738
739
740
741
742
743
744
745
          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:
746
        type: integer
Michel Roy's avatar
Michel Roy committed
747
748
749
750
751
752
753
      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:
754
        type: integer
Michel Roy's avatar
Michel Roy committed
755
756
757
758
759
760
761
      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:
762
        type: integer
Michel Roy's avatar
Michel Roy committed
763
764
765
766
767
768
769
      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:
770
        type: integer
Michel Roy's avatar
Michel Roy committed
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
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
      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
1007
      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
1008
1009
1010
1011
1012
1013
1014
1015
      required: false
      schema:
        type: string
      x-exportParamName: SubscriptionType
  schemas:
    AssociateId:
      properties:
        type:
Michel Roy's avatar
Michel Roy committed
1016
          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
1017
          enum:
Michel Roy's avatar
Michel Roy committed
1018
1019
1020
1021
1022
1023
          - 0
          - 1
          - 2
          - 3
          - 4
          type: integer
Michel Roy's avatar
Michel Roy committed
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
          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
1034
          description: 0 to N identifiers to associate the event for a specific UE or flow.
Michel Roy's avatar
Michel Roy committed
1035
1036
1037
1038
1039
1040
1041
          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
1042
          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
1043
1044
1045
1046
          items:
            type: object
            properties:
              cellIdNei:
Michel Roy's avatar
Michel Roy committed
1047
1048
1049
1050
                # 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
1051
              cellIdSrv:
Michel Roy's avatar
Michel Roy committed
1052
1053
1054
1055
                # 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
1056
              rsrpNei:
Michel Roy's avatar
Michel Roy committed
1057
1058
                description: "Reference Signal Received Power as defined in ETSI TS\_136 214 [i.5]."
                format: int32
Michel Roy's avatar
Michel Roy committed
1059
1060
1061
1062
                type: integer
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
              rsrpSrv:
Michel Roy's avatar
Michel Roy committed
1063
1064
                description: "Reference Signal Received Power as defined in ETSI TS\_136 214 [i.5]."
                format: int32
Michel Roy's avatar
Michel Roy committed
1065
1066
1067
1068
                type: integer
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
              rsrqNei:
Michel Roy's avatar
Michel Roy committed
1069
1070
                description: Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
                format: int32
Michel Roy's avatar
Michel Roy committed
1071
1072
1073
1074
                type: integer
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
              rsrqSrv:
Michel Roy's avatar
Michel Roy committed
1075
1076
                description: Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
                format: int32
Michel Roy's avatar
Michel Roy committed
1077
1078
1079
                type: integer
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
1080
          minItems: 0
Michel Roy's avatar
Michel Roy committed
1081
1082
1083
1084
1085
1086
1087
          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
1088
1089
1090
1091
          # 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
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
        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
1103
1104
1105
1106
1107
                # 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
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
          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
1119
1120
1121
1122
1123
                # 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
1124
1125
1126
1127
1128
1129
          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
1130
1131
1132
1133
          # 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
1134
1135
1136
1137
1138
1139
1140
1141
      required:
      - notificationType
      - ecgi
      type: object
      x-etsi-ref: 6.4.8
    CaReconfSubscription:
      properties:
        _links:
Michel Roy's avatar
Michel Roy committed
1142
          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
1143
1144
          properties:
            self:
Michel Roy's avatar
Michel Roy committed
1145
1146
1147
1148
              # 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
1149
1150
1151
1152
1153
1154
          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
1155
          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
1156
1157
1158
1159
1160
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
Michel Roy's avatar
Michel Roy committed
1161
1162
1163
1164
          # 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
1165
        filterCriteriaAssoc:
Michel Roy's avatar
Michel Roy committed
1166
          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
1167
1168
1169
1170
1171
1172
1173
          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
1174
              description: 0 to N identifiers to associate the information for a specific UE or flow.
Michel Roy's avatar
Michel Roy committed
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
              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
1199
      - callbackReference
Michel Roy's avatar
Michel Roy committed
1200
1201
1202
1203
1204
1205
      - filterCriteriaAssoc
      type: object
      x-etsi-ref: 6.3.8
    CellChangeNotification:
      properties:
        associateId:
Michel Roy's avatar
Michel Roy committed
1206
          description: 0 to N identifiers to associate the event for a specific UE or flow.
Michel Roy's avatar
Michel Roy committed
1207
1208
1209
1210
1211
1212
1213
          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
1214
1215
1216
1217
1218
1219
          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
1220
          enum:
Michel Roy's avatar
Michel Roy committed
1221
1222
1223
1224
1225
1226
          - 1
          - 2
          - 3
          - 4
          - 5
          type: integer
Michel Roy's avatar
Michel Roy committed
1227
1228
1229
1230
1231
1232
1233
1234
          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
1235
1236
1237
1238
          # 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
1239
        tempUeId:
Michel Roy's avatar
Michel Roy committed
1240
          description: The temporary identifier allocated for the specific UE as defined below.
Michel Roy's avatar
Michel Roy committed
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
          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
1259
1260
1261
1262
          # 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
1263
1264
        trgEcgi:
          description: 'E-UTRAN Cell Global Identifier of the target cell.
Michel Roy's avatar
Michel Roy committed
1265
1266

            NOTE: Cardinality N is valid only in case of statuses IN_PREPARATION, REJECTED and CANCELLED.'
Michel Roy's avatar
Michel Roy committed
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
          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
1283
          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
1284
1285
          properties:
            self:
Michel Roy's avatar
Michel Roy committed
1286
1287
1288
1289
              # 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
1290
1291
1292
1293
1294
1295
          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
1296
          description: URI selected by the service consumerto 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
1297
1298
1299
1300
1301
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
Michel Roy's avatar
Michel Roy committed
1302
1303
1304
1305
          # 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
1306
        filterCriteriaAssocHo:
Michel Roy's avatar
Michel Roy committed
1307
          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
1308
1309
1310
1311
1312
1313
1314
          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
1315
              description: 0 to N identifiers to associate the information for a specific UE or flow.
Michel Roy's avatar
Michel Roy committed
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
              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:
Michel Roy's avatar
Michel Roy committed
1331
1332
1333
1334
1335
1336
              description: 'In case hoStatus is not included in the subscription request, the default value 3 = COMPLETED shall be used and included in the response:
                <p>1