MEC029_FAI.yaml 78.1 KB
Newer Older
Muhammad Hamza's avatar
Muhammad Hamza committed
1
openapi: 3.1.0
Elian Kraja's avatar
Elian Kraja committed
2
3
4
5
6
7
info:
  title: "ETSI GS MEC 029 Fixed Access Information API"
  version: 2.1.1
  description: "ETSI GS MEC 029 Fixed Access Information API described using OpenAPI."
  license:
    name: BSD-3-Clause
Muhammad Hamza's avatar
Muhammad Hamza committed
8
    url: "https://forge.etsi.org/legal-matters"
Elian Kraja's avatar
Elian Kraja committed
9
  contact:
Elian Kraja's avatar
Elian Kraja committed
10
11
    name: ETSI Forge
    email: cti_support@etsi.org
Muhammad Hamza's avatar
Muhammad Hamza committed
12
    url: https://forge.etsi.org/rep/mec/gs029-fai-api
Elian Kraja's avatar
Elian Kraja committed
13
14
externalDocs:
  description: "ETSI GS MEC 029 Fixed Access Information API, v2.1.1"
Muhammad Hamza's avatar
Muhammad Hamza committed
15
  url: "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.01.01_60/gs_mec029v020101p.pdf"
Elian Kraja's avatar
Elian Kraja committed
16
servers:
Muhammad Hamza's avatar
Muhammad Hamza committed
17
  - url: "https://localhost/fai/v1"
Elian Kraja's avatar
Elian Kraja committed
18
tags:
19
  - name: Queries
Muhammad Hamza's avatar
Muhammad Hamza committed
20
  - name: Subscription
Elian Kraja's avatar
Elian Kraja committed
21
22

paths:
Muhammad Hamza's avatar
Muhammad Hamza committed
23
24
25
26
27
28
29
30
  /queries/fa_info:
    get:
      tags:
        - "Queries"
      summary: "Retrieve information on the available fixed access networks."
      description: "Retrieve information on the available fixed access networks."
      operationId: fa_infoGET
      parameters:
Elian Kraja's avatar
Elian Kraja committed
31
32
33
        - in: query
          name: customerPremisesInfo
          schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
34
35
36
            type: array
            items:
              $ref: "#/components/schemas/CpInfo"
Elian Kraja's avatar
Elian Kraja committed
37
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
38
          description: "Comma separated list of customer premises information"
Elian Kraja's avatar
Elian Kraja committed
39
40
41
42
43
        - in: query
          name: lastMileTech
          schema:
            type: array
            items:
Muhammad Hamza's avatar
Muhammad Hamza committed
44
              type: integer
Elian Kraja's avatar
Elian Kraja committed
45
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
46
          description: "Comma separated list of last mile technologies."
Elian Kraja's avatar
Elian Kraja committed
47
48
49
50
51
        - in: query
          name: interfaceType
          schema:
            type: array
            items:
Muhammad Hamza's avatar
Muhammad Hamza committed
52
53
              type: integer
          description: "Comma separated list of interface types."
Elian Kraja's avatar
Elian Kraja committed
54
55
56
57
58
        - in: query
          name: dsbw
          schema:
            type: array
            items:
Muhammad Hamza's avatar
Muhammad Hamza committed
59
              type: integer
Elian Kraja's avatar
Elian Kraja committed
60
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
61
          description: "Comma separated list of the bandwidth (in Mbps) from the network towards the customer site."
Elian Kraja's avatar
Elian Kraja committed
62
63
64
65
66
        - in: query
          name: usbw
          schema:
            type: array
            items:
Muhammad Hamza's avatar
Muhammad Hamza committed
67
              type: integer
Elian Kraja's avatar
Elian Kraja committed
68
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
69
          description: "Comma separated list of the bandwidth (in Mbps) from the customer site towards the network."
Elian Kraja's avatar
Elian Kraja committed
70
71
72
73
74
        - in: query
          name: latency
          schema:
            type: array
            items:
Muhammad Hamza's avatar
Muhammad Hamza committed
75
              type: integer
Elian Kraja's avatar
Elian Kraja committed
76
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
77
78
79
80
          description: "Comma separated list of the maximum baseline latency (in ms) between customer site and service edge node."
      responses:
        "200":
          description: "A response body containing the FAI is returned. "
Elian Kraja's avatar
Elian Kraja committed
81
82
83
          content:
            application/json:
              schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
                $ref: "#/components/schemas/FaInfo"
        "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"

  /queries/device_info:
    get:
      tags:
        - "Queries"
      summary: "retrieve information on the devices that are connected to a fixed access network."
      description: "retrieve information on the devices that are connected to a fixed access network."
      operationId: device_infoGET
      parameters:
Elian Kraja's avatar
Elian Kraja committed
106
107
108
        - in: query
          name: gwId
          schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
109
110
111
            type: array
            items:
              type: string
Elian Kraja's avatar
Elian Kraja committed
112
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
113
          description: "Comma separated list of gateway identifier"
Elian Kraja's avatar
Elian Kraja committed
114
115
116
117
118
        - in: query
          name: deviceId
          schema:
            type: array
            items:
Muhammad Hamza's avatar
Muhammad Hamza committed
119
              type: string
Elian Kraja's avatar
Elian Kraja committed
120
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
121
          description: "Comma separated list of device identifier."
Elian Kraja's avatar
Elian Kraja committed
122
123
124
125
126
        - in: query
          name: deviceStatus
          schema:
            type: array
            items:
Muhammad Hamza's avatar
Muhammad Hamza committed
127
128
129
130
131
132
              type: integer
          description: "Comma separated list of device status."

      responses:
        "200":
          description: "A response body containing the device information is returned"
Elian Kraja's avatar
Elian Kraja committed
133
134
135
          content:
            application/json:
              schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
                $ref: "#/components/schemas/DeviceInfo"
        "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"

  /queries/cable_line_info:
    get:
      tags:
        - "Cable line info"
      summary: "It Queries information about the cable line of a fixed access network."
      description: "It Queries information about the cable line of a fixed access network."
      operationId: cable_line_infoGET
      parameters:
158
159
160
        - in: query
          name: customerPremisesInfo
          schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
