Merge branch 'stf593' into 'develop'

STF593 - Final Drafts v2.1.1 merged to develop

See merge request !2

README.md

@@ -4,7 +4,7 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E
 
 ## Online resources
 
-
+* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.01.01_60/gs_MEC028v020101p.pdf)
 * [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs028-wai-api/raw/stf593/WlanInformationApi.yaml).
 * [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs028-wai-api/raw/stf593/WlanInformationApi.yaml).
 

proto3/models/ap_associated.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+
+message ApAssociated {
+
+  // Unique number which identifies a particular association between the station and Access Point.
+  string assoc_id = 1;
+
+  // IPv4 or IPv6 address allocated for the Access Point.
+  repeated string ip_address = 2;
+
+  // Unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment.
+  string mac_id = 3;
+
+  // Service Set Identifier to identify logical networks.
+  repeated string ssid = 4;
+
+}

proto3/models/ap_identity.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+
+message ApIdentity {
+
+  // IPv4 or IPv6 address allocated for the Access Point.
+  repeated string ip_address = 1;
+
+  // Unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment.
+  string mac_id = 2;
+
+  // Service Set Identifier to identify logical networks including Basic Service Set and Extended Service Set.
+  repeated string ssid = 3;
+
+}

proto3/models/ap_info.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+import public "models/ap_identity.proto";
+import public "models/ap_location.proto";
+import public "models/bss_load.proto";
+import public "models/ext_bss_load.proto";
+import public "models/neighbor_report.proto";
+import public "models/time_stamp.proto";
+import public "models/wan_metrics.proto";
+import public "models/wlan_capabilities.proto";
+
+message ApInfo {
+
+  ApIdentity ap_id = 1;
+
+  ApLocation ap_location = 2;
+
+  NeighborReport ap_neighbor = 3;
+
+  BssLoad bss_load = 4;
+
+  // Channel configured for the Access Point.
+  int32 channel = 5;
+
+  ExtBssLoad ext_bss_load = 6;
+
+  TimeStamp time_stamp = 7;
+
+  WanMetrics wan_metrics = 8;
+
+  WlanCapabilities wlan_cap = 9;
+
+}

proto3/models/ap_location.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+import public "models/civic_location.proto";
+import public "models/geo_location.proto";
+
+message ApLocation {
+
+  CivicLocation civic_location = 1;
+
+  GeoLocation geolocation = 2;
+
+}

proto3/models/assoc_sta_notification.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+import public "models/ap_identity.proto";
+import public "models/sta_identity.proto";
+import public "models/time_stamp.proto";
+
+message AssocStaNotification {
+
+  ApIdentity ap_id = 1;
+
+  // Shall be set to \"AssocStaNotification\".
+  string notification_type = 2;
+
+  // Identifier(s) to uniquely specify the client station(s) associated.
+  repeated StaIdentity sta_id = 3;
+
+  TimeStamp time_stamp = 4;
+
+}

proto3/models/assoc_sta_subscription.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+import public "models/ap_identity.proto";
+import public "models/assoc_sta_subscription_links.proto";
+import public "models/time_stamp.proto";
+
+message AssocStaSubscription {
+
+  AssocStaSubscriptionLinks underscorelinks = 1;
+
+  ApIdentity ap_id = 2;
+
+  // URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response.
+  string callback_reference = 3;
+
+  TimeStamp expiry_deadline = 4;
+
+  // Shall be set to \"AssocStaSubscription\".
+  string subscription_type = 5;
+
+}

proto3/models/assoc_sta_subscription_links.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+import public "models/link_type.proto";
+
+message AssocStaSubscriptionLinks {
+
+  LinkType self = 1;
+
+}

proto3/models/associated_stations.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+
+message AssociatedStations {
+
+  // Unique number which identifies a particular association between an Access Point and a station.
+  string assoc_id = 1;
+
+  // IPv4 or IPv6 address allocated for the station associated with the Access Point.
+  repeated string ip_address = 2;
+
+  // Unique identifier assigned to a station (as network interface controller) for communications at the data link layer of a network segment.
+  string mac_id = 3;
+
+}

proto3/models/beacon_report.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+import public "models/sta_identity.proto";
+
+message BeaconReport {
+
+  // The BSSID field indicates the BSSID of the BSS(s) for which a beacon report has been received.
+  repeated string bss_id = 1;
+
+  // Channel number where the beacon was received.
+  int32 channel_id = 2;
+
+  // Measurement ID of the Measurement configuration applied to this Beacon Report.
+  string measurement_id = 3;
+
+  // As in table T9-89 of IEEE 802.11-2012 [8].
+  int32 reporting_condition = 4;
+
+  // (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is received.
+  repeated string ss_id = 5;
+
+  StaIdentity sta_id = 6;
+
+}

