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/bss_capabilities.proto";
message BssidInfo {
// The apReachability field indicates whether the AP identified by this BSSID is reachable by the STA that requested the neighbor report. Valid values: 0 = reserved 1 = not reachable 2 = unknown 3 = reachable.
int32 apReachability = 1;
BssCapabilities capabilities = 2;
// True indicates the AP represented by this BSSID is an AP that has set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1. False indicates either that the reporting AP has dot11FineTimingMsmtRespActivated equal to false, or the reported AP has not set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1 or that the Fine Timing Measurement Responder field of the reported AP is not available to the reporting AP at this time.
bool ftm = 3;
// True indicates that the AP represented by this BSSID is an HT AP including the HT Capabilities element in its Beacons, and that the contents of that HT Capabilities element are identical to the HT Capabilities element advertised by the AP sending the report.
bool highThroughput = 4;
// True indicates the AP represented by this BSSID is including an MDE in its Beacon frames and that the contents of that MDE are identical to the MDE advertised by the AP sending the report.
bool mobilityDomain = 5;
// True indicates the AP identified by this BSSID supports the same security provisioning as used by the STA in its current association. False indicates either that the AP does not support the same security provisioning or that the security information is not available at this time.
bool security = 6;
// True indicates that the AP represented by this BSSID is a VHT AP and that the VHT Capabilities element, if included as a subelement in the report, is identical in content to the VHT Capabilities element included in the AP's Beacon.
bool veryHighThroughput = 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;
import public "models/sta_identity.proto";
message ChannelLoad {
// Channel number indicates the channel number for which the measurement report applies.
int32 channel = 1;
// Proportion of measurement duration for which the measuring STA determined the channel to be busy, as a percentage of time, linearly scaled with 255 representing 100 %.
int32 channelLoad = 2;
// Duration over which the Channel Load report was measured, in units of TUs of 1 024 µs.
int32 measurementDuration = 3;
// Measurement ID of the Measurement configuration applied to this Channel Load Report.
string measurementId = 4;
// Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].
int32 operatingClass = 5;
StaIdentity staId = 6;
}
......@@ -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,16 +12,19 @@ syntax = "proto3";
package mec028;
import public "models/ap_identity.proto";
message ChannelLoadConfig {
ApIdentity ap_id = 1;
// Channel for which the channel load report is requested.
int32 channel = 1;
// Channel number which load is reported
int32 c_channel_id = 2;
// Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].
int32 operatingClass = 2;
// Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3
int32 channel_load = 3;
// Reporting condition for the Beacon Report as per Table 9-153 of IEEE 802.11-2016 [8]: 0 = Report to be issued after each measurement. 1 = Report to be issued when Channel Load is greater than or equal to the threshold. 2 = Report to be issued when Channel Load is less than or equal to the threshold. If this optional field is not provided, channel load report should be issued after each measurement (reportingCondition = 0).
int32 reportingCondition = 3;
// Channel Load reference value for threshold reporting. This field shall be provided for reportingCondition values 1 and 2.
int32 threshold = 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
*/
......@@ -18,7 +18,7 @@ message CivicLocation {
// Language
string ca0 = 1;
// National subdivisions (state, canton, region,province, prefecture)
// National subdivisions (state, canton, region, province, prefecture)
string ca1 = 2;
// Script
......
......@@ -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,28 +15,22 @@ package mec028;
message DmgCapabilities {
// Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 [i.11]
int32 ext_sc_mcs_cap = 1;
// Extended SC MCS capabilities as defined in IEEE 802.11-2016 [8].
int32 ExtScMcsCap = 1;
// DMG AP or PCP capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]
int32 dmg_ap_or_pcp_cap_info = 2;
// DMG AP or PCP capabilities information as defined in IEEE 802.11-2016 [8].
int32 dmgApOrPcpCapInfo = 2;
// DMG station beam tracking time limit as defined in draft IEEE P802.11/D4.0 [i.11]
int32 dmg_sta_beam_track_time_limit = 3;
// DMG station beam tracking time limit as defined in IEEE 802.11-2016 [8].
int32 dmgStaBeamTrackTimeLimit = 3;
// DMG station capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]
int64 dmg_sta_cap_info = 4;
// DMG station capabilities information as defined in IEEE 802.11-2016 [8].
int32 dmgStaCapInfo = 4;
// Number of basic A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]
int32 max_nr_basic_amsdu_subframes = 5;
// Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].
int32 maxNrBasicAmsduSubframes = 5;
// Number of short A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]
int32 max_nr_short_amsdu_subframes = 6;
// SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11]
int32 sar_cap = 7;
// TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11]
int32 tdd_cap = 8;
// Number of short A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].
int32 maxNrShortAmsduSubframes = 6;
}
......@@ -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,15 +15,13 @@ package mec028;
message EdmgCapabilities {
// A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11]
int32 ampdu_parameters = 1;
// A-MPDU parameters as defined in draft IEEE P802.11ay [i.11]
int32 ampduParameters = 1;
int32 reserved = 2;
// Supported MCS as defined in draft IEEE P802.11ay [i.11]
int32 supportedMcs = 2;
// Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11]
int32 supported_mcs = 3;
// Training parameters as defined in draft IEEE P802.11/D4.0 [i.11]
int32 trn_parameters = 4;
// Training parameters as defined in draft IEEE P802.11ay [i.11]
int32 trnParameters = 3;
}
/*
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/expiry_notification_links.proto";
import public "models/time_stamp.proto";
message ExpiryNotification {
ExpiryNotificationLinks Underscorelinks = 1;
TimeStamp expiryDeadline = 2;
// Shall be set to \"ExpiryNotification\".
string notificationType = 3;
}
/*
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/link_type.proto";
message ExpiryNotificationLinks {
LinkType subscription = 1;
}
......@@ -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,18 +16,18 @@ package mec028;
message ExtBssLoad {
// Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element.
int32 mu_mimo_sta_count = 1;
int32 muMimoStaCount = 1;
// Observable loading on each of the secondary 20 MHz channel.
int32 obs_sec20_mhz_util = 2;
int32 obsSec20MhzUtil = 2;
// Observable loading on each of the secondary 40 MHz channel.
int32 obs_sec40_mhz_util = 3;
int32 obsSec40MhzUtil = 3;
// Observable loading on each of the secondary 80 MHz channel.
int32 obs_sec80_mhz_util = 4;
int32 obsSec80MhzUtil = 4;
// The percentage of time, linearly scaled with 255 representing 100 %, that the AP has underutilized spatial domain resources for given busy time of the medium.
int32 spat_stream_under_util = 5;
int32 spatStreamUnderUtil = 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
*/
......@@ -19,24 +19,24 @@ message GeoLocation {
int32 altitude = 1;
// The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6]
int32 altitude_type = 2;
int32 altitudeType = 2;
// The uncertainty for altitude information as defined in IETF RFC 6225 [6]
int32 altitude_uncertainty = 3;
int32 altitudeUncertainty = 3;
// The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6]
int32 datum = 4;
// The latitude value of location as defined in IETF RFC 6225 [6]
int64 lat = 5;
int32 lat = 5;
// The uncertainty for Latitude information as defined in IETF RFC 6225 [6]
int32 lat_uncertainty = 6;
int32 latUncertainty = 6;
// The longitude value of location as defined in IETF RFC 6225 [6]
int64 long = 7;
int32 long = 7;
// The uncertainty for Longitude information as defined in IETF RFC 6225 [6]
int32 long_uncertainty = 8;
int32 longUncertainty = 8;
}
......@@ -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,15 +16,12 @@ package mec028;
message HeCapabilities {
// MAC capabilities of an Access Point.
int32 he_mac_cap_info = 1;
int32 heMacCapInfo = 1;
// PHY capabilities of an Access Point.
int32 he_phy_capinfo = 2;
// PPE Threshold determines the nominal packet padding value for a HE PPDU.
int32 ppe_thresholds = 3;
int32 hePhyCapinfo = 2;
// Supported MCS and NSS Set.
int32 supported_he_mcs_nss_set = 4;
int32 supportedHeMcsNssSet = 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
*/
......@@ -16,21 +16,21 @@ package mec028;
message HtCapabilities {
// A-MPDU parameters as defined in IEEE 802.11-2016 [8].
int32 ampdu_parameters = 1;
int32 ampduParameters = 1;
// ASEL capabilities as defined in IEEE 802.11-2016 [8].
int32 asel_cap = 2;
int32 aselCap = 2;
// HT Capability Information as defined in IEEE 802.11-2016 [8].
int32 ht_capability_info = 3;
int32 htCapabilityInfo = 3;
// Extended HT Capabilities as defined in IEEE 802.11-2016 [8].
int32 ht_extended_cap = 4;
int32 htExtendedCap = 4;
// Supported MCS set as defined in IEEE 802.11-2016 [8].
int64 supported_mcs_set = 5;
int32 supportedMcsSet = 5;
// Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8].
int32 tx_beam_form_cap = 6;
int32 txBeamFormCap = 6;
}
......@@ -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,26 +12,14 @@ syntax = "proto3";
package mec028;
import public "models/ap_identity.proto";
import public "models/assoc_sta_notification.proto";
import public "models/sta_data_rate.proto";
import public "models/sta_data_rate_notification.proto";
import public "models/sta_identity.proto";
import public "models/time_stamp.proto";
import public "models/measurement_report_notification.proto";
message InlineNotification {
ApIdentity ap_id = 1;
// Shall be set to \"StaDataRateNotification\".
string notification_type = 2;
// Identifier(s) to uniquely specify the client station(s) associated.
repeated StaIdentity sta_id = 3;
TimeStamp time_stamp = 4;
// Data rates of a client station.
repeated StaDataRate sta_data_rate = 5;
oneof notification {
AssocStaNotification assocStaNotification = 1;
StaDataRateNotification staDataRateNotification = 2;
MeasurementReportNotification measurementReportNotification = 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
*/
......@@ -12,28 +12,14 @@ syntax = "proto3";
package mec028;
import public "models/ap_identity.proto";
import public "models/assoc_sta_subscription.proto";
import public "models/assoc_sta_subscription_links.proto";
import public "models/sta_data_rate_subscription.proto";
import public "models/sta_identity.proto";
import public "models/time_stamp.proto";
import public "models/measurement_report_subscription.proto";
message InlineSubscription {
AssocStaSubscriptionLinks underscorelinks = 1;
ApIdentity ap_id = 2;
// 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 = 3;
TimeStamp expiry_deadline = 4;
// Shall be set to \"StaDataRateSubscription\".
string subscription_type = 5;
// Identifier(s) to uniquely specify the target client station(s) for the subscription
repeated StaIdentity sta_id = 6;
oneof notification {
AssocStaSubscription assocStaSubscription = 1;
StaDataRateSubscription staDataRateSubscription = 2;
MeasurementReportSubscription measurementReportSubscription = 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,7 +15,6 @@ package mec028;
message LinkType {
// URI referring to a resource
string href = 1;
}
......@@ -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,25 +12,20 @@ syntax = "proto3";
package mec028;
import public "models/beacon_request_config.proto";
import public "models/channel_load_config.proto";
import public "models/sta_statistics_config.proto";
import public "models/measurement_config_links.proto";
import public "models/measurement_info.proto";
import public "models/sta_identity.proto";
message MeasurementConfig {
BeaconRequestConfig beacon_request = 1;
MeasurementConfigLinks Underscorelinks = 1;
ChannelLoadConfig channel_load = 2;
// Unique identifier allocated by the service consumer to identify measurement reports (within sta_information query), associated with this measurement configuration.
string measurementId = 2;
// Duration of the measurement, shall be lower than Maximum Measurement Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8].
int32 measurement_duration = 3;
MeasurementInfo measurementInfo = 3;
// Identifier of this measurement configuration.
string measurement_id = 4;
// Random interval to be used for starting the measurement. In units of TU as specifed in section 11.11.3 of IEEE 802.11 [8].
int32 randomn_interval = 5;
StaStatisticsConfig sta_statistics = 6;
// Identifier(s) to uniquely specify the target client station(s) for the measurement configuration.
repeated StaIdentity staId = 4;
}
/*
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/measurement_config_link_list_links.proto";
import public "models/measurement_config_link_list_measurement_config.proto";
message MeasurementConfigLinkList {
MeasurementConfigLinkListLinks Underscorelinks = 1;
repeated MeasurementConfigLinkListMeasurementConfig measurementConfig = 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;
import public "models/link_type.proto";
message MeasurementConfigLinkListLinks {
LinkType self = 1;
}
/*
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 MeasurementConfigLinkListMeasurementConfig {
// The URI referring to a measurement configuration.
string href = 1;