161
162
163
            type: array
            items:
              $ref: "#/components/schemas/CpInfo"
164
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
165
          description: "Comma separated list of customer premises information"
166
167
168
169
170
        - in: query
          name: cmId
          schema:
            type: array
            items:
Muhammad Hamza's avatar
Muhammad Hamza committed
171
              type: string
172
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
173
174
175
176
177
          description: "Comma separated list of Cable Modem identifiers."

      responses:
        "200":
          description: "A response body containing the cable line information is returned."
178
179
180
          content:
            application/json:
              schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
                $ref: "#/components/schemas/CableLineInfo"
        "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"
  /queries/optical_network_info:
    get:
      tags:
        - "Optical network info"
      summary: "used to query information about the optical network."
      description: "used to query information about the optical network."
      operationId: optical_network_infoGET
      parameters:
202
203
204
        - in: query
          name: customerPremisesInfo
          schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
205
206
207
            type: array
            items:
              $ref: "#/components/schemas/CpInfo"
208
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
209
          description: "Comma separated list of customer premises information"
210
211
212
213
214
        - in: query
          name: ponYS_ID
          schema:
            type: array
            items:
Muhammad Hamza's avatar
Muhammad Hamza committed
215
              type: string
216
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
217
          description: "Comma separated list of optical system identifiers."
218
219
220
221
222
        - in: query
          name: onuId
          schema:
            type: array
            items:
Muhammad Hamza's avatar
Muhammad Hamza committed
223
              type: string
224
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
225
226
227
228
229
          description: "Comma separated list of optical network unit identifiers."

      responses:
        "200":
          description: "A response body containing the optical network information is returned."
230
231
232
233
234
          content:
            application/json:
              schema:
                type: array
                items:
Muhammad Hamza's avatar
Muhammad Hamza committed
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
                  $ref: "#/components/schemas/PonInfo"
        "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"

  /subscriptions:
    get:
      tags:
        - "Subscription"
      summary: "request information about the subscriptions for this requestor."
      description: "request information about the subscriptions for this requestor."
      operationId: subGET
      parameters:
257
258
259
        - in: query
          name: subscription_type
          schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
260
            type: string
261
          required: false
Muhammad Hamza's avatar
Muhammad Hamza committed
262
263
264
265
266

          description: "Query parameter to filter on a specific subscription type. Permitted values: ONU_ALARM. DEVICE_ABNORMAL_ALERT. CM_CONNECTIVITY_STATE.  ANI_ALARM."
      responses:
        "200":
          description: "A response body containing the list of links to requestor subscriptions is returned."
267
268
269
          content:
            application/json:
              schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
                $ref: "#/components/schemas/SubscriptionLinkList"
        "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"
    post:
      tags:
        - "Subscription"
      summary: " create a new subscription to FAI notifications."
      description: " create a new subscription to FAI notifications."
      operationId: subPOST
      requestBody:
290
291
292
293
294
        required: true
        content:
          application/json:
            schema:
              oneOf:
Muhammad Hamza's avatar
Muhammad Hamza committed
295
296
297
298
299
300
301
302
                - $ref: "#/components/schemas/OnuAlarmSubscription"
                - $ref: "#/components/schemas/DevInfoSubscription"
                - $ref: "#/components/schemas/CmConnSubscription"
                - $ref: "#/components/schemas/AniAlarmSubscription"

      responses:
        "201":
          description: "In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type."
303
304
305
          content:
            application/json:
              schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
                oneOf:
                  - $ref: "#/components/schemas/OnuAlarmSubscription"
                  - $ref: "#/components/schemas/DevInfoSubscription"
                  - $ref: "#/components/schemas/CmConnSubscription"
                  - $ref: "#/components/schemas/AniAlarmSubscription"
        "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"
        "415":
          $ref: "#/components/responses/415"
        "422":
          $ref: "#/components/responses/422"
        "429":
          $ref: "#/components/responses/429"

      callbacks:
        notification:
          "{$request.body#/callbackReference}":
331
            post:
Muhammad Hamza's avatar
Muhammad Hamza committed
332
333
              summary: "Callback POST used to send a notification"
              description: "A notification from FAIS."
334
335
336
337
338
339
340
341
              operationId: notificationPOST
              requestBody:
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
                      oneOf:
Muhammad Hamza's avatar
Muhammad Hamza committed
342
343
344
345
                        - $ref: "#/components/schemas/OnuAlarmNotification"
                        - $ref: "#/components/schemas/DevInfoNotification"
                        - $ref: "#/components/schemas/CmConnNotification"
                        - $ref: "#/components/schemas/AniAlarmNotification"
346
              responses:
Muhammad Hamza's avatar
Muhammad Hamza committed
347
348
                "204":
                  $ref: "#/components/responses/204"
349

Muhammad Hamza's avatar
Muhammad Hamza committed
350
351
352
353
354
355
356
357
  /subscriptions/{subscriptionId}:
    parameters:
      - in: path
        name: subscriptionId
        description: "Refers to created subscription, where the FAI API allocates a unique resource name for this subscription"
        schema:
          type: string
        required: true
358
359
360

    get:
      tags:
Muhammad Hamza's avatar
Muhammad Hamza committed
361
362
363
        - "Subscription"
      summary: "Retrieve information about this subscription."
      description: "Retrieve information about this subscription."
364
      operationId: individualSubscriptionGET
Muhammad Hamza's avatar
Muhammad Hamza committed
365

366
      responses:
Muhammad Hamza's avatar
Muhammad Hamza committed
367
368
        "200":
          description: "A response body containing data type describing the specific FAI event subscription is returned"
369
370
371
          content:
            application/json:
              schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
                oneOf:
                  - $ref: "#/components/schemas/OnuAlarmSubscription"
                  - $ref: "#/components/schemas/DevInfoSubscription"
                  - $ref: "#/components/schemas/CmConnSubscription"
                  - $ref: "#/components/schemas/AniAlarmSubscription"
        "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"
389
390
391

    put:
      tags:
Muhammad Hamza's avatar
Muhammad Hamza committed
392
393
394
        - "Subscription"
      summary: "Used to update the existing subscription."
      description: "Used to update the existing subscription."
