Commit d024703b authored by Ayesha Ayub's avatar Ayesha Ayub
Browse files

Update meep-wais documentation to v2.3.1

parent 062d29f3
Loading
Loading
Loading
Loading
+48 −46
Original line number Diff line number Diff line
@@ -4,22 +4,19 @@ All URIs are relative to *https://localhost/sandboxname/wai/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**measurementLinkListMeasurementsGET**](UnsupportedApi.md#measurementLinkListMeasurementsGET) | **GET** /measurements | Retrieve information on measurements configuration
[**measurementsDELETE**](UnsupportedApi.md#measurementsDELETE) | **DELETE** /measurements/{measurementConfigId} | Cancel a measurement configuration
[**measurementsGET**](UnsupportedApi.md#measurementsGET) | **GET** /measurements/{measurementConfigId} | Retrieve information on an existing measurement configuration
[**measurementsPOST**](UnsupportedApi.md#measurementsPOST) | **POST** /measurements | Create a new measurement configuration
[**measurementsPUT**](UnsupportedApi.md#measurementsPUT) | **PUT** /measurements/{measurementConfigId} | Modify an existing measurement configuration


<a name="measurementLinkListMeasurementsGET"></a>
# **measurementLinkListMeasurementsGET**
> MeasurementConfigLinkList measurementLinkListMeasurementsGET()

[**MeasurementLinkListMeasurementsGET**](UnsupportedApi.md#MeasurementLinkListMeasurementsGET) | **Get** /measurements | Retrieve information on measurements configuration
[**MeasurementsDELETE**](UnsupportedApi.md#MeasurementsDELETE) | **Delete** /measurements/{measurementConfigId} | Cancel a measurement configuration
[**MeasurementsGET**](UnsupportedApi.md#MeasurementsGET) | **Get** /measurements/{measurementConfigId} | Retrieve information on an existing measurement configuration
[**MeasurementsPOST**](UnsupportedApi.md#MeasurementsPOST) | **Post** /measurements | Create a new measurement configuration
[**MeasurementsPUT**](UnsupportedApi.md#MeasurementsPUT) | **Put** /measurements/{measurementConfigId} | Modify an existing measurement configuration

# **MeasurementLinkListMeasurementsGET**
> MeasurementConfigLinkList MeasurementLinkListMeasurementsGET(ctx, )
Retrieve information on measurements configuration

Queries information on measurements configuration

### Parameters
### Required Parameters
This endpoint does not need any parameter.

### Return type
@@ -35,23 +32,24 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json

<a name="measurementsDELETE"></a>
# **measurementsDELETE**
> measurementsDELETE(measurementConfigId)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **MeasurementsDELETE**
> MeasurementsDELETE(ctx, measurementConfigId)
Cancel a measurement configuration

Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **measurementConfigId** | **URI**| Measurement configuration Id, specifically the \&quot;self\&quot; returned in the measurement configuration request | [default to null]
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **measurementConfigId** | **string**| Measurement configuration Id, specifically the \&quot;self\&quot; returned in the measurement configuration request | 

### Return type

null (empty response body)
 (empty response body)

### Authorization

@@ -62,19 +60,20 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/problem+json

<a name="measurementsGET"></a>
# **measurementsGET**
> MeasurementConfig measurementsGET(measurementConfigId)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **MeasurementsGET**
> MeasurementConfig MeasurementsGET(ctx, measurementConfigId)
Retrieve information on an existing measurement configuration

Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **measurementConfigId** | **URI**| Measurement configuration Id, specifically the \&quot;self\&quot; returned in the measurement configuration request | [default to null]
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **measurementConfigId** | **string**| Measurement configuration Id, specifically the \&quot;self\&quot; returned in the measurement configuration request | 

### Return type

@@ -89,15 +88,15 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json

<a name="measurementsPOST"></a>
# **measurementsPOST**
> MeasurementConfig measurementsPOST(MeasurementConfig)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **MeasurementsPOST**
> MeasurementConfig MeasurementsPOST(ctx, body)
Create a new measurement configuration

Creates a new measurement configuration

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
@@ -116,20 +115,21 @@ No authorization required
- **Content-Type**: application/json
- **Accept**: application/json, application/problem+json

<a name="measurementsPUT"></a>
# **measurementsPUT**
> MeasurementConfig measurementsPUT(measurementConfigId, MeasurementConfig)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **MeasurementsPUT**
> MeasurementConfig MeasurementsPUT(ctx, body, measurementConfigId)
Modify an existing measurement configuration

Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **measurementConfigId** | **URI**| Measurement configuration Id, specifically the \&quot;self\&quot; returned in the measurement configuration request | [default to null]
 **MeasurementConfig** | [**MeasurementConfig**](../Models/MeasurementConfig.md)| Measurement configuration to be modified |
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **body** | [**MeasurementConfig**](../Models/MeasurementConfig.md)| Measurement configuration to be modified | 
  **measurementConfigId** | **string**| Measurement configuration Id, specifically the \&quot;self\&quot; returned in the measurement configuration request | 

### Return type

@@ -144,3 +144,5 @@ No authorization required
 - **Content-Type**: application/json
 - **Accept**: application/json, application/problem+json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+97 −78
Original line number Diff line number Diff line
@@ -4,25 +4,23 @@ All URIs are relative to *https://localhost/sandboxname/wai/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**apInfoGET**](WaiApi.md#apInfoGET) | **GET** /queries/ap/ap_information | Retrieve information on existing Access Points
[**mec011AppTerminationPOST**](WaiApi.md#mec011AppTerminationPOST) | **POST** /notifications/mec011/appTermination | MEC011 Application Termination notification for self termination
[**staInfoGET**](WaiApi.md#staInfoGET) | **GET** /queries/sta/sta_information | Retrieve information on existing Stations
[**subscriptionLinkListSubscriptionsGET**](WaiApi.md#subscriptionLinkListSubscriptionsGET) | **GET** /subscriptions | Retrieve information on subscriptions for notifications
[**subscriptionsDELETE**](WaiApi.md#subscriptionsDELETE) | **DELETE** /subscriptions/{subscriptionId} | Cancel an existing subscription
[**subscriptionsGET**](WaiApi.md#subscriptionsGET) | **GET** /subscriptions/{subscriptionId} | Retrieve information on current specific subscription
[**subscriptionsPOST**](WaiApi.md#subscriptionsPOST) | **POST** /subscriptions | Create a new subscription
[**subscriptionsPUT**](WaiApi.md#subscriptionsPUT) | **PUT** /subscriptions/{subscriptionId} | Modify an existing subscription


<a name="apInfoGET"></a>
# **apInfoGET**
> List apInfoGET(filter, all\_fields, fields, exclude\_fields, exclude\_default)

[**ApInfoGET**](WaiApi.md#ApInfoGET) | **Get** /queries/ap/ap_information | Retrieve information on existing Access Points
[**Mec011AppTerminationPOST**](WaiApi.md#Mec011AppTerminationPOST) | **Post** /notifications/mec011/appTermination | MEC011 Application Termination notification for self termination
[**StaInfoGET**](WaiApi.md#StaInfoGET) | **Get** /queries/sta/sta_information | Retrieve information on existing Stations
[**SubscriptionLinkListSubscriptionsGET**](WaiApi.md#SubscriptionLinkListSubscriptionsGET) | **Get** /subscriptions | Retrieve information on subscriptions for notifications
[**SubscriptionsDELETE**](WaiApi.md#SubscriptionsDELETE) | **Delete** /subscriptions/{subscriptionId} | Cancel an existing subscription
[**SubscriptionsGET**](WaiApi.md#SubscriptionsGET) | **Get** /subscriptions/{subscriptionId} | Retrieve information on current specific subscription
[**SubscriptionsPOST**](WaiApi.md#SubscriptionsPOST) | **Post** /subscriptions | Create a new subscription
[**SubscriptionsPUT**](WaiApi.md#SubscriptionsPUT) | **Put** /subscriptions/{subscriptionId} | Modify an existing subscription


# **ApInfoGET**
> []ApInfo ApInfoGET(ctx, optional)
Retrieve information on existing Access Points

Queries information about existing WLAN Access Points

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
@@ -34,7 +32,7 @@ Name | Type | Description | Notes

### Return type

[**List**](../Models/ApInfo.md)
[**[]ApInfo**](../Models/ApInfo.md)

### Authorization

@@ -45,15 +43,15 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json

<a name="mec011AppTerminationPOST"></a>
# **mec011AppTerminationPOST**
> mec011AppTerminationPOST(AppTerminationNotification)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **Mec011AppTerminationPOST**
> Mec011AppTerminationPOST(ctx, body)
MEC011 Application Termination notification for self termination

Terminates itself.

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
@@ -61,7 +59,7 @@ Name | Type | Description | Notes

### Return type

null (empty response body)
 (empty response body)

### Authorization

@@ -72,15 +70,23 @@ No authorization required
 - **Content-Type**: application/json
 - **Accept**: Not defined

<a name="staInfoGET"></a>
# **staInfoGET**
> List staInfoGET(filter, all\_fields, fields, exclude\_fields, exclude\_default)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **StaInfoGET**
> []StaInfo StaInfoGET(ctx, optional)
Retrieve information on existing Stations

Queries information about existing WLAN stations

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
 **optional** | **StaInfoGETOpts** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a pointer to a StaInfoGETOpts struct

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
@@ -92,7 +98,7 @@ Name | Type | Description | Notes

### Return type

[**List**](../Models/StaInfo.md)
[**[]StaInfo**](../Models/StaInfo.md)

### Authorization

@@ -103,19 +109,26 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json

<a name="subscriptionLinkListSubscriptionsGET"></a>
# **subscriptionLinkListSubscriptionsGET**
> SubscriptionLinkList subscriptionLinkListSubscriptionsGET(subscription\_type)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **SubscriptionLinkListSubscriptionsGET**
> SubscriptionLinkList SubscriptionLinkListSubscriptionsGET(ctx, optional)
Retrieve information on subscriptions for notifications

Queries information on subscriptions for notifications

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **subscription\_type** | **String**| Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate, measure_report. | [optional] [default to null]
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
 **optional** | **SubscriptionLinkListSubscriptionsGETOpts** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a pointer to a SubscriptionLinkListSubscriptionsGETOpts struct
Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **subscriptionType** | **optional.String**| Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate, measure_report. | 

### Return type

@@ -130,23 +143,24 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json

<a name="subscriptionsDELETE"></a>
# **subscriptionsDELETE**
> subscriptionsDELETE(subscriptionId)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **SubscriptionsDELETE**
> SubscriptionsDELETE(ctx, subscriptionId)
Cancel an existing subscription

Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **subscriptionId** | **URI**| Subscription Id, specifically the \&quot;self\&quot; returned in the subscription request | [default to null]
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **subscriptionId** | **string**| Subscription Id, specifically the \&quot;self\&quot; returned in the subscription request | 

### Return type

null (empty response body)
 (empty response body)

### Authorization

@@ -157,19 +171,20 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/problem+json

<a name="subscriptionsGET"></a>
# **subscriptionsGET**
> InlineSubscription subscriptionsGET(subscriptionId)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **SubscriptionsGET**
> InlineSubscription SubscriptionsGET(ctx, subscriptionId)
Retrieve information on current specific subscription

Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **subscriptionId** | **URI**| Subscription Id, specifically the \&quot;self\&quot; returned in the subscription request | [default to null]
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **subscriptionId** | **string**| Subscription Id, specifically the \&quot;self\&quot; returned in the subscription request | 

### Return type

@@ -184,19 +199,20 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json

<a name="subscriptionsPOST"></a>
# **subscriptionsPOST**
> InlineSubscription subscriptionsPOST(InlineSubscription)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **SubscriptionsPOST**
> InlineSubscription SubscriptionsPOST(ctx, body)
Create a new subscription

Creates a new subscription to WLAN Access Information notifications

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **InlineSubscription** | [**InlineSubscription**](../Models/InlineSubscription.md)| Subscription to be created |
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **body** | [**InlineSubscription**](InlineSubscription.md)| Subscription to be created | 

### Return type

@@ -211,20 +227,21 @@ No authorization required
 - **Content-Type**: application/json
 - **Accept**: application/json, application/problem+json

<a name="subscriptionsPUT"></a>
# **subscriptionsPUT**
> InlineSubscription subscriptionsPUT(subscriptionId, InlineSubscription)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **SubscriptionsPUT**
> InlineSubscription SubscriptionsPUT(ctx, body, subscriptionId)
Modify an existing subscription

Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)

### Parameters
### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **subscriptionId** | **URI**| Subscription Id, specifically the \&quot;self\&quot; returned in the subscription request | [default to null]
 **InlineSubscription** | [**InlineSubscription**](../Models/InlineSubscription.md)| Subscription to be modified |
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **body** | [**InlineSubscription**](InlineSubscription.md)| Subscription to be modified | 
  **subscriptionId** | **string**| Subscription Id, specifically the \&quot;self\&quot; returned in the subscription request | 

### Return type

@@ -239,3 +256,5 @@ No authorization required
 - **Content-Type**: application/json
 - **Accept**: application/json, application/problem+json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+5 −5
Original line number Diff line number Diff line
# ApAssociated
## Properties

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assocId** | [**String**](string.md) | Unique number which identifies a particular association between the station and Access Point. | [optional] [default to null]
**bssid** | [**String**](string.md) | Basic Service Set Identifier (BSSID) is a unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point&#39;s MAC address. | [default to null]
**ipAddress** | [**List**](string.md) | IPv4 or IPv6 address allocated for the Access Point. | [optional] [default to null]
**ssid** | [**List**](string.md) | Service Set Identifier to identify logical networks. | [optional] [default to null]
**AssocId** | **string** | Unique number which identifies a particular association between the station and Access Point. | [optional] [default to null]
**Bssid** | **string** | Basic Service Set Identifier (BSSID) is a unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point&#x27;s MAC address. | [default to null]
**IpAddress** | **[]string** | IPv4 or IPv6 address allocated for the Access Point. | [optional] [default to null]
**Ssid** | **[]string** | Service Set Identifier to identify logical networks. | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+4 −4
Original line number Diff line number Diff line
# ApIdentity
## Properties

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bssid** | [**String**](string.md) | Basic Service Set Identifier (BSSID) is a unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point&#39;s MAC address. | [default to null]
**ipAddress** | [**List**](string.md) | IPv4 or IPv6 address allocated for the Access Point. | [optional] [default to null]
**ssid** | [**List**](string.md) | Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point. | [optional] [default to null]
**Bssid** | **string** | Basic Service Set Identifier (BSSID) is a unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point&#x27;s MAC address. | [default to null]
**IpAddress** | **[]string** | IPv4 or IPv6 address allocated for the Access Point. | [optional] [default to null]
**Ssid** | **[]string** | Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point. | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+11 −10
Original line number Diff line number Diff line
# ApInfo
## Properties

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**apId** | [**ApIdentity**](ApIdentity.md) |  | [default to null]
**apLocation** | [**ApLocation**](ApLocation.md) |  | [optional] [default to null]
**bssLoad** | [**BssLoad**](BssLoad.md) |  | [optional] [default to null]
**channel** | [**Integer**](integer.md) | Channel configured for the Access Point. | [optional] [default to null]
**extBssLoad** | [**ExtBssLoad**](ExtBssLoad.md) |  | [optional] [default to null]
**oBssLoad** | [**OBssLoad**](OBssLoad.md) |  | [optional] [default to null]
**timeStamp** | [**TimeStamp**](TimeStamp.md) |  | [optional] [default to null]
**wanMetrics** | [**WanMetrics**](WanMetrics.md) |  | [optional] [default to null]
**wlanCap** | [**WlanCapabilities**](WlanCapabilities.md) |  | [optional] [default to null]
**ApId** | [***ApIdentity**](ApIdentity.md) |  | [default to null]
**ApLocation** | [***ApLocation**](ApLocation.md) |  | [optional] [default to null]
**BssLoad** | [***BssLoad**](BssLoad.md) |  | [optional] [default to null]
**Channel** | **int32** | Channel configured for the Access Point. | [optional] [default to null]
**ExtBssLoad** | [***ExtBssLoad**](ExtBssLoad.md) |  | [optional] [default to null]
**OBssLoad** | [***OBssLoad**](OBssLoad.md) |  | [optional] [default to null]
**TimeStamp** | [***TimeStamp**](TimeStamp.md) |  | [optional] [default to null]
**WanMetrics** | [***WanMetrics**](WanMetrics.md) |  | [optional] [default to null]
**WlanCap** | [***WlanCapabilities**](WlanCapabilities.md) |  | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Loading