proto3/models/beacon_request_config.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+import public "models/sta_identity.proto";
+
+message BeaconRequestConfig {
+
+  // The BSSID field indicates the BSSID of the BSS(s) for which a beacon report is requested. When requesting beacon reports for all BSSs on the channel, the BSSID field contains the wildcard BSSID.
+  repeated string bss_id = 1;
+
+  // Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP.
+  int32 channel_id = 2;
+
+  // 0 for passive. 1 for active. 2 for beacon table.
+  int32 measurement_mode = 3;
+
+  // As in table T9-89 of IEEE 802.11-2012 [8].
+  int32 reporting_condition = 4;
+
+  // (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is requested.
+  repeated string ss_id = 5;
+
+  StaIdentity sta_id = 6;
+
+}

proto3/models/bss_load.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+
+message BssLoad {
+
+  // Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.
+  int32 avail_adm_cap = 1;
+
+  // The percentage of time, linearly scaled with 255 representing 100 %, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism.
+  int32 channel_utilization = 2;
+
+  // An unsigned integer that indicates the total number of STAs currently associated with this BSS.
+  int32 sta_count = 3;
+
+}

proto3/models/channel_load_config.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+import public "models/ap_identity.proto";
+
+message ChannelLoadConfig {
+
+  ApIdentity ap_id = 1;
+
+  // Channel number which load is reported
+  int32 c_channel_id = 2;
+
+  // Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3
+  int32 channel_load = 3;
+
+}

proto3/models/civic_location.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+
+message CivicLocation {
+
+  // Language
+  string ca0 = 1;
+
+  // National subdivisions (state, canton, region,province, prefecture) 
+  string ca1 = 2;
+
+  // Script
+  string ca128 = 3;
+
+  // Leading street direction
+  string ca16 = 4;
+
+  // Trailing street suffix
+  string ca17 = 5;
+
+  // Street suffix or type
+  string ca18 = 6;
+
+  // House number
+  string ca19 = 7;
+
+  // County, parish, gun (JP), district (IN)
+  string ca2 = 8;
+
+  // House number suffix
+  string ca20 = 9;
+
+  // Landmark of vanity address
+  string ca21 = 10;
+
+  // Additional location information
+  string ca22 = 11;
+
+  // Name (residence and office occupant)
+  string ca23 = 12;
+
+  // Postal/zip code
+  string ca24 = 13;
+
+  // Building (structure)
+  string ca25 = 14;
+
+  // Unit (apartment/suite)
+  string ca26 = 15;
+
+  // Floor
+  string ca27 = 16;
+
+  // Room
+  string ca28 = 17;
+
+  // Type of place
+  string ca29 = 18;
+
+  // City, township, shi (JP)
+  string ca3 = 19;
+
+  // Postal community name
+  string ca30 = 20;
+
+  // Post office box
+  string ca31 = 21;
+
+  // Additional code
+  string ca32 = 22;
+
+  // Seat (desk.cubicle, workstation)
+  string ca33 = 23;
+
+  // Primary road name
+  string ca34 = 24;
+
+  // Road section
+  string ca35 = 25;
+
+  // Branch road name
+  string ca36 = 26;
+
+  // Sub-branch road name
+  string ca37 = 27;
+
+  // Street name pre-modifier
+  string ca38 = 28;
+
+  // Street name post-modifier
+  string ca39 = 29;
+
+  // City division, borough, city district, ward, chou (JP)
+  string ca4 = 30;
+
+  // Neighborhood, block
+  string ca5 = 31;
+
+  // Group of streets below the neighborhood level 
+  string ca6 = 32;
+
+  // The two-letter ISO 3166 [i.9] country code in capital ASCII letters, e.g. DE or US, as per ISO 3166 [i.9]
+  string country = 33;
+
+}

proto3/models/dmg_capabilities.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+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;
+
+  // 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 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 capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]
+  int64 dmg_sta_cap_info = 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 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;
+
+}

proto3/models/edmg_capabilities.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec028;
+
+
+message EdmgCapabilities {
+
+  // A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11]
+  int32 ampdu_parameters = 1;
+
+  int32 reserved = 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;
+
+}

proto3/models/ext_bss_load.proto

+/*
+  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.1.1
+  
+  Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+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;
+
+  // Observable loading on each of the secondary 20 MHz channel.
+  int32 obs_sec20_mhz_util = 2;
+
+  // Observable loading on each of the secondary 40 MHz channel.
+  int32 obs_sec40_mhz_util = 3;
+
+  // Observable loading on each of the secondary 80 MHz channel.
+  int32 obs_sec80_mhz_util = 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;
+
+}

proto3/models/geo_location.proto

+/*
+  ETSI GS MEC 028 - WLAN Access Information API
+ 
+  The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
+