kibana/api_docs/kbn_investigation_shared.devdocs.json

1556 lines
No EOL
45 KiB
JSON

{
"id": "@kbn/investigation-shared",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.CreateInvestigationItemParams",
"type": "Type",
"tags": [],
"label": "CreateInvestigationItemParams",
"description": [],
"signature": [
"{ title: string; type: string; params: { [x: string]: any; }; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.CreateInvestigationItemResponse",
"type": "Type",
"tags": [],
"label": "CreateInvestigationItemResponse",
"description": [],
"signature": [
"{ id: string; createdAt: number; createdBy: string; } & { title: string; type: string; params: { [x: string]: any; }; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.CreateInvestigationNoteParams",
"type": "Type",
"tags": [],
"label": "CreateInvestigationNoteParams",
"description": [],
"signature": [
"{ content: string; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.CreateInvestigationNoteResponse",
"type": "Type",
"tags": [],
"label": "CreateInvestigationNoteResponse",
"description": [],
"signature": [
"{ id: string; content: string; createdAt: number; createdBy: string; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.CreateInvestigationParams",
"type": "Type",
"tags": [],
"label": "CreateInvestigationParams",
"description": [],
"signature": [
"{ id: string; title: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.CreateInvestigationResponse",
"type": "Type",
"tags": [],
"label": "CreateInvestigationResponse",
"description": [],
"signature": [
"{ id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; items: ({ id: string; createdAt: number; createdBy: string; } & { title: string; type: string; params: { [x: string]: any; }; })[]; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.DeleteInvestigationItemParams",
"type": "Type",
"tags": [],
"label": "DeleteInvestigationItemParams",
"description": [],
"signature": [
"{ investigationId: string; itemId: string; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/delete_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.DeleteInvestigationNoteParams",
"type": "Type",
"tags": [],
"label": "DeleteInvestigationNoteParams",
"description": [],
"signature": [
"{ investigationId: string; noteId: string; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/delete_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.DeleteInvestigationParams",
"type": "Type",
"tags": [],
"label": "DeleteInvestigationParams",
"description": [],
"signature": [
"{ investigationId: string; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/delete.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.FindInvestigationsParams",
"type": "Type",
"tags": [],
"label": "FindInvestigationsParams",
"description": [],
"signature": [
"{ alertId?: string | undefined; page?: string | undefined; perPage?: string | undefined; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/find.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.FindInvestigationsResponse",
"type": "Type",
"tags": [],
"label": "FindInvestigationsResponse",
"description": [],
"signature": [
"{ page: number; perPage: number; total: number; results: { id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; items: ({ id: string; createdAt: number; createdBy: string; } & { title: string; type: string; params: { [x: string]: any; }; })[]; }[]; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/find.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.GetInvestigationItemsResponse",
"type": "Type",
"tags": [],
"label": "GetInvestigationItemsResponse",
"description": [],
"signature": [
"({ id: string; createdAt: number; createdBy: string; } & { title: string; type: string; params: { [x: string]: any; }; })[]"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/get_items.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.GetInvestigationNotesResponse",
"type": "Type",
"tags": [],
"label": "GetInvestigationNotesResponse",
"description": [],
"signature": [
"{ id: string; content: string; createdAt: number; createdBy: string; }[]"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/get_notes.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.GetInvestigationParams",
"type": "Type",
"tags": [],
"label": "GetInvestigationParams",
"description": [],
"signature": [
"{ investigationId: string; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/get.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.GetInvestigationResponse",
"type": "Type",
"tags": [],
"label": "GetInvestigationResponse",
"description": [],
"signature": [
"{ id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; items: ({ id: string; createdAt: number; createdBy: string; } & { title: string; type: string; params: { [x: string]: any; }; })[]; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/get.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.InvestigationItem",
"type": "Type",
"tags": [],
"label": "InvestigationItem",
"description": [],
"signature": [
"{ id: string; createdAt: number; createdBy: string; } & { title: string; type: string; params: { [x: string]: any; }; }"
],
"path": "packages/kbn-investigation-shared/src/schema/investigation_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.InvestigationItemResponse",
"type": "Type",
"tags": [],
"label": "InvestigationItemResponse",
"description": [],
"signature": [
"{ id: string; createdAt: number; createdBy: string; } & { title: string; type: string; params: { [x: string]: any; }; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/investigation_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.InvestigationNoteResponse",
"type": "Type",
"tags": [],
"label": "InvestigationNoteResponse",
"description": [],
"signature": [
"{ id: string; content: string; createdAt: number; createdBy: string; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/investigation_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.Item",
"type": "Type",
"tags": [],
"label": "Item",
"description": [],
"signature": [
"{ title: string; type: string; params: { [x: string]: any; }; }"
],
"path": "packages/kbn-investigation-shared/src/schema/investigation_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.UpdateInvestigationItemParams",
"type": "Type",
"tags": [],
"label": "UpdateInvestigationItemParams",
"description": [],
"signature": [
"{ title: string; type: string; params: { [x: string]: any; }; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.UpdateInvestigationItemResponse",
"type": "Type",
"tags": [],
"label": "UpdateInvestigationItemResponse",
"description": [],
"signature": [
"{ id: string; createdAt: number; createdBy: string; } & { title: string; type: string; params: { [x: string]: any; }; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.UpdateInvestigationNoteParams",
"type": "Type",
"tags": [],
"label": "UpdateInvestigationNoteParams",
"description": [],
"signature": [
"{ content: string; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.UpdateInvestigationNoteResponse",
"type": "Type",
"tags": [],
"label": "UpdateInvestigationNoteResponse",
"description": [],
"signature": [
"{ id: string; content: string; createdAt: number; createdBy: string; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.UpdateInvestigationParams",
"type": "Type",
"tags": [],
"label": "UpdateInvestigationParams",
"description": [],
"signature": [
"{ title?: string | undefined; status?: \"closed\" | \"ongoing\" | undefined; params?: { timeRange: { from: number; to: number; }; } | undefined; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.UpdateInvestigationResponse",
"type": "Type",
"tags": [],
"label": "UpdateInvestigationResponse",
"description": [],
"signature": [
"{ id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; items: ({ id: string; createdAt: number; createdBy: string; } & { title: string; type: string; params: { [x: string]: any; }; })[]; }"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.alertOriginSchema",
"type": "Object",
"tags": [],
"label": "alertOriginSchema",
"description": [],
"signature": [
"TypeC",
"<{ type: ",
"LiteralC",
"<\"alert\">; id: ",
"StringC",
"; }>"
],
"path": "packages/kbn-investigation-shared/src/schema/origin.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.blankOriginSchema",
"type": "Object",
"tags": [],
"label": "blankOriginSchema",
"description": [],
"signature": [
"TypeC",
"<{ type: ",
"LiteralC",
"<\"blank\">; }>"
],
"path": "packages/kbn-investigation-shared/src/schema/origin.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.createInvestigationItemParamsSchema",
"type": "Object",
"tags": [],
"label": "createInvestigationItemParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.createInvestigationItemResponseSchema",
"type": "Object",
"tags": [],
"label": "createInvestigationItemResponseSchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>, ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>]>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.createInvestigationNoteParamsSchema",
"type": "Object",
"tags": [],
"label": "createInvestigationNoteParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ content: ",
"StringC",
"; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.createInvestigationNoteResponseSchema",
"type": "Object",
"tags": [],
"label": "createInvestigationNoteResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; content: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.createInvestigationParamsSchema",
"type": "Object",
"tags": [],
"label": "createInvestigationParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ body: ",
"TypeC",
"<{ id: ",
"StringC",
"; title: ",
"StringC",
"; params: ",
"TypeC",
"<{ timeRange: ",
"TypeC",
"<{ from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>; }>; origin: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"alert\">; id: ",
"StringC",
"; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"blank\">; }>]>; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.createInvestigationResponseSchema",
"type": "Object",
"tags": [],
"label": "createInvestigationResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; title: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; params: ",
"TypeC",
"<{ timeRange: ",
"TypeC",
"<{ from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>; }>; origin: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"alert\">; id: ",
"StringC",
"; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"blank\">; }>]>; status: ",
"UnionC",
"<[",
"LiteralC",
"<\"ongoing\">, ",
"LiteralC",
"<\"closed\">]>; notes: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; content: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>>; items: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>, ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>]>>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/create.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.deleteInvestigationItemParamsSchema",
"type": "Object",
"tags": [],
"label": "deleteInvestigationItemParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; itemId: ",
"StringC",
"; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/delete_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.deleteInvestigationNoteParamsSchema",
"type": "Object",
"tags": [],
"label": "deleteInvestigationNoteParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; noteId: ",
"StringC",
"; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/delete_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.deleteInvestigationParamsSchema",
"type": "Object",
"tags": [],
"label": "deleteInvestigationParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/delete.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.findInvestigationsParamsSchema",
"type": "Object",
"tags": [],
"label": "findInvestigationsParamsSchema",
"description": [],
"signature": [
"PartialC",
"<{ query: ",
"PartialC",
"<{ alertId: ",
"StringC",
"; page: ",
"StringC",
"; perPage: ",
"StringC",
"; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/find.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.findInvestigationsResponseSchema",
"type": "Object",
"tags": [],
"label": "findInvestigationsResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ page: ",
"NumberC",
"; perPage: ",
"NumberC",
"; total: ",
"NumberC",
"; results: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; title: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; params: ",
"TypeC",
"<{ timeRange: ",
"TypeC",
"<{ from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>; }>; origin: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"alert\">; id: ",
"StringC",
"; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"blank\">; }>]>; status: ",
"UnionC",
"<[",
"LiteralC",
"<\"ongoing\">, ",
"LiteralC",
"<\"closed\">]>; notes: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; content: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>>; items: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>, ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>]>>; }>>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/find.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.getInvestigationItemsParamsSchema",
"type": "Object",
"tags": [],
"label": "getInvestigationItemsParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/get_items.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.getInvestigationItemsResponseSchema",
"type": "Object",
"tags": [],
"label": "getInvestigationItemsResponseSchema",
"description": [],
"signature": [
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>, ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>]>>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/get_items.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.getInvestigationNotesParamsSchema",
"type": "Object",
"tags": [],
"label": "getInvestigationNotesParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/get_notes.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.getInvestigationNotesResponseSchema",
"type": "Object",
"tags": [],
"label": "getInvestigationNotesResponseSchema",
"description": [],
"signature": [
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; content: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/get_notes.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.getInvestigationParamsSchema",
"type": "Object",
"tags": [],
"label": "getInvestigationParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/get.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.getInvestigationResponseSchema",
"type": "Object",
"tags": [],
"label": "getInvestigationResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; title: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; params: ",
"TypeC",
"<{ timeRange: ",
"TypeC",
"<{ from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>; }>; origin: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"alert\">; id: ",
"StringC",
"; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"blank\">; }>]>; status: ",
"UnionC",
"<[",
"LiteralC",
"<\"ongoing\">, ",
"LiteralC",
"<\"closed\">]>; notes: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; content: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>>; items: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>, ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>]>>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/get.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.investigationItemResponseSchema",
"type": "Object",
"tags": [],
"label": "investigationItemResponseSchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>, ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>]>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/investigation_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.investigationItemSchema",
"type": "Object",
"tags": [],
"label": "investigationItemSchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>, ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>]>"
],
"path": "packages/kbn-investigation-shared/src/schema/investigation_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.investigationNoteResponseSchema",
"type": "Object",
"tags": [],
"label": "investigationNoteResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; content: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/investigation_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.investigationNoteSchema",
"type": "Object",
"tags": [],
"label": "investigationNoteSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; content: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>"
],
"path": "packages/kbn-investigation-shared/src/schema/investigation_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.investigationSchema",
"type": "Object",
"tags": [],
"label": "investigationSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; title: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; params: ",
"TypeC",
"<{ timeRange: ",
"TypeC",
"<{ from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>; }>; origin: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"alert\">; id: ",
"StringC",
"; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"blank\">; }>]>; status: ",
"UnionC",
"<[",
"LiteralC",
"<\"ongoing\">, ",
"LiteralC",
"<\"closed\">]>; notes: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; content: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>>; items: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>, ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>]>>; }>"
],
"path": "packages/kbn-investigation-shared/src/schema/investigation.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.itemSchema",
"type": "Object",
"tags": [],
"label": "itemSchema",
"description": [],
"signature": [
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>"
],
"path": "packages/kbn-investigation-shared/src/schema/investigation_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.updateInvestigationItemParamsSchema",
"type": "Object",
"tags": [],
"label": "updateInvestigationItemParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; itemId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.updateInvestigationItemResponseSchema",
"type": "Object",
"tags": [],
"label": "updateInvestigationItemResponseSchema",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>, ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>]>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update_item.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.updateInvestigationNoteParamsSchema",
"type": "Object",
"tags": [],
"label": "updateInvestigationNoteParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; noteId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ content: ",
"StringC",
"; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.updateInvestigationNoteResponseSchema",
"type": "Object",
"tags": [],
"label": "updateInvestigationNoteResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; content: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update_note.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.updateInvestigationParamsSchema",
"type": "Object",
"tags": [],
"label": "updateInvestigationParamsSchema",
"description": [],
"signature": [
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; body: ",
"PartialC",
"<{ title: ",
"StringC",
"; status: ",
"UnionC",
"<[",
"LiteralC",
"<\"ongoing\">, ",
"LiteralC",
"<\"closed\">]>; params: ",
"TypeC",
"<{ timeRange: ",
"TypeC",
"<{ from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>; }>; }>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/investigation-shared",
"id": "def-common.updateInvestigationResponseSchema",
"type": "Object",
"tags": [],
"label": "updateInvestigationResponseSchema",
"description": [],
"signature": [
"TypeC",
"<{ id: ",
"StringC",
"; title: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; params: ",
"TypeC",
"<{ timeRange: ",
"TypeC",
"<{ from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>; }>; origin: ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"alert\">; id: ",
"StringC",
"; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<\"blank\">; }>]>; status: ",
"UnionC",
"<[",
"LiteralC",
"<\"ongoing\">, ",
"LiteralC",
"<\"closed\">]>; notes: ",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; content: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>>; items: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; createdAt: ",
"NumberC",
"; createdBy: ",
"StringC",
"; }>, ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>]>>; }>"
],
"path": "packages/kbn-investigation-shared/src/rest_specs/update.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}