kibana/api_docs/inventory.devdocs.json

{
  "id": "inventory",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "inventory",
      "id": "def-public.InventoryPublicSetup",
      "type": "Interface",
      "tags": [],
      "label": "InventoryPublicSetup",
      "description": [],
      "path": "x-pack/solutions/observability/plugins/inventory/public/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "inventory",
      "id": "def-public.InventoryPublicStart",
      "type": "Interface",
      "tags": [],
      "label": "InventoryPublicStart",
      "description": [],
      "path": "x-pack/solutions/observability/plugins/inventory/public/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "inventory",
        "id": "def-server.InventoryServerRouteRepository",
        "type": "Type",
        "tags": [],
        "label": "InventoryServerRouteRepository",
        "description": [],
        "signature": [
          "{ \"GET /internal/inventory/has_data\": ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.ServerRoute",
            "text": "ServerRoute"
          },
          "<\"GET /internal/inventory/has_data\", undefined, ",
          "InventoryRouteHandlerResources",
          ", { hasData: boolean; }, ",
          "InventoryRouteCreateOptions",
          ">; \"GET /internal/inventory/entity/definitions/sources\": ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.ServerRoute",
            "text": "ServerRoute"
          },
          "<\"GET /internal/inventory/entity/definitions/sources\", undefined, ",
          "InventoryRouteHandlerResources",
          ", { definitionIndexPatterns: Record<string, string[]>; }, ",
          "InventoryRouteCreateOptions",
          ">; \"GET /internal/inventory/entities/types\": ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.ServerRoute",
            "text": "ServerRoute"
          },
          "<\"GET /internal/inventory/entities/types\", ",
          "PartialC",
          "<{ query: ",
          "PartialC",
          "<{ includeEntityTypes: ",
          "Type",
          "<string[], string, unknown>; excludeEntityTypes: ",
          "Type",
          "<string[], string, unknown>; kuery: ",
          "StringC",
          "; }>; }>, ",
          "InventoryRouteHandlerResources",
          ", { entityTypes: { count: number; id: string; display_name: string; }[]; totalEntities: number; }, ",
          "InventoryRouteCreateOptions",
          ">; \"GET /internal/inventory/entities\": ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.ServerRoute",
            "text": "ServerRoute"
          },
          "<\"GET /internal/inventory/entities\", ",
          "TypeC",
          "<{ query: ",
          "IntersectionC",
          "<[",
          "TypeC",
          "<{ sortField: ",
          "UnionC",
          "<[",
          "LiteralC",
          "<\"entityDisplayName\">, ",
          "LiteralC",
          "<\"entityLastSeenTimestamp\">, ",
          "LiteralC",
          "<\"entityType\">, ",
          "LiteralC",
          "<\"alertsCount\">, ",
          "LiteralC",
          "<\"actions\">]>; sortDirection: ",
          "UnionC",
          "<[",
          "LiteralC",
          "<\"asc\">, ",
          "LiteralC",
          "<\"desc\">]>; entityType: ",
          "StringC",
          "; }>, ",
          "PartialC",
          "<{ kuery: ",
          "StringC",
          "; }>]>; }>, ",
          "InventoryRouteHandlerResources",
          ", { entities: ",
          "InventoryEntity",
          "[]; }, ",
          "InventoryRouteCreateOptions",
          ">; }"
        ],
        "path": "x-pack/solutions/observability/plugins/inventory/server/routes/get_global_inventory_route_repository.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "setup": {
      "parentPluginId": "inventory",
      "id": "def-server.InventoryServerSetup",
      "type": "Interface",
      "tags": [],
      "label": "InventoryServerSetup",
      "description": [],
      "path": "x-pack/solutions/observability/plugins/inventory/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "inventory",
      "id": "def-server.InventoryServerStart",
      "type": "Interface",
      "tags": [],
      "label": "InventoryServerStart",
      "description": [],
      "path": "x-pack/solutions/observability/plugins/inventory/server/types.ts",
      "deprecated": false,
      "trackAdoption": false,
      "children": [],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}