kibana/api_docs/kbn_observability_alert_details.devdocs.json

{
  "id": "@kbn/observability-alert-details",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/observability-alert-details",
        "id": "def-common.AlertActiveTimeRangeAnnotation",
        "type": "Function",
        "tags": [],
        "label": "AlertActiveTimeRangeAnnotation",
        "description": [],
        "signature": [
          "({ alertStart, alertEnd, color, id }: Props) => JSX.Element"
        ],
        "path": "x-pack/packages/observability/alert_details/src/components/alert_active_time_range_annotation.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/observability-alert-details",
            "id": "def-common.AlertActiveTimeRangeAnnotation.$1",
            "type": "Object",
            "tags": [],
            "label": "{ alertStart, alertEnd, color, id }",
            "description": [],
            "signature": [
              "Props"
            ],
            "path": "x-pack/packages/observability/alert_details/src/components/alert_active_time_range_annotation.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/observability-alert-details",
        "id": "def-common.AlertAnnotation",
        "type": "Function",
        "tags": [],
        "label": "AlertAnnotation",
        "description": [],
        "signature": [
          "({ alertStart, color, dateFormat, id }: Props) => JSX.Element"
        ],
        "path": "x-pack/packages/observability/alert_details/src/components/alert_annotation.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/observability-alert-details",
            "id": "def-common.AlertAnnotation.$1",
            "type": "Object",
            "tags": [],
            "label": "{ alertStart, color, dateFormat, id }",
            "description": [],
            "signature": [
              "Props"
            ],
            "path": "x-pack/packages/observability/alert_details/src/components/alert_annotation.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/observability-alert-details",
        "id": "def-common.AlertThresholdAnnotation",
        "type": "Function",
        "tags": [],
        "label": "AlertThresholdAnnotation",
        "description": [],
        "signature": [
          "({ threshold, color, id }: Props) => JSX.Element"
        ],
        "path": "x-pack/packages/observability/alert_details/src/components/alert_threshold_annotation.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/observability-alert-details",
            "id": "def-common.AlertThresholdAnnotation.$1",
            "type": "Object",
            "tags": [],
            "label": "{ threshold, color, id }",
            "description": [],
            "signature": [
              "Props"
            ],
            "path": "x-pack/packages/observability/alert_details/src/components/alert_threshold_annotation.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/observability-alert-details",
        "id": "def-common.AlertThresholdTimeRangeRect",
        "type": "Function",
        "tags": [],
        "label": "AlertThresholdTimeRangeRect",
        "description": [],
        "signature": [
          "({ alertStarted, color, id, threshold }: Props) => JSX.Element"
        ],
        "path": "x-pack/packages/observability/alert_details/src/components/alert_threshold_time_range_rect.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/observability-alert-details",
            "id": "def-common.AlertThresholdTimeRangeRect.$1",
            "type": "Object",
            "tags": [],
            "label": "{ alertStarted, color, id, threshold }",
            "description": [],
            "signature": [
              "Props"
            ],
            "path": "x-pack/packages/observability/alert_details/src/components/alert_threshold_time_range_rect.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/observability-alert-details",
        "id": "def-common.getPaddedAlertTimeRange",
        "type": "Function",
        "tags": [],
        "label": "getPaddedAlertTimeRange",
        "description": [],
        "signature": [
          "(alertStart: string, alertEnd?: string | undefined) => ",
          "TimeRange"
        ],
        "path": "x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/observability-alert-details",
            "id": "def-common.getPaddedAlertTimeRange.$1",
            "type": "string",
            "tags": [],
            "label": "alertStart",
            "description": [],
            "signature": [
              "string"
            ],
            "path": "x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/observability-alert-details",
            "id": "def-common.getPaddedAlertTimeRange.$2",
            "type": "string",
            "tags": [],
            "label": "alertEnd",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/observability-alert-details",
        "id": "def-common.useAlertsHistory",
        "type": "Function",
        "tags": [],
        "label": "useAlertsHistory",
        "description": [],
        "signature": [
          "({ featureIds, ruleId, dateRange, http }: ",
          "Props",
          ") => ",
          "UseAlertsHistory"
        ],
        "path": "x-pack/packages/observability/alert_details/src/hooks/use_alerts_history.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/observability-alert-details",
            "id": "def-common.useAlertsHistory.$1",
            "type": "Object",
            "tags": [],
            "label": "{ featureIds, ruleId, dateRange, http }",
            "description": [],
            "signature": [
              "Props"
            ],
            "path": "x-pack/packages/observability/alert_details/src/hooks/use_alerts_history.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}