395
396
397
398
399
400
401
      operationId: individualSubscriptionPUT
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
Muhammad Hamza's avatar
Muhammad Hamza committed
402
403
404
405
                - $ref: "#/components/schemas/OnuAlarmSubscription"
                - $ref: "#/components/schemas/DevInfoSubscription"
                - $ref: "#/components/schemas/CmConnSubscription"
                - $ref: "#/components/schemas/AniAlarmSubscription"
406
      responses:
Muhammad Hamza's avatar
Muhammad Hamza committed
407
408
        "200":
          description: "A response body containing data type describing the updated subscription is returned"
409
410
411
          content:
            application/json:
              schema:
Muhammad Hamza's avatar
Muhammad Hamza committed
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
                oneOf:
                  - $ref: "#/components/schemas/OnuAlarmSubscription"
                  - $ref: "#/components/schemas/DevInfoSubscription"
                  - $ref: "#/components/schemas/CmConnSubscription"
                  - $ref: "#/components/schemas/AniAlarmSubscription"
        "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"

        "412":
          $ref: "#/components/responses/412"

        "422":
          $ref: "#/components/responses/422"

        "429":
          $ref: "#/components/responses/429"
439
440
    delete:
      tags:
Muhammad Hamza's avatar
Muhammad Hamza committed
441
442
443
        - "Subscription"
      summary: "Used to cancel the existing subscription."
      description: "Used to cancel the existing subscription."
444
445
      operationId: individualSubscriptionDELETE
      responses:
Muhammad Hamza's avatar
Muhammad Hamza committed
446
447
448
449
450
451
452
453
454
455
456
        "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"

Elian Kraja's avatar
Elian Kraja committed
457
458
459
components:
  schemas:
    AniAlarmNotification.alarm:
Muhammad Hamza's avatar
Muhammad Hamza committed
460
461
462
463
464
465
466
467
468
469
470
471
472
      description: "Indicates the alarm of the ANI: 0 = LowReceivedOpticalPower. 1 = HighReceivedOpticalPower. 2 = SignalFailure. 3 = SignalDegrade. 4 = LowTransmitOpticalPower.5 = HighTransmitOpticalPower.6 = LaserBiasCurrent."
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum

Elian Kraja's avatar
Elian Kraja committed
473
474
    AniAlarmNotification.aniId:
      properties:
Muhammad Hamza's avatar
Muhammad Hamza committed
475
        onuId:
Elian Kraja's avatar
Elian Kraja committed
476
477
          description: The unique identifiers for the optical network unit.
          type: string
Muhammad Hamza's avatar
Muhammad Hamza committed
478
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
479
          x-etsi-mec-origin-type: String
Muhammad Hamza's avatar
Muhammad Hamza committed
480
        aniIndex:
Elian Kraja's avatar
Elian Kraja committed
481
482
          description: The index of an access network interface supported by the optical network unit.
          type: string
Muhammad Hamza's avatar
Muhammad Hamza committed
483
484
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
Elian Kraja's avatar
Elian Kraja committed
485
      required:
Muhammad Hamza's avatar
Muhammad Hamza committed
486
487
488
        - onuId
        - aniIndex

Elian Kraja's avatar
Elian Kraja committed
489
490
491
    AniAlarmNotification:
      properties:
        alarm:
Muhammad Hamza's avatar
Muhammad Hamza committed
492
          $ref: "#/components/schemas/AniAlarmNotification.alarm"
Elian Kraja's avatar
Elian Kraja committed
493
        aniId:
Muhammad Hamza's avatar
Muhammad Hamza committed
494
495
          $ref: "#/components/schemas/AniAlarmNotification.aniId"

Elian Kraja's avatar
Elian Kraja committed
496
497
498
        customerPremisesInfo:
          description: The physical location of the related customer sites.
          items:
Muhammad Hamza's avatar
Muhammad Hamza committed
499
            $ref: "#/components/schemas/CpInfo"
Elian Kraja's avatar
Elian Kraja committed
500
501
502
503
504
505
506
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: CpInfo
        notificationType:
          description: Shall be set to "AniAlarmNotification".
          type: string
Muhammad Hamza's avatar
Muhammad Hamza committed
507
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
508
509
510
511
512
513
514
          x-etsi-mec-origin-type: String
        onuId:
          type: string
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
515
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
516
      required:
Muhammad Hamza's avatar
Muhammad Hamza committed
517
518
519
        - notificationType
        - aniIndex
        - alarm
Elian Kraja's avatar
Elian Kraja committed
520
521
      type: object
      x-etsi-ref: 6.4.6
Muhammad Hamza's avatar
Muhammad Hamza committed
522

Elian Kraja's avatar
Elian Kraja committed
523
    AniAlarmSubscription.filterCriteriaAniAlarm.alarms:
Muhammad Hamza's avatar
Muhammad Hamza committed
524
525
526
527
528
529
530
531
532
533
534
535
      description: "In case alarms is not included in the subscription request, the default value -1 = All shall be used and included in the response:\n0  =\tLowReceivedOpticalPower.\n(Received downstream optical power below threshold.)\n1  =\tHighReceivedOpticalPower.\n\t(Received downstream optical power above threshold.)\n2  =\tSignalFalure.\n(Bit error-based signal fail.)\n3  =\tSignalDegrade.\n(Bit error-based signal degrade.)\n4  =\tLowTransmitOpticalPower.\n(Transmit optical power below lower threshold.)\n5  =\tHighTransmitOpticalPower.\n(Transmit optical power above upper threshold.)\n6  =\tLaserBiasCurrent.\n(Laser bias current above threshold determined by vendor.)\n-1 =\tAll."
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - -1
      type: integer

Elian Kraja's avatar
Elian Kraja committed
536
    AniAlarmSubscription.links:
Muhammad Hamza's avatar
Muhammad Hamza committed
537
538
539
540
541
542
543
544
545
      properties:
        self:
          # description': Self referring URI. The URI shall be unique within the FAI 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"
      required:
        - self

Elian Kraja's avatar
Elian Kraja committed
546
    AniAlarmSubscription.filterCriteriaAniAlarm:
