Newer
Older
"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"
"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": [
{
"name": "Queries"
{
"name": "Subscription"
},
{
"name": "Cable line info"
},
{
"name": "Optical network info"
}
],
"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"
"required": false,
"description": "Comma separated list of customer premises information"
},
{
"in": "query",
"name": "lastMileTech",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
"required": false,
"description": "Comma separated list of last mile technologies."
},
{
"in": "query",
"name": "interfaceType",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
"description": "Comma separated list of interface types."
},
{
"in": "query",
"name": "dsbw",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
"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"
}
"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"
}
"required": false,
"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. ",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FaInfo"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
}
},
"/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"
"required": false,
"description": "Comma separated list of gateway identifier"
},
{
"in": "query",
"name": "deviceId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
"required": false,
"description": "Comma separated list of device identifier."
},
{
"in": "query",
"name": "deviceStatus",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
"description": "Comma separated list of device status."
],
"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"
},
"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": [
{
"in": "query",
"name": "customerPremisesInfo",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CpInfo"
"required": false,
"description": "Comma separated list of customer premises information"
},
{
"in": "query",
"name": "cmId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
"required": false,
"description": "Comma separated list of Cable Modem identifiers."
],
"responses": {
"200": {
"description": "Upon success, a response body containing the information of zero or more cable lines is returned.",
"content": {
"application/json": {
"schema": {
"$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",
"in": "query",
"name": "customerPremisesInfo",
"type": "array",
"items": {
"$ref": "#/components/schemas/CpInfo"
"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"
}
336
337
338
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
"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"
390
391
392
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
"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"
}
]
}
"responses": {
"201": {
"description": "In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/OnuAlarmSubscription"
},
{
"$ref": "#/components/schemas/DevInfoSubscription"
},
{
"$ref": "#/components/schemas/CmConnSubscription"
},
{
"$ref": "#/components/schemas/AniAlarmSubscription"
}
]
}
}
}
},
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
"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"
}
]
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
}
}
}
}
}
}
}
},
"/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"
555
556
557
558
559
560
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
"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"
}
]
}
}
"400": {
"$ref": "#/components/responses/400"
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
"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"
}
]
"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"
}
]
}
663
664
665
666
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
"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"
}
"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"
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "CpInfo"
"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"
}
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
"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"
}
"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"
"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": {
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
}
},
"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"
"alarms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm.alarms"
}
}
},
"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"
"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"
}
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"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": {