@itentialopensource/adapter-clearcable_noms
Version:
This adapter integrates with system described as: clearcableNoms.
835 lines • 29.8 kB
JSON
{
"openapi": "3.0.3",
"info": {
"contact": {},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"description": "Clearcable NOMS (Nomad Management System) http://clearcable.ca/",
"version": "1.0.0",
"title": "Clearcable NOMS",
"termsOfService": "http://swagger.io/terms/"
},
"servers": [
{
"url": "https://localhost/"
}
],
"security": [],
"paths": {
"/read/realtimedata/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address has to contain 12 hex characters",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemRealTimeData",
"summary": "Get Cable Modem Real Time Data",
"description": "CableModem Real Time Data",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/list_macs/hourly": {
"get": {
"parameters": [],
"tags": [
"default"
],
"operationId": "getMacsWithHourlyData",
"summary": "Get All MACs with Hourly Data",
"description": "Load List of Macs with Hourly Data Available",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/hourly/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"required": true,
"description": "MAC Address",
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getMacWithHourlyData",
"summary": "Get MAC with Hourly Data",
"description": "Load Hourly Data For A Single Mac",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/monthly/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getMacWithMonthlyData",
"summary": "Get MAC with Monthly Data",
"description": "Load Monthly Data For A Single Mac",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/this_month_sum/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getSumOfTransfersInCurrentMonth",
"summary": "Get Sum of Transfers Current Month",
"description": "Load Sum of Transfers In Current Month For A Single Mac",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/top_this_month/{limit}": {
"get": {
"parameters": [
{
"name": "limit",
"in": "path",
"description": "Limit Integer of the amount they transferred.",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getMACsTransferredMostCurrentMonth",
"summary": "Get MACs Transferred Most Current Month",
"description": "Load List of Macs Which Transferred Most In Current Month",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{date}": {
"get": {
"parameters": [
{
"name": "date",
"in": "path",
"description": "Date in YYYY-mm",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getSumTransfersInMonthForEachMac",
"summary": "Get Sum of Transfers by Month",
"description": "Load Sum of Transfers In Month For Each Mac",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{date}/count": {
"get": {
"parameters": [
{
"name": "date",
"in": "path",
"description": "Date in YYYY-mm",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getSumTransfersInMonthForEachMacCount",
"summary": "Get Sum of Transfers by Month Count",
"description": "Load Sum of Transfers In Month For Each Mac Count Only",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{date}/sort/total": {
"get": {
"parameters": [
{
"name": "date",
"in": "path",
"description": "Date in YYYY-mm",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getSumTransfersInMonthForEachMacSortTotal",
"summary": "Get Sum of Transfers by Month Sort Total",
"description": "Load Sum of Transfers In Month For Each Mac Sort Total",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{date}/sort/upload": {
"get": {
"parameters": [
{
"name": "date",
"in": "path",
"description": "Date in YYYY-mm",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getSumTransfersInMonthForEachMacSortUpload",
"summary": "Get Sum of Transfers by Month Sort Upload",
"description": "Load Sum of Transfers In Month For Each Mac Sort Upload",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{date}/sort/download": {
"get": {
"parameters": [
{
"name": "date",
"in": "path",
"description": "Date in YYYY-mm",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getSumTransfersInMonthForEachMacSortDownload",
"summary": "Get Sum of Transfers by Month Sort Download",
"description": "Load Sum of Transfers In Month For Each Mac Sort Download",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/sum_per_mac_in_month/{date}/limit/{limitStart}/{limitCount}": {
"get": {
"parameters": [
{
"name": "date",
"in": "path",
"description": "Date in YYYY-mm",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limitStart",
"in": "path",
"description": "Limit Start Rows Returned",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limitCount",
"in": "path",
"description": "Limit Count of Rows Returned",
"required": true,
"schema": {
"type": "integer"
}
}
],
"tags": [
"default"
],
"operationId": "getSumTransfersInMonthForEachMacLimit",
"summary": "Get Sum of Transfers by Month Limit",
"description": "Load Sum of Transfers In Month For Each Mac Limit",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/list_services_in_month/{date}": {
"get": {
"parameters": [
{
"name": "date",
"in": "path",
"description": "Date in YYYY-mm",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getSumServices",
"summary": "Get Services by Month",
"description": "Get Services by Month for MACs",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_rf/v0.1/list_macs/hourly": {
"get": {
"parameters": [],
"tags": [
"default"
],
"operationId": "getAllCableModemHourly",
"summary": "Get All Cable Modems Hourly",
"description": "Load List of Macs with Hourly Data Available",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_rf/v0.1/hourly/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemHourly",
"summary": "Get Cable Modem Hourly",
"description": " Load Hourly Data For A Single Mac",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_rf/v0.1/daily/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemDailyMac",
"summary": "Get Cable Modem Daily",
"description": "Load Daily Data For A Single Mac",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_rf/v0.1/monthly/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"default"
],
"operationId": "getCableModemMonthly",
"summary": "Get Cable Modem Monthly",
"description": "Load Monthly Data For A Single Mac",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_rf/v0.1/this_month_average/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemCurrentMonthAverage",
"summary": "Get Cable Modem Current Month Average",
"description": "Load Cable Modem Current Month Average",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_transfer/v0.1/average_per_mac_in_month/{date}": {
"get": {
"parameters": [
{
"name": "date",
"in": "path",
"description": "Date in YYYY-mm",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemAverageMac",
"summary": "Get Cable Modem Average MAC",
"description": "Load Average of Rf In Current Month For A Single Mac",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_flap/v0.1/list_macs/hourly": {
"get": {
"parameters": [],
"tags": [
"default"
],
"operationId": "getAllCableModemFlapHourly",
"summary": "Get All Cable Modem Flaps Hourly",
"description": "Load List of Macs with Hourly Data Available",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_flap/v0.1/list_macs/hourly/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemFlapHourly",
"summary": "Get Cable Modem Flaps Hourly",
"description": "Load Hourly Data For A Single Mac",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_flap/v0.1/daily/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"default"
],
"operationId": "getCableModemFlapDaily",
"summary": "Get Cable Modem Flaps Daily",
"description": "Load Daily Data For A Single Mac",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_flap/v0.1/monthly/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemFlapMonthly",
"summary": "Get Cable Modem Flaps Monthly",
"description": "Load Monthly Data For A Single Mac",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_flap/v0.1/this_day_sum/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemFlapCurrentDay",
"summary": "Get Cable Modem Flaps Current Day",
"description": "Load Monthly Data For A Single Mac Current Day",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_flap/v0.1/this_month_sum/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemFlapCurrentMonth",
"summary": "Get Cable Modem Flaps Current Month",
"description": "Load Monthly Data For A Single Mac Current Month",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_flap/v0.1/last_month_sum/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemFlapLastMonth",
"summary": "Get Cable Modem Flaps Last Month",
"description": "Load Monthly Data For A Single Mac Last Month",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_flap/v0.1/top_this_hour/{limit}": {
"get": {
"parameters": [
{
"name": "limit",
"in": "path",
"description": "limit amount transferred",
"required": true,
"schema": {
"type": "integer"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemFlapCurrentMonthMost",
"summary": "Get Cable Modem Flaps Current Month Most",
"description": "Load List of Macs Which Had the Most Flaps In Current Month",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
},
"/read/cablemodem_status/v0.1/mac/{macAddress}": {
"get": {
"parameters": [
{
"name": "macAddress",
"in": "path",
"description": "MAC Address",
"required": true,
"schema": {
"type": "string"
}
}
],
"tags": [
"default"
],
"operationId": "getCableModemStatus",
"summary": "Get Cable Modem Status",
"description": "Cable Modem Status Stats v0.1",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "failed operation"
}
}
}
}
},
"externalDocs": {
"description": "Find out more about the OpenAPI Initiative",
"url": "https://www.openapis.org/"
},
"tags": [
{
"name": "default",
"description": ""
}
],
"components": {
"securitySchemes": {}
}
}