Muhammad Hamza's avatar
Muhammad Hamza committed
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
      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."
      required:
        - onuId
        - aniId
      properties:
        customerPremisesInfo:
          required:
            - onuId
            - aniId
          description: 0 to N physical locations of the customer sites.
          minItems: 0
          type: array
          items:
            $ref: "#/components/schemas/CpInfo"

          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: CpInfo
        onuId:
          description: "1 to N unique identifiers for the optical network units.  Typical it is the unique serial number for each ONU, which contains the vendor ID and version number. The first four bytes are an ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number, under the control of the ONU vendor."
          type: array
          items:
            type: string
            x-etsi-mec-cardinality: "1..N"
            x-etsi-mec-origin-type: String

        aniId:
          description: ""
          type: object
Elian Kraja's avatar
Elian Kraja committed
575
          required:
Muhammad Hamza's avatar
Muhammad Hamza committed
576
577
            - onuId
            - aniIndex
Elian Kraja's avatar
Elian Kraja committed
578
579
          properties:
            onuId:
Muhammad Hamza's avatar
Muhammad Hamza committed
580
581
582
583
584
585
586
587
588
589
              description: "The unique identifiers for the optical network unit"
              type: string
            aniIndex:
              description: "The index of an access network interface supported by the optical network unit"
              type: string
        alarms:
          type: array
          items:
            $ref: "#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm.alarms"

Elian Kraja's avatar
Elian Kraja committed
590
591
592
    AniAlarmSubscription:
      properties:
        subscriptionType:
Muhammad Hamza's avatar
Muhammad Hamza committed
593
594
          description: 'Shall be set to \"AniAlarmSubscription\"'
          type: string
Elian Kraja's avatar
Elian Kraja committed
595
        _links:
Muhammad Hamza's avatar
Muhammad Hamza committed
596
          $ref: "#/components/schemas/AniAlarmSubscription.links"
Elian Kraja's avatar
Elian Kraja committed
597
598
599
        aniIndex:
          description: The index of an access network interface supported by the optical network unit.
          type: string
Muhammad Hamza's avatar
Muhammad Hamza committed
600
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
601
602
603
604
605
          x-etsi-mec-origin-type: String
        callbackReference:
          description: URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response.
          format: uri
          type: string
Muhammad Hamza's avatar
Muhammad Hamza committed
606
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
607
608
609
610
611
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
612
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
613
        filterCriteriaAniAlarm:
Muhammad Hamza's avatar
Muhammad Hamza committed
614
          $ref: "#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm"
Elian Kraja's avatar
Elian Kraja committed
615
      required:
Muhammad Hamza's avatar
Muhammad Hamza committed
616
617
618
619
620
        - subscriptionType
        - callbackReference
        - filterCriteriaAniAlarm
        - onuId
        - aniIndex
Elian Kraja's avatar
Elian Kraja committed
621
622
      type: object
      x-etsi-ref: 6.3.6
Muhammad Hamza's avatar
Muhammad Hamza committed
623

Elian Kraja's avatar
Elian Kraja committed
624
    CableLineInfo.cmInfo.serviceFlowStats:
Muhammad Hamza's avatar
Muhammad Hamza committed
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
      description: "It describes statistics associated with the Service Flows in a managed device."
      properties:
        ifIndex:
          description: "It represents the interface index of the MAC Domain of the Service Flow"
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        serviceFlowInfo:
          type: array
          items:
            $ref: "#/components/schemas/CableLineInfo.cmInfo.serviceFlowStats.serviceFlowInfo"
      type: object

      required:
        - ifIndex
        - serviceFlowInfo

Elian Kraja's avatar
Elian Kraja committed
642
643
644
645
646
647
    CableLineInfo.cmInfo.serviceFlowStats.serviceFlowInfo:
      description: It represents the information of a Service Flow.
      properties:
        aqmDroppedPkts:
          description: For upstream service flows on which AQM is enabled, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to Active Queue Management drop decisions.
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
648
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
649
650
651
652
          x-etsi-mec-origin-type: Integer
        pkts:
          description: For outgoing Service Flows, this attribute counts the number of Packet Data PDUs forwarded to this Service Flow. For incoming upstream CMTS service flows, this attribute counts the number of Packet Data PDUs actually received on the Service Flow identified by the SID for which the packet was scheduled.
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
653
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
654
655
656
657
          x-etsi-mec-origin-type: Integer
        policedDelayPkts:
          description: It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate.
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
658
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
659
660
661
662
          x-etsi-mec-origin-type: Integer
        policedDropPkts:
          description: "For upstream service flows, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to:\n1)\texceeding the selected Buffer Size for the service flow; or\n2)\tUGS packets dropped due to exceeding the Unsolicited Grant Size with a Request/Transmission policy that requires such packets to be dropped."
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
663
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
664
665
666
667
          x-etsi-mec-origin-type: Integer
        serviceFlowId:
          description: It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
668
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
669
670
671
672
          x-etsi-mec-origin-type: Integer
        timeActive:
          description: It indicates the number of seconds that the service flow has been active.
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
673
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
674
675
676
677
678
          x-etsi-mec-origin-type: Integer
        timeCreated:
          # description': It indicates the time when the service flow was created.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
679
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
680
      required:
Muhammad Hamza's avatar
Muhammad Hamza committed
681
682
683
684
685
686
687
688
        - serviceFlowId
        - pkts
        - timeCreated
        - timeActive
        - policedDropPkts
        - policedDelayPkts
        - aqmDroppedPkts

Elian Kraja's avatar
Elian Kraja committed
689
    CableLineInfo.cmInfo.cmStatus.cmRegState:
Muhammad Hamza's avatar
Muhammad Hamza committed
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
      description: "It defines the CM connectivity state. Enumeration of: 1 = other.  2 = notReady. 3 = notSynchronized. 4 = phySynchronized. 5 = usParametersAcquired. 6 = rangingComplete. 7 = dhcpV4Complete. 8 = todEstablished. 9 = securityEstablished. 10 = configFileDownloadComplete. 11 = registrationComplete. 12 = operational. 13 = accessDenied. 14 = eaeInProgress. 15 = dhcpv4InProgress. 16 = dhcpv6InProgress. 17 = dhcpV6Complete. 18 = registrationInProgress. 19 = bpiInit. 20 = forwardingDisabled. 21 = dsTopologyResolutionInProgress. 22 = rangingInProgress. 23 = rfMuteAll."
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
        - 14
        - 15
        - 16
        - 17
        - 18
        - 19
        - 20
        - 21
        - 22
        - 23
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
Elian Kraja's avatar
Elian Kraja committed
718
    CableLineInfo.cmInfo.cmStatus:
