Commit 5789a9e5 authored by Kevin Di Lallo's avatar Kevin Di Lallo
Browse files

bumped ansible k8s install version to 1.19 + added api documentation

parent 37101a73
Loading
Loading
Loading
Loading
+23 −0
Original line number Diff line number Diff line
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
+12 −0
Original line number Diff line number Diff line
.openapi-generator-ignore
Apis/AutomationApi.md
Apis/GeospatialDataApi.md
Models/AutomationState.md
Models/AutomationStateList.md
Models/GeoData.md
Models/GeoDataAsset.md
Models/GeoDataAssetAllOf.md
Models/GeoDataAssetList.md
Models/LineString.md
Models/Point.md
README.md
+1 −0
Original line number Diff line number Diff line
5.0.0-beta2
 No newline at end of file
+90 −0
Original line number Diff line number Diff line
# AutomationApi

All URIs are relative to *http://localhost/gis/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getAutomationState**](AutomationApi.md#getAutomationState) | **GET** /automation | Get automation state
[**getAutomationStateByName**](AutomationApi.md#getAutomationStateByName) | **GET** /automation/{type} | Get automation state
[**setAutomationStateByName**](AutomationApi.md#setAutomationStateByName) | **POST** /automation/{type} | Set automation state


<a name="getAutomationState"></a>
# **getAutomationState**
> AutomationStateList getAutomationState()

Get automation state

    Get automation state for all automation types

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

### Return type

[**AutomationStateList**](../Models/AutomationStateList.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getAutomationStateByName"></a>
# **getAutomationStateByName**
> AutomationState getAutomationStateByName(type)

Get automation state

    Get automation state for the given automation type

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **type** | **String**| Automation type.&lt;br&gt; Automation loop evaluates enabled automation types once every second.&lt;br&gt; &lt;p&gt;Supported Types: &lt;li&gt;MOVEMENT - Advances UEs along configured paths using previous position &amp; velocity as inputs. &lt;li&gt;MOBILITY - Sends Mobility events to Sanbox Controller when UE changes POA. &lt;li&gt;POAS-IN-RANGE - Sends POAS-IN-RANGE events to Sanbox Controller when list of POAs in range changes. &lt;li&gt;NETWORK-CHARACTERISTICS-UPDATE - Sends network characteristics update events to Sanbox Controller when throughput values change. | [default to null] [enum: MOBILITY, MOVEMENT, POAS-IN-RANGE, NETWORK-CHARACTERISTICS-UPDATE]

### Return type

[**AutomationState**](../Models/AutomationState.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="setAutomationStateByName"></a>
# **setAutomationStateByName**
> setAutomationStateByName(type, run)

Set automation state

    Set automation state for the given automation type \\

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **type** | **String**| Automation type.&lt;br&gt; Automation loop evaluates enabled automation types once every second.&lt;br&gt; &lt;p&gt;Supported Types: &lt;li&gt;MOBILITY - Sends Mobility events to Sanbox Controller when UE changes POA. &lt;li&gt;MOVEMENT - Advances UEs along configured paths using previous position &amp; velocity as inputs. &lt;li&gt;POAS-IN-RANGE - Sends POAS-IN-RANGE events to Sanbox Controller when list of POAs in range changes. &lt;li&gt;NETWORK-CHARACTERISTICS-UPDATE - Sends network characteristics update events to Sanbox Controller when throughput values change. | [default to null] [enum: MOBILITY, MOVEMENT, POAS-IN-RANGE, NETWORK-CHARACTERISTICS-UPDATE]
 **run** | **Boolean**| Automation state (e.g. true&#x3D;running, false&#x3D;stopped) | [default to null]

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined
+124 −0
Original line number Diff line number Diff line
# GeospatialDataApi

All URIs are relative to *http://localhost/gis/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**deleteGeoDataByName**](GeospatialDataApi.md#deleteGeoDataByName) | **DELETE** /geodata/{assetName} | Delete geospatial data
[**getAssetData**](GeospatialDataApi.md#getAssetData) | **GET** /geodata | Get geospatial data
[**getGeoDataByName**](GeospatialDataApi.md#getGeoDataByName) | **GET** /geodata/{assetName} | Get geospatial data
[**updateGeoDataByName**](GeospatialDataApi.md#updateGeoDataByName) | **POST** /geodata/{assetName} | Create/Update geospatial data


<a name="deleteGeoDataByName"></a>
# **deleteGeoDataByName**
> deleteGeoDataByName(assetName)

Delete geospatial data

    Delete geospatial data for the given asset

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **assetName** | **String**| Name of geospatial asset | [default to null]

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

<a name="getAssetData"></a>
# **getAssetData**
> GeoDataAssetList getAssetData(assetType, subType, excludePath)

Get geospatial data

    Get geospatial data for all assets present in database

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **assetType** | **String**| Filter by asset type | [optional] [default to null] [enum: UE, POA, COMPUTE]
 **subType** | **String**| Filter by asset sub type | [optional] [default to null] [enum: UE, POA, POA-4G, POA-5G, POA-WIFI, EDGE, FOG, CLOUD]
 **excludePath** | **String**| Exclude UE paths in response (default: false) | [optional] [default to null] [enum: true, false]

### Return type

[**GeoDataAssetList**](../Models/GeoDataAssetList.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="getGeoDataByName"></a>
# **getGeoDataByName**
> GeoDataAsset getGeoDataByName(assetName, excludePath)

Get geospatial data

    Get geospatial data for the given asset

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **assetName** | **String**| Name of geospatial asset | [default to null]
 **excludePath** | **String**| Exclude UE paths in response (default: false) | [optional] [default to null] [enum: true, false]

### Return type

[**GeoDataAsset**](../Models/GeoDataAsset.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="updateGeoDataByName"></a>
# **updateGeoDataByName**
> updateGeoDataByName(assetName, geoData)

Create/Update geospatial data

    Create/Update geospatial data for the given asset

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **assetName** | **String**| Name of geospatial asset | [default to null]
 **geoData** | [**GeoDataAsset**](../Models/GeoDataAsset.md)| Geospatial data |

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined
Loading