diff --git a/.jenkins.sh b/.jenkins.sh new file mode 100644 index 0000000000000000000000000000000000000000..74d0370875e23476bf3a058ebcb825f7494b3de7 --- /dev/null +++ b/.jenkins.sh @@ -0,0 +1,18 @@ +#!/bin/bash + +specfiles=$(ls | egrep "^[^.]*.(json|yaml)") + +fres=0 +for i in $specfiles ; do + echo "-- Validating and linting OpenAPI file $i..." + swagger-cli validate $i + res=$? + speccy lint "$i" + res2=$? + fres=$(($fres||$res||$res2)) + echo "--- Validator returned $res, linter returned $res2." +done + +echo "-- Final validator returns $fres." +exit $fres + diff --git a/MEC029_FAI.yaml b/MEC029_FAI.yaml new file mode 100644 index 0000000000000000000000000000000000000000..78079e18b0ca4c964ceb880fe94a8d5528106507 --- /dev/null +++ b/MEC029_FAI.yaml @@ -0,0 +1,2100 @@ +info: + title: "ETSI GS MEC 029 Fixed Access Information API" + version: 2.1.1 + description: "ETSI GS MEC 029 Fixed Access Information API described using OpenAPI." + license: + name: BSD-3-Clause + 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.1.1" + url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.01.01_60/gs_mec029v020101p.pdf' +openapi: 3.0.0 +servers: + - url: 'https://localhost/fai/v1' +tags: + - name: Queries + - name: Subscription + +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: + $ref: '#/components/schemas/FaInfo' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '429': + $ref: '#/components/responses/429' + + /queries/device_info: + get: + tags: + - 'Queries' + summary: 'retrieve information on the devices that are connected to a fixed access network.' + description: 'retrieve information on the devices that are connected to a fixed access network.' + operationId: device_infoGET + parameters: + - 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: 'A response body containing the device information is returned' + content: + application/json: + schema: + $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: 'A response body containing the cable line information 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 + 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: 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 + required: false + description: 'Comma separated list of optical network unit identifiers.' + + responses: + '200': + description: 'A response body containing the optical network information 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 + required: false + + description: 'Query parameter to filter on a specific subscription type. Permitted values: ONU_ALARM. DEVICE_ABNORMAL_ALERT. CM_CONNECTIVITY_STATE. ANI_ALARM.' + responses: + '200': + description: 'A response body containing the list of links to requestor subscriptions is returned.' + 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' + '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 + 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' + '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' + '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' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: CpInfo + notificationType: + description: Shall be set to "AniAlarmNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + onuId: + type: string + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + 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: + # description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - self + + + + 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. + minItems: 0 + type: array + items: + $ref: '#/components/schemas/CpInfo' + + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: CpInfo + onuId: + description: '1 to N unique identifiers for the optical network units. Typical it is the unique serial number for each ONU, which contains the vendor ID and version number. The first four bytes are an ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number, under the control of the ONU vendor.' + type: array + items: + type: string + x-etsi-mec-cardinality: '1..N' + x-etsi-mec-origin-type: String + + aniId: + description: '' + type: object + 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 selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + expiryDeadline: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + filterCriteriaAniAlarm: + $ref: '#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm' + required: + - subscriptionType + - callbackReference + - filterCriteriaAniAlarm + - onuId + - aniIndex + type: object + x-etsi-ref: 6.3.6 + + CableLineInfo.cmInfo.serviceFlowStats: + description: 'It describes statistics associated with the Service Flows in a managed device.' + properties: + ifIndex: + description: 'It represents the interface index of the MAC Domain of the Service Flow' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + serviceFlowInfo: + type: array + items: + $ref: '#/components/schemas/CableLineInfo.cmInfo.serviceFlowStats.serviceFlowInfo' + type: object + + required: + - ifIndex + - serviceFlowInfo + + CableLineInfo.cmInfo.serviceFlowStats.serviceFlowInfo: + description: It represents the information of a Service Flow. + properties: + aqmDroppedPkts: + description: For upstream service flows on which AQM is enabled, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to Active Queue Management drop decisions. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + pkts: + description: For outgoing Service Flows, this attribute counts the number of Packet Data PDUs forwarded to this Service Flow. For incoming upstream CMTS service flows, this attribute counts the number of Packet Data PDUs actually received on the Service Flow identified by the SID for which the packet was scheduled. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + policedDelayPkts: + description: It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + policedDropPkts: + description: "For upstream service flows, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to:\n1)\texceeding the selected Buffer Size for the service flow; or\n2)\tUGS packets dropped due to exceeding the Unsolicited Grant Size with a Request/Transmission policy that requires such packets to be dropped." + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + serviceFlowId: + description: It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + timeActive: + description: It indicates the number of seconds that the service flow has been active. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + timeCreated: + # description': It indicates the time when the service flow was created. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - serviceFlowId + - pkts + - timeCreated + - timeActive + - policedDropPkts + - policedDelayPkts + - aqmDroppedPkts + + CableLineInfo.cmInfo.cmStatus.cmRegState: + description: 'It defines the CM connectivity state. Enumeration of: 1 = other. 2 = notReady. 3 = notSynchronized. 4 = phySynchronized. 5 = usParametersAcquired. 6 = rangingComplete. 7 = dhcpV4Complete. 8 = todEstablished. 9 = securityEstablished. 10 = configFileDownloadComplete. 11 = registrationComplete. 12 = operational. 13 = accessDenied. 14 = eaeInProgress. 15 = dhcpv4InProgress. 16 = dhcpv6InProgress. 17 = dhcpV6Complete. 18 = registrationInProgress. 19 = bpiInit. 20 = forwardingDisabled. 21 = dsTopologyResolutionInProgress. 22 = rangingInProgress. 23 = rfMuteAll.' + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + - 13 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + CableLineInfo.cmInfo.cmStatus: + description: It provides CM connectivity status information of the CM. + properties: + cmRegState: + $ref: '#/components/schemas/CableLineInfo.cmInfo.cmStatus.cmRegState' + emDlsOperStatus: + description: It indicates whether the CM is currently operating in Energy Management DLS Mode. + type: boolean + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Boolean + energyMgt1x1OperStatus: + description: It indicates whether the CM is currently operating in Energy Management 1x1 Mode. + type: boolean + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Boolean + ifIndex: + description: It denotes the MAC Domain interface index of the CM. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + invalidRegRsps: + description: It denotes the number of times the CM received invalid registration response messages. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + lostSyncs: + description: It denotes the number of times the CM lost synchronization with the downstream channel. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + resets: + description: It denotes the number of times the CM reset or initialized this interface. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + required: + - ifIndex + - cmRegState + - resets + - lostSyncs + - invalidRegRsps + - energyMgt1x1OperStatus + - emDlsOperStatus + + CableLineInfo.cmInfo.cmDpvStats: + description: It represents the DOCSIS Path Verify Statistics collected in the cable modem device. + properties: + avgLatency: + description: The average latency measurement. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + ifIndex: + description: It represents the interface Index of the Downstream Interface where the measurements are taken. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + lastMeasLatency: + description: The last latency measurement. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + lastMeasTime: + # description': The last measurement time of the last latency measurement. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + maxLatency: + description: The maximum latency measurement. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + minLatency: + description: The minimum latency measurement. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + numMeas: + description: The number of latency measurements made. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + required: + - ifIndex + - lastMeasLatency + - lastMeasTime + - minLatency + - maxLatency + - avgLatency + - numMeas + + CableLineInfo.cmInfo: + description: '' + properties: + cmDpvStats: + type: array + items: + + $ref: '#/components/schemas/CableLineInfo.cmInfo.cmDpvStats' + cmId: + description: 'Information (typically the serial number) to identify a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.This value SHALL remain fixed over the lifetime of thedevice, including across firmware updates.' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + cmStatus: + $ref: '#/components/schemas/CableLineInfo.cmInfo.cmStatus' + serviceFlowStats: + type: array + items: + $ref: '#/components/schemas/CableLineInfo.cmInfo.serviceFlowStats' + + required: + - cmId + + CableLineInfo: + properties: + cmInfo: + $ref: '#/components/schemas/CableLineInfo.cmInfo' + customerPremisesInfo: + # description': The physical location of a customer site. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': CpInfo + $ref: '#/components/schemas/CpInfo' + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + type: object + required: + - customerPremisesInfo + - cmInfo + x-etsi-ref: 6.2.4 + + + + CmConnNotification.cmIf.cmRegState: + description: 'It indicates the CM connectivity state. Enumeration of: 1 = notReady. 2 = notSynchronized. 3 = phySynchronized. 4 = dsTopologyResolutionInProgress.5 = usParametersAcquired. 6 = rangingInProgress.7 = rangingComplete. 8 = eaeInProgress.9 = dhcpv4InProgress. 10 = dhcpv6InProgress.11 = dhcpV4Complete.12 = dhcpV6Complete.13 = todEstablished.14 = securityEstablished.15 = configFileDownloadComplete.16 = registrationInProgress.17 = registrationComplete. 18 = accessDenied. 19 =operational. 20 = bpiInit.21 =forwardingDisabled.' + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + - 13 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + type: integer + + CmConnNotification.cmIf: + description: '' + items: + type: object + properties: + cmId: + description: The Cable Modem identifier. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + cmRegState: + items: + $ref: '#/components/schemas/CmConnNotification.cmIf.cmRegState' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Enum + ifIndex: + description: The MAC Domain interface index of the CM. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + required: + - cmId + - ifIndex + - cmRegState + + CmConnNotification: + required: + - notificationType + - cmIf + properties: + cmIf: + type: array + items: + $ref: '#/components/schemas/CmConnNotification.cmIf' + customerPremisesInfo: + # description': The physical location of a customer site. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': CpInfo + $ref: '#/components/schemas/CpInfo' + notificationType: + description: 'Shall be set to \"CmconnNotification\".' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + type: object + + x-etsi-ref: 6.4.4 + + CmConnSubscription.links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + properties: + self: + # description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - self + type: object + x-etsi-mec-cardinality: 0..1 + + CmConnSubscription.filterCriteriaCmConn.cmIf.cmRegState: + description: 'It indicates the CM connectivity state. Enumeration of: 1 = notReady. 2 = notSynchronized. 3 = phySynchronized. 4 = dsTopologyResolutionInProgress.5 = usParametersAcquired. 6 = rangingInProgress.7 = rangingComplete. 8 = eaeInProgress.9 = dhcpv4InProgress. 10 = dhcpv6InProgress.11 = dhcpV4Complete.12 = dhcpV6Complete.13 = todEstablished.14 = securityEstablished.15 = configFileDownloadComplete.16 = registrationInProgress.17 = registrationComplete. 18 = accessDenied. 19 =operational. 20 = bpiInit.21 =forwardingDisabled.' + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + - 13 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + type: integer + + CmConnSubscription.filterCriteriaCmConn.cmIf: + description: '' + properties: + cmId: + description: The identifier of a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + cmRegState: + items: + $ref: '#/components/schemas/CmConnSubscription.filterCriteriaCmConn.cmIf.cmRegState' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Enum + ifIndex: + description: The MAC Domain interface index of the CM. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + required: + - cmId + - ifIndex + - cmRegState + CmConnSubscription.filterCriteriaCmConn: + description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response. + properties: + + cmIf: + type: array + items: + $ref: '#/components/schemas/CmConnSubscription.filterCriteriaCmConn.cmIf' + customerPremisesInfo: + # description': The physical location of a customer site. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': CpInfo + $ref: '#/components/schemas/CpInfo' + + type: object + x-etsi-mec-cardinality: '1' + + CmConnSubscription: + properties: + _links: + $ref: '#/components/schemas/CmConnSubscription.links' + + callbackReference: + description: URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + expiryDeadline: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + filterCriteriaCmConn: + $ref: '#/components/schemas/CmConnSubscription.filterCriteriaCmConn' + subscriptionType: + description: Shall be set to "CmConnSubscription". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackReference + - filterCriteriaCmConn + type: object + x-etsi-notes: "NOTE:\t'notReady' indicates that the CM has not started the registration process yet.\n\t'notSynchronized' indicates that the CM has not initiated or completed the synchronization of the downstream physical layer.\n\t'phySynchronized' indicates that the CM has completed the synchronization of the downstream physical layer.\n\t'dsTopologyResolutionInProgress' indicates that the CM is attempting to determine its MD-DS-SG.\n\t'usParametersAcquired' indicates that the CM has completed the upstream parameters acquisition or have completed the downstream and upstream service groups resolution.\n\t'rangingInProgress' indicates that the CM has initiated the initial ranging process.\n\t'rangingComplete' indicates that the CM has completed initial ranging and received a Ranging Status of success from the CMTS in the RNG-RSP message.\n\t'eaeInProgress' indicates that the CM has sent an Auth Info message for EAE.\n\t'dhcpv4InProgress' indicates that the CM has sent a DHCPv4 DISCOVER to gain IP connectivity.\n\t'dhcpv6InProgress' indicates that the CM has sent a DHCPv6 Solicit message.\n\t'dhcpv4Complete' indicates that the CM has received a DHCPv4 ACK message from the CMTS.\n\t'dhcpv6Complete' indicates that the CM has received a DHCPv6 Reply message from the CMTS.\n\t'todEstablished' indicates that the CM has successfully acquired time of day.\n\t'securityEstablished' indicates that the CM has successfully completed the BPI initialization process.\n\t'configFileDownloadComplete' indicates that the CM has completed the config file download process.\n\t'registrationInProgress' indicates that the CM has sent a Registration Request.\n\t'registrationComplete' indicates that the CM has successfully completed the Registration process with the CMTS.\n\t'accessDenied' indicates that the CM has received a registration aborted notification from the CMTS.\n\t'operational' indicates that the CM has completed all necessary initialization steps and is operational.\n\t'bpiInit' indicates that the CM has started the BPI initialization process as indicated in the CM config file.\n\t'forwardingDisabled' indicates that the registration process was completed, but the network access option in the received configuration file prohibits forwarding." + x-etsi-ref: 6.3.4 + CpInfo: + properties: + latitude: + description: 'Latitude (DATUM=WGS84) + + -90 to 90 in decimal degree format DDD.ddd' + format: Float + type: number + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Float + longitude: + description: 'Longitude (DATUM=WGS84) + + -180 to 180 in decimal degree format DDD.ddd' + format: Float + type: number + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Float + postalCode: + description: Postal code for the location + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: object + x-etsi-ref: 6.5.3 + DevInfoNotification: + properties: + deviceErrStatus: + $ref: '#/components/schemas/deviceErrStatus' + # x-etsi-mec-cardinality: '1' + # x-etsi-mec-origin-type: Enum + deviceId: + description: The identifier for a device. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + notificationType: + description: Shall be set to "DevInfoNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - notificationType + - deviceId + - deviceErrStatus + type: object + x-etsi-ref: 6.4.3 + + + deviceErrStatus: + description: 'The abnormal operational status of the device. Enumeration of: 1 = Error. 2 = Disabled.' + enum: + - 1 + - 2 + type: integer + + DevInfoSubscription.links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + properties: + self: + # description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - self + type: object + x-etsi-mec-cardinality: 0..1 + + DevInfoSubscription.filterCriteriaDevInfo: + description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response. + properties: + deviceErrStatus: + items: + $ref: '#/components/schemas/deviceErrStatus' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: Enum + deviceId: + description: The device identifier. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + gwId: + description: The identifier of an Internet Gateway Device through which the customer premises device is connected. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + type: object + x-etsi-mec-cardinality: '1' + + DevInfoSubscription: + properties: + _links: + $ref: '#/components/schemas/DevInfoSubscription.links' + callbackReference: + description: URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + expiryDeadline: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + filterCriteriaDevInfo: + $ref: '#/components/schemas/DevInfoSubscription.filterCriteriaDevInfo' + subscriptionType: + description: Shall be set to "DevInfoSubscription". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackReference + - filterCriteriaDevInfo + type: object + x-etsi-ref: 6.3.3 + + DeviceInfo.deviceStatus: + description: 'Current operational status of the device. Enumeration of: 1 = Up. 2 = Initializing. 3 = Error. 4 = Disabled.' + enum: + - 1 + - 2 + - 3 + - 4 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + DeviceInfo: + properties: + deviceId: + description: 'Typically, the serial number of the device.This value shall remain fixed over the lifetime of the device, including across firmware updates.' + type: array + items: + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + deviceStatus: + $ref: '#/components/schemas/DeviceInfo.deviceStatus' + downloadDiagnostics: + # description': The result of a HTTP and FTP DownloadDiagnostics Test. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': DownloadDiagnostics + $ref: '#/components/schemas/DownloadDiagnostics' + gwId: + description: 'Information (typically the serial number) to identify an Internet Gateway Device through which + + the customer premises device is connected. + + + This value shall remain fixed over the lifetime of the device, including across firmware updates.' + items: + type: string + 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: + # description': The result of an IP-layer ping test. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': IPPingDiagnostics + $ref: '#/components/schemas/IPPingDiagnostics' + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + totalBytesReceived: + description: Total number of IP payload bytes received since the device was last restarted. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + totalBytesSent: + description: Total number of IP payload bytes sent since the device was last restarted. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + totalPacketsReceived: + description: Total number of packets received since the device was last restarted. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + totalPacketsSent: + description: Total number of packets sent since the device was last restarted. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + traceRouteDiagnostics: + # description': The result of an IP-layer trace-route test. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TraceRouteDiagnostics + $ref: '#/components/schemas/TraceRouteDiagnostics' + 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: + # description': The result of a HTTP and FTP UploadDiagnostics Test. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': UploadDiagnostics + $ref: '#/components/schemas/UploadDiagnostics' + required: + - gwId + - deviceStatus + - upTime + - iPConnectionUpTime + - totalBytesSent + - totalBytesReceived + - totalPacketsSent + - totalPacketsReceived + type: object + x-etsi-ref: 6.2.3 + DownloadDiagnostics.diagnosticsState: + description: 'The state of the HTTP and FTP download test. Enumeration of:1 = None.2 = Requested.3 = Completed.4 = Error_InitConnectionFailed.5 = Error_NoResponse.6 = Error_TransferFailed. 7 = Error_PasswordRequestFailed.8 = Error_LoginFailed.9 = Error_NoTransferMode.10 = Error_NoPASV.11 = Error_IncorrectSize.12 = Error_Timeout.' + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + DownloadDiagnostics: + properties: + bOMTime: + # description': Begin of transmission time in UTC, which shall be specified to microsecond precision. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + diagnosticsState: + $ref: '#/components/schemas/DownloadDiagnostics.diagnosticsState' + downloadURI: + description: The URI for the device to perform the download on. + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + eOMTime: + # description': End of transmission in UTC, which shall be specified to microsecond precision. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + rOMTime: + # description': Request time in UTC, which shall be specified to microsecond precision. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + tCPOpenReponseTime: + # description': Response time in UTC, which shall be specified to microsecond precision. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + tCPOpenRequestTime: + # description': Request time in UTC, which shall be specified to microsecond precision. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + testBytesReceived: + description: The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Integer + totalBytesReceived: + description: The total number of bytes received on the Interface between bOMTime and eOMTime. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Integer + required: + - diagnosticsState + type: object + x-etsi-ref: 6.5.6 + ExpiryNotification.links: + description: List of hyperlinks related to the resource. + properties: + self: + description: Self referring URI. This shall be included in the response from the FAIS. The URI shall be unique within the FAI API as it acts as an ID for the subscription. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + required: + - self + type: object + x-etsi-mec-cardinality: '1' + ExpiryNotification: + properties: + _links: + $ref: '#/components/schemas/ExpiryNotification.links' + expiryDeadline: + # description': Time stamp. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - _links + - expiryDeadline + type: object + x-etsi-ref: 6.4.5 + + + FaInfo.connectivityInfo.interfaceType: + description: 'The physical interface used for the end customer site:1 = 100BASE-TX.2 = 1000BASE-TX.3 = 1000BASE-LX.4 = 1000BASELX10.5 = 1000BASEBX10. 6 = 1000BASE-LH.7 = 1000Base-ZX. 8 = ADSL-RJ11.9 = VDSL-RJ11.10 = GPON.' + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + FaInfo.connectivityInfo.lastMileTech: + description: 'An informative field identifying the last mile access technology used.The valid values are:1 = ADSL.2 = VDSL.3 = GPON. 4 = XGPON.5 = NGPON2. 6 = XGSPON. 7 = GFAST.8 = P2PEthernet.' + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + FaInfo.connectivityInfo: + description: The per connectivity domain FAI as defined below. + properties: + dsbw: + description: The bandwidth (in Mbps) from the network towards the customer site. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Integer + interfaceType: + $ref: '#/components/schemas/FaInfo.connectivityInfo.interfaceType' + lastMileTech: + $ref: '#/components/schemas/FaInfo.connectivityInfo.lastMileTech' + latency: + description: Maximum baseline latency (in ms) between customer site and service edge node. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Integer + usbw: + description: The bandwidth (in Mbps) from the customer site towards the network. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Integer + required: + - lastMileTech + - interfaceType + + FaInfo: + properties: + connectivityInfo: + type: array + items: + $ref: '#/components/schemas/FaInfo.connectivityInfo' + customerPremisesInfo: + description: The physical location of a customer site. + items: + $ref: '#/components/schemas/CpInfo' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: CpInfo + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + type: object + required: + - customerPremisesInfo + + x-etsi-ref: 6.2.2 + + IPPingDiagnostics.diagnosticsState: + description: 'The state of the IP ping test. Enumeration of: 1 = None. 2 = Requested. 3 = Complete. 4 = Error_CannotResolveHostName. 5 = Error_Internal.6 = Error_Other.' + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + + IPPingDiagnostics: + properties: + averageResponseTime: + description: 'Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. + + + If there were no successful responses, this value shall be zero.' + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Integer + dataBlockSize: + description: Size of the data block in bytes to be sent for each ping. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Integer + diagnosticsState: + $ref: '#/components/schemas/IPPingDiagnostics.diagnosticsState' + failureCount: + description: Result parameter indicating the number of failed pings in the most recent ping test. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Integer + host: + description: Host name or address of the host to ping. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + maximumResponseTime: + description: 'Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. + + + If 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. + + + If 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 + + pings (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 + + OnuAlarmNotification.alarm: + description: 'Indicates the alarm of the ONU:0 = EquipmentAlarm.1 = PoweringAlarm.2 = BatteryMissing.3 = BatteryFailure.4 = BatteryLow.5 = PhysicalIntrusion. 6 = OnuSelfTestFailure. 7 = DyingGasp. 8 = TemperatureYellow.9 = TemperatureRed.10 = VoltageYellow.11 = VoltageRed.12 = OnuManualPowerOff. 13 = InvImage.14 = PseOverloadYellow.15 = PseOverloadRed.' + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + - 13 + - 14 + - 15 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + OnuAlarmNotification: + properties: + alarm: + $ref: '#/components/schemas/OnuAlarmNotification.alarm' + customerPremisesInfo: + description: The physical location of the related customer sites. + items: + $ref: '#/components/schemas/CpInfo' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: CpInfo + notificationType: + description: Shall be set to "OnuAlarmNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + onuId: + description: The unique identifier for an optical network unit. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - notificationType + - onuId + - alarm + type: object + x-etsi-ref: 6.4.2 + + OnuAlarmSubscription.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 =\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 + OnuAlarmSubscription.links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + properties: + self: + # description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - self + type: object + x-etsi-mec-cardinality: 0..1 + + OnuAlarmSubscription.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: + $ref: '#/components/schemas/OnuAlarmSubscription.alarms' + minItems: 0 + 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: + $ref: '#/components/schemas/CpInfo' + minItems: 0 + 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' + OnuAlarmSubscription: + properties: + _links: + $ref: '#/components/schemas/OnuAlarmSubscription.links' + callbackReference: + description: URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + expiryDeadline: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + filterCriteriaOnuAlarm: + $ref: '#/components/schemas/OnuAlarmSubscription.filterCriteriaOnuAlarm' + subscriptionType: + description: Shall be set to \"OnuAlarmSubscription\". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackReference + - filterCriteriaOnuAlarm + type: object + x-etsi-ref: 6.3.2 + + PonInfo.opticalNetworkInfo.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 + PonInfo.opticalNetworkInfo.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 + PonInfo.opticalNetworkInfo.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 + PonInfo.opticalNetworkInfo.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 + PonInfo.opticalNetworkInfo: + description: '' + items: + type: object + minItems: 1 + properties: + dsRate: + $ref: '#/components/schemas/PonInfo.opticalNetworkInfo.dsRate' + onuId: + description: Information to identify an Optical Network Unit. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + operationalState: + $ref: '#/components/schemas/PonInfo.opticalNetworkInfo.operationalState' + ponTech: + $ref: '#/components/schemas/PonInfo.opticalNetworkInfo.ponTech' + usRate: + $ref: '#/components/schemas/PonInfo.opticalNetworkInfo.usRate' + required: + - onuId + - ponTech + - operationalState + - dsRate + - usRate + + PonInfo: + properties: + customerPremisesInfo: + description: The physical location of a customer site. + items: + $ref: '#/components/schemas/CpInfo' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: CpInfo + opticalNetworkInfo: + type: array + items: + $ref: '#/components/schemas/PonInfo.opticalNetworkInfo' + 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 + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - customerPremisesInfo + - ponSYS_ID + - opticalNetworkInfo + type: object + x-etsi-ref: 6.2.5 + + SubscriptionLinkList.links.subscription.subscriptionType: + description: 'Numeric value (0 - 255) corresponding to specified type of subscription as following: 0 = RESERVED. 1 = ONU_ALARM. 2 = DEVICE_ABNORMAL_ALERT. 3 = CM_CONNECTIVITY_STATE.4 = ANI_ALARM.' + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + + SubscriptionLinkList.links.subscription: + description: A link to a subscription. + 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: + $ref: '#/components/schemas/SubscriptionLinkList.links.subscription.subscriptionType' + required: + - href + - subscriptionType + + + SubscriptionLinkList.links: + description: List of hyperlinks related to the resource. + properties: + subscription: + type: array + items: + $ref: '#/components/schemas/SubscriptionLinkList.links.subscription' + + SubscriptionLinkList: + properties: + _links: + $ref: '#/components/schemas/SubscriptionLinkList.links' + required: + - _links + type: object + x-etsi-ref: 6.3.5 + 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 + + TraceRouteDiagnostics.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 + + 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: + $ref: '#/components/schemas/TraceRouteDiagnostics.diagnosticsState' + 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. + + + If 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. + + + If 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 + + + UploadDiagnostics.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 + UploadDiagnostics: + properties: + bOMTime: + # description': Begin of transmission time in UTC, which shall be specified to microsecond precision. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + diagnosticsState: + $ref: '#/components/schemas/UploadDiagnostics.diagnosticsState' + eOMTime: + # description': End of transmission in UTC, which shall be specified to microsecond precision. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + rOMTime: + # description': Request time in UTC, which shall be specified to microsecond precision. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + tCPOpenReponseTime: + # description': Response time in UTC, which shall be specified to microsecond precision. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + tCPOpenRequestTime: + # description': Request time in UTC, which shall be specified to microsecond precision. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + 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 + + server.' + 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 + + LinkType: + description: >- + 'This data type represents a type of link' + type: object + required: + - href + properties: + href: + $ref: '#/components/schemas/Href' + Href: + description: >- + The URI referring to the subscription. + type: string + format: uri + ProblemDetails: + properties: + detail: + description: A human-readable explanation specific to this occurrence of the problem + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + instance: + description: A URI reference that identifies the specific occurrence of the problem + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + status: + description: The HTTP status code for this occurrence of the problem + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + title: + description: A short, human-readable summary of the problem type + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: + description: A URI reference according to IETF RFC 3986 that identifies the problem type + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + type: object + responses: + 204: + description: No Content + 206: + description: Partial content + 400: + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 401: + description: 'Unauthorized : used when the client did not submit credentials.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 403: + description: 'Forbidden : operation is not allowed given the current status of the resource.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 404: + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 406: + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 409: + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 412: + description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 415: + description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 422: + description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 429: + description: 'Too Many Requests : used when a rate limiter has triggered.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + diff --git a/README.md b/README.md index adf2e51c7fbf1d8d9ec43a3f517322651e5f8be1..531d1eede0066882f649f3be482d024a47907aa3 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,13 @@ This repository contains OpenAPIs descriptions for the interfaces specified in ETSI GS MEC 029. -**=> Please note that the content of the current repository is not yet aligned -with the latest status of ETSI GS 029.** - -**In case of discrepancies the ETSI -Specification takes precedence over the content of the repository.** ## Online resources -* [Specification document (TBD)](#) -* [Navigate the API in the browser (TBD)](#). -* [Edit the API online (TBD)](#). +* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.01.01_60/gs_MEC029v020101p.pdf) +* [Navigate the Fixed Access Information API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs029-fai-api/raw/develop/MEC029_FAI.yaml) +* [Edit the Fixed Access Information API online ](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs029-fai-api/raw/develop/MEC029_FAI.yaml) + ## License diff --git a/proto3/models/ani_alarm_notification.proto b/proto3/models/ani_alarm_notification.proto new file mode 100644 index 0000000000000000000000000000000000000000..d2ddceaefdecfee76ad9c23a8de759f14870a6cb --- /dev/null +++ b/proto3/models/ani_alarm_notification.proto @@ -0,0 +1,36 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/ani_alarm_notification_alarm.proto"; +import public "models/ani_alarm_notification_ani_id.proto"; +import public "models/cp_info.proto"; +import public "models/time_stamp.proto"; + +message AniAlarmNotification { + + AniAlarmNotificationAlarm alarm = 1; + + AniAlarmNotificationAniId ani_id = 2; + + // The physical location of the related customer sites. + repeated CpInfo customer_premises_info = 3; + + // Shall be set to \"AniAlarmNotification\". + string notification_type = 4; + + string onu_id = 5; + + TimeStamp time_stamp = 6; + +} diff --git a/proto3/models/ani_alarm_notification_alarm.proto b/proto3/models/ani_alarm_notification_alarm.proto new file mode 100644 index 0000000000000000000000000000000000000000..7d21168dbba4956f967cffa92453fe707c1dd56d --- /dev/null +++ b/proto3/models/ani_alarm_notification_alarm.proto @@ -0,0 +1,26 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message AniAlarmNotificationAlarm { +enum TypeEnum { + ANI_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_0 = 0; + ANI_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_1 = 1; + ANI_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_2 = 2; + ANI_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_3 = 3; + ANI_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_4 = 4; + ANI_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_5 = 5; + ANI_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_6 = 6; + } +} diff --git a/proto3/models/ani_alarm_notification_ani_id.proto b/proto3/models/ani_alarm_notification_ani_id.proto new file mode 100644 index 0000000000000000000000000000000000000000..43e12f83b58a3bfd59981fe8e87d56ae48d76f36 --- /dev/null +++ b/proto3/models/ani_alarm_notification_ani_id.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message AniAlarmNotificationAniId { + + // The unique identifiers for the optical network unit. + string onu_id = 1; + + // The index of an access network interface supported by the optical network unit. + string ani_index = 2; + +} diff --git a/proto3/models/ani_alarm_subscription.proto b/proto3/models/ani_alarm_subscription.proto new file mode 100644 index 0000000000000000000000000000000000000000..0557f5aeac793523ab90c3eb20ef15025b0a08fe --- /dev/null +++ b/proto3/models/ani_alarm_subscription.proto @@ -0,0 +1,36 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/ani_alarm_subscription_filter_criteria_ani_alarm.proto"; +import public "models/ani_alarm_subscription_links.proto"; +import public "models/time_stamp.proto"; + +message AniAlarmSubscription { + + // Shall be set to \\\"AniAlarmSubscription\\\" + string subscription_type = 1; + + AniAlarmSubscriptionLinks links = 2; + + // The index of an access network interface supported by the optical network unit. + string ani_index = 3; + + // URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response. + string callback_reference = 4; + + TimeStamp expiry_deadline = 5; + + AniAlarmSubscriptionFilterCriteriaAniAlarm filter_criteria_ani_alarm = 6; + +} diff --git a/proto3/models/ani_alarm_subscription_filter_criteria_ani_alarm.proto b/proto3/models/ani_alarm_subscription_filter_criteria_ani_alarm.proto new file mode 100644 index 0000000000000000000000000000000000000000..776e8f8b8780e85bece794846d6f69ff6c31470e --- /dev/null +++ b/proto3/models/ani_alarm_subscription_filter_criteria_ani_alarm.proto @@ -0,0 +1,31 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/ani_alarm_subscription_filter_criteria_ani_alarm_alarms.proto"; +import public "models/ani_alarm_subscription_filter_criteria_ani_alarm_ani_id.proto"; +import public "models/cp_info.proto"; + +message AniAlarmSubscriptionFilterCriteriaAniAlarm { + + // 0 to N physical locations of the customer sites. + repeated CpInfo customer_premises_info = 1; + + // 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. + repeated string onu_id = 2; + + AniAlarmSubscriptionFilterCriteriaAniAlarmAniId ani_id = 3; + + repeated AniAlarmSubscriptionFilterCriteriaAniAlarmAlarms alarms = 4; + +} diff --git a/proto3/models/ani_alarm_subscription_filter_criteria_ani_alarm_alarms.proto b/proto3/models/ani_alarm_subscription_filter_criteria_ani_alarm_alarms.proto new file mode 100644 index 0000000000000000000000000000000000000000..ec654b3b901bce117fb9fd8c8ba8464e07631509 --- /dev/null +++ b/proto3/models/ani_alarm_subscription_filter_criteria_ani_alarm_alarms.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message AniAlarmSubscriptionFilterCriteriaAniAlarmAlarms { +enum TypeEnum { + ANI_ALARM_SUBSCRIPTION_FILTER_CRITERIA_ANI_ALARM_ALARMS_TYPE_ENUM_0 = 0; + ANI_ALARM_SUBSCRIPTION_FILTER_CRITERIA_ANI_ALARM_ALARMS_TYPE_ENUM_1 = 1; + ANI_ALARM_SUBSCRIPTION_FILTER_CRITERIA_ANI_ALARM_ALARMS_TYPE_ENUM_2 = 2; + ANI_ALARM_SUBSCRIPTION_FILTER_CRITERIA_ANI_ALARM_ALARMS_TYPE_ENUM_3 = 3; + ANI_ALARM_SUBSCRIPTION_FILTER_CRITERIA_ANI_ALARM_ALARMS_TYPE_ENUM_4 = 4; + ANI_ALARM_SUBSCRIPTION_FILTER_CRITERIA_ANI_ALARM_ALARMS_TYPE_ENUM_5 = 5; + ANI_ALARM_SUBSCRIPTION_FILTER_CRITERIA_ANI_ALARM_ALARMS_TYPE_ENUM_6 = 6; + ANI_ALARM_SUBSCRIPTION_FILTER_CRITERIA_ANI_ALARM_ALARMS_TYPE_ENUM_MINUS_1 = 7; + } +} diff --git a/proto3/models/ani_alarm_subscription_filter_criteria_ani_alarm_ani_id.proto b/proto3/models/ani_alarm_subscription_filter_criteria_ani_alarm_ani_id.proto new file mode 100644 index 0000000000000000000000000000000000000000..706b79954e117ed2c8f86e30fee61b06e7cdd510 --- /dev/null +++ b/proto3/models/ani_alarm_subscription_filter_criteria_ani_alarm_ani_id.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message AniAlarmSubscriptionFilterCriteriaAniAlarmAniId { + + // The unique identifiers for the optical network unit + string onu_id = 1; + + // The index of an access network interface supported by the optical network unit + string ani_index = 2; + +} diff --git a/proto3/models/ani_alarm_subscription_links.proto b/proto3/models/ani_alarm_subscription_links.proto new file mode 100644 index 0000000000000000000000000000000000000000..e843e580612aaf8253d017c10bc72a56a10a7b9a --- /dev/null +++ b/proto3/models/ani_alarm_subscription_links.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/link_type.proto"; + +message AniAlarmSubscriptionLinks { + + LinkType self = 1; + +} diff --git a/proto3/models/cable_line_info.proto b/proto3/models/cable_line_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..8eb5c005c077637c6ac07ff9a5a721a9ef5cdade --- /dev/null +++ b/proto3/models/cable_line_info.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cable_line_info_cm_info.proto"; +import public "models/cp_info.proto"; +import public "models/time_stamp.proto"; + +message CableLineInfo { + + CableLineInfoCmInfo cm_info = 1; + + CpInfo customer_premises_info = 2; + + TimeStamp time_stamp = 3; + +} diff --git a/proto3/models/cable_line_info_cm_info.proto b/proto3/models/cable_line_info_cm_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..20d4323e4935f3420610fc27f4651414e2d7917e --- /dev/null +++ b/proto3/models/cable_line_info_cm_info.proto @@ -0,0 +1,30 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cable_line_info_cm_info_cm_dpv_stats.proto"; +import public "models/cable_line_info_cm_info_cm_status.proto"; +import public "models/cable_line_info_cm_info_service_flow_stats.proto"; + +message CableLineInfoCmInfo { + + repeated CableLineInfoCmInfoCmDpvStats cm_dpv_stats = 1; + + // Information (typically the serial number) to identify a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.This value SHALL remain fixed over the lifetime of thedevice, including across firmware updates. + string cm_id = 2; + + CableLineInfoCmInfoCmStatus cm_status = 3; + + repeated CableLineInfoCmInfoServiceFlowStats service_flow_stats = 4; + +} diff --git a/proto3/models/cable_line_info_cm_info_cm_dpv_stats.proto b/proto3/models/cable_line_info_cm_info_cm_dpv_stats.proto new file mode 100644 index 0000000000000000000000000000000000000000..211290cc6c54ebffaba5898a55f0adf1bab37593 --- /dev/null +++ b/proto3/models/cable_line_info_cm_info_cm_dpv_stats.proto @@ -0,0 +1,39 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/time_stamp.proto"; + +message CableLineInfoCmInfoCmDpvStats { + + // The average latency measurement. + int32 avg_latency = 1; + + // It represents the interface Index of the Downstream Interface where the measurements are taken. + string if_index = 2; + + // The last latency measurement. + int32 last_meas_latency = 3; + + TimeStamp last_meas_time = 4; + + // The maximum latency measurement. + int32 max_latency = 5; + + // The minimum latency measurement. + int32 min_latency = 6; + + // The number of latency measurements made. + int32 num_meas = 7; + +} diff --git a/proto3/models/cable_line_info_cm_info_cm_status.proto b/proto3/models/cable_line_info_cm_info_cm_status.proto new file mode 100644 index 0000000000000000000000000000000000000000..207a0bf18c71844df4223941915050021fba43a0 --- /dev/null +++ b/proto3/models/cable_line_info_cm_info_cm_status.proto @@ -0,0 +1,39 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cable_line_info_cm_info_cm_status_cm_reg_state.proto"; + +message CableLineInfoCmInfoCmStatus { + + CableLineInfoCmInfoCmStatusCmRegState cm_reg_state = 1; + + // It indicates whether the CM is currently operating in Energy Management DLS Mode. + bool em_dls_oper_status = 2; + + // It indicates whether the CM is currently operating in Energy Management 1x1 Mode. + bool energy_mgt1x1_oper_status = 3; + + // It denotes the MAC Domain interface index of the CM. + string if_index = 4; + + // It denotes the number of times the CM received invalid registration response messages. + int32 invalid_reg_rsps = 5; + + // It denotes the number of times the CM lost synchronization with the downstream channel. + int32 lost_syncs = 6; + + // It denotes the number of times the CM reset or initialized this interface. + int32 resets = 7; + +} diff --git a/proto3/models/cable_line_info_cm_info_cm_status_cm_reg_state.proto b/proto3/models/cable_line_info_cm_info_cm_status_cm_reg_state.proto new file mode 100644 index 0000000000000000000000000000000000000000..9441a19fe0c0ef17eacf6e2ad74dbd2ccd7248ba --- /dev/null +++ b/proto3/models/cable_line_info_cm_info_cm_status_cm_reg_state.proto @@ -0,0 +1,42 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message CableLineInfoCmInfoCmStatusCmRegState { +enum TypeEnum { + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_1 = 0; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_2 = 1; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_3 = 2; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_4 = 3; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_5 = 4; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_6 = 5; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_7 = 6; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_8 = 7; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_9 = 8; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_10 = 9; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_11 = 10; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_12 = 11; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_13 = 12; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_14 = 13; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_15 = 14; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_16 = 15; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_17 = 16; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_18 = 17; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_19 = 18; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_20 = 19; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_21 = 20; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_22 = 21; + CABLE_LINE_INFO_CM_INFO_CM_STATUS_CM_REG_STATE_TYPE_ENUM_23 = 22; + } +} diff --git a/proto3/models/cable_line_info_cm_info_service_flow_stats.proto b/proto3/models/cable_line_info_cm_info_service_flow_stats.proto new file mode 100644 index 0000000000000000000000000000000000000000..333cb207cdcacc00785729f196869fbba9d3b81a --- /dev/null +++ b/proto3/models/cable_line_info_cm_info_service_flow_stats.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cable_line_info_cm_info_service_flow_stats_service_flow_info.proto"; + +message CableLineInfoCmInfoServiceFlowStats { + + // It represents the interface index of the MAC Domain of the Service Flow + string if_index = 1; + + repeated CableLineInfoCmInfoServiceFlowStatsServiceFlowInfo service_flow_info = 2; + +} diff --git a/proto3/models/cable_line_info_cm_info_service_flow_stats_service_flow_info.proto b/proto3/models/cable_line_info_cm_info_service_flow_stats_service_flow_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..ee1f1b4c561eb4160dac2dbd663153146652bda6 --- /dev/null +++ b/proto3/models/cable_line_info_cm_info_service_flow_stats_service_flow_info.proto @@ -0,0 +1,39 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/time_stamp.proto"; + +message CableLineInfoCmInfoServiceFlowStatsServiceFlowInfo { + + // 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. + int32 aqm_dropped_pkts = 1; + + // 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. + int32 pkts = 2; + + // It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate. + int32 policed_delay_pkts = 3; + + // 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. + int32 policed_drop_pkts = 4; + + // It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain. + int32 service_flow_id = 5; + + // It indicates the number of seconds that the service flow has been active. + int32 time_active = 6; + + TimeStamp time_created = 7; + +} diff --git a/proto3/models/cm_conn_notification.proto b/proto3/models/cm_conn_notification.proto new file mode 100644 index 0000000000000000000000000000000000000000..023f00ba2efecbcd6f696b88eb5edf71af343f74 --- /dev/null +++ b/proto3/models/cm_conn_notification.proto @@ -0,0 +1,30 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cm_conn_notification_cm_if.proto"; +import public "models/cp_info.proto"; +import public "models/time_stamp.proto"; + +message CmConnNotification { + + repeated CmConnNotificationCmIf cm_if = 1; + + CpInfo customer_premises_info = 2; + + // Shall be set to \\\"CmconnNotification\\\". + string notification_type = 3; + + TimeStamp time_stamp = 4; + +} diff --git a/proto3/models/cm_conn_notification_cm_if.proto b/proto3/models/cm_conn_notification_cm_if.proto new file mode 100644 index 0000000000000000000000000000000000000000..00f865c7c908a4cb9e23d0b698da6bbb8c1055cd --- /dev/null +++ b/proto3/models/cm_conn_notification_cm_if.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cm_conn_notification_cm_if_cm_reg_state.proto"; + +message CmConnNotificationCmIf { + + // The Cable Modem identifier. + string cm_id = 1; + + repeated CmConnNotificationCmIfCmRegState cm_conn_notification_if_cm_reg_state = 2; + + // The MAC Domain interface index of the CM. + repeated string if_index = 3; + +} diff --git a/proto3/models/cm_conn_notification_cm_if_cm_reg_state.proto b/proto3/models/cm_conn_notification_cm_if_cm_reg_state.proto new file mode 100644 index 0000000000000000000000000000000000000000..a2b1eb9303654e04912e5e007d2f895224a06854 --- /dev/null +++ b/proto3/models/cm_conn_notification_cm_if_cm_reg_state.proto @@ -0,0 +1,40 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message CmConnNotificationCmIfCmRegState { +enum TypeEnum { + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_1 = 0; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_2 = 1; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_3 = 2; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_4 = 3; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_5 = 4; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_6 = 5; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_7 = 6; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_8 = 7; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_9 = 8; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_10 = 9; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_11 = 10; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_12 = 11; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_13 = 12; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_14 = 13; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_15 = 14; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_16 = 15; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_17 = 16; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_18 = 17; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_19 = 18; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_20 = 19; + CM_CONN_NOTIFICATION_CM_IF_CM_REG_STATE_TYPE_ENUM_21 = 20; + } +} diff --git a/proto3/models/cm_conn_subscription.proto b/proto3/models/cm_conn_subscription.proto new file mode 100644 index 0000000000000000000000000000000000000000..7e6de19368613f49d06b20567e12e92e0a997686 --- /dev/null +++ b/proto3/models/cm_conn_subscription.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cm_conn_subscription_filter_criteria_cm_conn.proto"; +import public "models/cm_conn_subscription_links.proto"; +import public "models/time_stamp.proto"; + +message CmConnSubscription { + + CmConnSubscriptionLinks links = 1; + + // URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response. + string callback_reference = 2; + + TimeStamp expiry_deadline = 3; + + CmConnSubscriptionFilterCriteriaCmConn filter_criteria_cm_conn = 4; + + // Shall be set to \"CmConnSubscription\". + string subscription_type = 5; + +} diff --git a/proto3/models/cm_conn_subscription_filter_criteria_cm_conn.proto b/proto3/models/cm_conn_subscription_filter_criteria_cm_conn.proto new file mode 100644 index 0000000000000000000000000000000000000000..5ffda1083d4aac2962fc5610b900c87054ed4bbd --- /dev/null +++ b/proto3/models/cm_conn_subscription_filter_criteria_cm_conn.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cm_conn_subscription_filter_criteria_cm_conn_cm_if.proto"; +import public "models/cp_info.proto"; + +message CmConnSubscriptionFilterCriteriaCmConn { + + repeated CmConnSubscriptionFilterCriteriaCmConnCmIf cm_if = 1; + + CpInfo customer_premises_info = 2; + +} diff --git a/proto3/models/cm_conn_subscription_filter_criteria_cm_conn_cm_if.proto b/proto3/models/cm_conn_subscription_filter_criteria_cm_conn_cm_if.proto new file mode 100644 index 0000000000000000000000000000000000000000..f62615c106bd683400ce7246a434a6ce7480de3c --- /dev/null +++ b/proto3/models/cm_conn_subscription_filter_criteria_cm_conn_cm_if.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cm_conn_subscription_filter_criteria_cm_conn_cm_if_cm_reg_state.proto"; + +message CmConnSubscriptionFilterCriteriaCmConnCmIf { + + // The identifier of a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system. + string cm_id = 1; + + repeated CmConnSubscriptionFilterCriteriaCmConnCmIfCmRegState cm_reg_state = 2; + + // The MAC Domain interface index of the CM. + repeated string if_index = 3; + +} diff --git a/proto3/models/cm_conn_subscription_filter_criteria_cm_conn_cm_if_cm_reg_state.proto b/proto3/models/cm_conn_subscription_filter_criteria_cm_conn_cm_if_cm_reg_state.proto new file mode 100644 index 0000000000000000000000000000000000000000..69e39e8e354aeaa7128d0d7d829890ca32a73093 --- /dev/null +++ b/proto3/models/cm_conn_subscription_filter_criteria_cm_conn_cm_if_cm_reg_state.proto @@ -0,0 +1,40 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message CmConnSubscriptionFilterCriteriaCmConnCmIfCmRegState { +enum TypeEnum { + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_1 = 0; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_2 = 1; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_3 = 2; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_4 = 3; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_5 = 4; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_6 = 5; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_7 = 6; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_8 = 7; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_9 = 8; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_10 = 9; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_11 = 10; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_12 = 11; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_13 = 12; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_14 = 13; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_15 = 14; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_16 = 15; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_17 = 16; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_18 = 17; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_19 = 18; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_20 = 19; + CM_CONN_SUBSCRIPTION_FILTER_CRITERIA_CM_CONN_CM_IF_CM_REG_STATE_TYPE_ENUM_21 = 20; + } +} diff --git a/proto3/models/cm_conn_subscription_links.proto b/proto3/models/cm_conn_subscription_links.proto new file mode 100644 index 0000000000000000000000000000000000000000..66e3e30e062ea8f3d9b497b981a2a483ac4a7493 --- /dev/null +++ b/proto3/models/cm_conn_subscription_links.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/link_type.proto"; + +message CmConnSubscriptionLinks { + + LinkType self = 1; + +} diff --git a/proto3/models/cp_info.proto b/proto3/models/cp_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..a24054533547a61502081ffb1a7a5eb1a0f9efd7 --- /dev/null +++ b/proto3/models/cp_info.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message CpInfo { + + // Latitude (DATUM=WGS84) -90 to 90 in decimal degree format DDD.ddd + float latitude = 1; + + // Longitude (DATUM=WGS84) -180 to 180 in decimal degree format DDD.ddd + float longitude = 2; + + // Postal code for the location + string postal_code = 3; + +} diff --git a/proto3/models/dev_info_notification.proto b/proto3/models/dev_info_notification.proto new file mode 100644 index 0000000000000000000000000000000000000000..0731442e30e9e2597a0d05261f713552dc2c5faa --- /dev/null +++ b/proto3/models/dev_info_notification.proto @@ -0,0 +1,30 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/device_err_status.proto"; +import public "models/time_stamp.proto"; + +message DevInfoNotification { + + DeviceErrStatus device_err_status = 1; + + // The identifier for a device. + string device_id = 2; + + // Shall be set to \"DevInfoNotification\". + string notification_type = 3; + + TimeStamp time_stamp = 4; + +} diff --git a/proto3/models/dev_info_subscription.proto b/proto3/models/dev_info_subscription.proto new file mode 100644 index 0000000000000000000000000000000000000000..950da03c5fac26bf7ae2528dfeb31232c3600493 --- /dev/null +++ b/proto3/models/dev_info_subscription.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/dev_info_subscription_filter_criteria_dev_info.proto"; +import public "models/dev_info_subscription_links.proto"; +import public "models/time_stamp.proto"; + +message DevInfoSubscription { + + DevInfoSubscriptionLinks links = 1; + + // URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response. + string callback_reference = 2; + + TimeStamp expiry_deadline = 3; + + DevInfoSubscriptionFilterCriteriaDevInfo filter_criteria_dev_info = 4; + + // Shall be set to \"DevInfoSubscription\". + string subscription_type = 5; + +} diff --git a/proto3/models/dev_info_subscription_filter_criteria_dev_info.proto b/proto3/models/dev_info_subscription_filter_criteria_dev_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..babdeaa9b944b918a4a0c1fd8614b8fdc0af9020 --- /dev/null +++ b/proto3/models/dev_info_subscription_filter_criteria_dev_info.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/device_err_status.proto"; + +message DevInfoSubscriptionFilterCriteriaDevInfo { + + repeated DeviceErrStatus device_err_status = 1; + + // The device identifier. + repeated string device_id = 2; + + // The identifier of an Internet Gateway Device through which the customer premises device is connected. + repeated string gw_id = 3; + +} diff --git a/proto3/models/dev_info_subscription_links.proto b/proto3/models/dev_info_subscription_links.proto new file mode 100644 index 0000000000000000000000000000000000000000..77b2e57a8e9881ed971f5b71e0628b8b91aa6da8 --- /dev/null +++ b/proto3/models/dev_info_subscription_links.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/link_type.proto"; + +message DevInfoSubscriptionLinks { + + LinkType self = 1; + +} diff --git a/proto3/models/device_err_status.proto b/proto3/models/device_err_status.proto new file mode 100644 index 0000000000000000000000000000000000000000..45f9f34d954b31126dacde48b074841344ceb4a1 --- /dev/null +++ b/proto3/models/device_err_status.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message DeviceErrStatus { +enum TypeEnum { + DEVICE_ERR_STATUS_TYPE_ENUM_1 = 0; + DEVICE_ERR_STATUS_TYPE_ENUM_2 = 1; + } +} diff --git a/proto3/models/device_info.proto b/proto3/models/device_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..b76c7a01f5f4b39cc5e140f283ffc3a0a77801a0 --- /dev/null +++ b/proto3/models/device_info.proto @@ -0,0 +1,60 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/device_info_device_status.proto"; +import public "models/download_diagnostics.proto"; +import public "models/ip_ping_diagnostics.proto"; +import public "models/time_stamp.proto"; +import public "models/trace_route_diagnostics.proto"; +import public "models/upload_diagnostics.proto"; + +message DeviceInfo { + + // Typically, the serial number of the device. This value shall remain fixed over the lifetime of the device, including across firmware updates. + repeated string device_id = 1; + + DeviceInfoDeviceStatus device_status = 2; + + DownloadDiagnostics download_diagnostics = 3; + + // 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. + repeated string gw_id = 4; + + // The time in seconds that the IP interface has been connected. + int32 ip_connection_up_time = 5; + + IPPingDiagnostics ip_ping_diagnostics = 6; + + TimeStamp time_stamp = 7; + + // Total number of IP payload bytes received since the device was last restarted. + int32 total_bytes_received = 8; + + // Total number of IP payload bytes sent since the device was last restarted. + int32 total_bytes_sent = 9; + + // Total number of packets received since the device was last restarted. + int32 total_packets_received = 10; + + // Total number of packets sent since the device was last restarted. + int32 total_packets_sent = 11; + + TraceRouteDiagnostics trace_route_diagnostics = 12; + + // Time in seconds since the device was last restarted. + int32 up_time = 13; + + UploadDiagnostics upload_diagnostics = 14; + +} diff --git a/proto3/models/device_info_device_status.proto b/proto3/models/device_info_device_status.proto new file mode 100644 index 0000000000000000000000000000000000000000..53f1836cc8b78e6de79da20a44a24aac2dd9b881 --- /dev/null +++ b/proto3/models/device_info_device_status.proto @@ -0,0 +1,23 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message DeviceInfoDeviceStatus { +enum TypeEnum { + DEVICE_INFO_DEVICE_STATUS_TYPE_ENUM_1 = 0; + DEVICE_INFO_DEVICE_STATUS_TYPE_ENUM_2 = 1; + DEVICE_INFO_DEVICE_STATUS_TYPE_ENUM_3 = 2; + DEVICE_INFO_DEVICE_STATUS_TYPE_ENUM_4 = 3; + } +} diff --git a/proto3/models/download_diagnostics.proto b/proto3/models/download_diagnostics.proto new file mode 100644 index 0000000000000000000000000000000000000000..d5a601573e663d0a09f085cd067699792cbc5046 --- /dev/null +++ b/proto3/models/download_diagnostics.proto @@ -0,0 +1,41 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/download_diagnostics_diagnostics_state.proto"; +import public "models/time_stamp.proto"; + +message DownloadDiagnostics { + + TimeStamp b_om_time = 1; + + DownloadDiagnosticsDiagnosticsState diagnostics_state = 2; + + // The URI for the device to perform the download on. + string download_uri = 3; + + TimeStamp e_om_time = 4; + + TimeStamp r_om_time = 5; + + TimeStamp tcp_open_reponse_time = 6; + + TimeStamp tcp_open_request_time = 7; + + // The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between b_oMTime and e_oMTime. + int32 test_bytes_received = 8; + + // The total number of bytes received on the Interface between b_om_time and e_om_time. + int32 total_bytes_received = 9; + +} diff --git a/proto3/models/download_diagnostics_diagnostics_state.proto b/proto3/models/download_diagnostics_diagnostics_state.proto new file mode 100644 index 0000000000000000000000000000000000000000..117177fac12340f93110bc42491cb75af298ffde --- /dev/null +++ b/proto3/models/download_diagnostics_diagnostics_state.proto @@ -0,0 +1,32 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message DownloadDiagnosticsDiagnosticsState { +enum TypeEnum { + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_1 = 0; + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_2 = 1; + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_3 = 2; + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_4 = 3; + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_5 = 4; + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_6 = 5; + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_7 = 6; + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_8 = 7; + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_9 = 8; + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_10 = 9; + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_11 = 10; + DOWNLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_12 = 11; + } + +} diff --git a/proto3/models/expiry_notification.proto b/proto3/models/expiry_notification.proto new file mode 100644 index 0000000000000000000000000000000000000000..dac7c61e0e493362482f0057ffca04a2b03c6e4c --- /dev/null +++ b/proto3/models/expiry_notification.proto @@ -0,0 +1,26 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/expiry_notification_links.proto"; +import public "models/time_stamp.proto"; + +message ExpiryNotification { + + ExpiryNotificationLinks links = 1; + + TimeStamp expiry_deadline = 2; + + TimeStamp time_stamp = 3; + +} diff --git a/proto3/models/expiry_notification_links.proto b/proto3/models/expiry_notification_links.proto new file mode 100644 index 0000000000000000000000000000000000000000..3ca39036026c3d2c6418a06549e94e9490304634 --- /dev/null +++ b/proto3/models/expiry_notification_links.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message ExpiryNotificationLinks { + + // Self referring URI. This shall be included in the response from the FAIS. The URI shall be unique within the FAI API as it acts as an ID for the subscription. + string self = 1; + +} diff --git a/proto3/models/fa_info.proto b/proto3/models/fa_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..c95697d6d856103de637e8856cf9a9c07d463305 --- /dev/null +++ b/proto3/models/fa_info.proto @@ -0,0 +1,28 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cp_info.proto"; +import public "models/fa_info_connectivity_info.proto"; +import public "models/time_stamp.proto"; + +message FaInfo { + + repeated FaInfoConnectivityInfo connectivity_info = 1; + + // The physical location of a customer site. + repeated CpInfo customer_premises_info = 2; + + TimeStamp time_stamp = 3; + +} diff --git a/proto3/models/fa_info_connectivity_info.proto b/proto3/models/fa_info_connectivity_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..371c66de344afbe029f3ceda5106e1204c0ca69e --- /dev/null +++ b/proto3/models/fa_info_connectivity_info.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/fa_info_connectivity_info_interface_type.proto"; +import public "models/fa_info_connectivity_info_last_mile_tech.proto"; + +message FaInfoConnectivityInfo { + + // The bandwidth (in Mbps) from the network towards the customer site. + int32 dsbw = 1; + + FaInfoConnectivityInfoInterfaceType interface_type = 2; + + FaInfoConnectivityInfoLastMileTech last_mile_tech = 3; + + // Maximum baseline latency (in ms) between customer site and service edge node. + int32 latency = 4; + + // The bandwidth (in Mbps) from the customer site towards the network. + int32 usbw = 5; + +} diff --git a/proto3/models/fa_info_connectivity_info_interface_type.proto b/proto3/models/fa_info_connectivity_info_interface_type.proto new file mode 100644 index 0000000000000000000000000000000000000000..6655c79e5ed9c63b4f75fdc493802ae68d0b6718 --- /dev/null +++ b/proto3/models/fa_info_connectivity_info_interface_type.proto @@ -0,0 +1,30 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message FaInfoConnectivityInfoInterfaceType { + +enum TypeEnum { + FA_INFO_CONNECTIVITY_INFO_INTERFACE_TYPE_TYPE_ENUM_1 = 0; + FA_INFO_CONNECTIVITY_INFO_INTERFACE_TYPE_TYPE_ENUM_2 = 1; + FA_INFO_CONNECTIVITY_INFO_INTERFACE_TYPE_TYPE_ENUM_3 = 2; + FA_INFO_CONNECTIVITY_INFO_INTERFACE_TYPE_TYPE_ENUM_4 = 3; + FA_INFO_CONNECTIVITY_INFO_INTERFACE_TYPE_TYPE_ENUM_5 = 4; + FA_INFO_CONNECTIVITY_INFO_INTERFACE_TYPE_TYPE_ENUM_6 = 5; + FA_INFO_CONNECTIVITY_INFO_INTERFACE_TYPE_TYPE_ENUM_7 = 6; + FA_INFO_CONNECTIVITY_INFO_INTERFACE_TYPE_TYPE_ENUM_8 = 7; + FA_INFO_CONNECTIVITY_INFO_INTERFACE_TYPE_TYPE_ENUM_9 = 8; + FA_INFO_CONNECTIVITY_INFO_INTERFACE_TYPE_TYPE_ENUM_10 = 9; + } +} diff --git a/proto3/models/fa_info_connectivity_info_last_mile_tech.proto b/proto3/models/fa_info_connectivity_info_last_mile_tech.proto new file mode 100644 index 0000000000000000000000000000000000000000..812d5648c8aa6e0d85a30d7dce4acf439520d3e4 --- /dev/null +++ b/proto3/models/fa_info_connectivity_info_last_mile_tech.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message FaInfoConnectivityInfoLastMileTech { +enum TypeEnum { + FA_INFO_CONNECTIVITY_INFO_LAST_MILE_TECH_TYPE_ENUM_1 = 0; + FA_INFO_CONNECTIVITY_INFO_LAST_MILE_TECH_TYPE_ENUM_2 = 1; + FA_INFO_CONNECTIVITY_INFO_LAST_MILE_TECH_TYPE_ENUM_3 = 2; + FA_INFO_CONNECTIVITY_INFO_LAST_MILE_TECH_TYPE_ENUM_4 = 3; + FA_INFO_CONNECTIVITY_INFO_LAST_MILE_TECH_TYPE_ENUM_5 = 4; + FA_INFO_CONNECTIVITY_INFO_LAST_MILE_TECH_TYPE_ENUM_6 = 5; + FA_INFO_CONNECTIVITY_INFO_LAST_MILE_TECH_TYPE_ENUM_7 = 6; + FA_INFO_CONNECTIVITY_INFO_LAST_MILE_TECH_TYPE_ENUM_8 = 7; + } +} diff --git a/proto3/models/ip_ping_diagnostics.proto b/proto3/models/ip_ping_diagnostics.proto new file mode 100644 index 0000000000000000000000000000000000000000..df5d3e511f72f828de15adf2c1cb1ef2f5a918ce --- /dev/null +++ b/proto3/models/ip_ping_diagnostics.proto @@ -0,0 +1,49 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/ip_ping_diagnostics_diagnostics_state.proto"; +option java_outer_classname = "IpPingDiagnosticsProto"; + +message IPPingDiagnostics { + + // Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value shall be zero. + int32 average_response_time = 1; + + // Size of the data block in bytes to be sent for each ping. + int32 data_block_size = 2; + + IPPingDiagnosticsDiagnosticsState diagnostics_state = 3; + + // Result parameter indicating the number of failed pings in the most recent ping test. + int32 failure_count = 4; + + // Host name or address of the host to ping. + string host = 5; + + // Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value shall be zero. + int32 maximum_response_time = 6; + + // Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value shall be zero. + int32 minimum_response_time = 7; + + // Number of repetitions of the ping test to perform before reporting the results. + int32 number_of_repetitions = 8; + + // Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. + int32 success_count = 9; + + // Timeout in milliseconds for the ping test. + int32 timeout = 10; + +} diff --git a/proto3/models/ip_ping_diagnostics_diagnostics_state.proto b/proto3/models/ip_ping_diagnostics_diagnostics_state.proto new file mode 100644 index 0000000000000000000000000000000000000000..890c312ebc3279614cbe0114c255cccf3b2548b6 --- /dev/null +++ b/proto3/models/ip_ping_diagnostics_diagnostics_state.proto @@ -0,0 +1,26 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; +option java_outer_classname = "IpPingDiagnosticsDiagnosticsStateProto"; + +message IPPingDiagnosticsDiagnosticsState { + +enum TypeEnum { + IP_PING_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_1 = 0; + IP_PING_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_2 = 1; + IP_PING_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_3 = 2; + IP_PING_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_4 = 3; + IP_PING_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_5 = 4; + IP_PING_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_6 = 5; + } +} diff --git a/proto3/models/link_type.proto b/proto3/models/link_type.proto new file mode 100644 index 0000000000000000000000000000000000000000..17e71e2c2f0edbc364e7d5963164b56a12d92e67 --- /dev/null +++ b/proto3/models/link_type.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message LinkType { + + // The URI referring to the subscription. + string href = 1; + +} diff --git a/proto3/models/onu_alarm_notification.proto b/proto3/models/onu_alarm_notification.proto new file mode 100644 index 0000000000000000000000000000000000000000..b6894b020f9a69050c8a5695a5bbb53b67188337 --- /dev/null +++ b/proto3/models/onu_alarm_notification.proto @@ -0,0 +1,34 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cp_info.proto"; +import public "models/onu_alarm_notification_alarm.proto"; +import public "models/time_stamp.proto"; + +message OnuAlarmNotification { + + OnuAlarmNotificationAlarm alarm = 1; + + // The physical location of the related customer sites. + repeated CpInfo customer_premises_info = 2; + + // Shall be set to \"OnuAlarmNotification\". + string notification_type = 3; + + // The unique identifier for an optical network unit. + string onu_id = 4; + + TimeStamp time_stamp = 5; + +} diff --git a/proto3/models/onu_alarm_notification_alarm.proto b/proto3/models/onu_alarm_notification_alarm.proto new file mode 100644 index 0000000000000000000000000000000000000000..a378dcb4b188138c477ddb4eadfc64a2a04a1d1a --- /dev/null +++ b/proto3/models/onu_alarm_notification_alarm.proto @@ -0,0 +1,35 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message OnuAlarmNotificationAlarm { +enum TypeEnum { + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_0 = 0; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_1 = 1; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_2 = 2; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_3 = 3; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_4 = 4; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_5 = 5; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_6 = 6; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_7 = 7; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_8 = 8; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_9 = 9; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_10 = 10; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_11 = 11; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_12 = 12; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_13 = 13; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_14 = 14; + ONU_ALARM_NOTIFICATION_ALARM_TYPE_ENUM_15 = 15; + } +} diff --git a/proto3/models/onu_alarm_subscription.proto b/proto3/models/onu_alarm_subscription.proto new file mode 100644 index 0000000000000000000000000000000000000000..f19c2d1a2e01820be497eaf5742ab62c04cc6d1b --- /dev/null +++ b/proto3/models/onu_alarm_subscription.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/onu_alarm_subscription_filter_criteria_onu_alarm.proto"; +import public "models/onu_alarm_subscription_links.proto"; +import public "models/time_stamp.proto"; + +message OnuAlarmSubscription { + + OnuAlarmSubscriptionLinks links = 1; + + // URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response. + string callback_reference = 2; + + TimeStamp expiry_deadline = 3; + + OnuAlarmSubscriptionFilterCriteriaOnuAlarm filter_criteria_onu_alarm = 4; + + // Shall be set to \\\"OnuAlarmSubscription\\\". + string subscription_type = 5; + +} diff --git a/proto3/models/onu_alarm_subscription_alarms.proto b/proto3/models/onu_alarm_subscription_alarms.proto new file mode 100644 index 0000000000000000000000000000000000000000..2d2f1026be9eb029dc3f126fd32b9160ed7f77c5 --- /dev/null +++ b/proto3/models/onu_alarm_subscription_alarms.proto @@ -0,0 +1,36 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message OnuAlarmSubscriptionAlarms { +enum TypeEnum { + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_0 = 0; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_1 = 1; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_2 = 2; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_3 = 3; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_4 = 4; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_5 = 5; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_6 = 6; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_7 = 7; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_8 = 8; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_9 = 9; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_10 = 10; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_11 = 11; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_12 = 12; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_13 = 13; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_14 = 14; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_15 = 15; + ONU_ALARM_SUBSCRIPTION_ALARMS_TYPE_ENUM_MINUS_1 = 16; + } +} diff --git a/proto3/models/onu_alarm_subscription_filter_criteria_onu_alarm.proto b/proto3/models/onu_alarm_subscription_filter_criteria_onu_alarm.proto new file mode 100644 index 0000000000000000000000000000000000000000..16f46b2c4923f69f161f68b8a623c4e7ba3404ae --- /dev/null +++ b/proto3/models/onu_alarm_subscription_filter_criteria_onu_alarm.proto @@ -0,0 +1,28 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cp_info.proto"; +import public "models/onu_alarm_subscription_alarms.proto"; + +message OnuAlarmSubscriptionFilterCriteriaOnuAlarm { + + repeated OnuAlarmSubscriptionAlarms alarms = 1; + + // 0 to N physical locations of the customer sites. + repeated CpInfo customer_premises_info = 2; + + // 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. + repeated string onu_id = 3; + +} diff --git a/proto3/models/onu_alarm_subscription_links.proto b/proto3/models/onu_alarm_subscription_links.proto new file mode 100644 index 0000000000000000000000000000000000000000..d7440f66187968a9480e18118b90e750e5fd1a77 --- /dev/null +++ b/proto3/models/onu_alarm_subscription_links.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/link_type.proto"; + +message OnuAlarmSubscriptionLinks { + + LinkType self = 1; + +} diff --git a/proto3/models/pon_info.proto b/proto3/models/pon_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..d032b4cd77b1c9b32cc8b71d96cd7c627b9df295 --- /dev/null +++ b/proto3/models/pon_info.proto @@ -0,0 +1,31 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cp_info.proto"; +import public "models/pon_info_optical_network_info.proto"; +import public "models/time_stamp.proto"; + +message PonInfo { + + // The physical location of a customer site. + repeated CpInfo customer_premises_info = 1; + + repeated PonInfoOpticalNetworkInfo optical_network_info = 2; + + // The 20-bit identity of the optical system within a certain domain.This is a reference value set by the OSS. + string pon_sys_id = 3; + + TimeStamp time_stamp = 4; + +} diff --git a/proto3/models/pon_info_optical_network_info.proto b/proto3/models/pon_info_optical_network_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..2f638ae6d6a8a990ec7565bfd556248a118116e8 --- /dev/null +++ b/proto3/models/pon_info_optical_network_info.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/pon_info_optical_network_info_ds_rate.proto"; +import public "models/pon_info_optical_network_info_operational_state.proto"; +import public "models/pon_info_optical_network_info_pon_tech.proto"; +import public "models/pon_info_optical_network_info_us_rate.proto"; + +message PonInfoOpticalNetworkInfo { + + PonInfoOpticalNetworkInfoDsRate ds_rate = 1; + + // Information to identify an Optical Network Unit. + string onu_id = 2; + + PonInfoOpticalNetworkInfoOperationalState operational_state = 3; + + PonInfoOpticalNetworkInfoPonTech pon_tech = 4; + + PonInfoOpticalNetworkInfoUsRate us_rate = 5; + +} diff --git a/proto3/models/pon_info_optical_network_info_ds_rate.proto b/proto3/models/pon_info_optical_network_info_ds_rate.proto new file mode 100644 index 0000000000000000000000000000000000000000..8402c16f343d1b23157a953f5799f9b4b9a9555c --- /dev/null +++ b/proto3/models/pon_info_optical_network_info_ds_rate.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message PonInfoOpticalNetworkInfoDsRate { +enum TypeEnum { + PON_INFO_OPTICAL_NETWORK_INFO_DS_RATE_TYPE_ENUM_1 = 0; + PON_INFO_OPTICAL_NETWORK_INFO_DS_RATE_TYPE_ENUM_2 = 1; + } +} diff --git a/proto3/models/pon_info_optical_network_info_operational_state.proto b/proto3/models/pon_info_optical_network_info_operational_state.proto new file mode 100644 index 0000000000000000000000000000000000000000..a3f49f8b493af610ea7be783988a6ca08acd9bd0 --- /dev/null +++ b/proto3/models/pon_info_optical_network_info_operational_state.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message PonInfoOpticalNetworkInfoOperationalState { +enum TypeEnum { + PON_INFO_OPTICAL_NETWORK_INFO_OPERATIONAL_STATE_TYPE_ENUM_0 = 0; + PON_INFO_OPTICAL_NETWORK_INFO_OPERATIONAL_STATE_TYPE_ENUM_1 = 1; + } +} diff --git a/proto3/models/pon_info_optical_network_info_pon_tech.proto b/proto3/models/pon_info_optical_network_info_pon_tech.proto new file mode 100644 index 0000000000000000000000000000000000000000..c6ba507e9a7b7667f17b6f025eb7a5fc3bd4e988 --- /dev/null +++ b/proto3/models/pon_info_optical_network_info_pon_tech.proto @@ -0,0 +1,23 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message PonInfoOpticalNetworkInfoPonTech { +enum TypeEnum { + PON_INFO_OPTICAL_NETWORK_INFO_PON_TECH_TYPE_ENUM_1 = 0; + PON_INFO_OPTICAL_NETWORK_INFO_PON_TECH_TYPE_ENUM_2 = 1; + PON_INFO_OPTICAL_NETWORK_INFO_PON_TECH_TYPE_ENUM_3 = 2; + PON_INFO_OPTICAL_NETWORK_INFO_PON_TECH_TYPE_ENUM_4 = 3; + } +} diff --git a/proto3/models/pon_info_optical_network_info_us_rate.proto b/proto3/models/pon_info_optical_network_info_us_rate.proto new file mode 100644 index 0000000000000000000000000000000000000000..f139b2acc8370b6894c5a94c61331a5b80070cea --- /dev/null +++ b/proto3/models/pon_info_optical_network_info_us_rate.proto @@ -0,0 +1,22 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message PonInfoOpticalNetworkInfoUsRate { +enum TypeEnum { + PON_INFO_OPTICAL_NETWORK_INFO_US_RATE_TYPE_ENUM_1 = 0; + PON_INFO_OPTICAL_NETWORK_INFO_US_RATE_TYPE_ENUM_2 = 1; + PON_INFO_OPTICAL_NETWORK_INFO_US_RATE_TYPE_ENUM_3 = 2; + } +} diff --git a/proto3/models/problem_details.proto b/proto3/models/problem_details.proto new file mode 100644 index 0000000000000000000000000000000000000000..96f4fc439d0734d8ae68d38dcfdfbc1e6917abb5 --- /dev/null +++ b/proto3/models/problem_details.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message ProblemDetails { + + // A human-readable explanation specific to this occurrence of the problem + string detail = 1; + + // A URI reference that identifies the specific occurrence of the problem + string instance = 2; + + // The HTTP status code for this occurrence of the problem + int32 status = 3; + + // A short, human-readable summary of the problem type + string title = 4; + + // A URI reference according to IETF RFC 3986 that identifies the problem type + string type = 5; + +} diff --git a/proto3/models/subscription.proto b/proto3/models/subscription.proto new file mode 100644 index 0000000000000000000000000000000000000000..e2b8272fa111848cdabd0f5a621e2c6964491b4e --- /dev/null +++ b/proto3/models/subscription.proto @@ -0,0 +1,29 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +import public "models/onu_alarm_subscription.proto"; +import public "models/dev_info_subscription.proto"; +import public "models/cm_conn_subscription.proto"; +import public "models/ani_alarm_subscription.proto"; + + +message Subscription { + oneof subscription { + OnuAlarmSubscription onu_alarm_subscription = 1; + DevInfoSubscription dev_info_subscription = 2; + CmConnSubscription cm_conn_subscription = 3; + AniAlarmSubscription ani_alarm_subscription = 4; + } +} diff --git a/proto3/models/subscription_link_list.proto b/proto3/models/subscription_link_list.proto new file mode 100644 index 0000000000000000000000000000000000000000..5e777ab831a16f42a0f2b6c4f053076310bab74d --- /dev/null +++ b/proto3/models/subscription_link_list.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/subscription_link_list_links.proto"; + +message SubscriptionLinkList { + + SubscriptionLinkListLinks links = 1; + +} diff --git a/proto3/models/subscription_link_list_links.proto b/proto3/models/subscription_link_list_links.proto new file mode 100644 index 0000000000000000000000000000000000000000..66a91240191eef18bee14ef44e27a09bd22e93e4 --- /dev/null +++ b/proto3/models/subscription_link_list_links.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/subscription_link_list_links_subscription.proto"; + +message SubscriptionLinkListLinks { + + repeated SubscriptionLinkListLinksSubscription subscription = 1; + +} diff --git a/proto3/models/subscription_link_list_links_subscription.proto b/proto3/models/subscription_link_list_links_subscription.proto new file mode 100644 index 0000000000000000000000000000000000000000..0d4b18be5f49fb437572166ab71ac1c893d743af --- /dev/null +++ b/proto3/models/subscription_link_list_links_subscription.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/subscription_link_list_links_subscription_subscription_type.proto"; + +message SubscriptionLinkListLinksSubscription { + + // The URI referring to the subscription. + string href = 1; + + SubscriptionLinkListLinksSubscriptionSubscriptionType subscription_type = 2; + +} diff --git a/proto3/models/subscription_link_list_links_subscription_subscription_type.proto b/proto3/models/subscription_link_list_links_subscription_subscription_type.proto new file mode 100644 index 0000000000000000000000000000000000000000..f1fde352013a2f830c71269c4e3d88b1e8bb84eb --- /dev/null +++ b/proto3/models/subscription_link_list_links_subscription_subscription_type.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message SubscriptionLinkListLinksSubscriptionSubscriptionType { +enum TypeEnum { + SUBSCRIPTION_LINK_LIST_LINKS_SUBSCRIPTION_SUBSCRIPTION_TYPE_TYPE_ENUM_0 = 0; + SUBSCRIPTION_LINK_LIST_LINKS_SUBSCRIPTION_SUBSCRIPTION_TYPE_TYPE_ENUM_1 = 1; + SUBSCRIPTION_LINK_LIST_LINKS_SUBSCRIPTION_SUBSCRIPTION_TYPE_TYPE_ENUM_2 = 2; + SUBSCRIPTION_LINK_LIST_LINKS_SUBSCRIPTION_SUBSCRIPTION_TYPE_TYPE_ENUM_3 = 3; + SUBSCRIPTION_LINK_LIST_LINKS_SUBSCRIPTION_SUBSCRIPTION_TYPE_TYPE_ENUM_4 = 4; + } +} diff --git a/proto3/models/time_stamp.proto b/proto3/models/time_stamp.proto new file mode 100644 index 0000000000000000000000000000000000000000..e2a537b417dc93af8782ce5a5143ff2d2a283d2d --- /dev/null +++ b/proto3/models/time_stamp.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message TimeStamp { + + // The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + int32 nano_seconds = 1; + + // The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC. + int32 seconds = 2; + +} diff --git a/proto3/models/trace_route_diagnostics.proto b/proto3/models/trace_route_diagnostics.proto new file mode 100644 index 0000000000000000000000000000000000000000..dbd80cf2a165695ea9236711a6ea2eb2638b755b --- /dev/null +++ b/proto3/models/trace_route_diagnostics.proto @@ -0,0 +1,39 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/trace_route_diagnostics_diagnostics_state.proto"; + +message TraceRouteDiagnostics { + + // Size of the data block in bytes to be sent for each trace route. + int32 data_block_size = 1; + + TraceRouteDiagnosticsDiagnosticsState diagnostics_state = 2; + + // Host name or address of the host to find a route to. + string host = 3; + + // The maximum number of hop used in outgoing probe packets. The default is 30 hops. + int32 max_hop_count = 4; + + // Result parameter indicating the number of hops within the discovered route. If a route could not be determined, this value shall be zero. + int32 number_of_route_hops = 5; + + // Result parameter indicating the response time in milliseconds the most recent trace route test. If a route could not be determined, this value shall be zero. + int32 response_time = 6; + + // Timeout in milliseconds for the trace route test. + int32 timeout = 7; + +} diff --git a/proto3/models/trace_route_diagnostics_diagnostics_state.proto b/proto3/models/trace_route_diagnostics_diagnostics_state.proto new file mode 100644 index 0000000000000000000000000000000000000000..5331b7d2e76130500605e52be01d6dc39f382308 --- /dev/null +++ b/proto3/models/trace_route_diagnostics_diagnostics_state.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message TraceRouteDiagnosticsDiagnosticsState { +enum TypeEnum { + TRACE_ROUTE_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_1 = 0; + TRACE_ROUTE_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_2 = 1; + TRACE_ROUTE_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_3 = 2; + TRACE_ROUTE_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_4 = 3; + TRACE_ROUTE_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_5 = 4; + TRACE_ROUTE_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_6 = 5; + TRACE_ROUTE_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_7 = 6; + } + +} diff --git a/proto3/models/upload_diagnostics.proto b/proto3/models/upload_diagnostics.proto new file mode 100644 index 0000000000000000000000000000000000000000..ff3856141e5146b008591f55faebbd9afaf9a9b0 --- /dev/null +++ b/proto3/models/upload_diagnostics.proto @@ -0,0 +1,41 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/time_stamp.proto"; +import public "models/upload_diagnostics_diagnostics_state.proto"; + +message UploadDiagnostics { + + TimeStamp b_om_time = 1; + + UploadDiagnosticsDiagnosticsState diagnostics_state = 2; + + TimeStamp e_om_time = 3; + + TimeStamp r_om_time = 4; + + TimeStamp tcp_ppen_reponse_time = 5; + + TimeStamp tcp_open_request_time = 6; + + // The test traffic sent in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between b_oMTime and e_oMTime. + int32 test_bytes_sent = 7; + + // The size of the file (in bytes) to be uploaded to the server. + int32 test_file_length = 8; + + // The URI for the device to perform the upload to. + string upload_uri = 9; + +} diff --git a/proto3/models/upload_diagnostics_diagnostics_state.proto b/proto3/models/upload_diagnostics_diagnostics_state.proto new file mode 100644 index 0000000000000000000000000000000000000000..edefc5b705ceff84756ff64d9b04fcd02506d5a4 --- /dev/null +++ b/proto3/models/upload_diagnostics_diagnostics_state.proto @@ -0,0 +1,31 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + + +message UploadDiagnosticsDiagnosticsState { +enum TypeEnum { + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_1 = 0; + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_2 = 1; + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_3 = 2; + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_4 = 3; + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_5 = 4; + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_6 = 5; + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_7 = 6; + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_8 = 7; + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_9 = 8; + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_10 = 9; + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_11 = 10; + UPLOAD_DIAGNOSTICS_DIAGNOSTICS_STATE_TYPE_ENUM_12 = 11; + } +} diff --git a/proto3/services/cable_line_info_service.proto b/proto3/services/cable_line_info_service.proto new file mode 100644 index 0000000000000000000000000000000000000000..5e66622908ed727be7daed541bcb3243e37408a8 --- /dev/null +++ b/proto3/services/cable_line_info_service.proto @@ -0,0 +1,31 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cable_line_info.proto"; +import public "models/cp_info.proto"; +import public "models/problem_details.proto"; + +service CableLineInfoService { + rpc CableLineInfoGET (CableLineInfoGETRequest) returns (CableLineInfo); + +} + +message CableLineInfoGETRequest { + // Comma separated list of customer premises information + repeated CpInfo customer_premises_info = 1; + // Comma separated list of Cable Modem identifiers. + repeated string cm_id = 2; + +} + diff --git a/proto3/services/optical_network_info_service.proto b/proto3/services/optical_network_info_service.proto new file mode 100644 index 0000000000000000000000000000000000000000..1213078348c310a0eae086e1575d3cc1ffdb6559 --- /dev/null +++ b/proto3/services/optical_network_info_service.proto @@ -0,0 +1,37 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cp_info.proto"; +import public "models/pon_info.proto"; +import public "models/problem_details.proto"; + +service OpticalNetworkInfoService { + rpc OpticalNetworkInfoGET (OpticalNetworkInfoGETRequest) returns (OpticalNetworkInfoGETResponse); + +} + +message OpticalNetworkInfoGETRequest { + // Comma separated list of customer premises information + repeated CpInfo customer_premises_info = 1; + // Comma separated list of optical system identifiers. + repeated string pon_ysid = 2; + // Comma separated list of optical network unit identifiers. + repeated string onu_id = 3; + +} + +message OpticalNetworkInfoGETResponse { + repeated PonInfo data = 1; +} + diff --git a/proto3/services/queries_service.proto b/proto3/services/queries_service.proto new file mode 100644 index 0000000000000000000000000000000000000000..d3b2337bdb8bd9b14a32c612ed8aa9811da5ee98 --- /dev/null +++ b/proto3/services/queries_service.proto @@ -0,0 +1,52 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import public "models/cp_info.proto"; +import public "models/device_info.proto"; +import public "models/fa_info.proto"; +import public "models/problem_details.proto"; + +service QueriesService { + rpc DeviceInfoGET (DeviceInfoGETRequest) returns (DeviceInfo); + + rpc FaInfoGET (FaInfoGETRequest) returns (FaInfo); + +} + +message DeviceInfoGETRequest { + // Comma separated list of gateway identifier + repeated string gw_id = 1; + // Comma separated list of device identifier. + repeated string device_id = 2; + // Comma separated list of device status. + repeated int32 device_status = 3; + +} + +message FaInfoGETRequest { + // Comma separated list of customer premises information + repeated CpInfo customer_premises_info = 1; + // Comma separated list of last mile technologies. + repeated int32 last_mile_tech = 2; + // Comma separated list of interface types. + repeated int32 interface_type = 3; + // Comma separated list of the bandwidth (in Mbps) from the network towards the customer site. + repeated int32 dsbw = 4; + // Comma separated list of the bandwidth (in Mbps) from the customer site towards the network. + repeated int32 usbw = 5; + // Comma separated list of the maximum baseline latency (in ms) between customer site and service edge node. + repeated int32 latency = 6; + +} + diff --git a/proto3/services/subscription_service.proto b/proto3/services/subscription_service.proto new file mode 100644 index 0000000000000000000000000000000000000000..6a59d4306a4987f0a5d1a1722d3ee955d74dd6f5 --- /dev/null +++ b/proto3/services/subscription_service.proto @@ -0,0 +1,62 @@ +/* + ETSI GS MEC 029 Fixed Access Information API + + ETSI GS MEC 029 Fixed Access Information API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec029; + +import "google/protobuf/empty.proto"; +import public "models/subscription.proto"; +import public "models/problem_details.proto"; +import public "models/subscription_link_list.proto"; + +service SubscriptionService { + rpc IndividualSubscriptionDELETE (IndividualSubscriptionDELETERequest) returns (google.protobuf.Empty); + + rpc IndividualSubscriptionGET (IndividualSubscriptionGETRequest) returns (Subscription); + + rpc IndividualSubscriptionPUT (IndividualSubscriptionPUTRequest) returns (Subscription); + + rpc SubGET (SubGETRequest) returns (SubscriptionLinkList); + + rpc SubPOST (SubPOSTRequest) returns (Subscription); + +} + +message IndividualSubscriptionDELETERequest { + // Refers to created subscription, where the FAI API allocates a unique resource name for this subscription + string subscription_id = 1; + +} + +message IndividualSubscriptionGETRequest { + // Refers to created subscription, where the FAI API allocates a unique resource name for this subscription + string subscription_id = 1; + +} + +message IndividualSubscriptionPUTRequest { + // Refers to created subscription, where the FAI API allocates a unique resource name for this subscription + string subscription_id = 1; + Subscription subscription = 2; + +} + +message SubGETRequest { + // Query parameter to filter on a specific subscription type. Permitted values: ONU_ALARM. DEVICE_ABNORMAL_ALERT. CM_CONNECTIVITY_STATE. ANI_ALARM. + string subscription_type = 1; + +} + +message SubPOSTRequest { + Subscription subscription = 1; + +} +