kibana/api_docs/kbn_telemetry_tools.devdocs.json

{
  "id": "@kbn/telemetry-tools",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/telemetry-tools",
        "id": "def-server.assertTelemetryPayload",
        "type": "Function",
        "tags": [],
        "label": "assertTelemetryPayload",
        "description": [
          "\nMerges the telemetrySchema, generates a @kbn/config-schema version from it, and uses it to validate stats."
        ],
        "signature": [
          "(telemetrySchema: { root: ",
          "TelemetrySchemaObject",
          "; plugins: ",
          "TelemetrySchemaObject",
          "; }, stats: unknown) => void"
        ],
        "path": "src/platform/packages/private/kbn-telemetry-tools/src/schema_ftr_validations/schema_to_config_schema.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/telemetry-tools",
            "id": "def-server.assertTelemetryPayload.$1",
            "type": "Object",
            "tags": [],
            "label": "telemetrySchema",
            "description": [],
            "path": "src/platform/packages/private/kbn-telemetry-tools/src/schema_ftr_validations/schema_to_config_schema.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/telemetry-tools",
                "id": "def-server.assertTelemetryPayload.$1.root",
                "type": "Object",
                "tags": [],
                "label": "root",
                "description": [],
                "signature": [
                  "TelemetrySchemaObject"
                ],
                "path": "src/platform/packages/private/kbn-telemetry-tools/src/schema_ftr_validations/schema_to_config_schema.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/telemetry-tools",
                "id": "def-server.assertTelemetryPayload.$1.plugins",
                "type": "Object",
                "tags": [],
                "label": "plugins",
                "description": [],
                "signature": [
                  "TelemetrySchemaObject"
                ],
                "path": "src/platform/packages/private/kbn-telemetry-tools/src/schema_ftr_validations/schema_to_config_schema.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          },
          {
            "parentPluginId": "@kbn/telemetry-tools",
            "id": "def-server.assertTelemetryPayload.$2",
            "type": "Unknown",
            "tags": [],
            "label": "stats",
            "description": [
              "The full output of the telemetry plugin"
            ],
            "signature": [
              "unknown"
            ],
            "path": "src/platform/packages/private/kbn-telemetry-tools/src/schema_ftr_validations/schema_to_config_schema.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/telemetry-tools",
        "id": "def-server.runTelemetryCheck",
        "type": "Function",
        "tags": [],
        "label": "runTelemetryCheck",
        "description": [],
        "signature": [
          "() => void"
        ],
        "path": "src/platform/packages/private/kbn-telemetry-tools/src/cli/run_telemetry_check.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/telemetry-tools",
        "id": "def-server.runTelemetryExtract",
        "type": "Function",
        "tags": [],
        "label": "runTelemetryExtract",
        "description": [],
        "signature": [
          "() => void"
        ],
        "path": "src/platform/packages/private/kbn-telemetry-tools/src/cli/run_telemetry_extract.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}