Commit 658cd5a9 authored by piscione's avatar piscione
Browse files

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/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;
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 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;
DevInfoSubscriptionFilterCriteriaDevInfo filterCriteriaDevInfo = 4;
// Shall be set to \"DevInfoSubscription\".
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/device_err_status.proto";
message DevInfoSubscriptionFilterCriteriaDevInfo {
repeated DeviceErrStatus deviceErrStatus = 1;
// The device identifier.
repeated string deviceId = 2;
// The identifier of an Internet Gateway Device through which the customer premises device is connected.
repeated string gwId = 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 DevInfoSubscriptionLinks {
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 DeviceErrStatus {
}
/*
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_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 deviceId = 1;
DeviceInfoDeviceStatus deviceStatus = 2;
DownloadDiagnostics downloadDiagnostics = 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 gwId = 4;
// The time in seconds that the IP interface has been connected.
int32 iPConnectionUpTime = 5;
IPPingDiagnostics iPPingDiagnostics = 6;
TimeStamp timeStamp = 7;
// Total number of IP payload bytes received since the device was last restarted.
int32 totalBytesReceived = 8;
// Total number of IP payload bytes sent since the device was last restarted.
int32 totalBytesSent = 9;
// Total number of packets received since the device was last restarted.
int32 totalPacketsReceived = 10;
// Total number of packets sent since the device was last restarted.
int32 totalPacketsSent = 11;
TraceRouteDiagnostics traceRouteDiagnostics = 12;
// Time in seconds since the device was last restarted.
int32 upTime = 13;
UploadDiagnostics uploadDiagnostics = 14;
}
/*
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 DeviceInfoDeviceStatus {
}
/*
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/download_diagnostics_diagnostics_state.proto";
import public "models/time_stamp.proto";
message DownloadDiagnostics {
TimeStamp bOMTime = 1;
DownloadDiagnosticsDiagnosticsState diagnosticsState = 2;
// The URI for the device to perform the download on.
string downloadURI = 3;
TimeStamp eOMTime = 4;
TimeStamp rOMTime = 5;
TimeStamp tCPOpenReponseTime = 6;
TimeStamp tCPOpenRequestTime = 7;
// The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime.
int32 testBytesReceived = 8;
// The total number of bytes received on the Interface between bOMTime and eOMTime.
int32 totalBytesReceived = 9;
}
/*
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 DownloadDiagnosticsDiagnosticsState {
}
/*
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/expiry_notification_links.proto";
import public "models/time_stamp.proto";
message ExpiryNotification {
ExpiryNotificationLinks Underscorelinks = 1;
TimeStamp expiryDeadline = 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;
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;
}
/*
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/fa_info_connectivity_info.proto";
import public "models/time_stamp.proto";
message FaInfo {
repeated FaInfoConnectivityInfo connectivityInfo = 1;
// The physical location of a customer site.
repeated 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/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 interfaceType = 2;
FaInfoConnectivityInfoLastMileTech lastMileTech = 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;
}
/*
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 FaInfoConnectivityInfoInterfaceType {
}
/*
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 FaInfoConnectivityInfoLastMileTech {
}
/*
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/ip_ping_diagnostics_diagnostics_state.proto";
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 averageResponseTime = 1;
// Size of the data block in bytes to be sent for each ping.
int32 dataBlockSize = 2;
IPPingDiagnosticsDiagnosticsState diagnosticsState = 3;
// Result parameter indicating the number of failed pings in the most recent ping test.
int32 failureCount = 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 maximumResponseTime = 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 minimumResponseTime = 7;
// Number of repetitions of the ping test to perform before reporting the results.
int32 numberOfRepetitions = 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 successCount = 9;
// Timeout in milliseconds for the ping test.
int32 timeout = 10;
}
/*
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 IPPingDiagnosticsDiagnosticsState {
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment