Commit b95a7e6a authored by Kevin Di Lallo's avatar Kevin Di Lallo
Browse files

removed unused nodeport references

parent b3be7ff6
Loading
Loading
Loading
Loading
+0 −215
Original line number Diff line number Diff line
---
swagger: "2.0"
info:
  description: "Metrics Service provides metrics about the active scenario <p>**Micro-service**<br>[meep-metrics-engine](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-metrics-engine)\
    \ <p>**Type & Usage**<br>Platform Service used by control/monitoring software\
    \ and possibly by edge applications that require metrics <p>**Details**<br>API\
    \ details available at _your-AdvantEDGE-ip-address:30000/api_ <p>**Default Port**<br>`30005`"
  version: "1.0.0"
  title: "AdvantEDGE Metrics Service 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: "/v1"
tags:
- name: "Metrics"
schemes:
- "http"
consumes:
- "application/json"
produces:
- "application/json"
paths:
  /metrics:
    get:
      tags:
      - "metrics"
      description: "Used to get a list of all metrics for a specific message type,\
        \ destination pd and source pod combination"
      operationId: "metricsGet"
      produces:
      - "application/json"
      parameters:
      - name: "dest"
        in: "query"
        description: "Pod where the log message is taken from"
        required: false
        type: "string"
        x-exportParamName: "Dest"
        x-optionalDataType: "String"
      - name: "dataType"
        in: "query"
        description: "Log Message Type"
        required: false
        type: "string"
        x-exportParamName: "DataType"
        x-optionalDataType: "String"
      - name: "src"
        in: "query"
        description: "Pod that originated the metrics logged in the message"
        required: false
        type: "string"
        x-exportParamName: "Src"
        x-optionalDataType: "String"
      - name: "starTime"
        in: "query"
        description: "Starting timestamp of time range"
        required: false
        type: "string"
        x-exportParamName: "StarTime"
        x-optionalDataType: "String"
      - name: "stopTime"
        in: "query"
        description: "Ending timestamp of time range"
        required: false
        type: "string"
        x-exportParamName: "StopTime"
        x-optionalDataType: "String"
      responses:
        200:
          description: "Successful response to a query regarding metrics based on\
            \ search criteria"
          examples:
            application/json:
              logResponseList:
                logResponse:
                - dest: "pod1"
                  dataType: "latency"
                  src: "pod2"
                  timestamp: "2019-07-09T13:47:04.279+0000"
                - dest: "pod2"
                  dataType: "latency"
                  src: "pod1"
                  timestamp: "2019-07-09T13:47:04.379+0000"
          schema:
            $ref: "#/definitions/LogResponseList"
        404:
          description: "Not found"
        500:
          description: "Internal server error"
definitions:
  LogResponse:
    type: "object"
    required:
    - "dataType"
    - "dest"
    - "src"
    - "timestamp"
    properties:
      dest:
        type: "string"
        example: "node1"
        description: "Pod where the log message is taken from"
      dataType:
        type: "string"
        example: "node1"
        description: "Pod where the log message is taken from"
      src:
        type: "string"
        example: "node1"
        description: "Pod that originated the metrics logged in the message"
      timestamp:
        type: "string"
        example: "2019-07-09T13:47:03.279Z"
        description: "System time at which the metric was logged"
      data:
        $ref: "#/definitions/LogResponse_data"
  LogResponseList:
    type: "object"
    properties:
      logResponse:
        type: "array"
        items:
          $ref: "#/definitions/LogResponse"
  Inline_response_200:
    properties:
      logResponseList:
        $ref: "#/definitions/LogResponseList"
  LogResponse_data:
    type: "object"
    properties:
      rx:
        type: "integer"
        example: 128
        description: "Number of packets received since last log event"
      rxBytes:
        type: "integer"
        example: 6892
        description: "Number of bytes received since last log event"
      throughput:
        type: "number"
        format: "float"
        example: 17.01234
        description: "Throughput measured between 2 pods in Mbits/seconds"
      packet-loss:
        type: "string"
        example: "50.000"
        description: "Number of packets loss between2 pods as a percentage"
      latency:
        type: "integer"
        example: 63
        description: "Latency measured betwen 2 pods in ms"
      newPoa:
        type: "string"
        example: "poa1"
        description: "New poa affected by a mobility event"
      oldPoa:
        type: "string"
        example: "poa1"
        description: "Old poa affected by a mobility event"
