github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/investigate_app.devdocs.json

313 lines
No EOL
14 KiB
JSON
Raw Blame History

{
"id": "investigateApp",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "investigateApp",
"id": "def-public.InvestigateAppPublicSetup",
"type": "Interface",
"tags": [],
"label": "InvestigateAppPublicSetup",
"description": [],
"path": "x-pack/plugins/observability_solution/investigate_app/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "investigateApp",
"id": "def-public.InvestigateAppPublicStart",
"type": "Interface",
"tags": [],
"label": "InvestigateAppPublicStart",
"description": [],
"path": "x-pack/plugins/observability_solution/investigate_app/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "investigateApp",
"id": "def-server.InvestigateAppServerRouteRepository",
"type": "Type",
"tags": [],
"label": "InvestigateAppServerRouteRepository",
"description": [],
"signature": [
"{ \"GET /api/observability/investigations/{investigationId}/items 2023-10-31\": { endpoint: \"GET /api/observability/investigations/{investigationId}/items 2023-10-31\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { path: { investigationId: string; }; }; }) => Promise<({ id: string; createdAt: number; createdBy: string; } & { title: string; type: string; params: { [x: string]: any; }; })[]>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"PUT /api/observability/investigations/{investigationId}/items/{itemId} 2023-10-31\": { endpoint: \"PUT /api/observability/investigations/{investigationId}/items/{itemId} 2023-10-31\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; itemId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { path: { investigationId: string; itemId: string; }; body: { title: string; type: string; params: { [x: string]: any; }; }; }; }) => Promise<void>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"DELETE /api/observability/investigations/{investigationId}/items/{itemId} 2023-10-31\": { endpoint: \"DELETE /api/observability/investigations/{investigationId}/items/{itemId} 2023-10-31\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; itemId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { path: { investigationId: string; itemId: string; }; }; }) => Promise<void>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"POST /api/observability/investigations/{investigationId}/items 2023-10-31\": { endpoint: \"POST /api/observability/investigations/{investigationId}/items 2023-10-31\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ title: ",
"StringC",
"; type: ",
"StringC",
"; params: ",
"RecordC",
"<",
"StringC",
", ",
"AnyC",
">; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { path: { investigationId: string; }; body: { title: string; type: string; params: { [x: string]: any; }; }; }; }) => Promise<{ id: string; createdAt: number; createdBy: string; } & { title: string; type: string; params: { [x: string]: any; }; }>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"DELETE /api/observability/investigations/{investigationId}/notes/{noteId} 2023-10-31\": { endpoint: \"DELETE /api/observability/investigations/{investigationId}/notes/{noteId} 2023-10-31\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; noteId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { path: { investigationId: string; noteId: string; }; }; }) => Promise<void>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"PUT /api/observability/investigations/{investigationId}/notes/{noteId} 2023-10-31\": { endpoint: \"PUT /api/observability/investigations/{investigationId}/notes/{noteId} 2023-10-31\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; noteId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ content: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { path: { investigationId: string; noteId: string; }; body: { content: string; }; }; }) => Promise<void>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"GET /api/observability/investigations/{investigationId}/notes 2023-10-31\": { endpoint: \"GET /api/observability/investigations/{investigationId}/notes 2023-10-31\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { path: { investigationId: string; }; }; }) => Promise<{ id: string; content: string; createdAt: number; createdBy: string; }[]>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"POST /api/observability/investigations/{investigationId}/notes 2023-10-31\": { endpoint: \"POST /api/observability/investigations/{investigationId}/notes 2023-10-31\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; body: ",
"TypeC",
"<{ content: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { path: { investigationId: string; }; body: { content: string; }; }; }) => Promise<{ id: string; content: string; createdAt: number; createdBy: string; }>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"DELETE /api/observability/investigations/{investigationId} 2023-10-31\": { endpoint: \"DELETE /api/observability/investigations/{investigationId} 2023-10-31\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { path: { investigationId: string; }; }; }) => Promise<void>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"PUT /api/observability/investigations/{investigationId} 2023-10-31\": { endpoint: \"PUT /api/observability/investigations/{investigationId} 2023-10-31\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; body: ",
"PartialC",
"<{ title: ",
"StringC",
"; status: ",
"UnionC",
"<[",
"LiteralC",
"<\"ongoing\">, ",
"LiteralC",
"<\"closed\">]>; params: ",
"TypeC",
"<{ timeRange: ",
"TypeC",
"<{ from: ",
"NumberC",
"; to: ",
"NumberC",
"; }>; }>; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { path: { investigationId: string; }; body: { title?: string | undefined; status?: \"closed\" | \"ongoing\" | undefined; params?: { timeRange: { from: number; to: number; }; } | undefined; }; }; }) => Promise<{ 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; }; })[]; }>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"GET /api/observability/investigations/{investigationId} 2023-10-31\": { endpoint: \"GET /api/observability/investigations/{investigationId} 2023-10-31\"; params?: ",
"TypeC",
"<{ path: ",
"TypeC",
"<{ investigationId: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { path: { investigationId: string; }; }; }) => Promise<{ 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; }; })[]; }>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"GET /api/observability/investigations 2023-10-31\": { endpoint: \"GET /api/observability/investigations 2023-10-31\"; params?: ",
"PartialC",
"<{ query: ",
"PartialC",
"<{ alertId: ",
"StringC",
"; page: ",
"StringC",
"; perPage: ",
"StringC",
"; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params?: { query?: { alertId?: string | undefined; page?: string | undefined; perPage?: string | undefined; } | undefined; } | undefined; }) => Promise<{ 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; }; })[]; }[]; }>; } & ",
"InvestigateAppRouteCreateOptions",
"; \"POST /api/observability/investigations 2023-10-31\": { endpoint: \"POST /api/observability/investigations 2023-10-31\"; params?: ",
"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\">; }>]>; }>; }> | undefined; handler: ({}: ",
"InvestigateAppRouteHandlerResources",
" & { params: { body: { id: string; title: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; }; }; }) => Promise<{ 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; }; })[]; }>; } & ",
"InvestigateAppRouteCreateOptions",
"; }"
],
"path": "x-pack/plugins/observability_solution/investigate_app/server/routes/get_global_investigate_app_server_route_repository.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "investigateApp",
"id": "def-server.InvestigateAppServerSetup",
"type": "Interface",
"tags": [],
"label": "InvestigateAppServerSetup",
"description": [],
"path": "x-pack/plugins/observability_solution/investigate_app/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "investigateApp",
"id": "def-server.InvestigateAppServerStart",
"type": "Interface",
"tags": [],
"label": "InvestigateAppServerStart",
"description": [],
"path": "x-pack/plugins/observability_solution/investigate_app/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink