From 6696d307fef3453d3f55e5715a78698ff327092d Mon Sep 17 00:00:00 2001 From: Gabriele Scivoletto Date: Fri, 5 Jan 2024 17:49:48 +0100 Subject: [PATCH] updated MEC029 --- MEC029/SRV/FAIS/PlatFixedAcessInfo.robot | 68 +- MEC029/SRV/FAIS/environment/variables.txt | 4 +- .../SRV/FAIS/jsons/OnuAlarmSubscription.json | 35 + .../FAIS/jsons/OnuAlarmSubscriptionError.json | 35 + .../jsons/OnuAlarmSubscriptionUpdate.json | 35 + .../OnuAlarmSubscriptionUpdateError.json | 35 + .../FAIS/schemas/CableLineInfo.schema.json | 273 +++++++ .../SRV/FAIS/schemas/DeviceInfo.schema.json | 581 +++++++++++++++ MEC029/SRV/FAIS/schemas/FaInfo.schema.json | 133 ++++ .../schemas/OnuAlarmSubscription.schema.json | 672 ++++++++++++++++++ MEC029/SRV/FAIS/schemas/PonInfo.schema.json | 130 ++++ .../schemas/SubscriptionLinkList.schema.json | 63 ++ 12 files changed, 2031 insertions(+), 33 deletions(-) diff --git a/MEC029/SRV/FAIS/PlatFixedAcessInfo.robot b/MEC029/SRV/FAIS/PlatFixedAcessInfo.robot index aa2b87a..b3ca073 100644 --- a/MEC029/SRV/FAIS/PlatFixedAcessInfo.robot +++ b/MEC029/SRV/FAIS/PlatFixedAcessInfo.robot @@ -21,7 +21,7 @@ TC_MEC_MEC029_SRV_FAIS_001_OK ... Check that the IUT responds with the current status of the fixed access information ... when queried by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.3.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.3.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get fixed access information details @@ -34,7 +34,7 @@ TC_MEC_MEC029_SRV_FAIS_001_BR ... Check that the IUT responds with an error when ... a request with incorrect parameters is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.3.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.3.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get fixed access information details using query prameters interface ${INTERFACE_ID} @@ -46,7 +46,7 @@ TC_MEC_MEC029_SRV_FAIS_001_NF ... Check that the IUT responds with an error when ... a request for non-existing data is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.3.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.3.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get fixed access information details using query prameters interfaceType ${NON_EXISTENT_INTERFACE_ID} @@ -58,7 +58,7 @@ TC_MEC_MEC029_SRV_FAIS_002_OK ... Check that the IUT responds with the current status of the device information ... when queried by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.4.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.4.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get status of device information @@ -71,7 +71,7 @@ TC_MEC_MEC029_SRV_FAIS_002_BR ... Check that the IUT responds with an error when ... a request with incorrect parameters is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.4.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.4.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get status of device information using query prameters device ${DEVICE_ID} @@ -83,7 +83,7 @@ TC_MEC_MEC029_SRV_FAIS_002_NF ... Check that the IUT responds with an error when ... a request for non-existing data is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.4.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.4.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get status of device information using query prameters deviceId ${NON_EXISTENT_DEVICE_ID} @@ -95,7 +95,7 @@ TC_MEC_MEC029_SRV_FAIS_003_OK ... Check that the IUT responds with the current status of the cable line information ... when queried by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.5.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.5.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get status of the cable line information @@ -108,7 +108,7 @@ TC_MEC_MEC029_SRV_FAIS_003_BR ... Check that the IUT responds with an error when ... a request with incorrect parameters is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.5.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.5.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get status of the cable line information using query parameters cm ${CABLE_MODEM_ID} @@ -120,7 +120,7 @@ TC_MEC_MEC029_SRV_FAIS_003_NF ... Check that the IUT responds with an error when ... a request for non-existing data is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.5.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.5.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get status of the cable line information using query parameters cmId ${NON_EXISTING_FAI_CM_ID} @@ -132,7 +132,7 @@ TC_MEC_MEC029_SRV_FAIS_004_OK ... Check that the IUT responds with the current status of the optical network information ... when queried by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.6.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.6.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get status of the opentical network information @@ -145,7 +145,7 @@ TC_MEC_MEC029_SRV_FAIS_004_BR ... Check that the IUT responds with an error when ... a request with incorrect parameters is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.6.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.6.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get status of the opentical network information using query parameters onu ${ONU_ID} @@ -157,7 +157,7 @@ TC_MEC_MEC029_SRV_FAIS_004_NF ... Check that the IUT responds with an error when ... a request for non-existing data is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.6.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.6.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get status of the opentical network information using query parameters onuId ${NON_EXISTING_FAI_ONU_ID} @@ -169,7 +169,7 @@ TC_MEC_MEC029_SRV_FAIS_005_OK ... Check that the IUT responds with the subscriptions for fixed access information notifications ... when queried by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.7.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.7.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get list of subscriptions @@ -182,7 +182,7 @@ TC_MEC_MEC029_SRV_FAIS_005_BR ... Check that the IUT responds with an error when ... a request with incorrect parameters is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.7.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.7.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get list of subscriptions using query parameters subscription ${SUBSCRIPTION_TYPE} @@ -194,7 +194,7 @@ TC_MEC_MEC029_SRV_FAIS_005_NF ... Check that the IUT responds with an error when ... a request for non-existing data is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.7.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.7.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get list of subscriptions using query parameters subscriptionType ${NON_EXISTENT_SUBSCRIPTION_TYPE} @@ -206,14 +206,13 @@ TC_MEC_MEC029_SRV_FAIS_006_OK ... Check that the IUT acknowledges the subscription by a MEC Application ... to notifications on Optical Network Unit alarm events ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.7.3.4 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.7.3.4 [Tags] PIC_MEC_PLAT PIC_SERVICES Create a new subscription OnuAlarmSubscription Check HTTP Response Status Code Is 201 Check HTTP Response Body Json Schema Is OnuAlarmSubscription - Check Result Contains ${response['body']['OnuAlarmSubscription']} subscriptionType OnuAlarmSubscription - + Should Be Equal As Strings ${response['body']['subscriptionType']} OnuAlarmSubscription TC_MEC_MEC029_SRV_FAIS_006_BR @@ -221,7 +220,7 @@ TC_MEC_MEC029_SRV_FAIS_006_BR ... Check that the IUT responds with an error when ... a request with incorrect parameters is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.7.3.4 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.7.3.4 [Tags] PIC_MEC_PLAT PIC_SERVICES Create a new subscription OnuAlarmSubscriptionError @@ -233,13 +232,13 @@ TC_MEC_MEC029_SRV_FAIS_007_OK ... Check that the IUT responds with the information on a given subscription ... when queried by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.8.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.8.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get an individual subscription ${ONU_ALARM_SUBSCRIPTION_ID} Check HTTP Response Status Code Is 200 Check HTTP Response Body Json Schema Is OnuAlarmSubscription - Check Result Contains ${response['body']['OnuAlarmSubscription']} subscriptionType OnuAlarmSubscription + Should Be Equal As Strings ${response['body']['subscriptionType']} OnuAlarmSubscription TC_MEC_MEC029_SRV_FAIS_007_NF @@ -247,7 +246,7 @@ TC_MEC_MEC029_SRV_FAIS_007_NF ... Check that the IUT responds with an error when ... a request for an unknown URI is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.8.3.1 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.8.3.1 [Tags] PIC_MEC_PLAT PIC_SERVICES Get an individual subscription ${NON_ESISTENT_SUBSCRIPTION_ID} @@ -259,13 +258,13 @@ TC_MEC_MEC029_SRV_FAIS_008_OK ... Check that the IUT updates an existing subscription ... when commanded by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.8.3.2 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.8.3.2 [Tags] PIC_MEC_PLAT PIC_SERVICES Update subscription ${ONU_ALARM_SUBSCRIPTION_ID} OnuAlarmSubscriptionUpdate Check HTTP Response Status Code Is 200 Check HTTP Response Body Json Schema Is OnuAlarmSubscription - Check Result Contains ${response['body']['OnuAlarmSubscription']} subscriptionType OnuAlarmSubscription + Should Be Equal As Strings ${response['body']['subscriptionType']} OnuAlarmSubscription TC_MEC_MEC029_SRV_FAIS_008_BR @@ -273,7 +272,7 @@ TC_MEC_MEC029_SRV_FAIS_008_BR ... Check that the IUT responds with an error when ... a request with incorrect parameters is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.8.3.2 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.8.3.2 [Tags] PIC_MEC_PLAT PIC_SERVICES Update subscription ${ONU_ALARM_SUBSCRIPTION_ID} OnuAlarmSubscriptionUpdateError @@ -285,7 +284,7 @@ TC_MEC_MEC029_SRV_FAIS_008_NF ... Check that the IUT responds with an error when ... a request for an unknown URI is sent by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.8.3.2 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.8.3.2 [Tags] PIC_MEC_PLAT PIC_SERVICES Update subscription ${NON_ESISTENT_SUBSCRIPTION_ID} OnuAlarmSubscriptionUpdate @@ -297,7 +296,7 @@ TC_MEC_MEC029_SRV_FAIS_008_PF ... Check that the IUT responds with an error when ... a request sent by a MEC Application doesn't comply with a required condition ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.8.3.2 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.8.3.2 [Tags] PIC_MEC_PLAT PIC_SERVICES Update subscription using invalid etag ${ONU_ALARM_SUBSCRIPTION_ID} OnuAlarmSubscriptionUpdate @@ -309,7 +308,7 @@ TC_MEC_MEC029_SRV_FAIS_009_OK ... Check that the IUT cancels an existing subscription ... when commanded by a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.8.3.5 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.8.3.5 [Tags] PIC_MEC_PLAT PIC_SERVICES Remove subscription ${ONU_ALARM_SUBSCRIPTION_ID} @@ -321,7 +320,7 @@ TC_MEC_MEC029_SRV_FAIS_010_OK ... Check that the IUT sends notification on expiry of Fixed Access Information event subscription ... to a MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 7.7.3.4 + ... Reference ETSI GS MEC 029 V2.2.1, clause 7.7.3.4 [Tags] PIC_MEC_PLAT PIC_SERVICES ${json}= Get File schemas/DevInfoSubscription.schema.json @@ -341,7 +340,7 @@ TC_MEC_MEC029_SRV_FAIS_011_OK ... Check that the IUT sends notifications on Fixed Access Information events ... to a subscribed MEC Application ... - ... Reference ETSI GS MEC 029 V2.1.1, clause 5.2.7 + ... Reference ETSI GS MEC 029 V2.2.1, clause 5.2.7 [Tags] PIC_MEC_PLAT PIC_SERVICES ${json}= Get File schemas/OnuAlarmSubscription.schema.json @@ -460,7 +459,7 @@ Update subscription Set Headers {"Authorization":"${TOKEN}"} ${file}= Catenate SEPARATOR= jsons/ ${content} .json ${body}= Get File ${file} - Post ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId} ${body} + Put ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId} ${body} ${output}= Output response Set Suite Variable ${response} ${output} @@ -468,6 +467,13 @@ Update subscription Update subscription using invalid etag [Arguments] ${subscriptionId} ${content} Set Headers {"If-Match": "${INVALID_ETAG}"} + Set Headers {"Content-Type":"application/json"} + Set Headers {"Authorization":"${TOKEN}"} + ${file}= Catenate SEPARATOR= jsons/ ${content} .json + ${body}= Get File ${file} + Put ${apiRoot}/${apiName}/${apiVersion}/subscriptions/${subscriptionId} ${body} + ${output}= Output response + Set Suite Variable ${response} ${output} Remove subscription [Arguments] ${subscriptionId} diff --git a/MEC029/SRV/FAIS/environment/variables.txt b/MEC029/SRV/FAIS/environment/variables.txt index 698f298..e84f497 100644 --- a/MEC029/SRV/FAIS/environment/variables.txt +++ b/MEC029/SRV/FAIS/environment/variables.txt @@ -1,8 +1,8 @@ *** Variables *** # Generic variables ${SCHEMA} http -${HOST} 10.192.2.172 -${PORT} 8081 +${HOST} mockoon +${PORT} 3004 ${response} {} ${TOKEN} Basic YWxhZGRpbjpvcGVuc2VzYW1l ${apiRoot} diff --git a/MEC029/SRV/FAIS/jsons/OnuAlarmSubscription.json b/MEC029/SRV/FAIS/jsons/OnuAlarmSubscription.json index e69de29..46db685 100644 --- a/MEC029/SRV/FAIS/jsons/OnuAlarmSubscription.json +++ b/MEC029/SRV/FAIS/jsons/OnuAlarmSubscription.json @@ -0,0 +1,35 @@ +{ + "subscriptionType": "OnuAlarmSubscription", + "filterCriteriaOnuAlarm": { + "alarms": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -1], + "customerPremisesInfo": [ + { + "latitude": 37.7749, + "longitude": -122.4194, + "postalCode": "94105" + }, + { + "latitude": 40.7128, + "longitude": -74.0060, + "postalCode": "10001" + } + ], + "onuId": ["ABC123", "DEF456"] + }, + "_links": { + "self": { + "href": "https://example.com/resource/123" + } + }, + "callbackReference": "https://client/callback", + "requestTestNotification": true, + "websockNotifConfig": { + "subscriptionType": "ws://example.com/notification", + "requestWebsocketUri": true + }, + "expiryDeadline": { + "seconds": 1641398400, + "nanoSeconds": 0 + } + } + \ No newline at end of file diff --git a/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionError.json b/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionError.json index e69de29..69c9163 100644 --- a/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionError.json +++ b/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionError.json @@ -0,0 +1,35 @@ +{ + "subscriptionType": "OnuAlarmSubscriptionError", + "filterCriteriaOnuAlarm": { + "alarms": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -1], + "customerPremisesInfo": [ + { + "latitude": 37.7749, + "longitude": -122.4194, + "postalCode": "94105" + }, + { + "latitude": 40.7128, + "longitude": -74.0060, + "postalCode": "10001" + } + ], + "onuId": ["ABC123", "DEF456"] + }, + "_links": { + "self": { + "href": "https://example.com/resource/123" + } + }, + "callbackReference": "https://client/callback", + "requestTestNotification": true, + "websockNotifConfig": { + "subscriptionType": "ws://example.com/notification", + "requestWebsocketUri": true + }, + "expiryDeadline": { + "seconds": 1641398400, + "nanoSeconds": 0 + } + } + \ No newline at end of file diff --git a/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionUpdate.json b/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionUpdate.json index e69de29..46db685 100644 --- a/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionUpdate.json +++ b/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionUpdate.json @@ -0,0 +1,35 @@ +{ + "subscriptionType": "OnuAlarmSubscription", + "filterCriteriaOnuAlarm": { + "alarms": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -1], + "customerPremisesInfo": [ + { + "latitude": 37.7749, + "longitude": -122.4194, + "postalCode": "94105" + }, + { + "latitude": 40.7128, + "longitude": -74.0060, + "postalCode": "10001" + } + ], + "onuId": ["ABC123", "DEF456"] + }, + "_links": { + "self": { + "href": "https://example.com/resource/123" + } + }, + "callbackReference": "https://client/callback", + "requestTestNotification": true, + "websockNotifConfig": { + "subscriptionType": "ws://example.com/notification", + "requestWebsocketUri": true + }, + "expiryDeadline": { + "seconds": 1641398400, + "nanoSeconds": 0 + } + } + \ No newline at end of file diff --git a/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionUpdateError.json b/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionUpdateError.json index e69de29..69c9163 100644 --- a/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionUpdateError.json +++ b/MEC029/SRV/FAIS/jsons/OnuAlarmSubscriptionUpdateError.json @@ -0,0 +1,35 @@ +{ + "subscriptionType": "OnuAlarmSubscriptionError", + "filterCriteriaOnuAlarm": { + "alarms": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -1], + "customerPremisesInfo": [ + { + "latitude": 37.7749, + "longitude": -122.4194, + "postalCode": "94105" + }, + { + "latitude": 40.7128, + "longitude": -74.0060, + "postalCode": "10001" + } + ], + "onuId": ["ABC123", "DEF456"] + }, + "_links": { + "self": { + "href": "https://example.com/resource/123" + } + }, + "callbackReference": "https://client/callback", + "requestTestNotification": true, + "websockNotifConfig": { + "subscriptionType": "ws://example.com/notification", + "requestWebsocketUri": true + }, + "expiryDeadline": { + "seconds": 1641398400, + "nanoSeconds": 0 + } + } + \ No newline at end of file diff --git a/MEC029/SRV/FAIS/schemas/CableLineInfo.schema.json b/MEC029/SRV/FAIS/schemas/CableLineInfo.schema.json index e69de29..18c9bfc 100644 --- a/MEC029/SRV/FAIS/schemas/CableLineInfo.schema.json +++ b/MEC029/SRV/FAIS/schemas/CableLineInfo.schema.json @@ -0,0 +1,273 @@ +{ + "type": "object", + "required": [ + "customerPremisesInfo", + "cmId" + ], + "properties": { + "timeStamp": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "customerPremisesInfo": { + "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" + } + }, + "type": "object", + "x-etsi-ref": "6.5.3" + }, + "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." + }, + "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" + } + } + }, + "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": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "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" + } + } + }, + "serviceFlowStats": { + "type": "object", + "required": [ + "ifIndex", + "serviceFlowInfo" + ], + "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": { + "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.", + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "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" + } + } + } + } + } + } + }, + "x-etsi-ref": "6.2.4" + } \ No newline at end of file diff --git a/MEC029/SRV/FAIS/schemas/DeviceInfo.schema.json b/MEC029/SRV/FAIS/schemas/DeviceInfo.schema.json index e69de29..a868cb1 100644 --- a/MEC029/SRV/FAIS/schemas/DeviceInfo.schema.json +++ b/MEC029/SRV/FAIS/schemas/DeviceInfo.schema.json @@ -0,0 +1,581 @@ +{ + "type": "array", + "items": { + "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": { + "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" + }, + "downloadDiagnostics": { + "properties": { + "bOMTime": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "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" + }, + "downloadURI": { + "description": "The URI for the device to perform the download on.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + }, + "eOMTime": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "rOMTime": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "tCPOpenReponseTime": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "tCPOpenRequestTime": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "testBytesReceived": { + "description": "The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Integer" + }, + "totalBytesReceived": { + "description": "The total number of bytes received on the Interface between bOMTime and eOMTime.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Integer" + } + }, + "required": [ + "diagnosticsState" + ], + "type": "object", + "x-etsi-ref": "6.5.6" + }, + "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" + }, + "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": { + "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": { + "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" + }, + "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" + }, + "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" + } + }, + "required": [ + "diagnosticsState" + ], + "type": "object", + "x-etsi-ref": "6.5.4" + }, + "timeStamp": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "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": { + "properties": { + "dataBlockSize": { + "description": "Size of the data block in bytes to be sent for each trace route.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Integer" + }, + "diagnosticsState": { + "description": "The state of the IP trace-route test. Enumeration of: 1 = None. 2 = Requested. 3 = Complete. 4 = Error_CannotResolveHostName. 5 = Error_MaxHopCountExceeded. 6 = Error_Internal. 7 = Error_Other.", + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7 + ], + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, + "host": { + "description": "Host name or address of the host to find a route to.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "maxHopCount": { + "description": "The maximum number of hop used in outgoing probe packets. The default is 30 hops.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Integer" + }, + "numberOfRouteHops": { + "description": "Result parameter indicating the number of hops within the discovered route.\n\nIf a route could not be determined, this value shall be zero.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Integer" + }, + "responseTime": { + "description": "Result parameter indicating the response time in milliseconds the most recent trace route test.\n\nIf a route could not be determined, this value shall be zero.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Integer" + }, + "timeout": { + "description": "Timeout in milliseconds for the trace route test.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Integer" + } + }, + "required": [ + "diagnosticsState" + ], + "type": "object", + "x-etsi-ref": "6.5.5" + }, + "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": { + "properties": { + "bOMTime": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "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_PasswordRequestFailed. 7 = Error_LoginFailed. 8 = Error_NoTransferMode. 9 = Error_NoPASV. 10 = Error_NoCWD. 11 = Error_NoSTOR.12 = Error_NoTransferComplete.", + "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" + }, + "eOMTime": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "rOMTime": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "tCPOpenReponseTime": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "tCPOpenRequestTime": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "testBytesSent": { + "description": "The test traffic sent 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" + }, + "testFileLength": { + "description": "The size of the file (in bytes) to be uploaded to the\nserver.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Integer" + }, + "uploadURI": { + "description": "The URI for the device to perform the upload to.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + } + }, + "required": [ + "diagnosticsState" + ], + "type": "object", + "x-etsi-ref": "6.5.7" + } + }, + "required": [ + "gwId", + "deviceId", + "deviceStatus", + "upTime", + "iPConnectionUpTime", + "totalBytesSent", + "totalBytesReceived", + "totalPacketsSent", + "totalPacketsReceived" + ], + "type": "object", + "x-etsi-ref": "6.2.3" + } + } \ No newline at end of file diff --git a/MEC029/SRV/FAIS/schemas/FaInfo.schema.json b/MEC029/SRV/FAIS/schemas/FaInfo.schema.json index e69de29..76fae66 100644 --- a/MEC029/SRV/FAIS/schemas/FaInfo.schema.json +++ b/MEC029/SRV/FAIS/schemas/FaInfo.schema.json @@ -0,0 +1,133 @@ +{ + "type": "array", + "items": { + "properties": { + "connectivityInfo": { + "type": "array", + "items": { + "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": { + "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" + }, + "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" + }, + "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" + } + }, + "required": [ + "lastMileTech", + "interfaceType" + ] + } + }, + "customerPremisesInfo": { + "description": "The physical location of a customer site.", + "items": { + "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" + } + }, + "type": "object", + "x-etsi-ref": "6.5.3" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "CpInfo" + }, + "timeStamp": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + } + }, + "type": "object", + "required": [ + "customerPremisesInfo" + ], + "x-etsi-ref": "6.2.2" + } +} \ No newline at end of file diff --git a/MEC029/SRV/FAIS/schemas/OnuAlarmSubscription.schema.json b/MEC029/SRV/FAIS/schemas/OnuAlarmSubscription.schema.json index e69de29..88840d2 100644 --- a/MEC029/SRV/FAIS/schemas/OnuAlarmSubscription.schema.json +++ b/MEC029/SRV/FAIS/schemas/OnuAlarmSubscription.schema.json @@ -0,0 +1,672 @@ +{ + "oneOf": [ + { + "properties": { + "_links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "description": "'URI referring to a resource'", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "The URI referring to the subscription.", + "type": "string", + "format": "uri" + } + } + } + }, + "required": [ + "self" + ], + "type": "object", + "x-etsi-mec-cardinality": "0..1" + }, + "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.", + "type": "object", + "properties": { + "subscriptionType": { + "description": "Set by FAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.", + "type": "string", + "format": "uri" + }, + "requestWebsocketUri": { + "description": "Set to true by the service consumer to indicate that Websocket delivery is requested.", + "type": "boolean" + } + } + }, + "expiryDeadline": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "filterCriteriaOnuAlarm": { + "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": { + "alarms": { + "items": { + "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 =\tEquipmentAlarm.\n\t(Functional failure on an internal interface.)\n1 =\tPoweringAlarm.\n\t(Loss of external power to battery backup unit. This alarm is typically derived through an external interface to a battery backup unit, and indicates that AC is no longer available to maintain battery charge.)\n2 =\tBatteryMissing.\n\t(Battery is provisioned but missing.)\n3 =\tBatteryFailure.\n\t(Battery is provisioned and present but cannot recharge.)\n4 =\tBatteryLow.\n\t(Battery is provisioned and present but its voltage is too low.)\n5 =\tPhysicalIntrusion.\n\t(Applies if the ONU supports detection such as door or box open.)\n6 =\tOnuSelfTestFailure.\n\t(ONU has failed autonomous self-test.)\n7 =\tDyingGasp.\n\t(ONU is powering off imminently due to loss of power to the ONU itself.)\n8 =\tTemperatureYellow.\n\t(No service shutdown at present, but the circuit pack is operating beyond its recommended range.)\n9 =\tTemperatureRed.\n\t(Some services have been shut down to avoid equipment damage.)\n10 =\tVoltageYellow.\n\t(No service shutdown at present, but the line power voltage is below its recommended minimum.)\n11 =\tVoltageRed.\n\t(Some services have been shut down to avoid power collapse.)\n12 =\tOnuManualPowerOff.\n\t(The ONU is shutting down because the subscriber has turned off its power switch.)\n13 =\tInvImage.\n\t(Software image is invalid.)\n14 =\tPseOverloadYellow.\n\t(Indicates that the ONU is nearing its maximum ability to supply the known PoE demand of the attached PDs. The thresholds for declaring and clearing this alarm are vendor-specific.)\n15 =\tPseOverloadRed.\n\t(Indicates that the ONU is unable to supply all of the PoE demand of the attached PDs and has removed or reduced power to at least one PD.)\n-1 =\tAll.", + "enum": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + -1 + ], + "type": "integer" + }, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Enum" + }, + "customerPremisesInfo": { + "description": "0 to N physical locations of the customer sites.", + "items": { + "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" + } + }, + "type": "object", + "x-etsi-ref": "6.5.3" + }, + "type": "array", + "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.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "onuId" + ], + "type": "object", + "x-etsi-mec-cardinality": "1" + }, + "subscriptionType": { + "description": "Shall be set to \\\"OnuAlarmSubscription\\\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "subscriptionType", + "filterCriteriaOnuAlarm" + ], + "type": "object", + "x-etsi-ref": "6.3.2" + }, + { + "properties": { + "_links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "description": "'URI referring to a resource'", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "The URI referring to the subscription.", + "type": "string", + "format": "uri" + } + } + } + }, + "required": [ + "self" + ], + "type": "object", + "x-etsi-mec-cardinality": "0..1" + }, + "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.", + "type": "object", + "properties": { + "subscriptionType": { + "description": "Set by FAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.", + "type": "string", + "format": "uri" + }, + "requestWebsocketUri": { + "description": "Set to true by the service consumer to indicate that Websocket delivery is requested.", + "type": "boolean" + } + } + }, + "expiryDeadline": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "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": { + "description": "The abnormal operational status of the device. Enumeration of: 1 = Error. 2 = Disabled.", + "enum": [ + 1, + 2 + ], + "type": "integer" + }, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Enum" + }, + "deviceId": { + "description": "The device identifier.", + "items": { + "type": "string" + }, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "gwId": { + "description": "The identifier of an Internet Gateway Device through which the customer premises device is connected.", + "items": { + "type": "string" + }, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + } + }, + "type": "object", + "x-etsi-mec-cardinality": "1" + }, + "subscriptionType": { + "description": "Shall be set to \"DevInfoSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "subscriptionType", + "callbackReference", + "filterCriteriaDevInfo" + ], + "type": "object", + "x-etsi-ref": "6.3.3" + }, + { + "properties": { + "_links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "description": "'URI referring to a resource'", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "The URI referring to the subscription.", + "type": "string", + "format": "uri" + } + } + } + }, + "required": [ + "self" + ], + "type": "object", + "x-etsi-mec-cardinality": "0..1" + }, + "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.", + "type": "object", + "properties": { + "subscriptionType": { + "description": "Set by FAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.", + "type": "string", + "format": "uri" + }, + "requestWebsocketUri": { + "description": "Set to true by the service consumer to indicate that Websocket delivery is requested.", + "type": "boolean" + } + } + }, + "expiryDeadline": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "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": { + "description": "", + "properties": { + "cmId": { + "description": "The identifier of a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "cmRegState": { + "items": { + "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" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Enum" + }, + "ifIndex": { + "description": "The MAC Domain interface index of the CM.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "cmId", + "ifIndex", + "cmRegState" + ] + } + }, + "customerPremisesInfo": { + "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" + } + }, + "type": "object", + "x-etsi-ref": "6.5.3" + } + }, + "type": "object", + "x-etsi-mec-cardinality": "1" + }, + "subscriptionType": { + "description": "Shall be set to \"CmConnSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "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" + }, + { + "properties": { + "subscriptionType": { + "description": "Shall be set to \\\"AniAlarmSubscription\\\"", + "type": "string" + }, + "_links": { + "properties": { + "self": { + "description": "'URI referring to a resource'", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "The URI referring to the subscription.", + "type": "string", + "format": "uri" + } + } + } + }, + "required": [ + "self" + ] + }, + "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.", + "type": "object", + "properties": { + "subscriptionType": { + "description": "Set by FAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.", + "type": "string", + "format": "uri" + }, + "requestWebsocketUri": { + "description": "Set to true by the service consumer to indicate that Websocket delivery is requested.", + "type": "boolean" + } + } + }, + "expiryDeadline": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "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": { + "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" + } + }, + "type": "object", + "x-etsi-ref": "6.5.3" + }, + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "CpInfo" + }, + "onuId": { + "description": "1 to N unique identifiers for the optical network units. Typical it is the unique serial number for each ONU, which contains the vendor ID and version number. The first four bytes are an ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number, under the control of the ONU vendor.", + "type": "array", + "items": { + "type": "string", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + } + }, + "aniId": { + "description": "", + "type": "object", + "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": { + "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" + } + } + } + } + }, + "required": [ + "subscriptionType", + "callbackReference", + "filterCriteriaAniAlarm", + "onuId", + "aniIndex" + ], + "type": "object", + "x-etsi-ref": "6.3.6" + } + ] + } \ No newline at end of file diff --git a/MEC029/SRV/FAIS/schemas/PonInfo.schema.json b/MEC029/SRV/FAIS/schemas/PonInfo.schema.json index e69de29..8ffbb47 100644 --- a/MEC029/SRV/FAIS/schemas/PonInfo.schema.json +++ b/MEC029/SRV/FAIS/schemas/PonInfo.schema.json @@ -0,0 +1,130 @@ +{ + "type": "array", + "items": { + "properties": { + "timeStamp": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "customerPremisesInfo": { + "description": "The physical location of a customer site.", + "items": { + "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" + } + }, + "type": "object", + "x-etsi-ref": "6.5.3" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "CpInfo" + }, + "ponSYS_ID": { + "description": "The 20-bit identity of the optical system within a certain domain.This is a reference value set by the OSS.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "onuId": { + "description": "Information to identify an Optical Network Unit.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "ponTech": { + "description": "An informative field identifying the optical technology used. The valid values are: 1 = GPON. 2 = XGPON.3 = NGPON2. 4 = XGSPON.", + "enum": [ + 1, + 2, + 3, + 4 + ], + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, + "operationalState": { + "description": "It reports whether the ONU is currently capable of performing its function. Valid values are: 0 = enabled 1 = disabled", + "enum": [ + 0, + 1 + ], + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, + "dsRate": { + "description": "Downstream line rate, valid values are:\n1 =\t2,48832 Gbit/s: G-PON [i.9]; or\nNG-PON2 option 2 [i.8].\n2 =\t9,95328 Gbit/s: XG-PON [i.10]; or\n XGS-PON [i.11]; or\nNG-PON2 option 1 [i.8].", + "enum": [ + 1, + 2 + ], + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, + "usRate": { + "description": "Upstream line rate, valid values are:\n1 =\t1,24416 Gbit/s: G-PON option 1 [i.9].\n2 =\t2,48832 Gbit/s: G-PON option 2 [i.9]; or\nXG-PON [i.10]; or\nNG-PON2 option 2 [i.8].\n3 =\t9,95328 Gbit/s: XGS-PON [i.11]; or\nNG-PON2 option 1 [i.8].", + "enum": [ + 1, + 2, + 3 + ], + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + } + }, + "required": [ + "customerPremisesInfo", + "ponSYS_ID", + "onuId", + "ponTech", + "operationalState", + "dsRate", + "usRate" + ], + "type": "object", + "x-etsi-ref": "6.2.5" + } + } \ No newline at end of file diff --git a/MEC029/SRV/FAIS/schemas/SubscriptionLinkList.schema.json b/MEC029/SRV/FAIS/schemas/SubscriptionLinkList.schema.json index e69de29..e83a836 100644 --- a/MEC029/SRV/FAIS/schemas/SubscriptionLinkList.schema.json +++ b/MEC029/SRV/FAIS/schemas/SubscriptionLinkList.schema.json @@ -0,0 +1,63 @@ +{ + "properties": { + "_links": { + "description": "Hyperlinks related to the resource.", + "type": "object", + "required": [ + "self" + ], + "properties": { + "self": { + "description": "'URI referring to a resource'", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "The URI referring to the subscription.", + "type": "string", + "format": "uri" + } + } + }, + "subscriptions": { + "description": "The service consumer's subscriptions.", + "type": "array", + "items": { + "properties": { + "href": { + "description": "The URI referring to the subscription.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "URI" + }, + "subscriptionType": { + "description": "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in clauses 6.3.2, 6.3.3, 6.3.4 and 6.3.6 \"OnuAlarmSubscription\" \"DevInfoSubscription\" \"CmConnSubscription\" \"AniAlarmSubscription\"", + "enum": [ + "OnuAlarmSubscription", + "DevInfoSubscription", + "CmConnSubscription", + "AniAlarmSubscription\"" + ], + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + } + }, + "required": [ + "href", + "subscriptionType" + ] + } + } + } + } + }, + "required": [ + "_links" + ], + "type": "object", + "x-etsi-ref": "6.3.5" + } \ No newline at end of file -- GitLab