Muhammad Hamza's avatar
Muhammad Hamza committed
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
      description: It provides CM connectivity status information of the CM.
      properties:
        cmRegState:
          $ref: "#/components/schemas/CableLineInfo.cmInfo.cmStatus.cmRegState"
        emDlsOperStatus:
          description: It indicates whether the CM is currently operating in Energy Management DLS Mode.
          type: boolean
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Boolean
        energyMgt1x1OperStatus:
          description: It indicates whether the CM is currently operating in Energy Management 1x1 Mode.
          type: boolean
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Boolean
        ifIndex:
          description: It denotes the MAC Domain interface index of the CM.
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        invalidRegRsps:
          description: It denotes the number of times the CM received invalid registration response messages.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        lostSyncs:
          description: It denotes the number of times the CM lost synchronization with the downstream channel.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        resets:
          description: It denotes the number of times the CM reset or initialized this interface.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
      required:
        - ifIndex
        - cmRegState
        - resets
        - lostSyncs
        - invalidRegRsps
        - energyMgt1x1OperStatus
        - emDlsOperStatus

Elian Kraja's avatar
Elian Kraja committed
762
    CableLineInfo.cmInfo.cmDpvStats:
Muhammad Hamza's avatar
Muhammad Hamza committed
763
764
765
766
767
768
769
770
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
      description: It represents the DOCSIS Path Verify Statistics collected in the cable modem device.
      properties:
        avgLatency:
          description: The average latency measurement.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        ifIndex:
          description: It represents the interface Index of the Downstream Interface where the measurements are taken.
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        lastMeasLatency:
          description: The last latency measurement.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        lastMeasTime:
          # description': The last measurement time of the last latency measurement.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
        maxLatency:
          description: The maximum latency measurement.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        minLatency:
          description: The minimum latency measurement.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
        numMeas:
          description: The number of latency measurements made.
          type: integer
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: Integer
      required:
        - ifIndex
        - lastMeasLatency
        - lastMeasTime
        - minLatency
        - maxLatency
        - avgLatency
        - numMeas

Elian Kraja's avatar
Elian Kraja committed
809
    CableLineInfo.cmInfo:
Muhammad Hamza's avatar
Muhammad Hamza committed
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
      description: ""
      properties:
        cmDpvStats:
          type: array
          items:
            $ref: "#/components/schemas/CableLineInfo.cmInfo.cmDpvStats"
        cmId:
          description: "Information (typically the serial number) to identify a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.This value SHALL remain fixed over the lifetime of thedevice, including across firmware updates."
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        cmStatus:
          $ref: "#/components/schemas/CableLineInfo.cmInfo.cmStatus"
        serviceFlowStats:
          type: array
          items:
            $ref: "#/components/schemas/CableLineInfo.cmInfo.serviceFlowStats"

      required:
        - cmId

Elian Kraja's avatar
Elian Kraja committed
831
    CableLineInfo:
Muhammad Hamza's avatar
Muhammad Hamza committed
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
      properties:
        cmInfo:
          $ref: "#/components/schemas/CableLineInfo.cmInfo"
        customerPremisesInfo:
          # description': The physical location of a customer site.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': CpInfo
          $ref: "#/components/schemas/CpInfo"
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
      type: object
      required:
Elian Kraja's avatar
Elian Kraja committed
847
848
        - customerPremisesInfo
        - cmInfo
Muhammad Hamza's avatar
Muhammad Hamza committed
849
850
      x-etsi-ref: 6.2.4

851
    CmConnNotification.cmIf.cmRegState:
Muhammad Hamza's avatar
Muhammad Hamza committed
852
853
      description: "It indicates the CM connectivity state. Enumeration of:  1 = notReady. 2 = notSynchronized. 3 = phySynchronized. 4 = dsTopologyResolutionInProgress.5 = usParametersAcquired. 6 = rangingInProgress.7 = rangingComplete. 8 = eaeInProgress.9 = dhcpv4InProgress. 10 = dhcpv6InProgress.11 = dhcpV4Complete.12 = dhcpV6Complete.13 = todEstablished.14 = securityEstablished.15 = configFileDownloadComplete.16 = registrationInProgress.17 = registrationComplete. 18 = accessDenied. 19 =operational. 20 = bpiInit.21 =forwardingDisabled."
      enum:
Elian Kraja's avatar
Elian Kraja committed
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
        - 14
        - 15
        - 16
        - 17
        - 18
        - 19
        - 20
        - 21
Muhammad Hamza's avatar
Muhammad Hamza committed
875
876
      type: integer

Elian Kraja's avatar
Elian Kraja committed
877
    CmConnNotification.cmIf:
Muhammad Hamza's avatar
Muhammad Hamza committed
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
      description: ""
      items:
        type: object
      properties:
        cmId:
          description: The Cable Modem identifier.
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        cmRegState:
          items:
            $ref: "#/components/schemas/CmConnNotification.cmIf.cmRegState"
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Enum
        ifIndex:
          description: The MAC Domain interface index of the CM.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
      required:
        - cmId
        - ifIndex
        - cmRegState

Elian Kraja's avatar
Elian Kraja committed
907
    CmConnNotification:
Muhammad Hamza's avatar
Muhammad Hamza committed
908
      required:
Elian Kraja's avatar
Elian Kraja committed
909
910
        - notificationType
        - cmIf
Muhammad Hamza's avatar
Muhammad Hamza committed
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
      properties:
        cmIf:
          type: array
          items:
            $ref: "#/components/schemas/CmConnNotification.cmIf"
        customerPremisesInfo:
          # description': The physical location of a customer site.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': CpInfo
          $ref: "#/components/schemas/CpInfo"
        notificationType:
          description: 'Shall be set to \"CmconnNotification\".'
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
      type: object

      x-etsi-ref: 6.4.4

