Commit da441083 authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Merge branch 'develop' into 'master'

MEC028 v2.2.1 update - OAS & Proto3 representation updated

OAS & Proto3 representation have been updated to v2.2.1 specification.

Update followed [OpenAPI development guidelines](https://mecwiki.etsi.org/index.php?title=OpenAPI_development_guidelines)
- Generation using doc2oas *(a separate merge request has been created for the config file update)*
- Level-1 validation passing *(no warnings in Swagger-Editor, swagger-cli validate, speccy lint)*
- Level-2 validation passing *(no error in Swagger-UI, visual inspection)*
- Level-3 validation passing *(swagger code generation)*
- Proto3 generation passing
- Proto3 code generation passing
- Jenkins validation passing

See merge request !5
parents 4b527617 0f2db027
Pipeline #9934 passed with stage
in 0 seconds
/*
ETSI GS MEC 028 - WLAN Access Information API
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec028;
import public "models/beacon_request_config.proto";
import public "models/channel_load_config.proto";
import public "models/neighbor_report_config.proto";
import public "models/sta_statistics_config.proto";
message MeasurementInfo {
BeaconRequestConfig beaconRequestConf = 1;
ChannelLoadConfig channelLoadConf = 2;
// Duration of the measurement in Time Units (TUs) of 1 024 µs, as defined in section 11.11.4 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports.
int32 measurementDuration = 3;
NeighborReportConfig neighborReportConf = 4;
// Random interval to be used for starting the measurement in TUs of 1 024 µs, as specified in section 11.11.3 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports.
int32 randomInterval = 5;
StaStatisticsConfig staStatisticsConf = 6;
}
/*
ETSI GS MEC 028 - WLAN Access Information API
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec028;
import public "models/beacon_report.proto";
import public "models/channel_load.proto";
import public "models/neighbor_report.proto";
import public "models/sta_statistics.proto";
import public "models/time_stamp.proto";
message MeasurementReportNotification {
// Beacon Report as defined in IEEE 802.11-2016 [8].
repeated BeaconReport beaconReport = 1;
// Channel Load reports as seen by the station as defined in IEEE 802.11-2016 [8].
repeated ChannelLoad channelLoad = 2;
// Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE 802.112016 [8].
repeated NeighborReport neighborReport = 3;
// Shall be set to \"MeasurementReportNotification\".
string notificationType = 4;
// STA Statistics Report as defined in IEEE 802.11-2016 [8].
repeated StaStatistics staStatistics = 5;
TimeStamp timeStamp = 6;
}
/*
ETSI GS MEC 028 - WLAN Access Information API
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec028;
import public "models/assoc_sta_subscription_links.proto";
import public "models/measurement_info.proto";
import public "models/sta_identity.proto";
import public "models/time_stamp.proto";
import public "models/websock_notif_config.proto";
message MeasurementReportSubscription {
AssocStaSubscriptionLinks Underscorelinks = 1;
string callbackReference = 2;
TimeStamp expiryDeadline = 3;
// Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement subscription.
string measurementId = 4;
MeasurementInfo measurementInfo = 5;
// Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications.
bool requestTestNotification = 6;
// Identifier(s) to uniquely specify the target client station(s) for the subscription.
repeated StaIdentity staId = 7;
// Shall be set to \"MeasurementReportSubscription\".
string subscriptionType = 8;
WebsockNotifConfig websockNotifConfig = 9;
}
......@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.1.1
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
......@@ -12,22 +12,31 @@ syntax = "proto3";
package mec028;
import public "models/bssid_info.proto";
import public "models/sta_identity.proto";
message NeighborReport {
// BSS Id of the Access Point that is being reported.
string bssid = 1;
// Relative value indicating the preferred ordering for this BSS as a transition candidate for roaming. 255 indicating the most preferred candidate and 1 indicating the least preferred candidate, as defined in Table 9-152 within IEEE 802.112016 [8].
int32 bssTransitionCandidatePreference = 1;
// Additional information related to Access Point that is being reported such as AP reachability, security, key scope, Mobility Domain, HT/VHT capability and Fine Time Measurements.
int32 bssid_info = 2;
// BSSID (MAC address) of the Access Point that is being reported.
string bssid = 2;
// The channel currently used by this Access Point.
int32 channel = 3;
BssidInfo bssidInfo = 3;
// The channel set of the AP indicated by this BSSID.
int32 operating_class = 4;
// Channel field indicates a channel number, which is interpreted in the context of the indicated operating class. Channel numbers are defined in Annex E within IEEE 802.11-2016 [8].
int32 channel = 4;
// PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType.
int32 phy_type = 5;
// Measurement ID of the Measurement configuration applied to this Neighbor Report.
string measurementId = 5;
// Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].
int32 operatingClass = 6;
// PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType, Annex C within IEEE 802.11-2016 [8]. 2 = dsss 4 = ofdm 5 = hrdsss 6 = erp 7 = ht 8 = dmg 9 = vht 10 = tvht
int32 phyType = 7;
StaIdentity staId = 8;
}
/*
ETSI GS MEC 028 - WLAN Access Information API
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec028;
message NeighborReportConfig {
// BSSID of the neighbor AP which information is intended to obtain. If no specific BSSID is given, the information will be provided for all APs matching the ssid criteria.
string bssid = 1;
// The SSID field is optionally present. If present, it contains an SSID element. The presence of an SSID element in a Neighbor Report indicates a request for a neighbor list for the specified SSID in the SSID Element. The absence of an SSID element indicates neighbor report for the current ESS.
string ssid = 2;
}
/*
ETSI GS MEC 028 - WLAN Access Information API
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec028;
message OBssLoad {
// Mean of allocated traffic from this AP (BSS) in units of 32 µs per second.
int32 allocatedTrafficSelfMean = 1;
// Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second.
int32 allocatedTrafficSelfStdDev = 2;
// Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.
int32 allocatedTrafficShareMean = 3;
// Standard deviation from the mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.
int32 allocatedTrafficShareStdDev = 4;
// Indicates the number of other APs that are sharing the same channel as the reporting AP.
int32 overlap = 5;
}
......@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.1.1
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
......
/*
ETSI GS MEC 028 - WLAN Access Information API
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec028;
message ReportedBeaconFrameInfo {
// A value of 0 indicates a Beacon or Probe Response. A value of 1 indicates a Measurement Pilot frame.
int32 frameType = 1;
// Value between 0 and 127 coded according to dot11PHYType.
int32 phyType = 2;
}
/*
ETSI GS MEC 028 - WLAN Access Information API
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec028;
message ReportingReasonQoSCounters {
// dot11QoSAckFailure
bool qosAckFailure = 1;
// dot11QoSDiscarded
bool qosDiscarded = 2;
// dot11QoSFailed
bool qosFailed = 3;
// dot11QoSFrameDuplicate
bool qosFrameDuplicate = 4;
// dot11QoSMultipleRetry
bool qosMultipleRetry = 5;
// dot11QoSRetry
bool qosRetry = 6;
// dot11QoSRTSFailure
bool qosRtsFailure = 7;
}
/*
ETSI GS MEC 028 - WLAN Access Information API
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec028;
message ReportingReasonStaCounters {
// dot11AckFailure
bool ackFailure = 1;
// dot11Failed
bool failed = 2;
// dot11FCSError
bool fcsError = 3;
// dot11FrameDuplicate
bool frameDuplicate = 4;
// dot11MultipleRetry
bool multipleRetry = 5;
// dot11Retry
bool retry = 6;
// dot11RTSFailure
bool rtsFailure = 7;
}
......@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.1.1
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
......
/*
ETSI GS MEC 028 - WLAN Access Information API
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec028;
message STACounterTriggerCondition {
// Configure and set threshold for dot11AckFailureCount trigger
int32 ackFailureCountThreshold = 1;
// Configure and set threshold for dot11FailedCount trigger
int32 failedCountThreshold = 2;
// Configure and set threshold for dot11FCSErrorCount trigger
int32 fcsErrorCountThreshold = 3;
// Configure and set threshold for dot11FrameDuplicateCount trigger
int32 frameDuplicateCountThreshold = 4;
// Configure and set threshold for dot11MultipleRetryCount trigger
int32 multipleRetryCountThreshold = 5;
// Configure and set threshold for dot11RetryCount trigger
int32 retryCountThreshold = 6;
// Configure and set threshold for dot11RTSFailureCount trigger
int32 rtsFailureCountThreshold = 7;
}
......@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.1.1
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
......@@ -16,12 +16,12 @@ import public "models/sta_identity.proto";
message StaDataRate {
StaIdentity sta_id = 1;
StaIdentity staId = 1;
// The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station.
int32 sta_last_data_downlink_rate = 2;
int32 staLastDataDownlinkRate = 2;
// The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point.
int32 sta_last_data_uplink_rate = 3;
int32 staLastDataUplinkRate = 3;
}
......@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.1.1
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
......@@ -18,11 +18,11 @@ import public "models/time_stamp.proto";
message StaDataRateNotification {
// Shall be set to \"StaDataRateNotification\".
string notification_type = 1;
string notificationType = 1;
// Data rates of a client station.
repeated StaDataRate sta_data_rate = 2;
repeated StaDataRate staDataRate = 2;
TimeStamp time_stamp = 3;
TimeStamp timeStamp = 3;
}
......@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.1.1
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
......@@ -13,22 +13,33 @@ syntax = "proto3";
package mec028;
import public "models/assoc_sta_subscription_links.proto";
import public "models/sta_data_rate_subscription_notification_event.proto";
import public "models/sta_identity.proto";
import public "models/time_stamp.proto";
import public "models/websock_notif_config.proto";
message StaDataRateSubscription {
AssocStaSubscriptionLinks underscorelinks = 1;
AssocStaSubscriptionLinks Underscorelinks = 1;
// URI selected by the service consumer to receive notifications on the subscribed WLAN Access Information Service. This shall be included both in the request and in response.
string callback_reference = 2;
string callbackReference = 2;
TimeStamp expiry_deadline = 3;
TimeStamp expiryDeadline = 3;
// Identifier(s) to uniquely specify the target client station(s) for the subscription
repeated StaIdentity sta_id = 4;
StaDataRateSubscriptionNotificationEvent notificationEvent = 4;
// Set for periodic notification reporting. Value indicates the notification period in seconds.
int32 notificationPeriod = 5;
// Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications.
bool requestTestNotification = 6;
// Identifier(s) to uniquely specify the target client station(s) for the subscription.
repeated StaIdentity staId = 7;
// Shall be set to \"StaDataRateSubscription\".
string subscription_type = 5;
string subscriptionType = 8;
WebsockNotifConfig websockNotifConfig = 9;
}
/*
ETSI GS MEC 028 - WLAN Access Information API
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
syntax = "proto3";
package mec028;
message StaDataRateSubscriptionNotificationEvent {
// Downlink data rate threshold for StaDataRate reporting.
int32 downlinkRateThreshold = 1;
// Trigger event for the notification: 1 = Notification issued when the STA's downlink data rate is greater than or equal to the downlink threshold. 2 = Notification issued when the STA's downlink data rate is less than or equal to the downlink threshold. 3 = Notification issued when the STA's uplink data rate is greater than or equal to the uplink threshold. 4 = Notification issued when the STA's uplink data rate is less than or equal to the uplink threshold. 5 = Notification issued when the STA's downlink and uplink data rate is greater than or equal to their thresholds. 6 = Notification issued when the STA's downlink and uplink data rate is less than or equal to their thresholds. 7 = Notification issued when the STA's downlink or uplink data rate is greater than or equal to their thresholds. 8 = Notification issued when the STA's downlink or uplink data rate is less than or equal to their thresholds.
enum TriggerEnum {
_1 = 0;
_2 = 1;
_3 = 2;
_4 = 3;
_5 = 4;
_6 = 5;
_7 = 6;
_8 = 7;
}
TriggerEnum trigger = 2;
// Uplink data rate threshold for StaDataRate reporting.
int32 uplinkRateThreshold = 3;
}
......@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.1.1
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
......@@ -15,16 +15,16 @@ package mec028;
message StaIdentity {
// Number which identifies a particular association between a station and an Access Point
// Number which identifies a particular association between a station and an Access Point
string aid = 1;
// IPv4 or IPv6 address allocated for the station.
repeated string ip_address = 2;
// IPv4 or IPv6 address(es) allocated for the station.
repeated string ipAddress = 2;
// Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.
string mac_id = 3;
string macId = 3;
// Service Set Identifier to identify logical networks.
// Service Set Identifier(s) to identify logical networks.
repeated string ssid = 4;
}
......@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
The version of the OpenAPI document: 2.1.1
The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
......@@ -14,6 +14,8 @@ package mec028;
import public "models/ap_associated.proto";
import public "models/beacon_report.proto";
import public "models/channel_load.proto";
import public "models/neighbor_report.proto";
import public "models/rssi.proto";
import public "models/sta_data_rate.proto";
import public "models/sta_identity.proto";
......@@ -22,21 +24,29 @@ import public "models/time_stamp.proto";
message StaInfo {
ApAssociated ap_associated = 1;
ApAssociated apAssociated = 1;
BeaconReport beacon_report = 2;
// Beacon Report as defined in IEEE 802.11-2016 [8].
repeated BeaconReport beaconReport = 2;
// Channel currently used by the station.
// Channel currently used by the station to connect with its associated Access Point.
int32 channel = 3;
Rssi rssi = 4;
// Channel Load reports as seen by the station as defined IEEE 802.11-2016 [8]. Channel Load reports may be configured for any channel, including the station's current channel for association.
repeated ChannelLoad channelLoad = 4;
StaDataRate sta_data_rate = 5;
// Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016 [8].
repeated NeighborReport neighborReport = 5;
StaIdentity sta_id = 6;
Rssi