[EPM] Documentation of HTTP routes & TS types for Ingest

x-pack/legacy/plugins/integrations_manager/common/api_specs/ingest/models/asset.v1.json

@@ -0,0 +1,17 @@
+{
+  "title": "Asset",
+  "type": "object",
+  "description": "Item installed for Kibana (e.g. dashboard, visualization), Elasticsearch (e.g. ingest pipeline, ILM policy), or a Kibana plugin (e.g. ML job)",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "type": {
+      "$ref": "./asset_type.v1.json"
+    }
+  },
+  "required": [
+    "id",
+    "type"
+  ]
+}

x-pack/legacy/plugins/integrations_manager/common/api_specs/ingest/models/asset_type.v1.json

@@ -0,0 +1,13 @@
+{
+        "type": "string",
+        "title": "AssetType",
+        "description": "Types of assets which can be installed/removed",
+        "enum": [
+          "index-template",
+          "ingest-pipeline",
+          "ilm-policy",
+          "rollup-job",
+          "ml-job",
+          "data-frame-transform"
+        ]
+      }

x-pack/legacy/plugins/integrations_manager/common/api_specs/ingest/models/datasource.v1.json

@@ -0,0 +1,31 @@
+{
+  "title": "Datasource",
+  "type": "object",
+  "description": "A logical grouping of places where data is coming from, such as \"Production\", \"Staging\", \"Production East-1\", \"Metrics Cluster\", etc. -- these groupings are user-defined. We store information collected from the user about this logical grouping such as a name and any other information we need about it to generate the associated config. A package defines its own data source templates that can use user-provided values to generate the data source config. A single data source will typically enable users to collect both logs and metrics. A data source can be in multiple policies at the same time. A datasource can have multiple streams.",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "package": {
+      "$ref": "./package.v1.json"
+    },
+    "streams": {
+      "type": "array",
+      "items": {
+        "$ref": "./stream.v1.json"
+      }
+    },
+    "id": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "read_alias": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "name",
+    "package",
+    "streams"
+  ]
+}

x-pack/legacy/plugins/integrations_manager/common/api_specs/ingest/models/input.v1.json

@@ -0,0 +1,50 @@
+{
+  "title": "Input",
+  "type": "object",
+  "description": "Where the data comes from",
+  "properties": {
+    "type": {
+      "type": "string",
+      "enum": [
+        "log",
+        "metric/system",
+        "metric/docker",
+        "etc"
+      ]
+    },
+    "config": {
+      "type": "object",
+      "example": "{paths: \"/var/log/*.log\"} or {metricsets: [\"container\", \"cpu\"]} or {username: \"elastic\", password: \"changeme\"}",
+      "description": "Mix of configurable and required properties still TBD. Object for now might become string"
+    },
+    "ingest_pipelines": {
+      "type": "array",
+      "description": "Need a distinction for \"main\" ingest pipeline. Should be handled during install. Likely by package/manifest format",
+      "items": {
+        "type": "string"
+      }
+    },
+    "id": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "index_template": {
+      "type": "string"
+    },
+    "ilm_policy": {
+      "type": "string"
+    },
+    "fields": {
+      "type": "array",
+      "description": "",
+      "items": {
+        "type": "object",
+        "description": "contents from fields.yml"
+      }
+    }
+  },
+  "required": [
+    "type",
+    "config"
+  ]
+}

x-pack/legacy/plugins/integrations_manager/common/api_specs/ingest/models/output.v1.json

@@ -0,0 +1,47 @@
+{
+  "title": "Output",
+  "type": "object",
+  "description": "Where to send the data",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string",
+      "example": "\"default\" or \"infosec1\""
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "elasticsearch",
+        "something",
+        "else"
+      ]
+    },
+    "url": {
+      "type": "string",
+      "format": "uri"
+    },
+    "api_token": {
+      "type": "string"
+    },
+    "index_name": {
+      "type": "string",
+      "example": "metrics-mysql-prod_west-access",
+      "description": "unique alias with write index"
+    },
+    "ingest_pipeline": {
+      "type": "string",
+      "example": "metrics-mysql-prod_west-access"
+    },
+    "config": {
+      "type": "object",
+      "description": "contains everything not otherwise specified (e.g. TLS, etc)"
+    }
+  },
+  "required": [
+    "id",
+    "name",
+    "type"
+  ]
+}

x-pack/legacy/plugins/integrations_manager/common/api_specs/ingest/models/package.v1.json

@@ -0,0 +1,34 @@
+{
+  "title": "Package",
+  "type": "object",
+  "description": "A group of items related to a data ingestion source (e.g. MySQL, nginx, AWS). Can include Kibana assets, ES assets, data source configuration templates, manual install steps, etc.",
+  "properties": {
+    "name": {
+      "type": "string",
+      "example": "coredns"
+    },
+    "version": {
+      "type": "string",
+      "example": "1.0.1, 1.3.1"
+    },
+    "description": {
+      "type": "string",
+      "example": "CoreDNS logs and metrics integration.\nThe CoreDNS integrations allows to gather logs and metrics from the CoreDNS DNS server to get better insights.\n"
+    },
+    "title": {
+      "type": "string",
+      "example": "CoreDNS"
+    },
+    "assets": {
+      "type": "array",
+      "items": {
+        "$ref": "./asset.v1.json"
+      }
+    }
+  },
+  "required": [
+    "name",
+    "version",
+    "assets"
+  ]
+}

x-pack/legacy/plugins/integrations_manager/common/api_specs/ingest/models/policy.v1.json

@@ -0,0 +1,37 @@
+{
+  "title": "Policy",
+  "type": "object",
+  "description": "The entire config for the Beats agent, including all assigned data source config outputs along with agent-wide configuration values",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "use_case": {
+      "type": "string"
+    },
+    "datasources": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./datasource.v1.json"
+      }
+    },
+    "description": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "active",
+        "inactive"
+      ]
+    }
+  },
+  "required": [
+    "id",
+    "status"
+  ]
+}

x-pack/legacy/plugins/integrations_manager/common/api_specs/ingest/models/stream.v1.json

@@ -0,0 +1,31 @@
+{
+  "title": "Stream",
+  "type": "object",
+  "description": "A combination of an input type, the required config, an output, and any processors",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "input": {
+      "$ref": "./input.v1.json"
+    },
+    "config": {
+      "type": "object",
+      "example": "{paths: \"/var/log/*.log\"} or {metricsets: [\"container\", \"cpu\"]} or {username: \"elastic\", password: \"changeme\"}"
+    },
+    "output": {
+      "$ref": "./output.v1.json"
+    },
+    "processors": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "id",
+    "input",
+    "output"
+  ]
+}