Elian Kraja's avatar
Elian Kraja committed
935
    CmConnSubscription.links:
Muhammad Hamza's avatar
Muhammad Hamza committed
936
937
938
939
940
941
942
943
944
945
946
      description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
      properties:
        self:
          # description': Self referring URI. The URI shall be unique within the FAI 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"
      required:
        - self
      type: object
      x-etsi-mec-cardinality: 0..1
947
948

    CmConnSubscription.filterCriteriaCmConn.cmIf.cmRegState:
Muhammad Hamza's avatar
Muhammad Hamza committed
949
950
      description: "It indicates the CM connectivity state. Enumeration of:  1 = notReady. 2 = notSynchronized. 3 = phySynchronized. 4 = dsTopologyResolutionInProgress.5 = usParametersAcquired. 6 = rangingInProgress.7 = rangingComplete. 8 = eaeInProgress.9 = dhcpv4InProgress. 10 = dhcpv6InProgress.11 = dhcpV4Complete.12 = dhcpV6Complete.13 = todEstablished.14 = securityEstablished.15 = configFileDownloadComplete.16 = registrationInProgress.17 = registrationComplete. 18 = accessDenied. 19 =operational. 20 = bpiInit.21 =forwardingDisabled."
      enum:
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
        - 14
        - 15
        - 16
        - 17
        - 18
        - 19
        - 20
        - 21
Muhammad Hamza's avatar
Muhammad Hamza committed
972
973
      type: integer

Elian Kraja's avatar
Elian Kraja committed
974
    CmConnSubscription.filterCriteriaCmConn.cmIf:
Muhammad Hamza's avatar
Muhammad Hamza committed
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
      description: ""
      properties:
        cmId:
          description: The identifier of a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        cmRegState:
          items:
            $ref: "#/components/schemas/CmConnSubscription.filterCriteriaCmConn.cmIf.cmRegState"
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Enum
        ifIndex:
          description: The MAC Domain interface index of the CM.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
      required:
        - cmId
        - ifIndex
        - cmRegState
    CmConnSubscription.filterCriteriaCmConn:
      description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
      properties:
        cmIf:
          type: array
          items:
            $ref: "#/components/schemas/CmConnSubscription.filterCriteriaCmConn.cmIf"
        customerPremisesInfo:
          # description': The physical location of a customer site.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': CpInfo
          $ref: "#/components/schemas/CpInfo"

      type: object
      x-etsi-mec-cardinality: "1"

Elian Kraja's avatar
Elian Kraja committed
1017
1018
1019
    CmConnSubscription:
      properties:
        _links:
Muhammad Hamza's avatar
Muhammad Hamza committed
1020
1021
          $ref: "#/components/schemas/CmConnSubscription.links"

Elian Kraja's avatar
Elian Kraja committed
1022
1023
1024
1025
        callbackReference:
          description: URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response.
          format: uri
          type: string
Muhammad Hamza's avatar
Muhammad Hamza committed
1026
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1027
1028
1029
1030
1031
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
1032
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
1033
        filterCriteriaCmConn:
Muhammad Hamza's avatar
Muhammad Hamza committed
1034
          $ref: "#/components/schemas/CmConnSubscription.filterCriteriaCmConn"
Elian Kraja's avatar
Elian Kraja committed
1035
1036
1037
        subscriptionType:
          description: Shall be set to "CmConnSubscription".
          type: string
Muhammad Hamza's avatar
Muhammad Hamza committed
1038
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1039
1040
          x-etsi-mec-origin-type: String
      required:
Muhammad Hamza's avatar
Muhammad Hamza committed
1041
1042
1043
        - subscriptionType
        - callbackReference
        - filterCriteriaCmConn
Elian Kraja's avatar
Elian Kraja committed
1044
1045
1046
1047
1048
1049
      type: object
      x-etsi-notes: "NOTE:\t'notReady' indicates that the CM has not started the registration process yet.\n\t'notSynchronized' indicates that the CM has not initiated or completed the synchronization of the downstream physical layer.\n\t'phySynchronized' indicates that the CM has completed the synchronization of the downstream physical layer.\n\t'dsTopologyResolutionInProgress' indicates that the CM is attempting to determine its MD-DS-SG.\n\t'usParametersAcquired' indicates that the CM has completed the upstream parameters acquisition or have completed the downstream and upstream service groups resolution.\n\t'rangingInProgress' indicates that the CM has initiated the initial ranging process.\n\t'rangingComplete' indicates that the CM has completed initial ranging and received a Ranging Status of success from the CMTS in the RNG-RSP message.\n\t'eaeInProgress' indicates that the CM has sent an Auth Info message for EAE.\n\t'dhcpv4InProgress' indicates that the CM has sent a DHCPv4 DISCOVER to gain IP connectivity.\n\t'dhcpv6InProgress' indicates that the CM has sent a DHCPv6 Solicit message.\n\t'dhcpv4Complete' indicates that the CM has received a DHCPv4 ACK message from the CMTS.\n\t'dhcpv6Complete' indicates that the CM has received a DHCPv6 Reply message from the CMTS.\n\t'todEstablished' indicates that the CM has successfully acquired time of day.\n\t'securityEstablished' indicates that the CM has successfully completed the BPI initialization process.\n\t'configFileDownloadComplete' indicates that the CM has completed the config file download process.\n\t'registrationInProgress' indicates that the CM has sent a Registration Request.\n\t'registrationComplete' indicates that the CM has successfully completed the Registration process with the CMTS.\n\t'accessDenied' indicates that the CM has received a registration aborted notification from the CMTS.\n\t'operational' indicates that the CM has completed all necessary initialization steps and is operational.\n\t'bpiInit' indicates that the CM has started the BPI initialization process as indicated in the CM config file.\n\t'forwardingDisabled' indicates that the registration process was completed, but the network access option in the received configuration file prohibits forwarding."
      x-etsi-ref: 6.3.4
    CpInfo:
      properties:
        latitude:
Muhammad Hamza's avatar
Muhammad Hamza committed
1050
          description: "Latitude (DATUM=WGS84)
