@itentialopensource/adapter-oracle_assure1 0.1.1

package/report/adapterInfo.json

@@ -0,0 +1,10 @@
+{
+  "version": "0.1.0",
+  "configLines": 3207,
+  "scriptLines": 1783,
+  "codeLines": 2864,
+  "testLines": 3599,
+  "testCases": 167,
+  "totalCodeLines": 8246,
+  "wfTasks": 32
+}

package/report/assure1-api-5.3.3-openapi.json

@@ -0,0 +1,507 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Assure1 API",
+    "description": "# Introduction\nThis API is documented in **OpenAPI format** and is based on the\n[OpenAPI Specification](https://swagger.io/specification/). The OpenAPI syntax we use has a few\n[vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).\n\n# Authentication\nAssure1 offers two forms of authentication:\n - HTTP auth\n   - (e.g. username `operator` or `api`)\n - TLS client certificate auth\n   - (e.g. `User-api.crt` and `User-api-key`)\n \n# Authorization\nAssure1 _Users_ are assigned to _User Groups_ with associated _Roles_. These _Roles_ are assigned _Permissions_ which\nallow access to specific APIs and their methods. It is recommended to use the default `api` user. If further\nrestrictions are desired, additional users, groups, and roles should be created.",
+    "version": "5.3.3",
+    "x-logo": {
+      "url": "../../../resources/assure1/images/Assure1byFederosLogo.svg"
+    }
+  },
+  "paths": {
+    "/api/device/Devices/{id}": {
+      "get": {
+        "tags": [
+          "Devices"
+        ],
+        "summary": "View one Device",
+        "operationId": "device::Devices::Read_byID",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "Device ID",
+            "required": true,
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "properties": {
+                    "success": {
+                      "description": "Success or failure response",
+                      "type": "boolean",
+                      "example": "true"
+                    },
+                    "message": {
+                      "description": "Textual message",
+                      "type": "string",
+                      "example": "Loaded 1 entries"
+                    },
+                    "data": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/deviceDevicesRead"
+                      }
+                    }
+                  },
+                  "type": "object"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/FailedOperation"
+          }
+        }
+      },
+      "put": {
+        "tags": [
+          "Devices"
+        ],
+        "summary": "Update a Device",
+        "operationId": "Devices::update",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "Device ID",
+            "required": true,
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/Devices"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/SuccessfulAddOperation"
+          },
+          "default": {
+            "$ref": "#/components/responses/FailedOperation"
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "Devices"
+        ],
+        "summary": "Delete a Device",
+        "operationId": "Devices::delete",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "Device ID",
+            "required": true,
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/SuccessfulAddOperation"
+          },
+          "default": {
+            "$ref": "#/components/responses/FailedOperation"
+          }
+        }
+      }
+    },
+    "/api/device/Devices": {
+      "get": {
+        "tags": [
+          "Devices"
+        ],
+        "summary": "View all Devices",
+        "operationId": "device::Devices::Read",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/filter"
+          },
+          {
+            "$ref": "#/components/parameters/limit"
+          },
+          {
+            "$ref": "#/components/parameters/sort"
+          },
+          {
+            "$ref": "#/components/parameters/start"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "properties": {
+                    "success": {
+                      "description": "Success or failure response",
+                      "type": "boolean",
+                      "example": "true"
+                    },
+                    "message": {
+                      "description": "Textual message",
+                      "type": "string",
+                      "example": "Loaded 1 entries"
+                    },
+                    "total": {
+                      "description": "The total number of results regardless of paging",
+                      "type": "integer",
+                      "example": "1"
+                    },
+                    "data": {
+                      "description": "Record(s)",
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/deviceDevicesRead"
+                      }
+                    }
+                  },
+                  "type": "object"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/FailedOperation"
+          }
+        }
+      },
+      "post": {
+        "tags": [
+          "Devices"
+        ],
+        "summary": "Add a Device",
+        "operationId": "Devices::create",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/Devices"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/SuccessfulAddOperation"
+          },
+          "default": {
+            "$ref": "#/components/responses/FailedOperation"
+          }
+        }
+      }
+    },
+    "/api/device/Devices/readForSelect": {
+      "get": {
+        "tags": [
+          "Devices"
+        ],
+        "summary": "Show Devices for Comboboxes and ItemSelectors",
+        "operationId": "Devices::readForSelect",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/filter"
+          },
+          {
+            "$ref": "#/components/parameters/limit"
+          },
+          {
+            "$ref": "#/components/parameters/query"
+          },
+          {
+            "$ref": "#/components/parameters/sort"
+          },
+          {
+            "$ref": "#/components/parameters/start"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "properties": {
+                    "success": {
+                      "description": "Success or failure response",
+                      "type": "boolean",
+                      "example": "true"
+                    },
+                    "message": {
+                      "description": "Textual message",
+                      "type": "string",
+                      "example": "Loaded 1 entries"
+                    },
+                    "total": {
+                      "description": "The total number of results regardless of paging",
+                      "type": "integer",
+                      "example": "1"
+                    },
+                    "data": {
+                      "description": "Record(s)",
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/deviceDevicesReadForSelect"
+                      }
+                    }
+                  },
+                  "type": "object"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/FailedOperation"
+          }
+        }
+      }
+    },
+    "/api/metric/PerformanceData": {
+      "get": {
+        "tags": [
+          "PerformanceData"
+        ],
+        "summary": "Get all performance data",
+        "description": "Series are identified by passing:\n- DeviceName\n- Measurement or MetricType\n- Instance\n\n(e.g. Recommended: `DeviceName=router.example.com&Measurement=metrictype_Latency&Instance=Device`)\n\n(e.g. SOA apps only: `DeviceName=router.example.com&MetricType=Latency&Instance=Device`)\n\n___DEPRECATED___ - Series are identified by passing:\n- DeviceID\n- MetricID\n\n(e.g. `DeviceID=1&MetricID=1`)\n\nTime ranges are identified by passing:\n- TimeRange (start and end separated by `..`)\n\nExamples:\n\n- Last 2 days `now-2d..now`\n- Last 7 days `now-7d..now`\n- Last 30 days `now-30d..now`\n- Last 90 days `now-90d..now`\n- Last 6 months `now-6M..now`\n- Last 1 year `now-1y..now`\n- Last 2 years `now-2y..now`\n- Last 5 years `now-5y..now`\n- Yesterday `now-1d..now-1d`\n- Last week `now-1w..now-1w`\n- Last month `now-1M..now-1M`\n\n#### Limitations:\n- Performance Data only available for **Metrics**. Metrics must be created on your devices.\n- Device Metrics must have data in the last 5 years.\n- Series are restricted to the last 5 years.\n- Aggregates are limited to 10 series.",
+        "operationId": "performanceData::getAll",
+        "parameters": [
+          {
+            "name": "DeviceName",
+            "in": "query",
+            "description": "The Device Name",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "MetricType",
+            "in": "query",
+            "description": "Metric Type",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "Instance",
+            "in": "query",
+            "description": "The Instance",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "TimeRange",
+            "in": "query",
+            "description": "Time Range",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "Offset",
+            "in": "query",
+            "description": "Pagination offset",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "Limit",
+            "in": "query",
+            "description": "Pagination limit",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "Sort",
+            "in": "query",
+            "description": "Sort order",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/PerformanceData"
+                  }
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/FailedOperation"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Devices": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "name": {
+            "type": "string"
+          }
+        }
+      },
+      "deviceDevicesRead": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "name": {
+            "type": "string"
+          }
+        }
+      },
+      "deviceDevicesReadForSelect": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "name": {
+            "type": "string"
+          }
+        }
+      },
+      "PerformanceData": {
+        "type": "object",
+        "properties": {
+          "timestamp": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "value": {
+            "type": "number"
+          }
+        }
+      }
+    },
+    "responses": {
+      "SuccessfulAddOperation": {
+        "description": "Successful operation",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "success": {
+                  "type": "boolean",
+                  "example": "true"
+                },
+                "message": {
+                  "type": "string",
+                  "example": "Operation successful"
+                }
+              }
+            }
+          }
+        }
+      },
+      "FailedOperation": {
+        "description": "Failed operation",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "success": {
+                  "type": "boolean",
+                  "example": "false"
+                },
+                "message": {
+                  "type": "string",
+                  "example": "Operation failed"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "parameters": {
+      "filter": {
+        "name": "filter",
+        "in": "query",
+        "description": "Filter",
+        "schema": {
+          "type": "string"
+        }
+      },
+      "limit": {
+        "name": "limit",
+        "in": "query",
+        "description": "Limit",
+        "schema": {
+          "type": "integer"
+        }
+      },
+      "sort": {
+        "name": "sort",
+        "in": "query",
+        "description": "Sort order",
+        "schema": {
+          "type": "string"
+        }
+      },
+      "start": {
+        "name": "start",
+        "in": "query",
+        "description": "Start",
+        "schema": {
+          "type": "integer"
+        }
+      },
+      "query": {
+        "name": "query",
+        "in": "query",
+        "description": "Query parameter",
+        "schema": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}