system-test 1st merge

    # platform ingress configuration

    ingress:

      # host name

      host: my-platform-fqdn

      #host: my-platform-fqdn

      host: 10.3.16.150

      # enable https only (redirect http requests to https port)

      https-only: false

      # bind to host ports (true) or node ports (false)

[README](https://github.com/swagger-api/swagger-codegen/blob/master/README.md)

- API version: 1.0.0

- Build date: 2020-11-13T09:24:04.779-05:00

- Build date: 2020-12-09T09:06:59.942-05:00

### Running the server

# Go API client for client

This API allows to control geo-spatial behavior and simulation. <p>**Micro-service**<br>[meep-gis-engine](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-gis-engine) <p>**Type & Usage**<br>Platform runtime interface to control geo-spatial behavior and simulation <p>**Details**<br>API details available at _your-AdvantEDGE-ip-address/api_

## Overview

This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project.  By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.

- API version: 1.0.0

- Package version: 1.0.0

- Build package: io.swagger.codegen.languages.GoClientCodegen

## Installation

Put the package under your project folder and add the following in import:

```golang

import "./client"

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*AutomationApi* | [**GetAutomationState**](docs/AutomationApi.md#getautomationstate) | **Get** /automation | Get automation state

*AutomationApi* | [**GetAutomationStateByName**](docs/AutomationApi.md#getautomationstatebyname) | **Get** /automation/{type} | Get automation state

*AutomationApi* | [**SetAutomationStateByName**](docs/AutomationApi.md#setautomationstatebyname) | **Post** /automation/{type} | Set automation state

*GeospatialDataApi* | [**DeleteGeoDataByName**](docs/GeospatialDataApi.md#deletegeodatabyname) | **Delete** /geodata/{assetName} | Delete geospatial data

*GeospatialDataApi* | [**GetAssetData**](docs/GeospatialDataApi.md#getassetdata) | **Get** /geodata | Get geospatial data

*GeospatialDataApi* | [**GetGeoDataByName**](docs/GeospatialDataApi.md#getgeodatabyname) | **Get** /geodata/{assetName} | Get geospatial data

*GeospatialDataApi* | [**UpdateGeoDataByName**](docs/GeospatialDataApi.md#updategeodatabyname) | **Post** /geodata/{assetName} | Create/Update geospatial data

## Documentation For Models

 - [AutomationState](docs/AutomationState.md)

 - [AutomationStateList](docs/AutomationStateList.md)

 - [GeoData](docs/GeoData.md)

 - [GeoDataAssetList](docs/GeoDataAssetList.md)

 - [LineString](docs/LineString.md)

 - [Point](docs/Point.md)

 - [GeoDataAsset](docs/GeoDataAsset.md)

## Documentation For Authorization

 Endpoints do not require authorization.

## Author

AdvantEDGE@InterDigital.com

---

swagger: "2.0"

info:

  description: "This API allows to control geo-spatial behavior and simulation. <p>**Micro-service**<br>[meep-gis-engine](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-gis-engine)\

    \ <p>**Type & Usage**<br>Platform runtime interface to control geo-spatial behavior\

    \ and simulation <p>**Details**<br>API details available at _your-AdvantEDGE-ip-address/api_"

  version: "1.0.0"

  title: "AdvantEDGE GIS Engine REST API"

  contact:

    name: "InterDigital AdvantEDGE Support"

    email: "AdvantEDGE@InterDigital.com"

  license:

    name: "Apache 2.0"

    url: "https://github.com/InterDigitalInc/AdvantEDGE/blob/master/LICENSE"

basePath: "/gis/v1"

tags:

- name: "Automation"

- name: "Geospatial Data"

consumes:

- "application/json"

produces:

- "application/json"

paths:

  /automation:

    get:

      tags:

      - "Automation"

      summary: "Get automation state"

      description: "Get automation state for all automation types"

      operationId: "getAutomationState"

      produces:

      - "application/json"

      parameters: []

      responses:

        200:

          description: "OK"

          schema:

            $ref: "#/definitions/AutomationStateList"

  /automation/{type}:

    get:

      tags:

      - "Automation"

      summary: "Get automation state"

      description: "Get automation state for the given automation type"

      operationId: "getAutomationStateByName"

      produces:

      - "application/json"

      parameters:

      - name: "type"

        in: "path"

        description: "Automation type.<br> Automation loop evaluates enabled automation\

          \ types once every second.<br>\n<p>Supported Types: <li>MOVEMENT - Advances\

          \ UEs along configured paths using previous position & velocity as inputs.\

          \ <li>MOBILITY - Sends Mobility events to Sanbox Controller when UE changes\

          \ POA. <li>POAS-IN-RANGE - Sends POAS-IN-RANGE events to Sanbox Controller\

          \ when list of POAs in range changes. <li>NETWORK-CHARACTERISTICS-UPDATE\

          \ - Sends network characteristics update events to Sanbox Controller when\

          \ throughput values change."

        required: true

        type: "string"

        enum:

        - "MOBILITY"

        - "MOVEMENT"

        - "POAS-IN-RANGE"

        - "NETWORK-CHARACTERISTICS-UPDATE"

        x-exportParamName: "Type_"

      responses:

        200:

          description: "OK"

          schema:

            $ref: "#/definitions/AutomationState"

        500:

          description: "Internal server error"

    post:

      tags:

      - "Automation"

      summary: "Set automation state"

      description: "Set automation state for the given automation type \\"

      operationId: "setAutomationStateByName"

      produces:

      - "application/json"

      parameters:

      - name: "type"

        in: "path"

        description: "Automation type.<br> Automation loop evaluates enabled automation\

          \ types once every second.<br>\n<p>Supported Types: <li>MOBILITY - Sends\

          \ Mobility events to Sanbox Controller when UE changes POA. <li>MOVEMENT\

          \ - Advances UEs along configured paths using previous position & velocity\

          \ as inputs. <li>POAS-IN-RANGE - Sends POAS-IN-RANGE events to Sanbox Controller\

          \ when list of POAs in range changes. <li>NETWORK-CHARACTERISTICS-UPDATE\

          \ - Sends network characteristics update events to Sanbox Controller when\

          \ throughput values change."

        required: true

        type: "string"

        enum:

        - "MOBILITY"

        - "MOVEMENT"

        - "POAS-IN-RANGE"

        - "NETWORK-CHARACTERISTICS-UPDATE"

        x-exportParamName: "Type_"

      - name: "run"

        in: "query"

        description: "Automation state (e.g. true=running, false=stopped)"

        required: true

        type: "boolean"

        x-exportParamName: "Run"

      responses:

        200:

          description: "OK"

        500:

          description: "Internal server error"

  /geodata:

    get:

      tags:

      - "Geospatial Data"

      summary: "Get geospatial data"

      description: "Get geospatial data for all assets present in database"

      operationId: "getAssetData"

      produces:

      - "application/json"

      parameters:

      - name: "assetType"

        in: "query"

        description: "Filter by asset type"

        required: false

        type: "string"

        enum:

        - "UE"

        - "POA"

        - "COMPUTE"

        x-exportParamName: "AssetType"

        x-optionalDataType: "String"

      - name: "subType"

        in: "query"

        description: "Filter by asset sub type"

        required: false

        type: "string"

        enum:

        - "UE"

        - "POA"

        - "POA-4G"

        - "POA-5G"

        - "POA-WIFI"

        - "EDGE"

        - "FOG"

        - "CLOUD"

        x-exportParamName: "SubType"

        x-optionalDataType: "String"

      - name: "excludePath"

        in: "query"

        description: "Exclude UE paths in response (default: false)"

        required: false

        type: "string"

        enum:

        - "true"

        - "false"

        x-exportParamName: "ExcludePath"

        x-optionalDataType: "String"

      responses:

        200:

          description: "OK"

          schema:

            $ref: "#/definitions/GeoDataAssetList"

        500:

          description: "Internal server error"

  /geodata/{assetName}:

    get:

      tags:

      - "Geospatial Data"

      summary: "Get geospatial data"

      description: "Get geospatial data for the given asset"

      operationId: "getGeoDataByName"

      produces:

      - "application/json"

      parameters:

      - name: "assetName"

        in: "path"

        description: "Name of geospatial asset"

        required: true

        type: "string"

        x-exportParamName: "AssetName"

      - name: "excludePath"

        in: "query"

        description: "Exclude UE paths in response (default: false)"

        required: false

        type: "string"

        enum:

        - "true"

        - "false"

        x-exportParamName: "ExcludePath"

        x-optionalDataType: "String"

      responses:

        200:

          description: "OK"

          schema:

            $ref: "#/definitions/GeoDataAsset"

        404:

          description: "Not found"

        500:

          description: "Internal server error"

    post:

      tags:

      - "Geospatial Data"

      summary: "Create/Update geospatial data"

      description: "Create/Update geospatial data for the given asset"

      operationId: "updateGeoDataByName"

      produces:

      - "application/json"

      parameters:

      - name: "assetName"

        in: "path"

        description: "Name of geospatial asset"

        required: true

        type: "string"

        x-exportParamName: "AssetName"

      - in: "body"

        name: "geoData"

        description: "Geospatial data"

        required: true

        schema:

          $ref: "#/definitions/GeoDataAsset"

        x-exportParamName: "GeoData"

      responses:

        200:

          description: "OK"

        201:

          description: "Created"

        500:

          description: "Internal server error"

    delete:

      tags:

      - "Geospatial Data"

      summary: "Delete geospatial data"

      description: "Delete geospatial data for the given asset"

      operationId: "deleteGeoDataByName"

      produces:

      - "application/json"

      parameters:

      - name: "assetName"

        in: "path"

        description: "Name of geospatial asset"

        required: true

        type: "string"

        x-exportParamName: "AssetName"

      responses:

        200:

          description: "OK"

        404:

          description: "Not found"

        500:

          description: "Internal server error"

definitions:

  AutomationStateList:

    type: "object"

    properties:

      states:

        type: "array"

        items:

          $ref: "#/definitions/AutomationState"

    description: "List of automation states"

    example: {}

  AutomationState:

    type: "object"

    properties:

      type:

        type: "string"

        description: "Automation type.<br> Automation loop evaluates enabled automation\

          \ types once every second.<br>\n<p>Supported Types: <li>MOBILITY - Sends\

          \ Mobility events to Sanbox Controller when UE changes POA. <li>MOVEMENT\

          \ - Advances UEs along configured paths using previous position & velocity\

          \ as inputs. <li>POAS-IN-RANGE - Sends POAS-IN-RANGE events to Sanbox Controller\

          \ when list of POAs in range changes. <li>NETWORK-CHARACTERISTICS-UPDATE\

          \ - Sends network characteristics update events to Sanbox Controller when\

          \ throughput values change."

        enum:

        - "MOBILITY"

        - "MOVEMENT"

        - "POAS-IN-RANGE"

        - "NETWORK-CHARACTERISTICS-UPDATE"

      active:

        type: "boolean"

        description: "Automation feature state"

    example:

      active: true

      type: "MOBILITY"

  GeoDataAssetList:

    type: "object"

    properties:

      geoDataAssets:

        type: "array"

        items:

          $ref: "#/definitions/GeoDataAsset"

    description: "List of geospatial assets data"

    example: {}

  GeoDataAsset:

    allOf:

    - type: "object"

      properties:

        assetName:

          type: "string"

          description: "Name of geospatial asset"

        assetType:

          type: "string"

          description: "Asset type"

          enum:

          - "UE"

          - "POA"

          - "COMPUTE"

        subType:

          type: "string"

          description: "Asset sub-type"

          enum:

          - "UE"

          - "POA"

          - "POA-4G"

          - "POA-5G"

          - "POA-WIFI"

          - "EDGE"

          - "FOG"

          - "CLOUD"

    - $ref: "#/definitions/GeoData"

    description: "List of geospatial data"

  GeoData:

    type: "object"

    properties:

      location:

        $ref: "#/definitions/Point"

      radius:

        type: "number"

        description: "Optional - Radius (in meters) around the location"

      path:

        $ref: "#/definitions/LineString"

      eopMode:

        type: "string"

        description: "End-of-Path mode: <li>LOOP: When path endpoint is reached, start\

          \ over from the beginning <li>REVERSE: When path endpoint is reached, return\

          \ on the reverse path"

        enum:

        - "LOOP"

        - "REVERSE"

      velocity:

        type: "number"

        description: "Speed of movement along path in m/s"

    description: "Geographic data"

  Point:

    type: "object"

    required:

    - "type"

    properties:

      type:

        type: "string"

        description: "Must be Point"

        enum:

        - "Point"

      coordinates:

        type: "array"

        description: "For a Point, coordinates MUST be an array of two decimal numbers;\

          \ longitude and latitude precisely in that order"

        items:

          type: "number"

    externalDocs:

      url: "https://tools.ietf.org/html/rfc7946"

    description: "A single position in coordinate space (GeoJSON); a position is an\

      \ array of two numbers"

  LineString:

    type: "object"

    required:

    - "type"

    properties:

      type:

        type: "string"

        description: "Must be LineString"

        enum:

        - "LineString"

      coordinates:

        type: "array"

        description: "For a LineString, coordinates is an array of two or more positions;\

          \ a position is an array of two decimal numbers (longitude and latitude\

          \ precisely in that order)"

        items:

          type: "array"

          items:

            type: "number"

    externalDocs:

      url: "https://tools.ietf.org/html/rfc7946"

    description: "An array of two or more positions in coordinate space (GeoJSON);\

      \ a position is an array of two numbers"

responses:

  Std200:

    description: "OK"

  Std201:

    description: "Created"

  Std202:

    description: "Accepted"

  Std204:

    description: "No content"

  Std304:

    description: "Not modified"

  Std400:

    description: "Bad request"

  Std401:

    description: "Not authorized"

  Std403:

    description: "Forbidden"

  Std404:

    description: "Not found"

  Std409:

    description: "Conflict"

  Std416:

    description: "Requested range not satisfiable"

  Std500:

    description: "Internal server error"

externalDocs:

  description: "GitHub Wiki"

  url: "https://github.com/InterDigitalInc/AdvantEDGE/wiki"