Elian Kraja's avatar
Elian Kraja committed
1051

Muhammad Hamza's avatar
Muhammad Hamza committed
1052
            -90 to 90 in decimal degree format DDD.ddd"
Elian Kraja's avatar
Elian Kraja committed
1053
1054
1055
1056
1057
          format: Float
          type: number
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Float
        longitude:
Muhammad Hamza's avatar
Muhammad Hamza committed
1058
          description: "Longitude (DATUM=WGS84)
Elian Kraja's avatar
Elian Kraja committed
1059

Muhammad Hamza's avatar
Muhammad Hamza committed
1060
            -180 to 180 in decimal degree format DDD.ddd"
Elian Kraja's avatar
Elian Kraja committed
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
          format: Float
          type: number
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Float
        postalCode:
          description: Postal code for the location
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      type: object
      x-etsi-ref: 6.5.3
    DevInfoNotification:
      properties:
        deviceErrStatus:
Muhammad Hamza's avatar
Muhammad Hamza committed
1075
          $ref: "#/components/schemas/deviceErrStatus"
Elian Kraja's avatar
Elian Kraja committed
1076
        #  x-etsi-mec-cardinality: '1'
Muhammad Hamza's avatar
Muhammad Hamza committed
1077
        # x-etsi-mec-origin-type: Enum
Elian Kraja's avatar
Elian Kraja committed
1078
1079
1080
        deviceId:
          description: The identifier for a device.
          type: string
Muhammad Hamza's avatar
Muhammad Hamza committed
1081
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1082
1083
1084
1085
          x-etsi-mec-origin-type: String
        notificationType:
          description: Shall be set to "DevInfoNotification".
          type: string
Muhammad Hamza's avatar
Muhammad Hamza committed
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
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: String
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: "#/components/schemas/TimeStamp"
      required:
        - notificationType
        - deviceId
        - deviceErrStatus
      type: object
      x-etsi-ref: 6.4.3

    deviceErrStatus:
      description: "The abnormal operational status of the device. Enumeration of:  1 = Error. 2 = Disabled."
      enum:
        - 1
        - 2
      type: integer

    DevInfoSubscription.links:
      description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
      properties:
        self:
          # description': Self referring URI. The URI shall be unique within the FAI 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"
      required:
        - self
      type: object
      x-etsi-mec-cardinality: 0..1

    DevInfoSubscription.filterCriteriaDevInfo:
      description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
      properties:
        deviceErrStatus:
          items:
            $ref: "#/components/schemas/deviceErrStatus"
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Enum
        deviceId:
          description: The device identifier.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        gwId:
          description: The identifier of an Internet Gateway Device through which the customer premises device is connected.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
Elian Kraja's avatar
Elian Kraja committed
1145
1146
          x-etsi-mec-origin-type: String
      type: object
Muhammad Hamza's avatar
Muhammad Hamza committed
1147
1148
      x-etsi-mec-cardinality: "1"

Elian Kraja's avatar
Elian Kraja committed
1149
1150
1151
    DevInfoSubscription:
      properties:
        _links:
Muhammad Hamza's avatar
Muhammad Hamza committed
1152
          $ref: "#/components/schemas/DevInfoSubscription.links"
Elian Kraja's avatar
Elian Kraja committed
1153
1154
1155
1156
        callbackReference:
          description: URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response.
          format: uri
          type: string
Muhammad Hamza's avatar
Muhammad Hamza committed
1157
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1158
1159
1160
1161
1162
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
1163
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
1164
        filterCriteriaDevInfo:
Muhammad Hamza's avatar
Muhammad Hamza committed
1165
          $ref: "#/components/schemas/DevInfoSubscription.filterCriteriaDevInfo"
Elian Kraja's avatar
Elian Kraja committed
1166
1167
1168
        subscriptionType:
          description: Shall be set to "DevInfoSubscription".
          type: string
Muhammad Hamza's avatar
Muhammad Hamza committed
1169
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1170
1171
          x-etsi-mec-origin-type: String
      required:
Muhammad Hamza's avatar
Muhammad Hamza committed
1172
1173
1174
        - subscriptionType
        - callbackReference
        - filterCriteriaDevInfo
Elian Kraja's avatar
Elian Kraja committed
1175
1176
      type: object
      x-etsi-ref: 6.3.3
Muhammad Hamza's avatar
Muhammad Hamza committed
1177

Elian Kraja's avatar
Elian Kraja committed
1178
    DeviceInfo.deviceStatus:
Muhammad Hamza's avatar
Muhammad Hamza committed
1179
1180
1181
1182
1183
1184
1185
1186
1187
      description: "Current operational status of the device. Enumeration of: 1 = Up. 2 = Initializing. 3 = Error. 4 = Disabled."
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
Elian Kraja's avatar
Elian Kraja committed
1188
1189
1190
    DeviceInfo:
      properties:
        deviceId:
Muhammad Hamza's avatar
Muhammad Hamza committed
1191
          description: "Typically, the serial number of the device.This value shall remain fixed over the lifetime of the device, including across firmware updates."
piscione's avatar
piscione committed
1192
1193
1194
          type: array
          items:
            type: string
1195
          x-etsi-mec-cardinality: 0..1
Elian Kraja's avatar
Elian Kraja committed
1196
1197
          x-etsi-mec-origin-type: String
        deviceStatus:
Muhammad Hamza's avatar
Muhammad Hamza committed
1198
          $ref: "#/components/schemas/DeviceInfo.deviceStatus"
Elian Kraja's avatar
Elian Kraja committed
1199
1200
1201
1202
        downloadDiagnostics:
          # description': The result of a HTTP and FTP DownloadDiagnostics Test.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': DownloadDiagnostics
Muhammad Hamza's avatar
Muhammad Hamza committed
1203
          $ref: "#/components/schemas/DownloadDiagnostics"
Elian Kraja's avatar
Elian Kraja committed
1204
        gwId:
Muhammad Hamza's avatar
Muhammad Hamza committed
1205
1206
          description:
            "Information (typically the serial number) to identify an Internet Gateway Device through which
Elian Kraja's avatar
Elian Kraja committed
1207
1208
1209
1210

            the customer premises device is connected.