parameters:
  Query.Dest:
    name: "dest"
    in: "query"
    description: "Pod where the log message is taken from"
    required: false
    type: "string"
    x-exportParamName: "Dest"
    x-optionalDataType: "String"
  Query.DataType:
    name: "dataType"
    in: "query"
    description: "Log message type/category"
    required: false
    type: "string"
    x-exportParamName: "DataType"
    x-optionalDataType: "String"
  Query.Src:
    name: "src"
    in: "query"
    description: "Pod that originated the metrics logged in the message"
    required: false
    type: "string"
    x-exportParamName: "Src"
    x-optionalDataType: "String"
  Query.StartTime:
    name: "startTime"
    in: "query"
    description: "Starting timestamp of time range query"
    required: false
    type: "string"
    x-exportParamName: "StartTime"
    x-optionalDataType: "String"
  Query.StopTime:
    name: "stopTime"
    in: "query"
    description: "Ending timestamp of time range query"
    required: false
    type: "string"
    x-exportParamName: "StopTime"
    x-optionalDataType: "String"
responses:
  Std200:
    description: "OK"
  Std400:
    description: "Bad request"
  Std404:
    description: "Not found"
  Std500:
    description: "Internal server error"
externalDocs:
  description: "GitHub Wiki"
  url: "https://github.com/InterDigitalInc/AdvantEDGE/wiki"
+0 −25
Original line number Diff line number Diff line
# Go API Server for server

Metrics Service provides metrics about the active scenario <p>**Micro-service**<br>[meep-metrics-engine](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-metrics-engine) <p>**Type & Usage**<br>Platform Service used by control/monitoring software and possibly by edge applications that require metrics <p>**Details**<br>API details available at _your-AdvantEDGE-ip-address:30000/api_ <p>**Default Port**<br>`30005`

## Overview
This server was generated by the [swagger-codegen]
(https://github.com/swagger-api/swagger-codegen) project.  
By using the [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate a server stub.  
-

To see how to make this your own, look here:

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

- API version: 1.0.0
- Build date: 2019-12-03T16:13:43.566-05:00


### Running the server
To run the server, follow these simple steps:

```
go run main.go
```
+1 −1
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@
 *
 * AdvantEDGE Metrics Service REST API
 *
 * Metrics Service provides metrics about the active scenario <p>**Micro-service**<br>[meep-metrics-engine](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-metrics-engine) <p>**Type & Usage**<br>Platform Service used by control/monitoring software and possibly by edge applications that require metrics <p>**Details**<br>API details available at _your-AdvantEDGE-ip-address:30000/api_ <p>**Default Port**<br>`30005`
 * Metrics Service provides metrics about the active scenario <p>**Micro-service**<br>[meep-metrics-engine](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-metrics-engine) <p>**Type & Usage**<br>Platform Service used by control/monitoring software and possibly by edge applications that require metrics <p>**Details**<br>API details available at _your-AdvantEDGE-ip-address/api_
 *
 * API version: 1.0.0
 * Contact: AdvantEDGE@InterDigital.com
+1 −1
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@
 *
 * AdvantEDGE Metrics Service REST API
 *
 * Metrics Service provides metrics about the active scenario <p>**Micro-service**<br>[meep-metrics-engine](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-metrics-engine) <p>**Type & Usage**<br>Platform Service used by control/monitoring software and possibly by edge applications that require metrics <p>**Details**<br>API details available at _your-AdvantEDGE-ip-address:30000/api_ <p>**Default Port**<br>`30005`
 * Metrics Service provides metrics about the active scenario <p>**Micro-service**<br>[meep-metrics-engine](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-metrics-engine) <p>**Type & Usage**<br>Platform Service used by control/monitoring software and possibly by edge applications that require metrics <p>**Details**<br>API details available at _your-AdvantEDGE-ip-address/api_
 *
 * API version: 1.0.0
 * Contact: AdvantEDGE@InterDigital.com