Commit 658cd5a9 authored by piscione's avatar piscione

Added draft of proto files.

parent 2b361c37
Pipeline #5201 passed with stage
in 0 seconds
/*
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
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 aniId = 2;
// The physical location of the related customer sites.
repeated CpInfo customerPremisesInfo = 3;
// Shall be set to \"AniAlarmNotification\".
string notificationType = 4;
string onuId = 5;
TimeStamp timeStamp = 6;
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;
message AniAlarmNotificationAlarm {
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;
message AniAlarmNotificationAniId {
// The unique identifiers for the optical network unit.
string onuId = 1;
// The index of an access network interface supported by the optical network unit.
string aniIndex = 2;
}
/*
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
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 subscriptionType = 1;
AniAlarmSubscriptionLinks Underscorelinks = 2;
// The index of an access network interface supported by the optical network unit.
string aniIndex = 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 callbackReference = 4;
TimeStamp expiryDeadline = 5;
AniAlarmSubscriptionFilterCriteriaAniAlarm filterCriteriaAniAlarm = 6;
}
/*
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
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 customerPremisesInfo = 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 onuId = 2;
AniAlarmSubscriptionFilterCriteriaAniAlarmAniId aniId = 3;
repeated AniAlarmSubscriptionFilterCriteriaAniAlarmAlarms alarms = 4;
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;
message AniAlarmSubscriptionFilterCriteriaAniAlarmAlarms {
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;
message AniAlarmSubscriptionFilterCriteriaAniAlarmAniId {
// The unique identifiers for the optical network unit
string onuId = 1;
// The index of an access network interface supported by the optical network unit
string aniIndex = 2;
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;
import public "models/link_type.proto";
message AniAlarmSubscriptionLinks {
LinkType self = 1;
}
/*
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
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 cmInfo = 1;
CpInfo customerPremisesInfo = 2;
TimeStamp timeStamp = 3;
}
/*
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
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 cmDpvStats = 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 cmId = 2;
CableLineInfoCmInfoCmStatus cmStatus = 3;
repeated CableLineInfoCmInfoServiceFlowStats serviceFlowStats = 4;
}
/*
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
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 avgLatency = 1;
// It represents the interface Index of the Downstream Interface where the measurements are taken.
string ifIndex = 2;
// The last latency measurement.
int32 lastMeasLatency = 3;
TimeStamp lastMeasTime = 4;
// The maximum latency measurement.
int32 maxLatency = 5;
// The minimum latency measurement.
int32 minLatency = 6;
// The number of latency measurements made.
int32 numMeas = 7;
}
/*
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
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 cmRegState = 1;
// It indicates whether the CM is currently operating in Energy Management DLS Mode.
bool emDlsOperStatus = 2;
// It indicates whether the CM is currently operating in Energy Management 1x1 Mode.
bool energyMgt1x1OperStatus = 3;
// It denotes the MAC Domain interface index of the CM.
string ifIndex = 4;
// It denotes the number of times the CM received invalid registration response messages.
int32 invalidRegRsps = 5;
// It denotes the number of times the CM lost synchronization with the downstream channel.
int32 lostSyncs = 6;
// It denotes the number of times the CM reset or initialized this interface.
int32 resets = 7;
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;
message CableLineInfoCmInfoCmStatusCmRegState {
}
/*
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
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 ifIndex = 1;
repeated CableLineInfoCmInfoServiceFlowStatsServiceFlowInfo serviceFlowInfo = 2;
}
/*
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
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 aqmDroppedPkts = 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 policedDelayPkts = 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 policedDropPkts = 4;
// It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.
int32 serviceFlowId = 5;
// It indicates the number of seconds that the service flow has been active.
int32 timeActive = 6;
TimeStamp timeCreated = 7;
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;
import public "models/cp_info.proto";
import public "models/time_stamp.proto";
import public "models/todo_object_mapping.proto";
message CmConnNotification {
repeated array[TODO_OBJECT_MAPPING] cmIf = 1;
CpInfo customerPremisesInfo = 2;
// Shall be set to \\\"CmconnNotification\\\".
string notificationType = 3;
TimeStamp timeStamp = 4;
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;
import public "models/repeat.proto";
import public "models/todo_object_mapping.proto";
message CmConnNotificationCmIf {
}
/*
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
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 Underscorelinks = 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 callbackReference = 2;
TimeStamp expiryDeadline = 3;
CmConnSubscriptionFilterCriteriaCmConn filterCriteriaCmConn = 4;
// Shall be set to \"CmConnSubscription\".
string subscriptionType = 5;
}
/*
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
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 {
CmConnSubscriptionFilterCriteriaCmConnCmIf cmIf = 1;
CpInfo customerPremisesInfo = 2;
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;
import public "models/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 cmId = 1;
repeated CmRegState cmRegState = 2;
// The MAC Domain interface index of the CM.
repeated string ifIndex = 3;
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;
import public "models/link_type.proto";
message CmConnSubscriptionLinks {
LinkType self = 1;
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;
message CmRegState {
}
/*
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
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 postalCode = 3;
}
/*
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
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 deviceErrStatus = 1;
// The identifier for a device.
string deviceId = 2;
// Shall be set to \"DevInfoNotification\".
string notificationType = 3;
TimeStamp timeStamp = 4;
}
/*
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
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec029;