Muhammad Hamza's avatar
Muhammad Hamza committed
1211
            This value shall remain fixed over the lifetime of the device, including across firmware updates."
Elian Kraja's avatar
Elian Kraja committed
1212
1213
1214
1215
1216
1217
1218
1219
1220
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        iPConnectionUpTime:
          description: The time in seconds that the IP interface has been connected.
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
1221
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1222
1223
1224
1225
1226
          x-etsi-mec-origin-type: Integer
        iPPingDiagnostics:
          # description': The result of an IP-layer ping test.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': IPPingDiagnostics
Muhammad Hamza's avatar
Muhammad Hamza committed
1227
          $ref: "#/components/schemas/IPPingDiagnostics"
Elian Kraja's avatar
Elian Kraja committed
1228
1229
1230
1231
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
1232
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
1233
1234
1235
        totalBytesReceived:
          description: Total number of IP payload bytes received since the device was last restarted.
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
1236
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1237
1238
1239
1240
          x-etsi-mec-origin-type: Integer
        totalBytesSent:
          description: Total number of IP payload bytes sent since the device was last restarted.
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
1241
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1242
1243
1244
1245
          x-etsi-mec-origin-type: Integer
        totalPacketsReceived:
          description: Total number of packets received since the device was last restarted.
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
1246
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1247
1248
1249
1250
          x-etsi-mec-origin-type: Integer
        totalPacketsSent:
          description: Total number of packets sent since the device was last restarted.
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
1251
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1252
1253
1254
1255
1256
          x-etsi-mec-origin-type: Integer
        traceRouteDiagnostics:
          # description': The result of an IP-layer trace-route test.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TraceRouteDiagnostics
Muhammad Hamza's avatar
Muhammad Hamza committed
1257
          $ref: "#/components/schemas/TraceRouteDiagnostics"
Elian Kraja's avatar
Elian Kraja committed
1258
1259
1260
        upTime:
          description: Time in seconds since the device was last restarted.
          type: integer
Muhammad Hamza's avatar
Muhammad Hamza committed
1261
          x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1262
1263
1264
1265
1266
          x-etsi-mec-origin-type: Integer
        uploadDiagnostics:
          # description': The result of a HTTP and FTP UploadDiagnostics Test.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': UploadDiagnostics
Muhammad Hamza's avatar
Muhammad Hamza committed
1267
          $ref: "#/components/schemas/UploadDiagnostics"
Elian Kraja's avatar
Elian Kraja committed
1268
      required:
Muhammad Hamza's avatar
Muhammad Hamza committed
1269
1270
1271
1272
1273
1274
1275
1276
        - gwId
        - deviceStatus
        - upTime
        - iPConnectionUpTime
        - totalBytesSent
        - totalBytesReceived
        - totalPacketsSent
        - totalPacketsReceived
Elian Kraja's avatar
Elian Kraja committed
1277
1278
1279
      type: object
      x-etsi-ref: 6.2.3
    DownloadDiagnostics.diagnosticsState:
Muhammad Hamza's avatar
Muhammad Hamza committed
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
      description: "The state of the HTTP and FTP download test. Enumeration of:1 = None.2 = Requested.3 = Completed.4 = Error_InitConnectionFailed.5 = Error_NoResponse.6 = Error_TransferFailed. 7 = Error_PasswordRequestFailed.8 = Error_LoginFailed.9 = Error_NoTransferMode.10 = Error_NoPASV.11 = Error_IncorrectSize.12 = Error_Timeout."
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
      type: integer
      x-etsi-mec-cardinality: "1"
      x-etsi-mec-origin-type: Enum
Elian Kraja's avatar
Elian Kraja committed
1297
1298
1299
1300
1301
1302
    DownloadDiagnostics:
      properties:
        bOMTime:
          # description': Begin of transmission time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
1303
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
1304
        diagnosticsState:
Muhammad Hamza's avatar
Muhammad Hamza committed
1305
          $ref: "#/components/schemas/DownloadDiagnostics.diagnosticsState"
Elian Kraja's avatar
Elian Kraja committed
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
        downloadURI:
          description: The URI for the device to perform the download on.
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        eOMTime:
          # description': End of transmission in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
1316
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
1317
1318
1319
1320
        rOMTime:
          # description': Request time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
1321
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
1322
1323
1324
1325
        tCPOpenReponseTime:
          # description': Response time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
1326
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
1327
1328
1329
1330
        tCPOpenRequestTime:
          # description': Request time in UTC, which shall be specified to microsecond precision.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
1331
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
        testBytesReceived:
          description: The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        totalBytesReceived:
          description: The total number of bytes received on the Interface between bOMTime and eOMTime.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
      required:
Muhammad Hamza's avatar
Muhammad Hamza committed
1343
        - diagnosticsState
Elian Kraja's avatar
Elian Kraja committed
1344
1345
1346
      type: object
      x-etsi-ref: 6.5.6
    ExpiryNotification.links:
Muhammad Hamza's avatar
Muhammad Hamza committed
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
      description: List of hyperlinks related to the resource.
      properties:
        self:
          description: Self referring URI. This shall be included in the response from the FAIS. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
          format: uri
          type: string
          x-etsi-mec-cardinality: "1"
          x-etsi-mec-origin-type: URI
      required:
        - self
      type: object
      x-etsi-mec-cardinality: "1"
Elian Kraja's avatar
Elian Kraja committed
1359
1360
1361
    ExpiryNotification:
      properties:
        _links:
Muhammad Hamza's avatar
Muhammad Hamza committed
1362
          $ref: "#/components/schemas/ExpiryNotification.links"
Elian Kraja's avatar
Elian Kraja committed
1363
1364
1365
1366
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
1367
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
1368
1369
1370
1371
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
Muhammad Hamza's avatar
Muhammad Hamza committed
1372
          $ref: "#/components/schemas/TimeStamp"
Elian Kraja's avatar
Elian Kraja committed
1373
      required:
Muhammad Hamza's avatar
Muhammad Hamza committed
1374
1375
        - _links
        - expiryDeadline
Elian Kraja's avatar
Elian Kraja committed
1376
1377
      type: object
      x-etsi-ref: 6.4.5