MEC029_FAI.json 92.3 KB
Newer Older
Muhammad Hamza's avatar
Muhammad Hamza committed
1
{
2
3
4
5
6
7
8
9
  "openapi": "3.1.0",
  "info": {
    "title": "ETSI GS MEC 029 Fixed Access Information API",
    "version": "2.2.1",
    "description": "ETSI GS MEC 029 Fixed Access Information API described using OpenAPI.",
    "license": {
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
Muhammad Hamza's avatar
Muhammad Hamza committed
10
    },
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
    "contact": {
      "name": "ETSI Forge",
      "email": "cti_support@etsi.org",
      "url": "https://forge.etsi.org/rep/mec/gs029-fai-api"
    }
  },
  "externalDocs": {
    "description": "ETSI GS MEC 029 Fixed Access Information API, v2.2.1",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.02.01_60/gs_mec029v020201p.pdf"
  },
  "servers": [
    {
      "url": "https://localhost/fai/v1"
    }
  ],
  "tags": [
    {
piscione's avatar
piscione committed
28
29
      "name": "Queries",
      "description": "APIs for Device and fa_info"
Muhammad Hamza's avatar
Muhammad Hamza committed
30
    },
31
    {
piscione's avatar
piscione committed
32
33
      "name": "Subscription",
      "description": "Subscription API"
34
35
    },
    {
piscione's avatar
piscione committed
36
37
      "name": "Cable line info",
      "description": "Cable line info API"
38
39
    },
    {
piscione's avatar
piscione committed
40
41
      "name": "Optical network info",
      "description": "Optican network Info API"
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
    }
  ],
  "paths": {
    "/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": [
          {
            "in": "query",
            "name": "customerPremisesInfo",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/CpInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
61
62
              }
            },
63
64
65
66
67
68
69
70
71
72
73
            "required": false,
            "description": "Comma separated list of customer premises information"
          },
          {
            "in": "query",
            "name": "lastMileTech",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer"
              }
Muhammad Hamza's avatar
Muhammad Hamza committed
74
            },
75
76
77
78
79
80
81
82
83
84
85
            "required": false,
            "description": "Comma separated list of last mile technologies."
          },
          {
            "in": "query",
            "name": "interfaceType",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer"
              }
Muhammad Hamza's avatar
Muhammad Hamza committed
86
            },
87
88
89
90
91
92
93
94
95
96
            "description": "Comma separated list of interface types."
          },
          {
            "in": "query",
            "name": "dsbw",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer"
              }
Muhammad Hamza's avatar
Muhammad Hamza committed
97
            },
98
99
100
101
102
103
104
105
106
107
108
            "required": false,
            "description": "Comma separated list of the bandwidth (in Mbps) from the network towards the customer site."
          },
          {
            "in": "query",
            "name": "usbw",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer"
              }
Muhammad Hamza's avatar
Muhammad Hamza committed
109
            },
110
111
112
113
114
115
116
117
118
119
120
            "required": false,
            "description": "Comma separated list of the bandwidth (in Mbps) from the customer site towards the network."
          },
          {
            "in": "query",
            "name": "latency",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer"
              }
Muhammad Hamza's avatar
Muhammad Hamza committed
121
            },
122
123
            "required": false,
            "description": "Comma separated list of the maximum baseline latency (in ms) between customer site and service edge node."
Muhammad Hamza's avatar
Muhammad Hamza committed
124
          }
125
126
127
128
129
130
131
132
133
134
        ],
        "responses": {
          "200": {
            "description": "A response body containing the FAI is returned. ",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/FaInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
135
136
137
138
                  }
                }
              }
            }
139
140
141
142
143
144
145
146
147
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
Muhammad Hamza's avatar
Muhammad Hamza committed
148
149
          }
        }
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
      }
    },
    "/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": [
          {
            "in": "query",
            "name": "gwId",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
Muhammad Hamza's avatar
Muhammad Hamza committed
168
169
              }
            },
170
171
172
173
174
175
176
177
178
179
180
            "required": false,
            "description": "Comma separated list of gateway identifier"
          },
          {
            "in": "query",
            "name": "deviceId",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
Muhammad Hamza's avatar
Muhammad Hamza committed
181
            },
182
183
184
185
186
187
188
189
190
191
192
            "required": false,
            "description": "Comma separated list of device identifier."
          },
          {
            "in": "query",
            "name": "deviceStatus",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer"
              }
Muhammad Hamza's avatar
Muhammad Hamza committed
193
            },
194
            "description": "Comma separated list of device status."
Muhammad Hamza's avatar
Muhammad Hamza committed
195
          }
196
197
198
199
200
201
202
203
204
205
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing the information of zero or more devices is returned.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/DeviceInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
206
207
208
209
                  }
                }
              }
            }
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
          },
          "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"
Muhammad Hamza's avatar
Muhammad Hamza committed
228
229
          }
        }
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
      }
    },
    "/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": [
          {
            "in": "query",
            "name": "customerPremisesInfo",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/CpInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
248
249
              }
            },
250
251
252
253
254
255
256
257
258
259
260
            "required": false,
            "description": "Comma separated list of customer premises information"
          },
          {
            "in": "query",
            "name": "cmId",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
Muhammad Hamza's avatar
Muhammad Hamza committed
261
            },
262
263
            "required": false,
            "description": "Comma separated list of Cable Modem identifiers."
Muhammad Hamza's avatar
Muhammad Hamza committed
264
          }
265
266
267
268
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing the information of zero or more cable lines is returned.",
Muhammad Hamza's avatar
Muhammad Hamza committed
269
270
271
            "content": {
              "application/json": {
                "schema": {
272
                  "$ref": "#/components/schemas/CableLineInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
273
274
275
276
                }
              }
            }
          },
277
278
          "400": {
            "$ref": "#/components/responses/400"
Muhammad Hamza's avatar
Muhammad Hamza committed
279
          },
280
281
282
283
284
285
286
287
288
289
290
291
292
293
          "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"
Muhammad Hamza's avatar
Muhammad Hamza committed
294
295
          }
        }
296
297
298
299
300
301
302
303
304
305
      }
    },
    "/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",
Muhammad Hamza's avatar
Muhammad Hamza committed
306
307
        "parameters": [
          {
308
309
            "in": "query",
            "name": "customerPremisesInfo",
Muhammad Hamza's avatar
Muhammad Hamza committed
310
            "schema": {
311
312
313
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/CpInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
314
315
              }
            },
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
            "required": false,
            "description": "Comma separated list of customer premises information"
          },
          {
            "in": "query",
            "name": "ponYS_ID",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false,
            "description": "Comma separated list of optical system identifiers."
          },
          {
            "in": "query",
            "name": "onuId",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
Muhammad Hamza's avatar
Muhammad Hamza committed
339
            },
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
            "required": false,
            "description": "Comma separated list of optical network unit identifiers."
          }
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing the information of zero or more optical networks is returned",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$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": [
          {
            "in": "query",
            "name": "subscription_type",
            "schema": {
              "type": "string"
Muhammad Hamza's avatar
Muhammad Hamza committed
393
            },
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
            "required": false,
            "description": "Query parameter to filter on a specific subscription type. Permitted values onu_alarm Optical Network Unit alarm  device_abnormal_alert Device abnormal alert - cm_connectivity_state Cable Modem connectivity state - ani_alarm Access Node Interface alarm"
          }
        ],
        "responses": {
          "200": {
            "description": "A response body containing the list of links to requestor subscriptions is returned.",
            "content": {
              "application/json": {
                "schema": {
                  "$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": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/OnuAlarmSubscription"
                  },
                  {
                    "$ref": "#/components/schemas/DevInfoSubscription"
                  },
                  {
                    "$ref": "#/components/schemas/CmConnSubscription"
                  },
                  {
                    "$ref": "#/components/schemas/AniAlarmSubscription"
                  }
                ]
              }
Muhammad Hamza's avatar
Muhammad Hamza committed
456
457
458
            }
          }
        },
459
460
461
        "responses": {
          "201": {
            "description": "In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type.",
Muhammad Hamza's avatar
Muhammad Hamza committed
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/OnuAlarmSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/DevInfoSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/CmConnSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/AniAlarmSubscription"
                    }
                  ]
                }
              }
            }
          },
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
          "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}": {
              "post": {
                "summary": "Callback POST used to send a notification",
                "description": "A notification from FAIS.",
                "operationId": "notificationPOST",
                "requestBody": {
                  "description": "Subscription notification",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
                        "oneOf": [
                          {
                            "$ref": "#/components/schemas/OnuAlarmNotification"
                          },
                          {
                            "$ref": "#/components/schemas/DevInfoNotification"
                          },
                          {
                            "$ref": "#/components/schemas/CmConnNotification"
                          },
                          {
                            "$ref": "#/components/schemas/AniAlarmNotification"
                          }
                        ]
Muhammad Hamza's avatar
Muhammad Hamza committed
535
                      }
536
537
538
539
540
541
                    }
                  }
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
piscione's avatar
piscione committed
542
543
544
                  },
                  "400": {
                    "$ref": "#/components/responses/400"
Muhammad Hamza's avatar
Muhammad Hamza committed
545
546
547
548
549
550
551
552
                  }
                }
              }
            }
          }
        }
      }
    },
553
554
555
556
557
558
559
560
    "/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"
Muhammad Hamza's avatar
Muhammad Hamza committed
561
          },
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
          "required": true
        }
      ],
      "get": {
        "tags": [
          "Subscription"
        ],
        "summary": "Retrieve information about this subscription.",
        "description": "Retrieve information about this subscription.",
        "operationId": "individualSubscriptionGET",
        "responses": {
          "200": {
            "description": "A response body containing data type describing the specific FAI event subscription is returned",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/OnuAlarmSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/DevInfoSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/CmConnSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/AniAlarmSubscription"
                    }
                  ]
                }
              }
Muhammad Hamza's avatar
Muhammad Hamza committed
594
595
            }
          },
596
597
          "400": {
            "$ref": "#/components/responses/400"
Muhammad Hamza's avatar
Muhammad Hamza committed
598
          },
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
          "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"
          }
        }
      },
      "put": {
        "tags": [
          "Subscription"
        ],
        "summary": "Used to update the existing subscription.",
        "description": "Used to update the existing subscription.",
        "operationId": "individualSubscriptionPUT",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/OnuAlarmSubscription"
                  },
                  {
                    "$ref": "#/components/schemas/DevInfoSubscription"
                  },
                  {
                    "$ref": "#/components/schemas/CmConnSubscription"
                  },
                  {
                    "$ref": "#/components/schemas/AniAlarmSubscription"
                  }
                ]
Muhammad Hamza's avatar
Muhammad Hamza committed
642
643
644
645
              }
            }
          }
        },
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
        "responses": {
          "200": {
            "description": "A response body containing data type describing the updated subscription is returned",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/OnuAlarmSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/DevInfoSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/CmConnSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/AniAlarmSubscription"
                    }
                  ]
                }
Muhammad Hamza's avatar
Muhammad Hamza committed
667
668
669
              }
            }
          },
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
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
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
          "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"
          }
        }
      },
      "delete": {
        "tags": [
          "Subscription"
        ],
        "summary": "Used to cancel the existing subscription.",
        "description": "Used to cancel the existing subscription.",
        "operationId": "individualSubscriptionDELETE",
        "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"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AniAlarmNotification.alarm": {
        "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"
      },
      "AniAlarmNotification.aniId": {
        "properties": {
          "onuId": {
            "description": "The unique identifiers for the optical network unit.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "aniIndex": {
            "description": "The index of an access network interface supported by the optical network unit.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
754
        },
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
        "required": [
          "onuId",
          "aniIndex"
        ]
      },
      "AniAlarmNotification": {
        "properties": {
          "alarm": {
            "$ref": "#/components/schemas/AniAlarmNotification.alarm"
          },
          "aniId": {
            "$ref": "#/components/schemas/AniAlarmNotification.aniId"
          },
          "customerPremisesInfo": {
            "description": "The physical location of the related customer sites.",
            "items": {
              "$ref": "#/components/schemas/CpInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
772
            },
773
774
775
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "CpInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
776
          },
777
778
779
780
781
782
783
784
785
786
787
788
          "notificationType": {
            "description": "Shall be set to \"AniAlarmNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "onuId": {
            "type": "string"
          },
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
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
        "required": [
          "notificationType",
          "aniIndex",
          "alarm"
        ],
        "type": "object",
        "x-etsi-ref": "6.4.6"
      },
      "AniAlarmSubscription.filterCriteriaAniAlarm.alarms": {
        "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"
      },
      "AniAlarmSubscription.links": {
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
817
        },
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
        "required": [
          "self"
        ]
      },
      "AniAlarmSubscription.filterCriteriaAniAlarm": {
        "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.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CpInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
838
            },
839
840
841
842
843
844
845
            "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": {
Muhammad Hamza's avatar
Muhammad Hamza committed
846
              "type": "string",
847
              "x-etsi-mec-cardinality": "1..N",
Muhammad Hamza's avatar
Muhammad Hamza committed
848
849
850
              "x-etsi-mec-origin-type": "String"
            }
          },
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
          "aniId": {
            "description": "",
            "type": "object",
            "required": [
              "onuId",
              "aniIndex"
            ],
            "properties": {
              "onuId": {
                "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"
Muhammad Hamza's avatar
Muhammad Hamza committed
866
867
868
              }
            }
          },
869
870
871
872
          "alarms": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm.alarms"
Muhammad Hamza's avatar
Muhammad Hamza committed
873
            }
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
          }
        }
      },
      "AniAlarmSubscription": {
        "properties": {
          "subscriptionType": {
            "description": "Shall be set to \\\"AniAlarmSubscription\\\"",
            "type": "string"
          },
          "_links": {
            "$ref": "#/components/schemas/AniAlarmSubscription.links"
          },
          "aniIndex": {
            "description": "The index of an access network interface supported by the optical network unit.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Muhammad Hamza's avatar
Muhammad Hamza committed
891
          },
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
          "callbackReference": {
            "description": "URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "URI"
          },
          "requestTestNotification": {
            "description": "Shall be set to TRUE by the service consumer to request",
            "type": "boolean"
          },
          "websockNotifConfig": {
            "description": "Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
            "$ref": "#/components/schemas/WebsockNotifConfig"
          },
          "expiryDeadline": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "filterCriteriaAniAlarm": {
            "$ref": "#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
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
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
        "required": [
          "subscriptionType",
          "callbackReference",
          "filterCriteriaAniAlarm",
          "onuId",
          "aniIndex"
        ],
        "type": "object",
        "x-etsi-ref": "6.3.6"
      },
      "CableLineInfo.cmStatus": {
        "description": "It provides CM connectivity status information of the CM.",
        "type": "object",
        "required": [
          "ifIndex",
          "cmRegState",
          "resets",
          "lostSyncs",
          "invalidRegRsps",
          "energyMgt1x1OperStatus",
          "emDlsOperStatus"
        ],
        "properties": {
          "ifIndex": {
            "description": "It denotes the MAC Domain interface index of the CM.",
            "type": "string"
          },
          "cmRegState": {
            "type": "integer",
            "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. 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
            ]
          },
          "resets": {
            "description": "It denotes the number of times the CM reset or initialized this interface.",
            "type": "integer"
          },
          "lostSyncs": {
            "description": "It denotes the number of times the CM lost synchronization with the downstream channel.",
            "type": "integer"
          },
          "invalidRegRsps": {
            "description": "It denotes the number of times the CM received invalid registration response messages.",
            "type": "integer"
          },
          "energyMgt1x1OperStatus": {
            "description": "It indicates whether the CM is currently operating in Energy Management 1x1 Mode.",
            "type": "boolean"
          },
          "emDlsOperStatus": {
            "description": "It indicates whether the CM is currently operating in Energy Management DLS Mode.",
            "type": "boolean"
          }
        }
      },
      "CableLineInfo.cmDpvStats": {
        "required": [
          "ifIndex",
          "lastMeasLatency",
          "lastMeasTime",
          "minLatency",
          "maxLatency",
          "avgLatency",
          "numMeas"
        ],
        "properties": {
          "ifIndex": {
            "description": "It represents the interface Index of the Downstream Interface where the measurements are taken.",
            "type": "string"
          },
          "lastMeasLatency": {
            "description": "The last latency measurement",
            "type": "integer"
          },
          "lastMeasTime": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "minLatency": {
            "description": "The minimum latency measurement.",
            "type": "integer"
          },
          "maxLatency": {
            "description": "The maximum latency measurement.",
            "type": "integer"
          },
          "avgLatency": {
            "description": "The average latency measurement.",
            "type": "integer"
          },
          "numMeas": {
            "description": "The number of latency measurements made.",
            "type": "integer"
          }
        }
      },
      "CableLineInfo.serviceFlowStats.serviceFlowInfo": {
        "type": "object",
        "required": [
          "serviceFlowId",
          "description",
          "timeCreated",
          "timeActive",
          "policedDropPkts",
          "policedDelayPkts",
          "aqmDroppedPkts"
        ],
        "properties": {
          "serviceFlowId": {
            "description": "It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.",
            "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"
          },
          "timeCreated": {
            "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.",
            "$ref": "#/components/schemas/TimeStamp"
          },
          "timeActive": {
            "description": "FIt indicates the number of seconds that the service flow has been active",
            "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 1) exceeding the selected Buffer Size for the service flow; or 2) UGS packets dropped due to exceeding the Unsolicited Grant Size with a Request/Transmission policy that requires such packets to be dropped.",
            "type": "integer"
          },
          "policedDelayPkts": {
            "description": "It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate.",
            "type": "integer"
          },
          "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"
          }
        }
      },
      "CableLineInfo.serviceFlowStats": {
        "type": "object",
        "required": [
          "ifIndex",
          "serviceFlowInfo"
        ],
piscione's avatar
piscione committed
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
        "properties": {
          "ifIndex": {
            "description": "It represents the interface index of the MAC Domain of the Service Flow.",
            "type": "string"
          },
          "serviceFlowInfo": {
            "description": "It represents the information of a Service Flow.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CableLineInfo.serviceFlowStats.serviceFlowInfo"
            }
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
          }
        }
      },
      "CableLineInfo": {
        "type": "object",
        "required": [
          "customerPremisesInfo",
          "cmId"
        ],
        "properties": {
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
Muhammad Hamza's avatar
Muhammad Hamza committed
1103
          },
1104
1105
          "customerPremisesInfo": {
            "$ref": "#/components/schemas/CpInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
1106
          },
1107
1108
1109
          "cmId": {
            "type": "string",
            "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 the device, including across firmware updates."
Muhammad Hamza's avatar
Muhammad Hamza committed
1110
          },
1111
1112
          "cmStatus": {
            "$ref": "#/components/schemas/CableLineInfo.cmStatus"
Muhammad Hamza's avatar
Muhammad Hamza committed
1113
          },
1114
1115
1116
1117
1118
1119
          "cmDpvStats": {
            "$ref": "#/components/schemas/CableLineInfo.cmDpvStats"
          },
          "serviceFlowStats": {
            "$ref": "#/components/schemas/CableLineInfo.serviceFlowStats"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1120
        },
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
        "x-etsi-ref": "6.2.4"
      },
      "CmConnNotification.cmIf.cmRegState": {
        "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. 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
        ],
        "type": "integer"
      },
      "CmConnNotification.cmIf": {
        "description": "",
        "properties": {
          "cmId": {
            "description": "The Cable Modem identifier.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Muhammad Hamza's avatar
Muhammad Hamza committed
1158
          },
1159
1160
1161
1162
1163
1164
1165
1166
          "cmRegState": {
            "items": {
              "$ref": "#/components/schemas/CmConnNotification.cmIf.cmRegState"
            },
            "minItems": 1,
            "type": "array",
            "x-etsi-mec-cardinality": "1..N",
            "x-etsi-mec-origin-type": "Enum"
Muhammad Hamza's avatar
Muhammad Hamza committed
1167
          },
1168
1169
1170
1171
          "ifIndex": {
            "description": "The MAC Domain interface index of the CM.",
            "items": {
              "type": "string"
Muhammad Hamza's avatar
Muhammad Hamza committed
1172
            },
1173
1174
1175
1176
1177
            "minItems": 1,
            "type": "array",
            "x-etsi-mec-cardinality": "1..N",
            "x-etsi-mec-origin-type": "String"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1178
        },
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
        "required": [
          "cmId",
          "ifIndex",
          "cmRegState"
        ]
      },
      "CmConnNotification": {
        "required": [
          "notificationType",
          "cmIf"
        ],
        "properties": {
          "cmIf": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CmConnNotification.cmIf"
Muhammad Hamza's avatar
Muhammad Hamza committed
1195
1196
            }
          },
1197
1198
1199
1200
1201
1202
1203
1204
          "customerPremisesInfo": {
            "$ref": "#/components/schemas/CpInfo"
          },
          "notificationType": {
            "description": "Shall be set to \\\"CmconnNotification\\\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Muhammad Hamza's avatar
Muhammad Hamza committed
1205
          },
1206
1207
1208
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1209
        },
1210
1211
1212
1213
1214
1215
1216
1217
1218
        "type": "object",
        "x-etsi-ref": "6.4.4"
      },
      "CmConnSubscription.links": {
        "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1219
        },
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
        "required": [
          "self"
        ],
        "type": "object",
        "x-etsi-mec-cardinality": "0..1"
      },
      "CmConnSubscription.filterCriteriaCmConn.cmIf.cmRegState": {
        "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": [
          1,
          2,
          3,
          4,
          5,
          6,
          7,
          8,
          9,
          10,
          11,
          12,
          13,
          14,
          15,
          16,
          17,
          18,
          19,
          20,
          21
        ],
        "type": "integer"
      },
      "CmConnSubscription.filterCriteriaCmConn.cmIf": {
        "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"
Muhammad Hamza's avatar
Muhammad Hamza committed
1261
          },
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
          "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"
Muhammad Hamza's avatar
Muhammad Hamza committed
1275
            },
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
            "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"
Muhammad Hamza's avatar
Muhammad Hamza committed
1295
1296
            }
          },
1297
1298
1299
          "customerPremisesInfo": {
            "$ref": "#/components/schemas/CpInfo"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1300
        },
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
        "type": "object",
        "x-etsi-mec-cardinality": "1"
      },
      "CmConnSubscription": {
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/CmConnSubscription.links"
          },
          "callbackReference": {
            "description": "URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "URI"
Muhammad Hamza's avatar
Muhammad Hamza committed
1315
          },
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
          "requestTestNotification": {
            "description": "Shall be set to TRUE by the service consumer to request",
            "type": "boolean"
          },
          "websockNotifConfig": {
            "description": "Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
            "$ref": "#/components/schemas/WebsockNotifConfig"
          },
          "expiryDeadline": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "filterCriteriaCmConn": {
            "$ref": "#/components/schemas/CmConnSubscription.filterCriteriaCmConn"
          },
          "subscriptionType": {
            "description": "Shall be set to \"CmConnSubscription\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1336
        },
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
        "required": [
          "subscriptionType",
          "filterCriteriaCmConn"
        ],
        "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": {
            "description": "Latitude (DATUM=WGS84) -90 to 90 in decimal degree format DDD.ddd",
            "format": "Float",
            "type": "number",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Float"
          },
          "longitude": {
            "description": "Longitude (DATUM=WGS84) -180 to 180 in decimal degree format DDD.ddd",
            "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"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1367
        },
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
        "type": "object",
        "x-etsi-ref": "6.5.3"
      },
      "DevInfoNotification": {
        "properties": {
          "deviceErrStatus": {
            "$ref": "#/components/schemas/deviceErrStatus"
          },
          "deviceId": {
            "description": "The identifier for a device.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "notificationType": {
            "description": "Shall be set to \"DevInfoNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Muhammad Hamza's avatar
Muhammad Hamza committed
1387
          },
1388
1389
1390
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1391
        },
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
        "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": {
            "$ref": "#/components/schemas/LinkType"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1414
        },
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
        "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"
Muhammad Hamza's avatar
Muhammad Hamza committed
1427
            },
1428
1429
1430
1431
1432
1433
1434
1435
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "Enum"
          },
          "deviceId": {
            "description": "The device identifier.",
            "items": {
              "type": "string"
Muhammad Hamza's avatar
Muhammad Hamza committed
1436
            },
1437
1438
1439
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "String"
Muhammad Hamza's avatar
Muhammad Hamza committed
1440
          },
1441
1442
1443
1444
1445
1446
1447
1448
1449
          "gwId": {
            "description": "The identifier of an Internet Gateway Device through which the customer premises device is connected.",
            "items": {
              "type": "string"
            },
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "String"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1450
        },
1451
1452
1453
1454
1455
1456
1457
        "type": "object",
        "x-etsi-mec-cardinality": "1"
      },
      "DevInfoSubscription": {
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/DevInfoSubscription.links"
Muhammad Hamza's avatar
Muhammad Hamza committed
1458
          },
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
          "callbackReference": {
            "description": "URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "URI"
          },
          "requestTestNotification": {
            "description": "Shall be set to TRUE by the service consumer to request",
            "type": "boolean"
          },
          "websockNotifConfig": {
            "description": "Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
            "$ref": "#/components/schemas/WebsockNotifConfig"
          },
          "expiryDeadline": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "filterCriteriaDevInfo": {
            "$ref": "#/components/schemas/DevInfoSubscription.filterCriteriaDevInfo"
          },
          "subscriptionType": {
            "description": "Shall be set to \"DevInfoSubscription\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1486
        },
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
        "required": [
          "subscriptionType",
          "callbackReference",
          "filterCriteriaDevInfo"
        ],
        "type": "object",
        "x-etsi-ref": "6.3.3"
      },
      "DeviceInfo.deviceStatus": {
        "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"
      },
      "DeviceInfo": {
        "properties": {
          "deviceId": {
            "description": "Typically, the serial number of the device.This value shall remain fixed over the lifetime of the device, including across firmware updates.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "deviceStatus": {
            "$ref": "#/components/schemas/DeviceInfo.deviceStatus"
          },
          "downloadDiagnostics": {
            "$ref": "#/components/schemas/DownloadDiagnostics"
          },
          "gwId": {
            "description": "Information (typically the serial number) to identify an Internet Gateway Device through which the customer premises device is connected. This value shall remain fixed over the lifetime of the device, including across firmware updates.",
            "items": {
              "type": "string"
Muhammad Hamza's avatar
Muhammad Hamza committed
1525
            },
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
            "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",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "iPPingDiagnostics": {
            "$ref": "#/components/schemas/IPPingDiagnostics"
          },
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "totalBytesReceived": {
            "description": "Total number of IP payload bytes received since the device was last restarted.",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "totalBytesSent": {
            "description": "Total number of IP payload bytes sent since the device was last restarted.",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "totalPacketsReceived": {
            "description": "Total number of packets received since the device was last restarted.",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "totalPacketsSent": {
            "description": "Total number of packets sent since the device was last restarted.",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "traceRouteDiagnostics": {
            "$ref": "#/components/schemas/TraceRouteDiagnostics"
Muhammad Hamza's avatar
Muhammad Hamza committed
1569
          },
1570
1571
1572
1573
1574
1575
1576
1577
1578
          "upTime": {
            "description": "Time in seconds since the device was last restarted.",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "uploadDiagnostics": {
            "$ref": "#/components/schemas/UploadDiagnostics"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1579
        },
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
        "required": [
          "gwId",
          "deviceId",
          "deviceStatus",
          "upTime",
          "iPConnectionUpTime",
          "totalBytesSent",
          "totalBytesReceived",
          "totalPacketsSent",
          "totalPacketsReceived"
        ],
        "type": "object",
        "x-etsi-ref": "6.2.3"
      },
      "DownloadDiagnostics.diagnosticsState": {
        "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"
      },
      "DownloadDiagnostics": {
        "properties": {
          "bOMTime": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "diagnosticsState": {
            "$ref": "#/components/schemas/DownloadDiagnostics.diagnosticsState"
          },
          "downloadURI": {
            "description": "The URI for the device to perform the download on.",
            "format": "uri",
piscione's avatar
piscione committed
1625
            "type": "string",
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "URI"
          },
          "eOMTime": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "rOMTime": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "tCPOpenReponseTime": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "tCPOpenRequestTime": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "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"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1653
        },
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
        "required": [
          "diagnosticsState"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.6"
      },
      "ExpiryNotification.links": {
        "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",
piscione's avatar
piscione committed
1666
            "type": "string",
1667
1668
1669
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "URI"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1670
        },
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
        "required": [
          "self"
        ],
        "type": "object",
        "x-etsi-mec-cardinality": "1"
      },
      "ExpiryNotification": {
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/ExpiryNotification.links"
Muhammad Hamza's avatar
Muhammad Hamza committed
1681
          },
1682
1683
          "expiryDeadline": {
            "$ref": "#/components/schemas/TimeStamp"
Muhammad Hamza's avatar
Muhammad Hamza committed
1684
          },
1685
1686
1687
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1688
        },
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
        "required": [
          "_links",
          "expiryDeadline"
        ],
        "type": "object",
        "x-etsi-ref": "6.4.5"
      },
      "FaInfo.connectivityInfo.interfaceType": {
        "description": "The physical interface used for the end customer site:1   =   100BASE-TX.2   =   1000BASE-TX.3   =   1000BASE-LX.4   =   1000BASELX10.5   =   1000BASEBX10. 6   =   1000BASE-LH.7   =   1000Base-ZX. 8   =   ADSL-RJ11.9   =   VDSL-RJ11.10 =   GPON.",
        "enum": [
          1,
          2,
          3,
          4,
          5,
          6,
          7,
          8,
          9,
          10
        ],
        "type": "integer",
        "x-etsi-mec-cardinality": "1",
        "x-etsi-mec-origin-type": "Enum"
      },
      "FaInfo.connectivityInfo.lastMileTech": {
        "description": "An informative field identifying the last mile access technology used.The valid values are:1 = ADSL.2 = VDSL.3 = GPON. 4 = XGPON.5 = NGPON2. 6 = XGSPON. 7 = GFAST.8 = P2PEthernet.",
        "enum": [
          1,
          2,
          3,
          4,
          5,
          6,
          7,
          8
        ],
        "type": "integer",
        "x-etsi-mec-cardinality": "1",
        "x-etsi-mec-origin-type": "Enum"
      },
      "FaInfo.connectivityInfo": {
        "description": "The per connectivity domain FAI as defined below.",
        "properties": {
          "dsbw": {
            "description": "The bandwidth (in Mbps) from the network towards the customer site.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "interfaceType": {
            "$ref": "#/components/schemas/FaInfo.connectivityInfo.interfaceType"
          },
          "lastMileTech": {
            "$ref": "#/components/schemas/FaInfo.connectivityInfo.lastMileTech"
          },
          "latency": {
            "description": "Maximum baseline latency (in ms) between customer site and service edge node.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "usbw": {
            "description": "The bandwidth (in Mbps) from the customer site towards the network.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Integer"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1757
        },
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
        "required": [
          "lastMileTech",
          "interfaceType"
        ]
      },
      "FaInfo": {
        "properties": {
          "connectivityInfo": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FaInfo.connectivityInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
1769
1770
            }
          },
1771
1772
1773
1774
          "customerPremisesInfo": {
            "description": "The physical location of a customer site.",
            "items": {
              "$ref": "#/components/schemas/CpInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
1775
            },
1776
1777
1778
1779
            "minItems": 1,
            "type": "array",
            "x-etsi-mec-cardinality": "1..N",
            "x-etsi-mec-origin-type": "CpInfo"
Muhammad Hamza's avatar
Muhammad Hamza committed
1780
          },
1781
1782
1783
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1784
        },
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
        "type": "object",
        "required": [
          "customerPremisesInfo"
        ],
        "x-etsi-ref": "6.2.2"
      },
      "IPPingDiagnostics.diagnosticsState": {
        "description": "The state of the IP ping test. Enumeration of: 1 = None. 2 = Requested. 3 = Complete. 4 = Error_CannotResolveHostName. 5 = Error_Internal.6 = Error_Other.",
        "enum": [
          1,
          2,
          3,
          4,
          5,
          6
        ],
        "type": "integer",
        "x-etsi-mec-cardinality": "1",
        "x-etsi-mec-origin-type": "Enum"
      },
      "IPPingDiagnostics": {
        "properties": {
          "averageResponseTime": {
            "description": "Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test.\n\nIf there were no successful responses, this value shall be zero.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "dataBlockSize": {
            "description": "Size of the data block in bytes to be sent for each ping.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "diagnosticsState": {
            "$ref": "#/components/schemas/IPPingDiagnostics.diagnosticsState"
          },
          "failureCount": {
            "description": "Result parameter indicating the number of failed pings in the most recent ping test.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "host": {
            "description": "Host name or address of the host to ping.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
Muhammad Hamza's avatar
Muhammad Hamza committed
1833
          },
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
          "maximumResponseTime": {
            "description": "Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test.\n\nIf there were no successful responses, this value shall be zero.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "minimumResponseTime": {
            "description": "Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test.\n\nIf there were no successful responses, this value shall be zero.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "numberOfRepetitions": {
            "description": "Number of repetitions of the ping test to perform before reporting the results.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "successCount": {
            "description": "Result parameter indicating the number of successful\npings (those in which a successful response was received prior to the timeout) in the most recent ping test.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "timeout": {
            "description": "Timeout in milliseconds for the ping test.",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Integer"
          }
Muhammad Hamza's avatar
Muhammad Hamza committed
1864
        },
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
        "required": [
          "diagnosticsState"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.4"
      },
      "OnuAlarmNotification.alarm": {
        "description": "Indicates the alarm of the ONU:0  = EquipmentAlarm.1  = PoweringAlarm.2  = BatteryMissing.3  = BatteryFailure.4  = BatteryLow.5  = PhysicalIntrusion. 6  = OnuSelfTestFailure. 7  = DyingGasp. 8  = TemperatureYellow.9  = TemperatureRed.10 = VoltageYellow.11 = VoltageRed.12 = OnuManualPowerOff. 13 = InvImage.14 = PseOverloadYellow.15 = PseOverloadRed.",
        "enum": [
          0,
          1,
          2,
          3,
          4,
          5,
          6,
          7,
          8,
          9,
          10,
          11,
          12,
          13,
          14,
          15
        ],
        "type": "integer",
        "x-etsi-mec-cardinality": "1",
        "x-etsi-mec-origin-type": "Enum"
      },
      "OnuAlarmNotification": {
        "properties": {
          "alarm": {
            "$ref": "#/components/schemas/OnuAlarmNotification.alarm"
Muhammad Hamza's avatar
Muhammad Hamza committed
1899
          },
1900
1901
1902
1903
          "customerPremisesInfo": {
            "description": "The physical location of the related customer sites.",
            "items": {
              "$ref": "#/components/schemas/CpInfo"